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 のビジネスの場合は必須です。住所確認では、この住所を使用してハガキの送付が行われます。他のメソッドでは、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

通話の発信または SMS の送信先となる電話番号。有効なオプションの電話番号のいずれかを指定する必要があります。