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_ARGUMENT。

回應主體

Verifications.FetchVerificationOptions 的回應訊息。

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

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

object (VerificationOption)

可用的驗證選項。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱OAuth 2.0 Overview。

VerificationOption

驗證選項代表驗證地點的方式 (由驗證方法表示),以及驗證資訊的傳送位置 (由顯示資料表示)。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of mutually exclusive fields.
}
欄位
verificationMethod

enum (VerificationMethod)

驗證地點的方法。

其中一項顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料,則為空白。以下列出互斥欄位。回應中最多會設定下列其中一個欄位:
phoneNumber

string

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

addressData

object (AddressVerificationData)

只有在方法為 MAIL 時才設定。

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

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