GetAccount 服務作業 - 客戶管理
取得帳戶的詳細數據。
要求專案
GetAccountRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AccountId | 要取得之帳戶的標識碼。 | 長 |
ReturnAdditionalFields | 您想要包含在每個傳回帳戶中的其他屬性清單。 其他域值可讓您使用目前版本的客戶管理 API 取得最新功能,而在下一個版本中,預設會包含對應的元素。 此要求項目是選擇性的。 |
AccountAdditionalField |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetAccountResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
帳戶 | 包含帳戶相關信息的帳戶物件,例如付款方式、帳戶類型和父客戶。 | 廣告客戶帳戶 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
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">GetAccount</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetAccountRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<AccountId>ValueHere</AccountId>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAccountRequest>
</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>
<GetAccountResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Account xmlns:e479="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e479:BillToCustomerId d4p1:nil="false">ValueHere</e479:BillToCustomerId>
<e479:CurrencyCode d4p1:nil="false">ValueHere</e479:CurrencyCode>
<e479:AccountFinancialStatus d4p1:nil="false">ValueHere</e479:AccountFinancialStatus>
<e479:Id d4p1:nil="false">ValueHere</e479:Id>
<e479:Language d4p1:nil="false">ValueHere</e479:Language>
<e479:LastModifiedByUserId d4p1:nil="false">ValueHere</e479:LastModifiedByUserId>
<e479:LastModifiedTime d4p1:nil="false">ValueHere</e479:LastModifiedTime>
<e479:Name d4p1:nil="false">ValueHere</e479:Name>
<e479:Number d4p1:nil="false">ValueHere</e479:Number>
<e479:ParentCustomerId>ValueHere</e479:ParentCustomerId>
<e479:PaymentMethodId d4p1:nil="false">ValueHere</e479:PaymentMethodId>
<e479:PaymentMethodType d4p1:nil="false">ValueHere</e479:PaymentMethodType>
<e479:PrimaryUserId d4p1:nil="false">ValueHere</e479:PrimaryUserId>
<e479:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e479:AccountLifeCycleStatus>
<e479:TimeStamp d4p1:nil="false">ValueHere</e479:TimeStamp>
<e479:TimeZone d4p1:nil="false">ValueHere</e479:TimeZone>
<e479:PauseReason d4p1:nil="false">ValueHere</e479:PauseReason>
<e479:ForwardCompatibilityMap xmlns:e480="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e480:KeyValuePairOfstringstring>
<e480:key d4p1:nil="false">ValueHere</e480:key>
<e480:value d4p1:nil="false">ValueHere</e480:value>
</e480:KeyValuePairOfstringstring>
</e479:ForwardCompatibilityMap>
<e479:LinkedAgencies d4p1:nil="false">
<e479:CustomerInfo>
<e479:Id d4p1:nil="false">ValueHere</e479:Id>
<e479:Name d4p1:nil="false">ValueHere</e479:Name>
</e479:CustomerInfo>
</e479:LinkedAgencies>
<e479:SalesHouseCustomerId d4p1:nil="false">ValueHere</e479:SalesHouseCustomerId>
<e479:TaxInformation xmlns:e481="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e481:KeyValuePairOfstringstring>
<e481:key d4p1:nil="false">ValueHere</e481:key>
<e481:value d4p1:nil="false">ValueHere</e481:value>
</e481:KeyValuePairOfstringstring>
</e479:TaxInformation>
<e479:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e479:BackUpPaymentInstrumentId>
<e479:BillingThresholdAmount d4p1:nil="false">ValueHere</e479:BillingThresholdAmount>
<e479:BusinessAddress d4p1:nil="false">
<e479:City d4p1:nil="false">ValueHere</e479:City>
<e479:CountryCode d4p1:nil="false">ValueHere</e479:CountryCode>
<e479:Id d4p1:nil="false">ValueHere</e479:Id>
<e479:Line1 d4p1:nil="false">ValueHere</e479:Line1>
<e479:Line2 d4p1:nil="false">ValueHere</e479:Line2>
<e479:Line3 d4p1:nil="false">ValueHere</e479:Line3>
<e479:Line4 d4p1:nil="false">ValueHere</e479:Line4>
<e479:PostalCode d4p1:nil="false">ValueHere</e479:PostalCode>
<e479:StateOrProvince d4p1:nil="false">ValueHere</e479:StateOrProvince>
<e479:TimeStamp d4p1:nil="false">ValueHere</e479:TimeStamp>
<e479:BusinessName d4p1:nil="false">ValueHere</e479:BusinessName>
</e479:BusinessAddress>
<e479:AutoTagType d4p1:nil="false">ValueHere</e479:AutoTagType>
<e479:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e479:SoldToPaymentInstrumentId>
<e479:TaxCertificate d4p1:nil="false">
<e479:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e479:TaxCertificateBlobContainerName>
<e479:TaxCertificates xmlns:e482="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e482:KeyValuePairOfstringbase64Binary>
<e482:key d4p1:nil="false">ValueHere</e482:key>
<e482:value d4p1:nil="false">ValueHere</e482:value>
</e482:KeyValuePairOfstringbase64Binary>
</e479:TaxCertificates>
<e479:Status d4p1:nil="false">ValueHere</e479:Status>
</e479:TaxCertificate>
<e479:AccountMode d4p1:nil="false">ValueHere</e479:AccountMode>
</Account>
</GetAccountResponse>
</s:Body>
</s:Envelope>
程序代碼語法
範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetAccountResponse> GetAccountAsync(
long accountId,
AccountAdditionalField? returnAdditionalFields)
{
var request = new GetAccountRequest
{
AccountId = accountId,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountAsync(r), request));
}
static GetAccountResponse getAccount(
java.lang.Long accountId,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAccountRequest request = new GetAccountRequest();
request.setAccountId(accountId);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().getAccount(request);
}
static function GetAccount(
$accountId,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new GetAccountRequest();
$request->AccountId = $accountId;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccount($request);
}
response=customermanagement_service.GetAccount(
AccountId=AccountId,
ReturnAdditionalFields=ReturnAdditionalFields)
需求
服務: CustomerManagementService.svc v13
命名空間: https://bingads.microsoft.com/Customer/v13
要求 URL
要求專案
GetAccountRequest 物件會定義服務作業要求的主體和標頭元素。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AccountId | 要取得之帳戶的標識碼。 | 長 |
ReturnAdditionalFields | 您想要包含在每個傳回帳戶中的其他屬性清單。 其他域值可讓您使用目前版本的客戶管理 API 取得最新功能,而在下一個版本中,預設會包含對應的元素。 此要求項目是選擇性的。 |
AccountAdditionalField |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
授權 | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetAccountResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
帳戶 | 包含帳戶相關信息的帳戶物件,例如付款方式、帳戶類型和父客戶。 | 廣告客戶帳戶 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細數據的記錄項目識別碼。 | string |
要求 JSON
此範本是由工具所產生,用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文項目 參考。
{
"AccountId": "LongValueHere",
"ReturnAdditionalFields": "ValueHere"
}
回應 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"
}
}
程序代碼語法
若要透過 SDK 呼叫 REST API,您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetAccountResponse> GetAccountAsync(
long accountId,
AccountAdditionalField? returnAdditionalFields)
{
var request = new GetAccountRequest
{
AccountId = accountId,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountAsync(r), request));
}
static GetAccountResponse getAccount(
java.lang.Long accountId,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAccountRequest request = new GetAccountRequest();
request.setAccountId(accountId);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().getAccount(request);
}
static function GetAccount(
$accountId,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new GetAccountRequest();
$request->AccountId = $accountId;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccount($request);
}
response=customermanagement_service.GetAccount(
AccountId=AccountId,
ReturnAdditionalFields=ReturnAdditionalFields)