SearchAccounts サービス操作 - 顧客管理
要求条件に一致するアカウントを検索します。
たとえば、現在認証されているユーザーがアクセスできるアカウントを検索できます。
ヒント
例を含む概要については、 アカウント Hierchy とユーザーのアクセス許可 に関するガイドを参照してください。
Request 要素
SearchAccountsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
| 要素 | 説明 | データ型 |
|---|---|---|
| 順序 | アカウントの指定したプロパティによって結果の順序を決定します。 この要求要素は省略可能です。 配列には、最大 1 つの OrderBy 要素を指定できます。 追加の要素はサポートされていないため、サービスによって無視されます。 OrderBy オブジェクトの Field 要素を "Id"、"Name"、または "Number" に設定した場合、返されるアカウントは、それに応じてアカウント識別子、名前、または数値で並べ替えられます。 この要求要素は省略可能です。 |
OrderBy 配列 |
| PageInfo | ページごとの結果のインデックスとサイズを決定します。 | Paging |
| 述語 | アカウントを返すためにすべて満たす必要がある条件を決定します。 述語を 1 つだけ含める必要があります。 述語 Field が "AccountLifeCycleStatus" に設定されている場合は、 Field を UserId などの別の値に設定して、1 つの追加の述語を指定する必要があります。 サポートされている各述語 フィールド 値の詳細については、「 述語の備考」を参照してください。 |
述語 配列 |
| ReturnAdditionalFields | 返された各アカウントに含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。 この要求要素は省略可能です。 |
AccountAdditionalField |
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
SearchAccountsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| アカウント | 要求条件を満たすアカウントの一覧。 | AdvertiserAccount 配列 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| 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">SearchAccounts</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Predicates xmlns:e53="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e53:Predicate>
<e53:Field i:nil="false">ValueHere</e53:Field>
<e53:Operator>ValueHere</e53:Operator>
<e53:Value i:nil="false">ValueHere</e53:Value>
</e53:Predicate>
</Predicates>
<Ordering xmlns:e54="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e54:OrderBy>
<e54:Field>ValueHere</e54:Field>
<e54:Order>ValueHere</e54:Order>
</e54:OrderBy>
</Ordering>
<PageInfo xmlns:e55="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e55:Index>ValueHere</e55:Index>
<e55:Size>ValueHere</e55:Size>
</PageInfo>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</SearchAccountsRequest>
</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>
<SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Accounts xmlns:e56="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e56:AdvertiserAccount>
<e56:BillToCustomerId d4p1:nil="false">ValueHere</e56:BillToCustomerId>
<e56:CurrencyCode d4p1:nil="false">ValueHere</e56:CurrencyCode>
<e56:AccountFinancialStatus d4p1:nil="false">ValueHere</e56:AccountFinancialStatus>
<e56:Id d4p1:nil="false">ValueHere</e56:Id>
<e56:Language d4p1:nil="false">ValueHere</e56:Language>
<e56:LastModifiedByUserId d4p1:nil="false">ValueHere</e56:LastModifiedByUserId>
<e56:LastModifiedTime d4p1:nil="false">ValueHere</e56:LastModifiedTime>
<e56:Name d4p1:nil="false">ValueHere</e56:Name>
<e56:Number d4p1:nil="false">ValueHere</e56:Number>
<e56:ParentCustomerId>ValueHere</e56:ParentCustomerId>
<e56:PaymentMethodId d4p1:nil="false">ValueHere</e56:PaymentMethodId>
<e56:PaymentMethodType d4p1:nil="false">ValueHere</e56:PaymentMethodType>
<e56:PrimaryUserId d4p1:nil="false">ValueHere</e56:PrimaryUserId>
<e56:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e56:AccountLifeCycleStatus>
<e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
<e56:TimeZone d4p1:nil="false">ValueHere</e56:TimeZone>
<e56:PauseReason d4p1:nil="false">ValueHere</e56:PauseReason>
<e56:ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e57:KeyValuePairOfstringstring>
<e57:key d4p1:nil="false">ValueHere</e57:key>
<e57:value d4p1:nil="false">ValueHere</e57:value>
</e57:KeyValuePairOfstringstring>
</e56:ForwardCompatibilityMap>
<e56:LinkedAgencies d4p1:nil="false">
<e56:CustomerInfo>
<e56:Id d4p1:nil="false">ValueHere</e56:Id>
<e56:Name d4p1:nil="false">ValueHere</e56:Name>
</e56:CustomerInfo>
</e56:LinkedAgencies>
<e56:SalesHouseCustomerId d4p1:nil="false">ValueHere</e56:SalesHouseCustomerId>
<e56:TaxInformation xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e58:KeyValuePairOfstringstring>
<e58:key d4p1:nil="false">ValueHere</e58:key>
<e58:value d4p1:nil="false">ValueHere</e58:value>
</e58:KeyValuePairOfstringstring>
</e56:TaxInformation>
<e56:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e56:BackUpPaymentInstrumentId>
<e56:BillingThresholdAmount d4p1:nil="false">ValueHere</e56:BillingThresholdAmount>
<e56:BusinessAddress d4p1:nil="false">
<e56:City d4p1:nil="false">ValueHere</e56:City>
<e56:CountryCode d4p1:nil="false">ValueHere</e56:CountryCode>
<e56:Id d4p1:nil="false">ValueHere</e56:Id>
<e56:Line1 d4p1:nil="false">ValueHere</e56:Line1>
<e56:Line2 d4p1:nil="false">ValueHere</e56:Line2>
<e56:Line3 d4p1:nil="false">ValueHere</e56:Line3>
<e56:Line4 d4p1:nil="false">ValueHere</e56:Line4>
<e56:PostalCode d4p1:nil="false">ValueHere</e56:PostalCode>
<e56:StateOrProvince d4p1:nil="false">ValueHere</e56:StateOrProvince>
<e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
<e56:BusinessName d4p1:nil="false">ValueHere</e56:BusinessName>
</e56:BusinessAddress>
<e56:AutoTagType d4p1:nil="false">ValueHere</e56:AutoTagType>
<e56:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e56:SoldToPaymentInstrumentId>
<e56:TaxCertificate d4p1:nil="false">
<e56:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e56:TaxCertificateBlobContainerName>
<e56:TaxCertificates xmlns:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e59:KeyValuePairOfstringbase64Binary>
<e59:key d4p1:nil="false">ValueHere</e59:key>
<e59:value d4p1:nil="false">ValueHere</e59:value>
</e59:KeyValuePairOfstringbase64Binary>
</e56:TaxCertificates>
<e56:Status d4p1:nil="false">ValueHere</e56:Status>
</e56:TaxCertificate>
<e56:AccountMode d4p1:nil="false">ValueHere</e56:AccountMode>
</e56:AdvertiserAccount>
</Accounts>
</SearchAccountsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<SearchAccountsResponse> SearchAccountsAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo,
AccountAdditionalField? returnAdditionalFields)
{
var request = new SearchAccountsRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchAccountsAsync(r), request));
}
static SearchAccountsResponse searchAccounts(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
SearchAccountsRequest request = new SearchAccountsRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().searchAccounts(request);
}
static function SearchAccounts(
$predicates,
$ordering,
$pageInfo,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchAccountsRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchAccounts($request);
}
response=customermanagement_service.SearchAccounts(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo,
ReturnAdditionalFields=ReturnAdditionalFields)
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Accounts/Search
Request 要素
SearchAccountsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
| 要素 | 説明 | データ型 |
|---|---|---|
| 順序 | アカウントの指定したプロパティによって結果の順序を決定します。 この要求要素は省略可能です。 配列には、最大 1 つの OrderBy 要素を指定できます。 追加の要素はサポートされていないため、サービスによって無視されます。 OrderBy オブジェクトの Field 要素を "Id"、"Name"、または "Number" に設定した場合、返されるアカウントは、それに応じてアカウント識別子、名前、または数値で並べ替えられます。 この要求要素は省略可能です。 |
OrderBy 配列 |
| PageInfo | ページごとの結果のインデックスとサイズを決定します。 | Paging |
| 述語 | アカウントを返すためにすべて満たす必要がある条件を決定します。 述語を 1 つだけ含める必要があります。 述語 Field が "AccountLifeCycleStatus" に設定されている場合は、 Field を UserId などの別の値に設定して、1 つの追加の述語を指定する必要があります。 サポートされている各述語 フィールド 値の詳細については、「 述語の備考」を参照してください。 |
述語 配列 |
| ReturnAdditionalFields | 返された各アカウントに含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。 この要求要素は省略可能です。 |
AccountAdditionalField |
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
SearchAccountsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| アカウント | 要求条件を満たすアカウントの一覧。 | AdvertiserAccount 配列 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
},
"ReturnAdditionalFields": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"Accounts": [
{
"AccountFinancialStatus": "ValueHere",
"AccountLifeCycleStatus": "ValueHere",
"AccountMode": "ValueHere",
"AutoTagType": "ValueHere",
"BackUpPaymentInstrumentId": "LongValueHere",
"BillingThresholdAmount": DecimalValueHere,
"BillToCustomerId": "LongValueHere",
"BusinessAddress": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
},
"CurrencyCode": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Language": "ValueHere",
"LastModifiedByUserId": "LongValueHere",
"LastModifiedTime": "ValueHere",
"LinkedAgencies": [
{
"Id": "LongValueHere",
"Name": "ValueHere"
}
],
"Name": "ValueHere",
"Number": "ValueHere",
"ParentCustomerId": "LongValueHere",
"PauseReason": "ValueHere",
"PaymentMethodId": "LongValueHere",
"PaymentMethodType": "ValueHere",
"PrimaryUserId": "LongValueHere",
"SalesHouseCustomerId": "LongValueHere",
"SoldToPaymentInstrumentId": "LongValueHere",
"TaxCertificate": {
"Status": "ValueHere",
"TaxCertificateBlobContainerName": "ValueHere",
"TaxCertificates": [
{
"key": "ValueHere",
"value": "ValueHere"
}
]
},
"TaxInformation": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"TimeStamp": "ValueHere",
"TimeZone": "ValueHere"
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<SearchAccountsResponse> SearchAccountsAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo,
AccountAdditionalField? returnAdditionalFields)
{
var request = new SearchAccountsRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchAccountsAsync(r), request));
}
static SearchAccountsResponse searchAccounts(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
SearchAccountsRequest request = new SearchAccountsRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().searchAccounts(request);
}
static function SearchAccounts(
$predicates,
$ordering,
$pageInfo,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchAccountsRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchAccounts($request);
}
response=customermanagement_service.SearchAccounts(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo,
ReturnAdditionalFields=ReturnAdditionalFields)