UpdateCustomer サービス操作 - 顧客管理
指定した顧客の詳細をUpdatesします。
注:
Super 管理 資格情報を持つユーザーのみが顧客を更新できます。 詳細については、 ユーザー ロール のテクニカル ガイドを参照してください。
更新操作には最新の顧客書き込み操作のタイム スタンプが必要であるため、最初に GetCustomer 操作を呼び出す必要があります。 GetCustomer 操作は、タイム スタンプを含む顧客のデータを返します。 古いタイム スタンプを使用すると、更新呼び出しは失敗します。たとえば、顧客データは、タイム スタンプを取得した後、アプリケーションまたは別のアプリケーションによって更新されます。
更新操作によって既存の顧客データが完全に上書きされるため、顧客データには必要なすべてのデータが含まれている必要があります。それ以外の場合、操作は失敗します。
Request 要素
UpdateCustomerRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
顧客 | 更新された顧客情報を含む顧客オブジェクト。 この操作により、既存の顧客データが、渡した顧客オブジェクトの内容で上書きされます。 この操作は、部分的な更新ではなく、完全な更新を実行します。 Customer オブジェクトには、Customer オブジェクトが最後に書き込まれた時点からのタイム スタンプ値が含まれている必要があります。 タイム スタンプに正しい値が含まれていることを確認するには、 GetCustomer 操作を呼び出します。 その後、必要に応じて顧客データを更新し、 UpdateCustomer を呼び出すことができます。 |
お客様 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
UpdateCustomerResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
LastModifiedTime | 顧客が最後に更新された日付と時刻。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。 |
dateTime |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">UpdateCustomer</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<UpdateCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Customer xmlns:e129="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e129:CustomerFinancialStatus i:nil="false">ValueHere</e129:CustomerFinancialStatus>
<e129:Id i:nil="false">ValueHere</e129:Id>
<e129:Industry i:nil="false">ValueHere</e129:Industry>
<e129:LastModifiedByUserId i:nil="false">ValueHere</e129:LastModifiedByUserId>
<e129:LastModifiedTime i:nil="false">ValueHere</e129:LastModifiedTime>
<e129:MarketCountry i:nil="false">ValueHere</e129:MarketCountry>
<e129:ForwardCompatibilityMap xmlns:e130="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e130:KeyValuePairOfstringstring>
<e130:key i:nil="false">ValueHere</e130:key>
<e130:value i:nil="false">ValueHere</e130:value>
</e130:KeyValuePairOfstringstring>
</e129:ForwardCompatibilityMap>
<e129:MarketLanguage i:nil="false">ValueHere</e129:MarketLanguage>
<e129:Name i:nil="false">ValueHere</e129:Name>
<e129:ServiceLevel i:nil="false">ValueHere</e129:ServiceLevel>
<e129:CustomerLifeCycleStatus i:nil="false">ValueHere</e129:CustomerLifeCycleStatus>
<e129:TimeStamp i:nil="false">ValueHere</e129:TimeStamp>
<e129:Number i:nil="false">ValueHere</e129:Number>
<e129:CustomerAddress i:nil="false">
<e129:City i:nil="false">ValueHere</e129:City>
<e129:CountryCode i:nil="false">ValueHere</e129:CountryCode>
<e129:Id i:nil="false">ValueHere</e129:Id>
<e129:Line1 i:nil="false">ValueHere</e129:Line1>
<e129:Line2 i:nil="false">ValueHere</e129:Line2>
<e129:Line3 i:nil="false">ValueHere</e129:Line3>
<e129:Line4 i:nil="false">ValueHere</e129:Line4>
<e129:PostalCode i:nil="false">ValueHere</e129:PostalCode>
<e129:StateOrProvince i:nil="false">ValueHere</e129:StateOrProvince>
<e129:TimeStamp i:nil="false">ValueHere</e129:TimeStamp>
<e129:BusinessName i:nil="false">ValueHere</e129:BusinessName>
</e129:CustomerAddress>
</Customer>
</UpdateCustomerRequest>
</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>
<UpdateCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<LastModifiedTime>ValueHere</LastModifiedTime>
</UpdateCustomerResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<UpdateCustomerResponse> UpdateCustomerAsync(
Customer customer)
{
var request = new UpdateCustomerRequest
{
Customer = customer
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateCustomerAsync(r), request));
}
static UpdateCustomerResponse updateCustomer(
Customer customer) throws RemoteException, Exception
{
UpdateCustomerRequest request = new UpdateCustomerRequest();
request.setCustomer(customer);
return CustomerManagementService.getService().updateCustomer(request);
}
static function UpdateCustomer(
$customer)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateCustomerRequest();
$request->Customer = $customer;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateCustomer($request);
}
response=customermanagement_service.UpdateCustomer(
Customer=Customer)
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customer
Request 要素
UpdateCustomerRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
顧客 | 更新された顧客情報を含む顧客オブジェクト。 この操作により、既存の顧客データが、渡した顧客オブジェクトの内容で上書きされます。 この操作は、部分的な更新ではなく、完全な更新を実行します。 Customer オブジェクトには、Customer オブジェクトが最後に書き込まれた時点からのタイム スタンプ値が含まれている必要があります。 タイム スタンプに正しい値が含まれていることを確認するには、 GetCustomer 操作を呼び出します。 その後、必要に応じて顧客データを更新し、 UpdateCustomer を呼び出すことができます。 |
お客様 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
UpdateCustomerResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
LastModifiedTime | 顧客が最後に更新された日付と時刻。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。 |
dateTime |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
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"
}
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"LastModifiedTime": "ValueHere"
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<UpdateCustomerResponse> UpdateCustomerAsync(
Customer customer)
{
var request = new UpdateCustomerRequest
{
Customer = customer
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateCustomerAsync(r), request));
}
static UpdateCustomerResponse updateCustomer(
Customer customer) throws RemoteException, Exception
{
UpdateCustomerRequest request = new UpdateCustomerRequest();
request.setCustomer(customer);
return CustomerManagementService.getService().updateCustomer(request);
}
static function UpdateCustomer(
$customer)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateCustomerRequest();
$request->Customer = $customer;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateCustomer($request);
}
response=customermanagement_service.UpdateCustomer(
Customer=Customer)