RetrieveRecommendations サービス操作 - Ad Insight

[アーティクル]
11/14/2024

推奨事項の一覧を取得します。

Request 要素

RetrieveRecommendationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
MaxCount	返される推奨事項の最大数。既定値は null です。 MaxCount が null または 0 の場合は、使用可能なすべての推奨事項が返されます。省略可能。	int
RecommendationTypes	推奨事項の種類名: ADD_BROAD_MATCH_KEYWORD、CAMPAIGN_BUDGET、KEYWORD、REMOVE_CONFLICTING_NEGATIVE_KEYWORD、RESPONSIVE_SEARCH_AD、またはRESPONSIVE_SEARCH_AD_ASSET。必須です。	string 配列

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
CustomerId	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

RetrieveRecommendationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
推奨事項	特定のアカウント ID に対して使用可能な推奨事項。推奨事項の種類は、 AddBroadMatchKeywordRecommendation、 CampaignBudgetRecommendation、 KeywordRecommendation、 RemoveConflictingNegativeKeywordRecommendation、 ResponsiveSearchAdRecommendation、および ResponsiveSearchAdAssetRecommendation です。	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>
          <AccountName d4p1:nil="false">ValueHere</AccountName>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CampaignName d4p1:nil="false">ValueHere</CampaignName>
          <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>
          <!--These fields are applicable if the derived type attribute is set to RemoveConflictingNegativeKeywordRecommendation-->
          <NegativeKeyword d4p1:nil="false">ValueHere</NegativeKeyword>
          <NegativeKeywordId>ValueHere</NegativeKeywordId>
          <NegativeKeywordListName d4p1:nil="false">ValueHere</NegativeKeywordListName>
          <NegativeKeywordMatchType>ValueHere</NegativeKeywordMatchType>
          <NegativeKeywordSharedListId d4p1:nil="false">ValueHere</NegativeKeywordSharedListId>
          <Source d4p1:nil="false">ValueHere</Source>
          <!--These fields are applicable if the derived type attribute is set to UseBroadMatchKeywordRecommendation-->
          <CurrentMatchType>ValueHere</CurrentMatchType>
          <CurrentStatus d4p1:nil="false">ValueHere</CurrentStatus>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordOrderItemId>ValueHere</KeywordOrderItemId>
          <SuggestedBid>ValueHere</SuggestedBid>
          <SuggestedMatchType>ValueHere</SuggestedMatchType>
          <SuggestedStatus d4p1:nil="false">ValueHere</SuggestedStatus>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAdAssetRecommendation-->
          <RecommendedResponsiveSearchAd 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>
          </RecommendedResponsiveSearchAd>
          <ResponsiveSearchAdId>ValueHere</ResponsiveSearchAdId>
        </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)

要件

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

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/Recommendations/Retrieve

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/Recommendations/Retrieve

Request 要素

RetrieveRecommendationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
MaxCount	返される推奨事項の最大数。既定値は null です。 MaxCount が null または 0 の場合は、使用可能なすべての推奨事項が返されます。省略可能。	int
RecommendationTypes	推奨事項の種類名: ADD_BROAD_MATCH_KEYWORD、CAMPAIGN_BUDGET、KEYWORD、REMOVE_CONFLICTING_NEGATIVE_KEYWORD、RESPONSIVE_SEARCH_AD、またはRESPONSIVE_SEARCH_AD_ASSET。必須です。	string 配列

要求ヘッダー要素

要素	説明	データ型
Authorization	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
CustomerId	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

RetrieveRecommendationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、 Response JSON に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
推奨事項	特定のアカウント ID に対して使用可能な推奨事項。推奨事項の種類は、 AddBroadMatchKeywordRecommendation、 CampaignBudgetRecommendation、 KeywordRecommendation、 RemoveConflictingNegativeKeywordRecommendation、 ResponsiveSearchAdRecommendation、および ResponsiveSearchAdAssetRecommendation です。	RecommendationBase 配列

応答ヘッダー要素

要素	説明	データ型
TrackingId	API 呼び出しの詳細を含むログエントリの識別子。	string

JSON を要求する

このテンプレートは、JSON 要求の本文とヘッダー要素を表示するツールによって生成されました。このサービス操作で使用できるサポートされる型については、上記の要求本文要素のリファレンスを参照してください。

{
  "RecommendationTypes": [
    "ValueHere"
  ],
  "MaxCount": IntValueHere
}

応答 JSON

このテンプレートは、JSON 応答の本文とヘッダー要素を表示するツールによって生成されました。

RecommendationBase の種類が CampaignBudgetRecommendation の場合に適用される例を次に示します。

{
  "Recommendations": [
    {
      "AccountId": "LongValueHere",
      "AccountName": "ValueHere",
      "AdGroupId": "LongValueHere",
      "AdGroupName": "ValueHere",
      "CampaignId": "LongValueHere",
      "CampaignName": "ValueHere",
      "CurrentClicks": "LongValueHere",
      "CurrentConversions": "LongValueHere",
      "CurrentCost": DoubleValueHere,
      "CurrentImpressions": "LongValueHere",
      "Dismissed": "ValueHere",
      "EstimatedIncreaseInClicks": "LongValueHere",
      "EstimatedIncreaseInConversions": "LongValueHere",
      "EstimatedIncreaseInCost": DoubleValueHere,
      "EstimatedIncreaseInImpressions": "LongValueHere",
      "RecommendationHash": "ValueHere",
      "RecommendationId": "ValueHere",
      "RecommendationType": "ValueHere",
      "Type": "CampaignBudgetRecommendation",
      "BudgetPoints": [
        {
          "BudgetAmount": DoubleValueHere,
          "BudgetPointType": "ValueHere",
          "EstimatedWeeklyClicks": DoubleValueHere,
          "EstimatedWeeklyCost": DoubleValueHere,
          "EstimatedWeeklyImpressions": DoubleValueHere
        }
      ],
      "BudgetType": "ValueHere",
      "CurrentBudget": DoubleValueHere,
      "RecommendedBudget": DoubleValueHere
    }
  ]
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システムパラメーターを構成する必要があります。構文の例は、 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)

次の方法で共有

RetrieveRecommendations サービス操作 - Ad Insight

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

SOAP を要求する

応答 SOAP

コード構文

要件

要求 URL

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

JSON を要求する

応答 JSON

コード構文

フィードバック

その他のリソース