ValidateAddress 服務作業 - 客戶管理
判斷提交的位址是否適用於 Microsoft Advertising 帳戶。
如果位址有效,您可以使用它作為 帳戶 BusinessAddress。
針對澳大利亞 (AU) 、加拿大 (CA) ,以及 美國 (美國) ,此作業會驗證您是否可以將某個專案寄送至位址。 針對所有其他國家或地區,基本地址驗證 (AVS) 已完成。
要求專案
ValidateAddressRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
地址 | 要驗證的位址。 | Address |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
ValidateAddressResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
OriginalAddress | 提交以進行驗證的位址。 送出的 Address 一律會在回應中傳回這裡,因此一律會設定這個專案。 |
Address |
地位 | 判斷提交的位址是否適用於 Microsoft Advertising 帳戶,以及是否可透過 SuggestedAddresses 回應元素取得任何地址建議。 可能的字串值為 AddressValidWithoutSuggestions、 AddressValidWithSuggestions、 AddressInvalidWithoutSuggestions 和 AddressInvalidWithSuggestions。 |
string |
SuggestedAddresses | 如果 Status 為 AddressValidWithSuggestions 或 AddressInvalidWithSuggestions,則為一或多個建議的位址。 如果 Status 為 AddressValidWithoutSuggestions 或 AddressInvalidWithoutSuggestions,則此元素會是 nil。 |
地址 陣列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
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">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>
程序代碼語法
範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 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
要求專案
ValidateAddressRequest 物件會定義服務作業要求的主體和標頭元素。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
地址 | 要驗證的位址。 | Address |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
授權 | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
ValidateAddressResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
OriginalAddress | 提交以進行驗證的位址。 送出的 Address 一律會在回應中傳回這裡,因此一律會設定這個專案。 |
Address |
地位 | 判斷提交的位址是否適用於 Microsoft Advertising 帳戶,以及是否可透過 SuggestedAddresses 回應元素取得任何地址建議。 可能的字串值為 AddressValidWithoutSuggestions、 AddressValidWithSuggestions、 AddressInvalidWithoutSuggestions 和 AddressInvalidWithSuggestions。 |
string |
SuggestedAddresses | 如果 Status 為 AddressValidWithSuggestions 或 AddressInvalidWithSuggestions,則為一或多個建議的位址。 如果 Status 為 AddressValidWithoutSuggestions 或 AddressInvalidWithoutSuggestions,則此元素會是 nil。 |
地址 陣列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 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 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 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)