Method: accounts.locations.verify

ビジネスのオーナー確認プロセスを開始します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 の場合は必須です。ADDRESS 確認の場合、住所はハガキの郵送先に使用されます。他のメソッドの場合、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

EMAIL 確認用の入力です。

JSON 表現
{
  "emailAddress": string
}
フィールド
emailAddress

string

PIN の送付先メールアドレスです。

メールアドレスは、locations.fetchVerificationOptions で指定されたアドレスのいずれかである場合にのみ受け入れられます。EmailVerificationData で isUserNameEditable が true に設定されている場合、クライアントは別のユーザー名(local-part)を指定できますが、ドメイン名と一致する必要があります。

AddressInput

ADDRESS 確認のための入力です。

JSON 表現
{
  "mailerContactName": string
}
フィールド
mailerContactName

string

郵便物の送り先の名前です。

PhoneInput

PHONE_CALL または SMS によるオーナー確認用の入力です。

JSON 表現
{
  "phoneNumber": string
}
フィールド
phoneNumber

string

発信または SMS の送信先となる電話番号。有効なオプションに記載されている電話番号のいずれかである必要があります。