GetEditorialReasonsByIds サービス操作 - キャンペーン管理
指定したエンティティが編集レビューに失敗した理由と、問題が申し立て可能かどうかを取得します。
Request 要素
GetEditorialReasonsByIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 指定したエンティティを含むアカウントの識別子。 | long |
EntityIdToParentIdAssociations | エンティティの一意のシステム識別子 (ad や キーワード (keyword) など) とその親の識別子を含む EntityIdToParentIdAssociation オブジェクトの一覧。 広告グループは、広告またはキーワード (keyword)の親です。 リストには、編集レビューに失敗したすべての広告またはすべてのキーワードが含まれている必要があります。 リストにミックス広告とキーワードを含めることはできません。 リストには、最大 1,000 個の識別子を含めることができます。 |
EntityIdToParentIdAssociation 配列 |
EntityType | エンティティ リストに含まれるエンティティの種類。 サポートされているエンティティの種類の値は 、Ad と Keyword です。 |
EntityType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetEditorialReasonsByIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
EditorialReasons | 要求で指定した EntityIdToParentIdAssociation オブジェクトに直接対応する EditorialReasonCollection オブジェクトの配列。 各オブジェクトは、エラーの理由と、それが訴えられるかどうかを識別します。 リストの項目は null として返される場合があります。
EditorialReasonCollection が取得されなかったリスト インデックスごとに、対応する要素は null になります。 エンティティが編集レビューに失敗しなかった場合、このコレクション内の対応する項目は NULL です。 また、指定した広告またはキーワード (keyword)識別子が無効な場合、アイテムは NULL になります。 |
EditorialReasonCollection 配列 |
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/CampaignManagement/v13">
<Action mustUnderstand="1">GetEditorialReasonsByIds</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>
<GetEditorialReasonsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<EntityIdToParentIdAssociations i:nil="false">
<EntityIdToParentIdAssociation>
<EntityId>ValueHere</EntityId>
<ParentId>ValueHere</ParentId>
</EntityIdToParentIdAssociation>
</EntityIdToParentIdAssociations>
<EntityType>ValueHere</EntityType>
</GetEditorialReasonsByIdsRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetEditorialReasonsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<EditorialReasons d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<EditorialReasonCollection>
<AdGroupId>ValueHere</AdGroupId>
<AdOrKeywordId>ValueHere</AdOrKeywordId>
<AppealStatus>ValueHere</AppealStatus>
<Reasons d4p1:nil="false">
<EditorialReason>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountries d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</PublisherCountries>
<ReasonCode>ValueHere</ReasonCode>
<Term d4p1:nil="false">ValueHere</Term>
</EditorialReason>
</Reasons>
</EditorialReasonCollection>
</EditorialReasons>
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e451="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e451:KeyValuePairOfstringstring>
<e451:key d4p1:nil="false">ValueHere</e451:key>
<e451:value d4p1:nil="false">ValueHere</e451:value>
</e451:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</GetEditorialReasonsByIdsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetEditorialReasonsByIdsResponse> GetEditorialReasonsByIdsAsync(
long accountId,
IList<EntityIdToParentIdAssociation> entityIdToParentIdAssociations,
EntityType entityType)
{
var request = new GetEditorialReasonsByIdsRequest
{
AccountId = accountId,
EntityIdToParentIdAssociations = entityIdToParentIdAssociations,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetEditorialReasonsByIdsAsync(r), request));
}
static GetEditorialReasonsByIdsResponse getEditorialReasonsByIds(
java.lang.Long accountId,
ArrayOfEntityIdToParentIdAssociation entityIdToParentIdAssociations,
EntityType entityType) throws RemoteException, Exception
{
GetEditorialReasonsByIdsRequest request = new GetEditorialReasonsByIdsRequest();
request.setAccountId(accountId);
request.setEntityIdToParentIdAssociations(entityIdToParentIdAssociations);
request.setEntityType(entityType);
return CampaignManagementService.getService().getEditorialReasonsByIds(request);
}
static function GetEditorialReasonsByIds(
$accountId,
$entityIdToParentIdAssociations,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetEditorialReasonsByIdsRequest();
$request->AccountId = $accountId;
$request->EntityIdToParentIdAssociations = $entityIdToParentIdAssociations;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetEditorialReasonsByIds($request);
}
response=campaignmanagement_service.GetEditorialReasonsByIds(
AccountId=AccountId,
EntityIdToParentIdAssociations=EntityIdToParentIdAssociations,
EntityType=EntityType)
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/EditorialReasons/QueryByIds
Request 要素
GetEditorialReasonsByIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 指定したエンティティを含むアカウントの識別子。 | long |
EntityIdToParentIdAssociations | エンティティの一意のシステム識別子 (ad や キーワード (keyword) など) とその親の識別子を含む EntityIdToParentIdAssociation オブジェクトの一覧。 広告グループは、広告またはキーワード (keyword)の親です。 リストには、編集レビューに失敗したすべての広告またはすべてのキーワードが含まれている必要があります。 リストにミックス広告とキーワードを含めることはできません。 リストには、最大 1,000 個の識別子を含めることができます。 |
EntityIdToParentIdAssociation 配列 |
EntityType | エンティティ リストに含まれるエンティティの種類。 サポートされているエンティティの種類の値は 、Ad と Keyword です。 |
EntityType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetEditorialReasonsByIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
EditorialReasons | 要求で指定した EntityIdToParentIdAssociation オブジェクトに直接対応する EditorialReasonCollection オブジェクトの配列。 各オブジェクトは、エラーの理由と、それが訴えられるかどうかを識別します。 リストの項目は null として返される場合があります。
EditorialReasonCollection が取得されなかったリスト インデックスごとに、対応する要素は null になります。 エンティティが編集レビューに失敗しなかった場合、このコレクション内の対応する項目は NULL です。 また、指定した広告またはキーワード (keyword)識別子が無効な場合、アイテムは NULL になります。 |
EditorialReasonCollection 配列 |
PartialErrors | 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"AccountId": "LongValueHere",
"EntityIdToParentIdAssociations": [
{
"EntityId": "LongValueHere",
"ParentId": "LongValueHere"
}
],
"EntityType": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
BatchError の種類が EditorialError の場合に適用される例を次に示します。
{
"EditorialReasons": [
{
"AdGroupId": "LongValueHere",
"AdOrKeywordId": "LongValueHere",
"AppealStatus": "ValueHere",
"Reasons": [
{
"Location": "ValueHere",
"PublisherCountries": [
"ValueHere"
],
"ReasonCode": IntValueHere,
"Term": "ValueHere"
}
]
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetEditorialReasonsByIdsResponse> GetEditorialReasonsByIdsAsync(
long accountId,
IList<EntityIdToParentIdAssociation> entityIdToParentIdAssociations,
EntityType entityType)
{
var request = new GetEditorialReasonsByIdsRequest
{
AccountId = accountId,
EntityIdToParentIdAssociations = entityIdToParentIdAssociations,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetEditorialReasonsByIdsAsync(r), request));
}
static GetEditorialReasonsByIdsResponse getEditorialReasonsByIds(
java.lang.Long accountId,
ArrayOfEntityIdToParentIdAssociation entityIdToParentIdAssociations,
EntityType entityType) throws RemoteException, Exception
{
GetEditorialReasonsByIdsRequest request = new GetEditorialReasonsByIdsRequest();
request.setAccountId(accountId);
request.setEntityIdToParentIdAssociations(entityIdToParentIdAssociations);
request.setEntityType(entityType);
return CampaignManagementService.getService().getEditorialReasonsByIds(request);
}
static function GetEditorialReasonsByIds(
$accountId,
$entityIdToParentIdAssociations,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetEditorialReasonsByIdsRequest();
$request->AccountId = $accountId;
$request->EntityIdToParentIdAssociations = $entityIdToParentIdAssociations;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetEditorialReasonsByIds($request);
}
response=campaignmanagement_service.GetEditorialReasonsByIds(
AccountId=AccountId,
EntityIdToParentIdAssociations=EntityIdToParentIdAssociations,
EntityType=EntityType)