BidOpportunity Data Object - Ad Insight

Article
11/13/2024

Defines an object that contains the suggested bid with estimated clicks and impressions opportunities.

Note

The bid opportunity is an estimate based on the last 7 days of performance data, and not a prediction or guarantee of future performance.

XML
JSON

<xs:complexType name="BidOpportunity" 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="CampaignId" type="xs:long" />
        <xs:element minOccurs="0" name="CurrentBid" 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="KeywordId" type="xs:long" />
        <xs:element minOccurs="0" name="MatchType" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="SuggestedBid" type="xs:double" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

{
  "OpportunityKey": "ValueHere",
  "Type": "BidOpportunity",
  "AdGroupId": "LongValueHere",
  "CampaignId": "LongValueHere",
  "CurrentBid": DoubleValueHere,
  "EstimatedIncreaseInClicks": DoubleValueHere,
  "EstimatedIncreaseInCost": DoubleValueHere,
  "EstimatedIncreaseInImpressions": "LongValueHere",
  "KeywordId": "LongValueHere",
  "MatchType": "ValueHere",
  "SuggestedBid": DoubleValueHere
}

Elements

The BidOpportunity object has the following elements: AdGroupId, CampaignId, CurrentBid, EstimatedIncreaseInClicks, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, KeywordId, MatchType, SuggestedBid.

Element	Description	Data Type
AdGroupId	The identifier of the ad group that owns the keyword.	long
CampaignId	The identifier of the campaign for the ad group that owns the keyword.	long
CurrentBid	The current keyword bid amount specified for the match type in the MatchType element.	double
EstimatedIncreaseInClicks	The estimated clicks opportunities corresponding to the suggested bid.	double
EstimatedIncreaseInCost	The estimated increase in spend corresponding to the suggested bid.	double
EstimatedIncreaseInImpressions	The estimated impressions opportunities corresponding to the suggested bid.	long
KeywordId	The identifier of the keyword to which the bid opportunity applies.	long
MatchType	The match type to which the suggested bid value applies. The possible values are BroadMatch, ExactMatch, and PhraseMatch.	string
SuggestedBid	The suggested bid based on the last 7 days of performance history for the corresponding ad group.	double

The BidOpportunity object has Inherited Elements.

Inherited Elements

Inherited Elements from Opportunity

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

GetBidOpportunities

Share via