BroadMatchKeywordOpportunity Data Object - Ad Insight

Article
03/20/2023

Defines an object that contains the marketplace impact statistics of including broad match type keyword bids.

Syntax

<xs:complexType name="BroadMatchKeywordOpportunity" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:KeywordOpportunity">
      <xs:sequence>
        <xs:element minOccurs="0" name="AverageCPC" type="xs:double" />
        <xs:element minOccurs="0" name="AverageCTR" type="xs:double" />
        <xs:element minOccurs="0" name="ClickShare" type="xs:double" />
        <xs:element minOccurs="0" name="ImpressionShare" type="xs:double" />
        <xs:element minOccurs="0" name="ReferenceKeywordBid" type="xs:double" />
        <xs:element minOccurs="0" name="ReferenceKeywordId" type="xs:long" />
        <xs:element minOccurs="0" name="ReferenceKeywordMatchType" type="xs:int" />
        <xs:element minOccurs="0" name="SearchQueryKPIs" nillable="true" type="tns:ArrayOfBroadMatchSearchQueryKPI" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The BroadMatchKeywordOpportunity object has the following elements: AverageCPC, AverageCTR, ClickShare, ImpressionShare, ReferenceKeywordBid, ReferenceKeywordId, ReferenceKeywordMatchType, SearchQueryKPIs.

Element	Description	Data Type
AverageCPC	Broad match average CPC in the marketplace.	double
AverageCTR	Broad match average CTR in the marketplace.	double
ClickShare	Broad match click share in the marketplace.	double
ImpressionShare	Broad match impression share in the marketplace.	double
ReferenceKeywordBid	The bid of an existing reference keyword used by the service to offer the keyword opportunity.	double
ReferenceKeywordId	The identifier of an existing reference keyword used by the service to offer the keyword opportunity.	long
ReferenceKeywordMatchType	The match type of an existing reference keyword used by the service to offer the keyword opportunity. The following are the possible match-type values: 1 - Exact match 2 - Phrase match	int
SearchQueryKPIs	A list of up to three broad match search query KPI objects. Each item contains search query statistics of including broad match type keyword bids	BroadMatchSearchQueryKPI array

The BroadMatchKeywordOpportunity object has Inherited Elements.

Inherited Elements

Inherited Elements from KeywordOpportunity

The BroadMatchKeywordOpportunity object derives from the KeywordOpportunity object, and inherits the following elements: AdGroupId, AdGroupName, CampaignId, CampaignName, Competition, EstimatedIncreaseInClicks, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, MatchType, MonthlySearches, SuggestedBid, SuggestedKeyword. The descriptions below are specific to BroadMatchKeywordOpportunity, and might not apply to other objects that inherit the same elements from the KeywordOpportunity object.

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

Inherited Elements from Opportunity

The BroadMatchKeywordOpportunity object derives from the Opportunity object, and inherits the following elements: OpportunityKey. The descriptions below are specific to BroadMatchKeywordOpportunity, 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

Share via