Method: locations.verify

開始驗證地點。

HTTP 要求

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

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

路徑參數

參數
name

string

必填。要驗證的地點資源名稱。

要求主體

要求主體會包含結構如下的資料:

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  },
  "trustedPartnerToken": string
  // End of mutually exclusive fields.
}
欄位
method

enum (VerificationMethod)

必填。驗證方法。

languageCode

string

(選用步驟) BCP 47 語言代碼,代表驗證程序使用的語言。

context

object (ServiceBusinessContext)

(選用步驟) 服務商家驗證的額外背景資訊。只有業務類型為 CUSTOMER_LOCATION_ONLY 的地點才需要提供。如要驗證地址,系統會將明信片寄到該地址。如果是其他方法,則應與傳遞至 GetVerificationOptions 的方法相同。如果為其他類型的商家所在地點設定這項屬性,系統會擲回 INVALID_ARGUMENT。

除了顯示資料外,使用者輸入的特定方法資料。資料必須與要求的方法相符。如果不需要資料,請留空。以下列出互斥欄位。回應中最多會設定下列其中一個欄位:
emailAddress

string

(選用步驟) EMAIL 方法的輸入內容。接收 PIN 碼的電子郵件地址。

只有 locations.fetchVerificationOptions 提供的電子郵件地址,才能用於驗證。如果 [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] 的 isUserNameEditable 設為 true,用戶端可以指定其他使用者名稱 (本機部分),但必須與網域名稱相符。

mailerContact

string

(選用步驟) ADDRESS 方法的輸入內容。郵件收件者的姓名。

phoneNumber

string

(選用步驟) PHONE_CALL/SMS 方法的輸入內容,也就是要撥打或傳送簡訊的電話號碼。必須是符合資格選項中的其中一個電話號碼。

token

object (VerificationToken)

(選用步驟) VETTED_PARTNER 方法的輸入內容,僅供特定合作夥伴使用。如果帳戶已通過審查,則不需輸入。與地點相關聯的權杖。與位置相關聯的權杖。

trustedPartnerToken

string

TRUSTED_PARTNER 方法的輸入內容,即與地點相關聯的驗證權杖。

互斥欄位結束。

回應主體

Verifications.VerifyLocation 的回應訊息。

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

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

object (Verification)

建立的驗證要求。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱OAuth 2.0 Overview。

VerificationToken

由經過審查的合作夥伴產生的權杖。

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

string

權杖字串。