GetRecommendations 服務作業 - Ad Insight

發行項
12/21/2023

探索您的建議。

要求專案

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

注意事項

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

要求本文專案

元素	說明	資料類型
AdGroupId	您想要判斷回應式搜尋廣告商機之廣告群組的識別碼。如果此元素為 nil 或空白，作業會傳回指定行銷活動特定建議類型的所有機會。	長
CampaignId	活動識別碼，該活動擁有 AdGroupId 元素中指定的廣告群組。如果此元素為 nil 或空白，則 AdGroupId 也必須是 nil 或空白，而且作業會傳回帳戶特定建議類型的所有機會。	長
RecommendationType	您想要取得之建議類型的識別碼。目前僅支援 ResponsiveSearchAdsOpportunity 。這個專案不能是 nil 或空白。每個要求一個建議類型，例如 ResponsiveSearchAdsOpportunity。	string

要求標頭元素

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

Response 元素

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

回應本文專案

元素	說明	資料類型
建議	Recommendation物件的陣列。最多可以傳回 2,000 個清單專案。	建議陣列

回應標頭元素

元素	說明	資料類型
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">GetRecommendations</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>
    <GetRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <RecommendationType i:nil="false">ValueHere</RecommendationType>
    </GetRecommendationsRequest>
  </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>
    <GetRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Recommendation d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AccountId>ValueHere</AccountId>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CurrentClicks>ValueHere</CurrentClicks>
          <CurrentConversions>ValueHere</CurrentConversions>
          <CurrentCost>ValueHere</CurrentCost>
          <CurrentImpressions>ValueHere</CurrentImpressions>
          <EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
          <EstimatedIncreaseInConversions>ValueHere</EstimatedIncreaseInConversions>
          <EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
          <EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
          <RecommendationHash d4p1:nil="false">ValueHere</RecommendationHash>
          <RecommendationId d4p1:nil="false">ValueHere</RecommendationId>
          <RecommendationType d4p1:nil="false">ValueHere</RecommendationType>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsRecommendation-->
          <SuggestedAd d4p1:nil="false">
            <Descriptions d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Descriptions>
            <FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
            <Headlines d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Headlines>
            <Path1 d4p1:nil="false">ValueHere</Path1>
            <Path2 d4p1:nil="false">ValueHere</Path2>
          </SuggestedAd>
        </Recommendation>
      </Recommendations>
    </GetRecommendationsResponse>
  </s:Body>
</s:Envelope>

程式碼語法

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

public async Task<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

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

static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

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

static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

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

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

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

response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)

需求

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

共用方式為