RetrieveRecommendations サービス操作 - Ad Insight
推奨事項の一覧を取得します。
Request 要素
RetrieveRecommendationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 に対して使用可能な推奨事項。 推奨事項の種類は 、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)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示