Skip to content

Latest commit

 

History

History
175 lines (152 loc) · 7.96 KB

getrecommendations.md

File metadata and controls

175 lines (152 loc) · 7.96 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description dev_langs
GetRecommendations Service Operation - Ad Insight
bing-ads
ad-insight-api
article
jonmeyers
jonmeyers
Discover your recommendations.
csharp
java
php
python

GetRecommendations Service Operation - Ad Insight

Discover your recommendations.

Request Elements

The GetRecommendationsRequest 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

Element Description Data Type
AdGroupId The identifier of the ad group for which you want to determine responsive search ads opportunities.

If this element is nil or empty, the operation will return all opportunities of certain recommendation type for the specified campaign.		 long
CampaignId The identifier of the campaign that owns the ad group specified in the AdGroupId element.

If this element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all opportunities of a certain recommendation type for the account.		 long
RecommendationType The identifier of the recommendation type that you want to get. Currently only ResponsiveSearchAdsOpportunity is supported.

This element can't be nil or empty. One recommendation type per request, e.g., ResponsiveSearchAdsOpportunity.		 string

Request Header Elements

[!INCLUDErequest-header]

Response Elements

The GetRecommendationsResponse 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 An array of Recommendation objects.

2,000 list items can be returned at maximum.		 Recommendation array

Response Header Elements

[!INCLUDEresponse-header]

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">GetRecommendations</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>
    <GetRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <RecommendationType i:nil="false">ValueHere</RecommendationType>
    </GetRecommendationsRequest>
  </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>
    <GetRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Recommendation d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AccountId>ValueHere</AccountId>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CurrentClicks>ValueHere</CurrentClicks>
          <CurrentConversions>ValueHere</CurrentConversions>
          <CurrentCost>ValueHere</CurrentCost>
          <CurrentImpressions>ValueHere</CurrentImpressions>
          <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>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsRecommendation-->
          <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>
        </Recommendation>
      </Recommendations>
    </GetRecommendationsResponse>
  </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<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetRecommendationsAsync(r), request));
}
static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

	return AdInsightService.getService().getRecommendations(request);
}
static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

	return $GLOBALS['AdInsightProxy']->GetService()->GetRecommendations($request);
}
response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13