Method: accounts.locations.fetchVerificationOptions

回報某地點使用特定語言的所有合格驗證選項。

HTTP 要求

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions

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

路徑參數

參數
name

string

待驗證地點的資源名稱。

要求主體

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

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

string

BCP 47 語言代碼，代表驗證程序採用的語言。可用選項因語言而異。
context

object (ServiceBusinessContext)

用於驗證服務商家的額外背景資訊。對於商家類型為 CUSTOMER_LOCATION_ONLY 的地點，此為必填屬性。如果針對其他商家類型的位置設定 INVALID_src，系統將擲回限制。

回應主體

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

Verifications.FetchVerificationOptions 的回應訊息。

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

object (VerificationOption)

可用的驗證方式。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/plus.business.manage
  • 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:
  "phoneData": {
    object (PhoneVerificationData)
  },
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  }
  // End of list of possible types for union field DisplayData.
}
欄位
verificationMethod

enum (VerificationMethod)

用於驗證地點的方法。
聯集欄位 DisplayData。其中一個顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料，則為空白。DisplayData 只能是下列其中一項：
phoneData

object (PhoneVerificationData)

僅在方法為 PHONE_CALL 或 SMS 時設定。
addressData

object (AddressVerificationData)

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

object (EmailVerificationData)

僅在方法為 EMAIL 時設定。

PhoneVerificationData

顯示透過電話驗證的資料，例如簡訊、簡訊

JSON 表示法 
{
  "phoneNumber": string
}
欄位
phoneNumber

string

要接收 PIN 碼的電話號碼。

AddressVerificationData

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

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

string

商家的商家名稱。
address

object (PostalAddress)

明信片的收件地址。

EmailVerificationData

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

JSON 表示法 
{
  "domainName": string,
  "userName": string,
  "isUserNameEditable": boolean
}
欄位
domainName

string

電子郵件地址中的網域名稱。例如："gmail.com"foo@gmail.com
userName

string

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

boolean

是否允許用戶端提供不同的使用者名稱。