Edit

Share via

KeywordRecommendation Data Object - Ad Insight

  • Article

Defines a KeywordRecommendation data object.

Syntax

<xs:complexType name="KeywordRecommendation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:RecommendationBase">
      <xs:sequence>
        <xs:element minOccurs="0" name="Competition" type="xs:double" />
        <xs:element minOccurs="0" name="MatchType" type="xs:int" />
        <xs:element minOccurs="0" name="MonthlySearches" type="xs:long" />
        <xs:element minOccurs="0" name="SuggestedBid" type="xs:double" />
        <xs:element minOccurs="0" name="SuggestedKeyword" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The KeywordRecommendation object has the following elements: Competition, MatchType, MonthlySearches, SuggestedBid, SuggestedKeyword.

Element Description Data Type
Competition An indicator of competitive bids for this keyword relative to all search keywords. The competition score ranges from 0 to 1.00, where 0 indicates low competition and 1.00 indicates that there is a high number of advertisers competing for this keyword. Output only. double
MatchType The match type that the suggested bid applies to. Output only.

The following are the possible match-type values:
  • 1 - Exact match
  • 2 - Phrase match
  • 3 - Broad match
 int
MonthlySearches The estimated monthly volume of user search queries that may match the suggested keyword for the corresponding MatchType element. Output only. long
SuggestedBid The suggested bid that may result in your ads serving on the first page of the search query results. Output only. double
SuggestedKeyword The text of the keyword (at most 80 characters and 10 words). Output only. string

The KeywordRecommendation object has Inherited Elements.

Inherited Elements

Inherited Elements from RecommendationBase

The KeywordRecommendation object derives from the RecommendationBase object, and inherits the following elements: AccountId, AccountName, AdGroupId, AdGroupName, CampaignId, CampaignName, CurrentClicks, CurrentConversions, CurrentCost, CurrentImpressions, Dismissed, EstimatedIncreaseInClicks, EstimatedIncreaseInConversions, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, RecommendationHash, RecommendationId, RecommendationType, Type. The descriptions below are specific to KeywordRecommendation, and might not apply to other objects that inherit the same elements from the RecommendationBase object.

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 CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.		 string
Type The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation. RecommendationType

Requirements

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