ValidateAddress 服务操作 - 客户管理
确定提交的地址是否对Microsoft广告帐户有效。
如果地址有效,则可以将其用作 BusinessAddress 帐户。
对于澳大利亚 (AU) 、加拿大 (CA) 和 美国 (美国) ,操作将验证是否可以将内容寄送到地址。 对于所有其他国家或地区,已完成基本地址验证 (AVS) 。
请求元素
ValidateAddressRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
地址 | 要验证的地址。 | 地址 |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
ValidateAddressResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
OriginalAddress | 已提交验证的地址。 提交的 地址 始终在响应中传递回此处,因此始终设置此元素。 |
地址 |
状态 | 确定提交的地址是否对Microsoft广告帐户有效,以及是否通过 SuggestedAddresses 响应元素提供任何地址建议。 可能的字符串值为 AddressValidWithoutSuggestions、 AddressValidWithSuggestions、 AddressInvalidWithoutSuggestions 和 AddressInvalidWithSuggestions。 |
string |
SuggestedAddresses | 如果 Status 为 AddressValidWithSuggestions 或 AddressInvalidWithSuggestions,则为一个或多个建议地址。 如果 Status 为 AddressValidWithoutSuggestions 或 AddressInvalidWithoutSuggestions,则此元素将为零。 |
地址 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 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">ValidateAddress</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<ValidateAddressRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Address xmlns:e137="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e137:City i:nil="false">ValueHere</e137:City>
<e137:CountryCode i:nil="false">ValueHere</e137:CountryCode>
<e137:Id i:nil="false">ValueHere</e137:Id>
<e137:Line1 i:nil="false">ValueHere</e137:Line1>
<e137:Line2 i:nil="false">ValueHere</e137:Line2>
<e137:Line3 i:nil="false">ValueHere</e137:Line3>
<e137:Line4 i:nil="false">ValueHere</e137:Line4>
<e137:PostalCode i:nil="false">ValueHere</e137:PostalCode>
<e137:StateOrProvince i:nil="false">ValueHere</e137:StateOrProvince>
<e137:TimeStamp i:nil="false">ValueHere</e137:TimeStamp>
<e137:BusinessName i:nil="false">ValueHere</e137:BusinessName>
</Address>
</ValidateAddressRequest>
</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>
<ValidateAddressResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<OriginalAddress xmlns:e138="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e138:City d4p1:nil="false">ValueHere</e138:City>
<e138:CountryCode d4p1:nil="false">ValueHere</e138:CountryCode>
<e138:Id d4p1:nil="false">ValueHere</e138:Id>
<e138:Line1 d4p1:nil="false">ValueHere</e138:Line1>
<e138:Line2 d4p1:nil="false">ValueHere</e138:Line2>
<e138:Line3 d4p1:nil="false">ValueHere</e138:Line3>
<e138:Line4 d4p1:nil="false">ValueHere</e138:Line4>
<e138:PostalCode d4p1:nil="false">ValueHere</e138:PostalCode>
<e138:StateOrProvince d4p1:nil="false">ValueHere</e138:StateOrProvince>
<e138:TimeStamp d4p1:nil="false">ValueHere</e138:TimeStamp>
<e138:BusinessName d4p1:nil="false">ValueHere</e138:BusinessName>
</OriginalAddress>
<Status d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Status>
<SuggestedAddresses xmlns:e139="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e139:Address>
<e139:City d4p1:nil="false">ValueHere</e139:City>
<e139:CountryCode d4p1:nil="false">ValueHere</e139:CountryCode>
<e139:Id d4p1:nil="false">ValueHere</e139:Id>
<e139:Line1 d4p1:nil="false">ValueHere</e139:Line1>
<e139:Line2 d4p1:nil="false">ValueHere</e139:Line2>
<e139:Line3 d4p1:nil="false">ValueHere</e139:Line3>
<e139:Line4 d4p1:nil="false">ValueHere</e139:Line4>
<e139:PostalCode d4p1:nil="false">ValueHere</e139:PostalCode>
<e139:StateOrProvince d4p1:nil="false">ValueHere</e139:StateOrProvince>
<e139:TimeStamp d4p1:nil="false">ValueHere</e139:TimeStamp>
<e139:BusinessName d4p1:nil="false">ValueHere</e139:BusinessName>
</e139:Address>
</SuggestedAddresses>
</ValidateAddressResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<ValidateAddressResponse> ValidateAddressAsync(
Address address)
{
var request = new ValidateAddressRequest
{
Address = address
};
return (await CustomerManagementService.CallAsync((s, r) => s.ValidateAddressAsync(r), request));
}
static ValidateAddressResponse validateAddress(
Address address) throws RemoteException, Exception
{
ValidateAddressRequest request = new ValidateAddressRequest();
request.setAddress(address);
return CustomerManagementService.getService().validateAddress(request);
}
static function ValidateAddress(
$address)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new ValidateAddressRequest();
$request->Address = $address;
return $GLOBALS['CustomerManagementProxy']->GetService()->ValidateAddress($request);
}
response=customermanagement_service.ValidateAddress(
Address=Address)
要求
服务: CustomerManagementService.svc v13
命名空间: https://bingads.microsoft.com/Customer/v13
请求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Address/Validate
请求元素
ValidateAddressRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
地址 | 要验证的地址。 | 地址 |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
ValidateAddressResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
OriginalAddress | 已提交验证的地址。 提交的 地址 始终在响应中传递回此处,因此始终设置此元素。 |
地址 |
状态 | 确定提交的地址是否对Microsoft广告帐户有效,以及是否通过 SuggestedAddresses 响应元素提供任何地址建议。 可能的字符串值为 AddressValidWithoutSuggestions、 AddressValidWithSuggestions、 AddressInvalidWithoutSuggestions 和 AddressInvalidWithSuggestions。 |
string |
SuggestedAddresses | 如果 Status 为 AddressValidWithSuggestions 或 AddressInvalidWithSuggestions,则为一个或多个建议地址。 如果 Status 为 AddressValidWithoutSuggestions 或 AddressInvalidWithoutSuggestions,则此元素将为零。 |
地址 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"Address": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
}
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
{
"OriginalAddress": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
},
"Status": "ValueHere",
"SuggestedAddresses": [
{
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
}
]
}
代码语法
若要通过 SDK 调用 REST API,需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<ValidateAddressResponse> ValidateAddressAsync(
Address address)
{
var request = new ValidateAddressRequest
{
Address = address
};
return (await CustomerManagementService.CallAsync((s, r) => s.ValidateAddressAsync(r), request));
}
static ValidateAddressResponse validateAddress(
Address address) throws RemoteException, Exception
{
ValidateAddressRequest request = new ValidateAddressRequest();
request.setAddress(address);
return CustomerManagementService.getService().validateAddress(request);
}
static function ValidateAddress(
$address)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new ValidateAddressRequest();
$request->Address = $address;
return $GLOBALS['CustomerManagementProxy']->GetService()->ValidateAddress($request);
}
response=customermanagement_service.ValidateAddress(
Address=Address)