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