TagRecommendations サービス操作 - Ad Insight
レスポンシブ検索広告を作成するための特定の推奨事項を 適用 または却下としてタグ付けする必要があることを Microsoft Advertising に通知します。 無視された推奨事項は、今後 30 日間に GetRecommendations を呼び出すときにユーザーに表示されません。
Request 要素
TagRecommendationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
Lable | 値は、適用または無視のいずれかに設定する必要があります | string |
RecommendationsInfo | 個々の推奨事項の情報。 Duplicate RecommendationInfo (RecommendationId) は DuplicateRecommendationInfo エラーとして返されます。 最大 100 個の入力要素を指定できます。 |
RecommendationInfo 配列 |
RecommendationType | 適用した推奨事項の種類の識別子。 この要素を nil または空にすることはできません。 要求ごとに 1 つの特定の推奨事項の種類 (例: ResponsiveSearchAdsOpportunity)。 |
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 要素
TagRecommendationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
PartialErrors | 成功しなかった要求項目の詳細を含む 配列 BatchError 。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、要求に失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">TagRecommendations</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>
<TagRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<RecommendationType i:nil="false">ValueHere</RecommendationType>
<RecommendationsInfo i:nil="false">
<RecommendationInfo i:type="-- derived type specified here with the appropriate prefix --">
<RecommendationHash i:nil="false">ValueHere</RecommendationHash>
<RecommendationId i:nil="false">ValueHere</RecommendationId>
<!--This field is applicable if the derived type attribute is set to RSARecommendationInfo-->
<AdId i:nil="false">ValueHere</AdId>
</RecommendationInfo>
</RecommendationsInfo>
<Lable i:nil="false">ValueHere</Lable>
</TagRecommendationsRequest>
</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>
<TagRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError>
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
</BatchError>
</PartialErrors>
</TagRecommendationsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<TagRecommendationsResponse> TagRecommendationsAsync(
string recommendationType,
IList<RecommendationInfo> recommendationsInfo,
string lable)
{
var request = new TagRecommendationsRequest
{
RecommendationType = recommendationType,
RecommendationsInfo = recommendationsInfo,
Lable = lable
};
return (await AdInsightService.CallAsync((s, r) => s.TagRecommendationsAsync(r), request));
}
static TagRecommendationsResponse tagRecommendations(
java.lang.String recommendationType,
ArrayOfRecommendationInfo recommendationsInfo,
java.lang.String lable) throws RemoteException, Exception
{
TagRecommendationsRequest request = new TagRecommendationsRequest();
request.setRecommendationType(recommendationType);
request.setRecommendationsInfo(recommendationsInfo);
request.setLable(lable);
return AdInsightService.getService().tagRecommendations(request);
}
static function TagRecommendations(
$recommendationType,
$recommendationsInfo,
$lable)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new TagRecommendationsRequest();
$request->RecommendationType = $recommendationType;
$request->RecommendationsInfo = $recommendationsInfo;
$request->Lable = $lable;
return $GLOBALS['AdInsightProxy']->GetService()->TagRecommendations($request);
}
response=adinsight_service.TagRecommendations(
RecommendationType=RecommendationType,
RecommendationsInfo=RecommendationsInfo,
Lable=Lable)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/Recommendations/Tag
Request 要素
TagRecommendationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
Lable | 値は、適用または無視のいずれかに設定する必要があります | string |
RecommendationsInfo | 個々の推奨事項の情報。 Duplicate RecommendationInfo (RecommendationId) は DuplicateRecommendationInfo エラーとして返されます。 最大 100 個の入力要素を指定できます。 |
RecommendationInfo 配列 |
RecommendationType | 適用した推奨事項の種類の識別子。 この要素を nil または空にすることはできません。 要求ごとに 1 つの特定の推奨事項の種類 (例: ResponsiveSearchAdsOpportunity)。 |
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 要素
TagRecommendationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
PartialErrors | 成功しなかった要求項目の詳細を含む 配列 BatchError 。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、要求に失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
RecommendationInfo の種類が RSARecommendationInfo の場合に適用可能な例を次に示します。
{
"RecommendationType": "ValueHere",
"RecommendationsInfo": [
{
"RecommendationHash": "ValueHere",
"RecommendationId": "ValueHere",
"Type": "RSARecommendationInfo",
"AdId": "LongValueHere"
}
],
"Lable": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"Index": IntValueHere,
"Message": "ValueHere"
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<TagRecommendationsResponse> TagRecommendationsAsync(
string recommendationType,
IList<RecommendationInfo> recommendationsInfo,
string lable)
{
var request = new TagRecommendationsRequest
{
RecommendationType = recommendationType,
RecommendationsInfo = recommendationsInfo,
Lable = lable
};
return (await AdInsightService.CallAsync((s, r) => s.TagRecommendationsAsync(r), request));
}
static TagRecommendationsResponse tagRecommendations(
java.lang.String recommendationType,
ArrayOfRecommendationInfo recommendationsInfo,
java.lang.String lable) throws RemoteException, Exception
{
TagRecommendationsRequest request = new TagRecommendationsRequest();
request.setRecommendationType(recommendationType);
request.setRecommendationsInfo(recommendationsInfo);
request.setLable(lable);
return AdInsightService.getService().tagRecommendations(request);
}
static function TagRecommendations(
$recommendationType,
$recommendationsInfo,
$lable)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new TagRecommendationsRequest();
$request->RecommendationType = $recommendationType;
$request->RecommendationsInfo = $recommendationsInfo;
$request->Lable = $lable;
return $GLOBALS['AdInsightProxy']->GetService()->TagRecommendations($request);
}
response=adinsight_service.TagRecommendations(
RecommendationType=RecommendationType,
RecommendationsInfo=RecommendationsInfo,
Lable=Lable)