GetAdExtensionIdsByAccountId サービス操作 - キャンペーン管理
アカウントの広告拡張機能ライブラリから広告表示オプションを取得します。
Request 要素
GetAdExtensionIdsByAccountIdRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 取得する広告表示オプションを含むアカウントの識別子。 | long |
AdExtensionType | アカウントから取得する広告表示オプションの種類。 フラグとして複数の値を含めることができます。 複数のフラグを指定する方法は、使用するプログラミング言語によって異なります。 たとえば、C# はこれらの値をフラグ値として扱い、Java はそれらを文字列の配列として扱います。 SOAP には、スペース区切りの値の一覧 (たとえば、 <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> ) を含む文字列を含める必要があります。 |
AdExtensionsTypeFilter |
AssociationType | 特定のエンティティ型に関連付けられているかどうかに基づいて拡張機能をフィルター処理する値。 使用可能な値については、「 AssociationType」を参照してください。 エンティティに関連付けられていない拡張機能を含むすべての拡張機能を取得するには、この要素を NULL に設定します。 |
AssociationType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetAdExtensionIdsByAccountIdResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AdExtensionIds | 広告拡張機能 ID の一覧。 拡張機能を取得するには、 GetAdExtensionsByIds 操作を 呼び出します。 | long 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetAdExtensionIdsByAccountId</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>
<GetAdExtensionIdsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<AdExtensionType>ValueHere</AdExtensionType>
<AssociationType i:nil="false">ValueHere</AssociationType>
</GetAdExtensionIdsByAccountIdRequest>
</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>
<GetAdExtensionIdsByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdExtensionIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<a1:long>ValueHere</a1:long>
</AdExtensionIds>
</GetAdExtensionIdsByAccountIdResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetAdExtensionIdsByAccountIdResponse> GetAdExtensionIdsByAccountIdAsync(
long accountId,
AdExtensionsTypeFilter adExtensionType,
AssociationType? associationType)
{
var request = new GetAdExtensionIdsByAccountIdRequest
{
AccountId = accountId,
AdExtensionType = adExtensionType,
AssociationType = associationType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionIdsByAccountIdAsync(r), request));
}
static GetAdExtensionIdsByAccountIdResponse getAdExtensionIdsByAccountId(
java.lang.Long accountId,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
AssociationType associationType) throws RemoteException, Exception
{
GetAdExtensionIdsByAccountIdRequest request = new GetAdExtensionIdsByAccountIdRequest();
request.setAccountId(accountId);
request.setAdExtensionType(adExtensionType);
request.setAssociationType(associationType);
return CampaignManagementService.getService().getAdExtensionIdsByAccountId(request);
}
static function GetAdExtensionIdsByAccountId(
$accountId,
$adExtensionType,
$associationType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionIdsByAccountIdRequest();
$request->AccountId = $accountId;
$request->AdExtensionType = $adExtensionType;
$request->AssociationType = $associationType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionIdsByAccountId($request);
}
response=campaignmanagement_service.GetAdExtensionIdsByAccountId(
AccountId=AccountId,
AdExtensionType=AdExtensionType,
AssociationType=AssociationType)
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdExtensionIds/QueryByAccountId
Request 要素
GetAdExtensionIdsByAccountIdRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 取得する広告表示オプションを含むアカウントの識別子。 | long |
AdExtensionType | アカウントから取得する広告表示オプションの種類。 フラグとして複数の値を含めることができます。 複数のフラグを指定する方法は、使用するプログラミング言語によって異なります。 たとえば、C# はこれらの値をフラグ値として扱い、Java はそれらを文字列の配列として扱います。 SOAP には、スペース区切りの値の一覧 (たとえば、 <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> ) を含む文字列を含める必要があります。 |
AdExtensionsTypeFilter |
AssociationType | 特定のエンティティ型に関連付けられているかどうかに基づいて拡張機能をフィルター処理する値。 使用可能な値については、「 AssociationType」を参照してください。 エンティティに関連付けられていない拡張機能を含むすべての拡張機能を取得するには、この要素を NULL に設定します。 |
AssociationType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetAdExtensionIdsByAccountIdResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AdExtensionIds | 広告拡張機能 ID の一覧。 拡張機能を取得するには、 GetAdExtensionsByIds 操作を 呼び出します。 | long 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"AccountId": "LongValueHere",
"AdExtensionType": "ValueHere",
"AssociationType": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"AdExtensionIds": [
"LongValueHere"
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetAdExtensionIdsByAccountIdResponse> GetAdExtensionIdsByAccountIdAsync(
long accountId,
AdExtensionsTypeFilter adExtensionType,
AssociationType? associationType)
{
var request = new GetAdExtensionIdsByAccountIdRequest
{
AccountId = accountId,
AdExtensionType = adExtensionType,
AssociationType = associationType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionIdsByAccountIdAsync(r), request));
}
static GetAdExtensionIdsByAccountIdResponse getAdExtensionIdsByAccountId(
java.lang.Long accountId,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
AssociationType associationType) throws RemoteException, Exception
{
GetAdExtensionIdsByAccountIdRequest request = new GetAdExtensionIdsByAccountIdRequest();
request.setAccountId(accountId);
request.setAdExtensionType(adExtensionType);
request.setAssociationType(associationType);
return CampaignManagementService.getService().getAdExtensionIdsByAccountId(request);
}
static function GetAdExtensionIdsByAccountId(
$accountId,
$adExtensionType,
$associationType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionIdsByAccountIdRequest();
$request->AccountId = $accountId;
$request->AdExtensionType = $adExtensionType;
$request->AssociationType = $associationType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionIdsByAccountId($request);
}
response=campaignmanagement_service.GetAdExtensionIdsByAccountId(
AccountId=AccountId,
AdExtensionType=AdExtensionType,
AssociationType=AssociationType)