Edit

KeywordOpportunity Data Object - Ad Insight

  • Article

Defines an object that contains a suggested keyword and bid value.

Syntax

<xs:complexType name="KeywordOpportunity" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Opportunity">
      <xs:sequence>
        <xs:element minOccurs="0" name="AdGroupId" type="xs:long" />
        <xs:element minOccurs="0" name="AdGroupName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="CampaignId" type="xs:long" />
        <xs:element minOccurs="0" name="CampaignName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Competition" type="xs:double" />
        <xs:element minOccurs="0" name="EstimatedIncreaseInClicks" type="xs:double" />
        <xs:element minOccurs="0" name="EstimatedIncreaseInCost" type="xs:double" />
        <xs:element minOccurs="0" name="EstimatedIncreaseInImpressions" type="xs:long" />
        <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 KeywordOpportunity object has the following elements: AdGroupId, AdGroupName, CampaignId, CampaignName, Competition, EstimatedIncreaseInClicks, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, MatchType, MonthlySearches, SuggestedBid, SuggestedKeyword.

Element Description Data Type
AdGroupId The identifier of the ad group to apply the suggested keyword to. long
AdGroupName The name of the ad group to apply the suggested keyword to. string
CampaignId The identifier of the campaign that owns the ad group. long
CampaignName The name of the campaign that owns the ad group. string
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. double
EstimatedIncreaseInClicks Estimated increase in clicks if the opportunity is applied. double
EstimatedIncreaseInCost Estimated increase in cost if the opportunity is applied. double
EstimatedIncreaseInImpressions Estimated increase in impressions if the opportunity is applied. long
MatchType The match type that the suggested bid applies to. 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. long
SuggestedBid The suggested bid that may result in your ads serving on the first page of the search query results. double
SuggestedKeyword The suggested keyword. string

The KeywordOpportunity object has Inherited Elements.

Inherited Elements

Inherited Elements from Opportunity

The KeywordOpportunity object derives from the Opportunity object, and inherits the following elements: OpportunityKey. The descriptions below are specific to KeywordOpportunity, and might not apply to other objects that inherit the same elements from the Opportunity object.

Element Description Data Type
OpportunityKey An identifier that uniquely identifies the opportunity. string

Requirements

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

Used By

GetKeywordOpportunities