GetCustomer サービス操作 - 顧客管理
顧客の詳細を取得します。
Request 要素
GetCustomerRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
CustomerId | 情報を取得する顧客の識別子。 | long |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetCustomerResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
顧客 | 顧客に関する情報を含む Customer オブジェクト。 | お客様 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetCustomer</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<CustomerId>ValueHere</CustomerId>
</GetCustomerRequest>
</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>
<GetCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Customer xmlns:e33="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e33:CustomerFinancialStatus d4p1:nil="false">ValueHere</e33:CustomerFinancialStatus>
<e33:Id d4p1:nil="false">ValueHere</e33:Id>
<e33:Industry d4p1:nil="false">ValueHere</e33:Industry>
<e33:LastModifiedByUserId d4p1:nil="false">ValueHere</e33:LastModifiedByUserId>
<e33:LastModifiedTime d4p1:nil="false">ValueHere</e33:LastModifiedTime>
<e33:MarketCountry d4p1:nil="false">ValueHere</e33:MarketCountry>
<e33:ForwardCompatibilityMap xmlns:e34="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e34:KeyValuePairOfstringstring>
<e34:key d4p1:nil="false">ValueHere</e34:key>
<e34:value d4p1:nil="false">ValueHere</e34:value>
</e34:KeyValuePairOfstringstring>
</e33:ForwardCompatibilityMap>
<e33:MarketLanguage d4p1:nil="false">ValueHere</e33:MarketLanguage>
<e33:Name d4p1:nil="false">ValueHere</e33:Name>
<e33:ServiceLevel d4p1:nil="false">ValueHere</e33:ServiceLevel>
<e33:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e33:CustomerLifeCycleStatus>
<e33:TimeStamp d4p1:nil="false">ValueHere</e33:TimeStamp>
<e33:Number d4p1:nil="false">ValueHere</e33:Number>
<e33:CustomerAddress d4p1:nil="false">
<e33:City d4p1:nil="false">ValueHere</e33:City>
<e33:CountryCode d4p1:nil="false">ValueHere</e33:CountryCode>
<e33:Id d4p1:nil="false">ValueHere</e33:Id>
<e33:Line1 d4p1:nil="false">ValueHere</e33:Line1>
<e33:Line2 d4p1:nil="false">ValueHere</e33:Line2>
<e33:Line3 d4p1:nil="false">ValueHere</e33:Line3>
<e33:Line4 d4p1:nil="false">ValueHere</e33:Line4>
<e33:PostalCode d4p1:nil="false">ValueHere</e33:PostalCode>
<e33:StateOrProvince d4p1:nil="false">ValueHere</e33:StateOrProvince>
<e33:TimeStamp d4p1:nil="false">ValueHere</e33:TimeStamp>
<e33:BusinessName d4p1:nil="false">ValueHere</e33:BusinessName>
</e33:CustomerAddress>
</Customer>
</GetCustomerResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetCustomerResponse> GetCustomerAsync(
long customerId)
{
var request = new GetCustomerRequest
{
CustomerId = customerId
};
return (await CustomerManagementService.CallAsync((s, r) => s.GetCustomerAsync(r), request));
}
static GetCustomerResponse getCustomer(
java.lang.Long customerId) throws RemoteException, Exception
{
GetCustomerRequest request = new GetCustomerRequest();
request.setCustomerId(customerId);
return CustomerManagementService.getService().getCustomer(request);
}
static function GetCustomer(
$customerId)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new GetCustomerRequest();
$request->CustomerId = $customerId;
return $GLOBALS['CustomerManagementProxy']->GetService()->GetCustomer($request);
}
response=customermanagement_service.GetCustomer(
CustomerId=CustomerId)
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customer/Query
Request 要素
GetCustomerRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
CustomerId | 情報を取得する顧客の識別子。 | long |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetCustomerResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
顧客 | 顧客に関する情報を含む Customer オブジェクト。 | お客様 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"CustomerId": "LongValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"Customer": {
"CustomerAddress": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
},
"CustomerFinancialStatus": "ValueHere",
"CustomerLifeCycleStatus": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Industry": "ValueHere",
"LastModifiedByUserId": "LongValueHere",
"LastModifiedTime": "ValueHere",
"MarketCountry": "ValueHere",
"MarketLanguage": "ValueHere",
"Name": "ValueHere",
"Number": "ValueHere",
"ServiceLevel": "ValueHere",
"TimeStamp": "ValueHere"
}
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetCustomerResponse> GetCustomerAsync(
long customerId)
{
var request = new GetCustomerRequest
{
CustomerId = customerId
};
return (await CustomerManagementService.CallAsync((s, r) => s.GetCustomerAsync(r), request));
}
static GetCustomerResponse getCustomer(
java.lang.Long customerId) throws RemoteException, Exception
{
GetCustomerRequest request = new GetCustomerRequest();
request.setCustomerId(customerId);
return CustomerManagementService.getService().getCustomer(request);
}
static function GetCustomer(
$customerId)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new GetCustomerRequest();
$request->CustomerId = $customerId;
return $GLOBALS['CustomerManagementProxy']->GetService()->GetCustomer($request);
}
response=customermanagement_service.GetCustomer(
CustomerId=CustomerId)