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

聯集欄位 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

輸入電子郵件驗證碼。

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

應撥打電話或傳送簡訊的電話號碼。必須是符合資格的選項中提供的電話號碼之一。