RetrieveRecommendations Service Operation - Ad Insight
Retrieve a list of recommendations.
Request Elements
The RetrieveRecommendationsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The RetrieveRecommendationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Recommendations | The available recommendations for specific account ID. The types of recommendations are: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation, and ResponsiveSearchAdAssetRecommendation. | RecommendationBase array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Action mustUnderstand="1">RetrieveRecommendations</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<RetrieveRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<RecommendationTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</RecommendationTypes>
<MaxCount i:nil="false">ValueHere</MaxCount>
</RetrieveRecommendationsRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<RetrieveRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<RecommendationBase d4p1:type="-- derived type specified here with the appropriate prefix --">
<AccountId>ValueHere</AccountId>
<AccountName d4p1:nil="false">ValueHere</AccountName>
<AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
<AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
<CampaignId d4p1:nil="false">ValueHere</CampaignId>
<CampaignName d4p1:nil="false">ValueHere</CampaignName>
<CurrentClicks>ValueHere</CurrentClicks>
<CurrentConversions>ValueHere</CurrentConversions>
<CurrentCost>ValueHere</CurrentCost>
<CurrentImpressions>ValueHere</CurrentImpressions>
<Dismissed>ValueHere</Dismissed>
<EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
<EstimatedIncreaseInConversions>ValueHere</EstimatedIncreaseInConversions>
<EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
<EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
<RecommendationHash d4p1:nil="false">ValueHere</RecommendationHash>
<RecommendationId d4p1:nil="false">ValueHere</RecommendationId>
<RecommendationType d4p1:nil="false">ValueHere</RecommendationType>
<Type>ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to CampaignBudgetRecommendation-->
<BudgetPoints d4p1:nil="false">
<BudgetPoint>
<BudgetAmount>ValueHere</BudgetAmount>
<BudgetPointType>ValueHere</BudgetPointType>
<EstimatedWeeklyClicks>ValueHere</EstimatedWeeklyClicks>
<EstimatedWeeklyCost>ValueHere</EstimatedWeeklyCost>
<EstimatedWeeklyImpressions>ValueHere</EstimatedWeeklyImpressions>
</BudgetPoint>
</BudgetPoints>
<BudgetType>ValueHere</BudgetType>
<CurrentBudget>ValueHere</CurrentBudget>
<RecommendedBudget>ValueHere</RecommendedBudget>
<!--These fields are applicable if the derived type attribute is set to KeywordRecommendation-->
<Competition>ValueHere</Competition>
<MatchType>ValueHere</MatchType>
<MonthlySearches>ValueHere</MonthlySearches>
<SuggestedBid>ValueHere</SuggestedBid>
<SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
<!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdRecommendation-->
<SuggestedAd d4p1:nil="false">
<Descriptions d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Descriptions>
<FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
<Headlines d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Headlines>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
</SuggestedAd>
<!--These fields are applicable if the derived type attribute is set to RemoveConflictingNegativeKeywordRecommendation-->
<NegativeKeyword d4p1:nil="false">ValueHere</NegativeKeyword>
<NegativeKeywordId>ValueHere</NegativeKeywordId>
<NegativeKeywordListName d4p1:nil="false">ValueHere</NegativeKeywordListName>
<NegativeKeywordMatchType>ValueHere</NegativeKeywordMatchType>
<NegativeKeywordSharedListId d4p1:nil="false">ValueHere</NegativeKeywordSharedListId>
<Source d4p1:nil="false">ValueHere</Source>
<!--These fields are applicable if the derived type attribute is set to UseBroadMatchKeywordRecommendation-->
<CurrentMatchType>ValueHere</CurrentMatchType>
<CurrentStatus d4p1:nil="false">ValueHere</CurrentStatus>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<KeywordOrderItemId>ValueHere</KeywordOrderItemId>
<SuggestedBid>ValueHere</SuggestedBid>
<SuggestedMatchType>ValueHere</SuggestedMatchType>
<SuggestedStatus d4p1:nil="false">ValueHere</SuggestedStatus>
<!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAdAssetRecommendation-->
<RecommendedResponsiveSearchAd d4p1:nil="false">
<Descriptions d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Descriptions>
<FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
<Headlines d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Headlines>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
</RecommendedResponsiveSearchAd>
<ResponsiveSearchAdId>ValueHere</ResponsiveSearchAdId>
</RecommendationBase>
</Recommendations>
</RetrieveRecommendationsResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<RetrieveRecommendationsResponse> RetrieveRecommendationsAsync(
IList<string> recommendationTypes,
int? maxCount)
{
var request = new RetrieveRecommendationsRequest
{
RecommendationTypes = recommendationTypes,
MaxCount = maxCount
};
return (await AdInsightService.CallAsync((s, r) => s.RetrieveRecommendationsAsync(r), request));
}
static RetrieveRecommendationsResponse retrieveRecommendations(
ArrayOfstring recommendationTypes,
int maxCount) throws RemoteException, Exception
{
RetrieveRecommendationsRequest request = new RetrieveRecommendationsRequest();
request.setRecommendationTypes(recommendationTypes);
request.setMaxCount(maxCount);
return AdInsightService.getService().retrieveRecommendations(request);
}
static function RetrieveRecommendations(
$recommendationTypes,
$maxCount)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new RetrieveRecommendationsRequest();
$request->RecommendationTypes = $recommendationTypes;
$request->MaxCount = $maxCount;
return $GLOBALS['AdInsightProxy']->GetService()->RetrieveRecommendations($request);
}
response=adinsight_service.RetrieveRecommendations(
RecommendationTypes=RecommendationTypes,
MaxCount=MaxCount)
Requirements
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
Request Url
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/Recommendations/Retrieve
Request Elements
The RetrieveRecommendationsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The RetrieveRecommendationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Recommendations | The available recommendations for specific account ID. The types of recommendations are: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation, and ResponsiveSearchAdAssetRecommendation. | RecommendationBase array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"RecommendationTypes": [
"ValueHere"
],
"MaxCount": IntValueHere
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of RecommendationBase is CampaignBudgetRecommendation.
{
"Recommendations": [
{
"AccountId": "LongValueHere",
"AccountName": "ValueHere",
"AdGroupId": "LongValueHere",
"AdGroupName": "ValueHere",
"CampaignId": "LongValueHere",
"CampaignName": "ValueHere",
"CurrentClicks": "LongValueHere",
"CurrentConversions": "LongValueHere",
"CurrentCost": DoubleValueHere,
"CurrentImpressions": "LongValueHere",
"Dismissed": "ValueHere",
"EstimatedIncreaseInClicks": "LongValueHere",
"EstimatedIncreaseInConversions": "LongValueHere",
"EstimatedIncreaseInCost": DoubleValueHere,
"EstimatedIncreaseInImpressions": "LongValueHere",
"RecommendationHash": "ValueHere",
"RecommendationId": "ValueHere",
"RecommendationType": "ValueHere",
"Type": "CampaignBudgetRecommendation",
"BudgetPoints": [
{
"BudgetAmount": DoubleValueHere,
"BudgetPointType": "ValueHere",
"EstimatedWeeklyClicks": DoubleValueHere,
"EstimatedWeeklyCost": DoubleValueHere,
"EstimatedWeeklyImpressions": DoubleValueHere
}
],
"BudgetType": "ValueHere",
"CurrentBudget": DoubleValueHere,
"RecommendedBudget": DoubleValueHere
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<RetrieveRecommendationsResponse> RetrieveRecommendationsAsync(
IList<string> recommendationTypes,
int? maxCount)
{
var request = new RetrieveRecommendationsRequest
{
RecommendationTypes = recommendationTypes,
MaxCount = maxCount
};
return (await AdInsightService.CallAsync((s, r) => s.RetrieveRecommendationsAsync(r), request));
}
static RetrieveRecommendationsResponse retrieveRecommendations(
ArrayOfstring recommendationTypes,
int maxCount) throws RemoteException, Exception
{
RetrieveRecommendationsRequest request = new RetrieveRecommendationsRequest();
request.setRecommendationTypes(recommendationTypes);
request.setMaxCount(maxCount);
return AdInsightService.getService().retrieveRecommendations(request);
}
static function RetrieveRecommendations(
$recommendationTypes,
$maxCount)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new RetrieveRecommendationsRequest();
$request->RecommendationTypes = $recommendationTypes;
$request->MaxCount = $maxCount;
return $GLOBALS['AdInsightProxy']->GetService()->RetrieveRecommendations($request);
}
response=adinsight_service.RetrieveRecommendations(
RecommendationTypes=RecommendationTypes,
MaxCount=MaxCount)