- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- VerificationOption
- PhoneVerificationData
- AddressVerificationData
- EmailVerificationData
回報特定語言地區所有符合資格的驗證選項。
HTTP 要求
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
要驗證位置的資源名稱。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{
"languageCode": string,
"context": {
object ( |
欄位 | |
---|---|
languageCode |
BCP 47 語言代碼,代表用於驗證程序的語言。可用選項因語言而異。 |
context |
服務商家驗證的額外背景資訊。對商家類型為「CUSTOMER_LOCATION_ONLY」的地點必填。如果為其他商家類型設定的話,則系統會擲回 INVALID_COUNTRY。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
Verifications.FetchVerificationOptions 的回應訊息。
JSON 表示法 | |
---|---|
{
"options": [
{
object ( |
欄位 | |
---|---|
options[] |
可用的驗證選項。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。
VerificationOption
驗證選項是指如何驗證位置 (以驗證方法表示),以及驗證的目的地 (以多媒體廣告資料表示)。
JSON 表示法 | |
---|---|
{ "verificationMethod": enum ( |
欄位 | ||
---|---|---|
verificationMethod |
驗證地點的方法。 |
|
聯集欄位 DisplayData 。其中一個顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料,則為空白。DisplayData 只能是下列其中一項: |
||
phoneData |
只有在方法為 PHONE_CALL 或 SMS 時才需要設定。 |
|
addressData |
只有在方法為 導致 時,才需要設定。 |
|
emailData |
只有在方法為 EMAIL 時才會設定。 |
PhoneVerificationData
顯示電話驗證資料 (例如通話和簡訊)。
JSON 表示法 | |
---|---|
{ "phoneNumber": string } |
欄位 | |
---|---|
phoneNumber |
要接收 PIN 碼的電話號碼。 |
AddressVerificationData
透過明信片顯示驗證資料。
JSON 表示法 | |
---|---|
{
"businessName": string,
"address": {
object ( |
欄位 | |
---|---|
businessName |
商家的商家名稱。 |
address |
明信片的收件地址。 |
EmailVerificationData
顯示透過電子郵件進行驗證的資料。
JSON 表示法 | |
---|---|
{ "domainName": string, "userName": string, "isUserNameEditable": boolean } |
欄位 | |
---|---|
domainName |
電子郵件地址中的網域名稱,例如 foo@gmail.com 中的「gmail.com」 |
userName |
電子郵件地址中的使用者名稱,例如 foo@gmail.com 中的「foo」 |
isUserNameEditable |
用戶端是否可提供其他使用者名稱。 |