GetAccount 服务操作 - 客户管理
获取帐户的详细信息。
请求元素
GetAccountRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AccountId | 要获取的帐户的标识符。 | long |
ReturnAdditionalFields | 要包含在每个返回的帐户中的其他属性的列表。 借助其他字段值,可以使用当前版本的客户管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
AccountAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAccountResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
帐户 | 一个帐户对象,其中包含有关帐户的信息,例如付款方式、帐户类型和父客户。 | AdvertiserAccount |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 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:e23="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e23:BillToCustomerId d4p1:nil="false">ValueHere</e23:BillToCustomerId>
<e23:CurrencyCode d4p1:nil="false">ValueHere</e23:CurrencyCode>
<e23:AccountFinancialStatus d4p1:nil="false">ValueHere</e23:AccountFinancialStatus>
<e23:Id d4p1:nil="false">ValueHere</e23:Id>
<e23:Language d4p1:nil="false">ValueHere</e23:Language>
<e23:LastModifiedByUserId d4p1:nil="false">ValueHere</e23:LastModifiedByUserId>
<e23:LastModifiedTime d4p1:nil="false">ValueHere</e23:LastModifiedTime>
<e23:Name d4p1:nil="false">ValueHere</e23:Name>
<e23:Number d4p1:nil="false">ValueHere</e23:Number>
<e23:ParentCustomerId>ValueHere</e23:ParentCustomerId>
<e23:PaymentMethodId d4p1:nil="false">ValueHere</e23:PaymentMethodId>
<e23:PaymentMethodType d4p1:nil="false">ValueHere</e23:PaymentMethodType>
<e23:PrimaryUserId d4p1:nil="false">ValueHere</e23:PrimaryUserId>
<e23:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e23:AccountLifeCycleStatus>
<e23:TimeStamp d4p1:nil="false">ValueHere</e23:TimeStamp>
<e23:TimeZone d4p1:nil="false">ValueHere</e23:TimeZone>
<e23:PauseReason d4p1:nil="false">ValueHere</e23:PauseReason>
<e23:ForwardCompatibilityMap xmlns:e24="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e24:KeyValuePairOfstringstring>
<e24:key d4p1:nil="false">ValueHere</e24:key>
<e24:value d4p1:nil="false">ValueHere</e24:value>
</e24:KeyValuePairOfstringstring>
</e23:ForwardCompatibilityMap>
<e23:LinkedAgencies d4p1:nil="false">
<e23:CustomerInfo>
<e23:Id d4p1:nil="false">ValueHere</e23:Id>
<e23:Name d4p1:nil="false">ValueHere</e23:Name>
</e23:CustomerInfo>
</e23:LinkedAgencies>
<e23:SalesHouseCustomerId d4p1:nil="false">ValueHere</e23:SalesHouseCustomerId>
<e23:TaxInformation xmlns:e25="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e25:KeyValuePairOfstringstring>
<e25:key d4p1:nil="false">ValueHere</e25:key>
<e25:value d4p1:nil="false">ValueHere</e25:value>
</e25:KeyValuePairOfstringstring>
</e23:TaxInformation>
<e23:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e23:BackUpPaymentInstrumentId>
<e23:BillingThresholdAmount d4p1:nil="false">ValueHere</e23:BillingThresholdAmount>
<e23:BusinessAddress d4p1:nil="false">
<e23:City d4p1:nil="false">ValueHere</e23:City>
<e23:CountryCode d4p1:nil="false">ValueHere</e23:CountryCode>
<e23:Id d4p1:nil="false">ValueHere</e23:Id>
<e23:Line1 d4p1:nil="false">ValueHere</e23:Line1>
<e23:Line2 d4p1:nil="false">ValueHere</e23:Line2>
<e23:Line3 d4p1:nil="false">ValueHere</e23:Line3>
<e23:Line4 d4p1:nil="false">ValueHere</e23:Line4>
<e23:PostalCode d4p1:nil="false">ValueHere</e23:PostalCode>
<e23:StateOrProvince d4p1:nil="false">ValueHere</e23:StateOrProvince>
<e23:TimeStamp d4p1:nil="false">ValueHere</e23:TimeStamp>
<e23:BusinessName d4p1:nil="false">ValueHere</e23:BusinessName>
</e23:BusinessAddress>
<e23:AutoTagType d4p1:nil="false">ValueHere</e23:AutoTagType>
<e23:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e23:SoldToPaymentInstrumentId>
<e23:TaxCertificate d4p1:nil="false">
<e23:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e23:TaxCertificateBlobContainerName>
<e23:TaxCertificates xmlns:e26="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e26:KeyValuePairOfstringbase64Binary>
<e26:key d4p1:nil="false">ValueHere</e26:key>
<e26:value d4p1:nil="false">ValueHere</e26:value>
</e26:KeyValuePairOfstringbase64Binary>
</e23:TaxCertificates>
<e23:Status d4p1:nil="false">ValueHere</e23:Status>
</e23:TaxCertificate>
<e23:AccountMode d4p1:nil="false">ValueHere</e23:AccountMode>
</Account>
</GetAccountResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 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 | 要获取的帐户的标识符。 | long |
ReturnAdditionalFields | 要包含在每个返回的帐户中的其他属性的列表。 借助其他字段值,可以使用当前版本的客户管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
AccountAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAccountResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
帐户 | 一个帐户对象,其中包含有关帐户的信息,例如付款方式、帐户类型和父客户。 | AdvertiserAccount |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 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)