Method: locations.fetchVerificationOptions

特定の言語のビジネスで使用できるすべてのオーナー確認の方法を表します。

HTTP リクエスト

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

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

パスパラメータ

パラメータ
location

string

必須。オーナー確認を行うビジネス情報。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
フィールド
languageCode

string

必須。確認プロセスに使用する言語を表す BCP 47 言語コード。利用可能なオプションは言語によって異なります。

context

object (ServiceBusinessContext)

省略可。サービス ビジネスの確認に関する追加のコンテキスト情報。ビジネスタイプが CUSTOMER_LOCATION_ONLY の拠点にのみ適用できます。正確な住所を指定すると、より多くのオプションを利用できるようになります。他の業種のビジネス拠点に設定されている場合は、INVALID_ARGUMENT がスローされます。

レスポンスの本文

Verifications.FetchVerificationOptions のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
フィールド
options[]

object (VerificationOption)

利用可能なオーナー確認オプション。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

VerificationOption

オーナー確認オプションは、ビジネスのオーナー確認方法(確認方法で指定)と、確認コードの送信先(表示データで指定)を表します。

JSON 表現
{
  "verificationMethod": enum (VerificationMethod),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of mutually exclusive fields.
}
フィールド
verificationMethod

enum (VerificationMethod)

ビジネスのオーナー確認を行う方法。

表示データの 1 つ。データはメソッドと一致している必要があります。対応するメソッドに表示データがない場合は空になります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
phoneNumber

string

method が PHONE_CALL または SMS の場合にのみ設定されます。PIN の送信先となる電話番号。

addressData

object (AddressVerificationData)

method が MAIL の場合にのみ設定します。

emailData

object (EmailVerificationData)

メソッドが EMAIL の場合にのみ設定します。

announcement

string

メソッドが VETTED_PARTNER の場合にのみ設定します。

相互に排他的なフィールドの終了。

AddressVerificationData

ハガキによるオーナー確認のデータを表示します。

JSON 表現
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
フィールド
business

string

販売者のビジネス名。

address

object (PostalAddress)

ハガキの送付先住所。

expectedDeliveryDaysRegion

integer

住所の地域にハガキが届くまでにかかる予想日数。

EmailVerificationData

メールによるオーナー確認のデータを表示します。

JSON 表現
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
フィールド
domain

string

メールアドレスのドメイン名。例: foo@gmail.com の「gmail.com」

user

string

メールアドレスのユーザー名。例: foo@gmail.com の「foo」

isUserNameEditable

boolean

クライアントが別のユーザー名を指定できるかどうか。