GetBidOpportunities Service Operation - Ad Insight

Article
03/20/2023

Gets the keyword bid opportunities of the specified ad group.

The estimates are based on the last 7 days of performance data, and not a prediction or guarantee of future performance.

Note

This operation is optimized for search campaigns using the manual CPC bid strategy. With the sunset of manual CPC for search campaigns in April 2021, this operation is deprecated.

Request Elements

The GetBidOpportunitiesRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
AdGroupId	The identifier of the ad group for which you want to determine keyword bid opportunities. If this element is nil or empty, the operation will return all bid opportunities for the specified campaign.	long
CampaignId	The identifier of the campaign that owns the ad group specified in the AdGroupId element. If this element is nil or empty, then the AdGroupId must also be nil or empty, and the operation will return all bid opportunities for the account.	long
OpportunityType	Determines the type or types of bid opportunities corresponding to your ad position goals. The operation will only return opportunities if there's a suggested increase within 100% of your current bid that will help you achieve the specified goal.	BidOpportunityType

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetBidOpportunitiesResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
Opportunities	An array of BidOpportunity objects that identifies the keywords whose clicks and impressions may increase if you were to apply the suggested match-type bid value. Currently up to 1,000 list items can be returned although the limit is subject to change.	BidOpportunity array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <Action mustUnderstand="1">GetBidOpportunities</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBidOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <OpportunityType>ValueHere</OpportunityType>
    </GetBidOpportunitiesRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBidOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BidOpportunity>
          <AdGroupId>ValueHere</AdGroupId>
          <CampaignId>ValueHere</CampaignId>
          <CurrentBid>ValueHere</CurrentBid>
          <EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
          <EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
          <EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
          <KeywordId>ValueHere</KeywordId>
          <MatchType d4p1:nil="false">ValueHere</MatchType>
          <SuggestedBid>ValueHere</SuggestedBid>
        </BidOpportunity>
      </Opportunities>
    </GetBidOpportunitiesResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetBidOpportunitiesResponse> GetBidOpportunitiesAsync(
	long? adGroupId,
	long? campaignId,
	BidOpportunityType opportunityType)
{
	var request = new GetBidOpportunitiesRequest
	{
		AdGroupId = adGroupId,
		CampaignId = campaignId,
		OpportunityType = opportunityType
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetBidOpportunitiesAsync(r), request));
}

static GetBidOpportunitiesResponse getBidOpportunities(
	java.lang.Long adGroupId,
	java.lang.Long campaignId,
	ArrayList<BidOpportunityType> opportunityType) throws RemoteException, Exception
{
	GetBidOpportunitiesRequest request = new GetBidOpportunitiesRequest();

	request.setAdGroupId(adGroupId);
	request.setCampaignId(campaignId);
	request.setOpportunityType(opportunityType);

	return AdInsightService.getService().getBidOpportunities(request);
}

static function GetBidOpportunities(
	$adGroupId,
	$campaignId,
	$opportunityType)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetBidOpportunitiesRequest();

	$request->AdGroupId = $adGroupId;
	$request->CampaignId = $campaignId;
	$request->OpportunityType = $opportunityType;

	return $GLOBALS['AdInsightProxy']->GetService()->GetBidOpportunities($request);
}

response=adinsight_service.GetBidOpportunities(
	AdGroupId=AdGroupId,
	CampaignId=CampaignId,
	OpportunityType=OpportunityType)

Requirements

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

Share via