FindAccounts Service Operation - Customer Management
指定したフィルター条件に一致する、指定した顧客が所有するアカウントの一覧を取得します。
Request 要素
FindAccountsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountFilter | アカウントの一覧をフィルター処理するために使用する条件。 アカウント名またはアカウント番号を指定できます。 フィルター値が形式 Xnnnnn の場合、 nnnnn は一連の数字で、操作はアカウント番号でフィルター処理されます。 フィルター値には、取得するアカウントの一部または完全なアカウント名または番号を含めることができます。 アカウントの名前または番号が指定したフィルター値で始まる場合、操作には結果にアカウントが含まれます。 操作は、フィルター値をアカウント名または数値と比較するときに、大文字と小文字を区別しない比較を実行します。 たとえば、フィルター値として "t" を指定すると、名前が "t" または "T" で始まるアカウントが一覧に含まれます。 この要素を空の文字列に設定することは、 GetAccountsInfo の呼び出しと同じです。 |
string |
CustomerId | 取得するアカウントを持つ顧客の識別子。 null の場合、操作は、ユーザーが管理および所有している顧客のすべてのアカウント間で一致するものを検索します。 |
long |
TopN | 結果で返されるアカウントの数を指定する 0 以外の正の整数。 1 から 5,000 までの値を指定する必要があります。 | int |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
FindAccountsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AccountsInfo | 指定したフィルター条件に一致するアカウントの AccountInfo オブジェクトの一覧。 リスト内のアカウントの完全な詳細を取得するには、AccountInfo オブジェクトの Id 要素にアクセスし、それを使用して GetAccount を呼び出します。 |
AccountInfo 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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/Customer/v13">
<Action mustUnderstand="1">FindAccounts</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<FindAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<CustomerId i:nil="false">ValueHere</CustomerId>
<AccountFilter i:nil="false">ValueHere</AccountFilter>
<TopN>ValueHere</TopN>
</FindAccountsRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<FindAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<AccountsInfo xmlns:e19="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e19:AccountInfo>
<e19:Id>ValueHere</e19:Id>
<e19:Name d4p1:nil="false">ValueHere</e19:Name>
<e19:Number d4p1:nil="false">ValueHere</e19:Number>
<e19:AccountLifeCycleStatus>ValueHere</e19:AccountLifeCycleStatus>
<e19:PauseReason d4p1:nil="false">ValueHere</e19:PauseReason>
</e19:AccountInfo>
</AccountsInfo>
</FindAccountsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<FindAccountsResponse> FindAccountsAsync(
long? customerId,
string accountFilter,
int topN)
{
var request = new FindAccountsRequest
{
CustomerId = customerId,
AccountFilter = accountFilter,
TopN = topN
};
return (await CustomerManagementService.CallAsync((s, r) => s.FindAccountsAsync(r), request));
}
static FindAccountsResponse findAccounts(
java.lang.Long customerId,
java.lang.String accountFilter,
int topN) throws RemoteException, Exception
{
FindAccountsRequest request = new FindAccountsRequest();
request.setCustomerId(customerId);
request.setAccountFilter(accountFilter);
request.setTopN(topN);
return CustomerManagementService.getService().findAccounts(request);
}
static function FindAccounts(
$customerId,
$accountFilter,
$topN)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new FindAccountsRequest();
$request->CustomerId = $customerId;
$request->AccountFilter = $accountFilter;
$request->TopN = $topN;
return $GLOBALS['CustomerManagementProxy']->GetService()->FindAccounts($request);
}
response=customermanagement_service.FindAccounts(
CustomerId=CustomerId,
AccountFilter=AccountFilter,
TopN=TopN)
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Accounts/Find
Request 要素
FindAccountsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountFilter | アカウントの一覧をフィルター処理するために使用する条件。 アカウント名またはアカウント番号を指定できます。 フィルター値が形式 Xnnnnn の場合、 nnnnn は一連の数字で、操作はアカウント番号でフィルター処理されます。 フィルター値には、取得するアカウントの一部または完全なアカウント名または番号を含めることができます。 アカウントの名前または番号が指定したフィルター値で始まる場合、操作には結果にアカウントが含まれます。 操作は、フィルター値をアカウント名または数値と比較するときに、大文字と小文字を区別しない比較を実行します。 たとえば、フィルター値として "t" を指定すると、名前が "t" または "T" で始まるアカウントが一覧に含まれます。 この要素を空の文字列に設定することは、 GetAccountsInfo の呼び出しと同じです。 |
string |
CustomerId | 取得するアカウントを持つ顧客の識別子。 null の場合、操作は、ユーザーが管理および所有している顧客のすべてのアカウント間で一致するものを検索します。 |
long |
TopN | 結果で返されるアカウントの数を指定する 0 以外の正の整数。 1 から 5,000 までの値を指定する必要があります。 | int |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
FindAccountsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AccountsInfo | 指定したフィルター条件に一致するアカウントの AccountInfo オブジェクトの一覧。 リスト内のアカウントの完全な詳細を取得するには、AccountInfo オブジェクトの Id 要素にアクセスし、それを使用して GetAccount を呼び出します。 |
AccountInfo 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"CustomerId": "LongValueHere",
"AccountFilter": "ValueHere",
"TopN": IntValueHere
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"AccountsInfo": [
{
"AccountLifeCycleStatus": "ValueHere",
"Id": "LongValueHere",
"Name": "ValueHere",
"Number": "ValueHere",
"PauseReason": "ValueHere"
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<FindAccountsResponse> FindAccountsAsync(
long? customerId,
string accountFilter,
int topN)
{
var request = new FindAccountsRequest
{
CustomerId = customerId,
AccountFilter = accountFilter,
TopN = topN
};
return (await CustomerManagementService.CallAsync((s, r) => s.FindAccountsAsync(r), request));
}
static FindAccountsResponse findAccounts(
java.lang.Long customerId,
java.lang.String accountFilter,
int topN) throws RemoteException, Exception
{
FindAccountsRequest request = new FindAccountsRequest();
request.setCustomerId(customerId);
request.setAccountFilter(accountFilter);
request.setTopN(topN);
return CustomerManagementService.getService().findAccounts(request);
}
static function FindAccounts(
$customerId,
$accountFilter,
$topN)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new FindAccountsRequest();
$request->CustomerId = $customerId;
$request->AccountFilter = $accountFilter;
$request->TopN = $topN;
return $GLOBALS['CustomerManagementProxy']->GetService()->FindAccounts($request);
}
response=customermanagement_service.FindAccounts(
CustomerId=CustomerId,
AccountFilter=AccountFilter,
TopN=TopN)