RetrieveRecommendations 服務作業 - Ad Insight

發行項
03/21/2024

擷取建議清單。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
MaxCount	傳回的建議數目上限。預設值為 null。如果 MaxCount 為 null 或 0，則會傳回所有可用的建議。選用。	int
RecommendationTypes	建議類型名稱：CAMPAIGN_BUDGET、KEYWORD 或 RESPONSIVE_SEARCH_AD。此為必要動作。	字串陣列

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
建議	特定帳戶標識碼的可用建議。建議的類型為： CampaignBudgetRecommendation、 KeywordRecommendation、 ResponsiveSearchAdRecommendation。	RecommendationBase 陣列

回應標頭元素

元素	描述	資料類型
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">RetrieveRecommendations</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>
    <RetrieveRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <RecommendationTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </RecommendationTypes>
      <MaxCount i:nil="false">ValueHere</MaxCount>
    </RetrieveRecommendationsRequest>
  </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>
    <RetrieveRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <RecommendationBase 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>
          <Dismissed>ValueHere</Dismissed>
          <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>
          <Type>ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to CampaignBudgetRecommendation-->
          <BudgetPoints d4p1:nil="false">
            <BudgetPoint>
              <BudgetAmount>ValueHere</BudgetAmount>
              <BudgetPointType>ValueHere</BudgetPointType>
              <EstimatedWeeklyClicks>ValueHere</EstimatedWeeklyClicks>
              <EstimatedWeeklyCost>ValueHere</EstimatedWeeklyCost>
              <EstimatedWeeklyImpressions>ValueHere</EstimatedWeeklyImpressions>
            </BudgetPoint>
          </BudgetPoints>
          <BudgetType>ValueHere</BudgetType>
          <CurrentBudget>ValueHere</CurrentBudget>
          <RecommendedBudget>ValueHere</RecommendedBudget>
          <!--These fields are applicable if the derived type attribute is set to KeywordRecommendation-->
          <Competition>ValueHere</Competition>
          <MatchType>ValueHere</MatchType>
          <MonthlySearches>ValueHere</MonthlySearches>
          <SuggestedBid>ValueHere</SuggestedBid>
          <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdRecommendation-->
          <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>
        </RecommendationBase>
      </Recommendations>
    </RetrieveRecommendationsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<RetrieveRecommendationsResponse> RetrieveRecommendationsAsync(
	IList<string> recommendationTypes,
	int? maxCount)
{
	var request = new RetrieveRecommendationsRequest
	{
		RecommendationTypes = recommendationTypes,
		MaxCount = maxCount
	};

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

static RetrieveRecommendationsResponse retrieveRecommendations(
	ArrayOfstring recommendationTypes,
	int maxCount) throws RemoteException, Exception
{
	RetrieveRecommendationsRequest request = new RetrieveRecommendationsRequest();

	request.setRecommendationTypes(recommendationTypes);
	request.setMaxCount(maxCount);

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

static function RetrieveRecommendations(
	$recommendationTypes,
	$maxCount)
{

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

	$request = new RetrieveRecommendationsRequest();

	$request->RecommendationTypes = $recommendationTypes;
	$request->MaxCount = $maxCount;

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

response=adinsight_service.RetrieveRecommendations(
	RecommendationTypes=RecommendationTypes,
	MaxCount=MaxCount)

需求

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

共用方式為