Method: locations.fetchVerificationOptions

回報特定語言地區所有符合資格的驗證選項。

HTTP 要求

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
location

string

必要欄位。要驗證的位置。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
欄位
languageCode

string

必要欄位。BCP 47 語言代碼,代表用於驗證程序的語言。可用選項因語言而異。

context

object (ServiceBusinessContext)

選用設定。服務商家驗證的額外背景資訊。只能套用至業務類型為「CUSTOMER_LOCATION_ONLY」的地點。指定正確的地址可能會啟用更多選項。如果為其他商家類型設定的話,則系統會擲回 INVALID_COUNTRY。

回應主體

Verifications.FetchVerificationOptions 的回應訊息。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
欄位
options[]

object (VerificationOption)

可用的驗證選項。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/business.manage

詳情請參閱 OAuth 2.0 總覽

VerificationOption

驗證選項是指如何驗證位置 (以驗證方法表示),以及驗證的目的地 (以多媒體廣告資料表示)。

JSON 表示法
{
  "verificationMethod": enum (VerificationMethod),

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of list of possible types for union field DisplayData.
}
欄位
verificationMethod

enum (VerificationMethod)

驗證地點的方法。

聯集欄位 DisplayData。其中一個顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料,則為空白。DisplayData 只能是下列其中一項:
phoneNumber

string

只有在方法為 PHONE_CALL 或 SMS 時才需要設定。要接收 PIN 碼的電話號碼。

addressData

object (AddressVerificationData)

只有在方法為 導致 時,才需要設定。

emailData

object (EmailVerificationData)

只有在方法為 EMAIL 時才會設定。

announcement

string

只有在方法為 VETTED_PARTNER 時才需要設定。

AddressVerificationData

透過明信片顯示驗證資料。

JSON 表示法
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
欄位
business

string

商家的商家名稱。

address

object (PostalAddress)

明信片的收件地址。

expectedDeliveryDaysRegion

integer

寄送明信片到地址所在區域的預估天數。

EmailVerificationData

顯示透過電子郵件進行驗證的資料。

JSON 表示法
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
欄位
domain

string

電子郵件地址中的網域名稱,例如 foo@gmail.com 中的「gmail.com」

user

string

電子郵件地址中的使用者名稱,例如 foo@gmail.com 中的「foo」

isUserNameEditable

boolean

用戶端是否可提供其他使用者名稱。