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)
  },

  // Union field RequestData can be only one of the following:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
欄位
method

enum (VerificationMethod)

必要欄位。驗證方法。
languageCode

string

選用設定。BCP 47 語言代碼，代表用於驗證程序的語言。
context

object (ServiceBusinessContext)

選用設定。服務商家驗證的額外背景資訊。只有業務類型為「CUSTOMER_LOCATION_ONLY」的地點需要這項參數。如果是地址驗證，地址將用於寄送明信片。如果是其他方法，則應與傳遞至 GetVerificationOptions 的方法相同。如果為其他類型的商家所在地點設定 INVALID_VALUE，則系統會擲回該字串。
聯集欄位 RequestData。除了顯示資料以外，特定方法的使用者輸入資料。資料必須符合要求的方法。如果不需要資料，請留空。RequestData 只能是下列其中一項：
emailAddress

string

選用設定。EMAIL 方法的輸入內容。接收 PIN 碼的電子郵件地址。

系統只接受 location.fetchVerificationOptions 提供的其中一個地址電子郵件地址。如果 [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] 設為 true，用戶端可以指定不同的使用者名稱 (local-part)，但必須與網域名稱相符。
mailerContact

string

選用設定。ADDRESS 方法的輸入內容。要接收郵件的聯絡人姓名。
phoneNumber

string

選用設定。PHONE_CALL/SMS 方法的輸入內容。應用於通話或傳送簡訊的電話號碼。且必須是適用選項中其中一個電話號碼。
token

object (VerificationToken)

選用設定。可供特定partners.使用的 VETTED_PARTNER 方法輸入內容。無須為通過審查的帳戶輸入資料。與位置相關聯的權杖。與位置相關聯的權杖。

回應主體

Verifications.VerifyLocation 的回應訊息。

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

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

object (Verification)

已建立的驗證要求。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

VerificationToken

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

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

string

權杖字串。