GetBidOpportunities 服務作業 - Ad Insight

取得指定廣告群組的關鍵詞「申請商機」。

估計值是以過去 7 天的效能數據為基礎，而不是預測或保證未來的效能。

注意事項

此作業已針對使用手動的一手動的地道的搜尋活動進行優化。 隨著 2021 年 4 月搜尋活動手動的一段時間，此作業已被取代。

要求專案

GetBidOpportunitiesRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AdGroupId	您要決定關鍵字中標示商機之廣告群組的標識碼。 如果此元素為 nil 或空白，作業會傳回指定之行銷活動的所有申請機會。	長
CampaignId	活動標識碼，該活動擁有 AdGroupId 元素中指定的廣告群組。 如果此元素為 nil 或空白， 則 AdGroupId 也必須是 nil 或空白，且作業會傳回帳戶的所有中標商機。	長
OpportunityType	決定與您的廣告位置目標對應的中標商機類型。 只有當您目前的約定中有 100% 內的建議增加可協助您達成指定的目標時，作業才會傳回商機。	BidOpportunityType

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

GetBidOpportunitiesResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
機會	BidOpportunity 物件的數位，識別如果您要套用建議的比對類型標示值，其點擊次數和曝光數可能會增加的關鍵詞。 目前最多可以傳回 1,000 個清單專案，但限制可能會變更。	BidOpportunity 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求SOAP

此範本是由工具所產生，用來顯示SOAP要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

<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>

回應 SOAP

此範本是由工具所產生，用來顯示SOAP回應的 主體 和 標頭 元素順序。

<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>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)

需求

服務： AdInsightService.svc v13
命名空間： https://bingads.microsoft.com/AdInsight/v13

要求 URL

生產URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidOpportunities/Query

沙箱 URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/BidOpportunities/Query

要求專案

GetBidOpportunitiesRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AdGroupId	您要決定關鍵字中標示商機之廣告群組的標識碼。 如果此元素為 nil 或空白，作業會傳回指定之行銷活動的所有申請機會。	長
CampaignId	活動標識碼，該活動擁有 AdGroupId 元素中指定的廣告群組。 如果此元素為 nil 或空白， 則 AdGroupId 也必須是 nil 或空白，且作業會傳回帳戶的所有中標商機。	長
OpportunityType	決定與您的廣告位置目標對應的中標商機類型。 只有當您目前的約定中有 100% 內的建議增加可協助您達成指定的目標時，作業才會傳回商機。	BidOpportunityType

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

GetBidOpportunitiesResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
機會	BidOpportunity 物件的數位，識別如果您要套用建議的比對類型標示值，其點擊次數和曝光數可能會增加的關鍵詞。 目前最多可以傳回 1,000 個清單專案，但限制可能會變更。	BidOpportunity 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "AdGroupId": "LongValueHere",
  "CampaignId": "LongValueHere",
  "OpportunityType": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "Opportunities": [
    {
      "AdGroupId": "LongValueHere",
      "CampaignId": "LongValueHere",
      "CurrentBid": DoubleValueHere,
      "EstimatedIncreaseInClicks": DoubleValueHere,
      "EstimatedIncreaseInCost": DoubleValueHere,
      "EstimatedIncreaseInImpressions": "LongValueHere",
      "KeywordId": "LongValueHere",
      "MatchType": "ValueHere",
      "SuggestedBid": DoubleValueHere
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)