Method: accounts.locations.verify

開始特定地點的驗證程序。

HTTP 要求

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

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

路徑參數

參數
name

string

待驗證地點的資源名稱。

要求主體

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

JSON 表示法 
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
欄位
method

enum (VerificationMethod)

驗證方法。
languageCode

string

BCP 47 語言代碼，代表驗證程序採用的語言。
context

object (ServiceBusinessContext)

用於驗證服務商家的額外背景資訊。對於商家類型為 CUSTOMER_LOCATION_ONLY 的地點，此為必填屬性。地址驗證會用來傳送明信片，其他方法應與傳遞至 locations.fetchVerificationOptions 的方法相同。如果將 INVALID_src 設為其他商家地點類型，就會擲回。
聯集欄位 RequestData。除了顯示資料以外，使用者為特定方法輸入的資料。資料必須與要求的方法相符。如果不需要任何資料，請將此欄位留空。RequestData 只能是下列其中一項：
emailInput

object (EmailInput)

EMAIL 方法的輸入內容。
addressInput

object (AddressInput)

ADDRESS 方法的輸入內容。
phoneInput

object (PhoneInput)

PHONE_CALL/SMS 方法的輸入內容

回應主體

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

Verifications.VerifyLocation 的回應訊息。

JSON 表示法 
{
  "verification": {
    object (Verification)
  }
}
欄位
verification

object (Verification)

已建立的驗證要求。

授權範圍

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

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

詳情請參閱 OAuth 2.0 總覽。

EmailInput

EMAIL 驗證的輸入欄位。

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

string

要接收 PIN 碼的電子郵件地址。

系統僅接受 locations.fetchVerificationOptions 中輸入的電子郵件地址。如果 EmailVerificationData isUserNameEditable 設為 true，用戶端可以指定不同的使用者名稱 (local-part)，但必須與網域名稱相符。

AddressInput

地址驗證的輸入內容。

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

string

收件者名稱。

PhoneInput

PHONE_CALL/SMS 驗證的輸入欄位。

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

string

應該撥打或接收簡訊的電話號碼。必須是符合資格選項中的其中一組電話號碼。