Edit

Share via

RecommendationBase Data Object - Ad Insight

  • Article

Defines the RecommendationBase data object.

Syntax

<xs:complexType name="RecommendationBase" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountId" type="xs:long" />
    <xs:element minOccurs="0" name="AccountName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="AdGroupId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="AdGroupName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CampaignId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="CampaignName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CurrentClicks" type="xs:long" />
    <xs:element minOccurs="0" name="CurrentConversions" type="xs:long" />
    <xs:element minOccurs="0" name="CurrentCost" type="xs:double" />
    <xs:element minOccurs="0" name="CurrentImpressions" type="xs:long" />
    <xs:element minOccurs="0" name="Dismissed" type="xs:boolean" />
    <xs:element minOccurs="0" name="EstimatedIncreaseInClicks" type="xs:long" />
    <xs:element minOccurs="0" name="EstimatedIncreaseInConversions" type="xs:long" />
    <xs:element minOccurs="0" name="EstimatedIncreaseInCost" type="xs:double" />
    <xs:element minOccurs="0" name="EstimatedIncreaseInImpressions" type="xs:long" />
    <xs:element minOccurs="0" name="RecommendationHash" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="RecommendationId" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="RecommendationType" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Type" type="tns:RecommendationType" />
  </xs:sequence>
</xs:complexType>

Elements

The RecommendationBase object has the following elements: AccountId, AccountName, AdGroupId, AdGroupName, CampaignId, CampaignName, CurrentClicks, CurrentConversions, CurrentCost, CurrentImpressions, Dismissed, EstimatedIncreaseInClicks, EstimatedIncreaseInConversions, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, RecommendationHash, RecommendationId, RecommendationType, Type.

Element Description Data Type
AccountId The identifier of the account. Output only. long
AccountName The name of the account. Output only. string
AdGroupId The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only.

This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.		 long
AdGroupName The name of the ad group. Output only. string
CampaignId The campaign ID targeted by this recommendation. Output only.

This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD		 long
CampaignName The name of the campaign. Output only. string
CurrentClicks Actual clicks of the ad group in the past 7 days. Output only. long
CurrentConversions Actual conversions of the ad group in the past 7 days. Output only. long
CurrentCost Actual spending of the ad group in the past 7 days, in the currency of this account. double
CurrentImpressions Actual impressions of the ad group in the past 7 days. long
Dismissed Whether the recommendation is dismissed or not. Output only. boolean
EstimatedIncreaseInClicks The estimated click opportunities corresponding to the suggested ad. long
EstimatedIncreaseInConversions The estimated impression opportunities corresponding to the suggested ad. long
EstimatedIncreaseInCost The estimated increase in spend corresponding to the suggested ad. double
EstimatedIncreaseInImpressions The estimated impressions opportunities corresponding to the suggested ad. long
RecommendationHash The hash of the recommendation. string
RecommendationId The identifier of the recommendation. string
RecommendationType The type of recommendation.

Note: We currently support ADD_BROAD_MATCH_KEYWORD, CAMPAIGN_BUDGET, KEYWORD, REMOVE_CONFLICTING_NEGATIVE_KEYWORD, RESPONSIVE_SEARCH_AD, and RESPONSIVE_SEARCH_AD_ASSET. RecommendationType is output only.		 string
Type The RecommendationType value set has the following values: AddBroadMatchKeywordRecommendation, CampaignBudgetRecommendation, KeywordRecommendation, RemoveConflictingNegativeKeywordRecommendation, ResponsiveSearchAdRecommendation, and ResponsiveSearchAdAssetRecommendation. RecommendationType

Requirements

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

Used By

RetrieveRecommendations