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 の概要をご覧ください。

VerificationOption

オーナー確認オプションは、ビジネスのオーナー確認方法（オーナー確認方法によって示される）とオーナー確認の送信先（表示データによって示される）を表します。

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

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of list of possible types for union field DisplayData.
}
フィールド
verificationMethod

enum (VerificationMethod)

ビジネスのオーナー確認を行う方法です。
共用体フィールド DisplayData。表示データの 1 つ。データはメソッドと一致する必要があります。対応するメソッドに表示データがない場合は空になります。DisplayData は次のいずれかになります。
phoneNumber

string

メソッドが PHONE_CALL または SMS の場合にのみ設定されます。PIN の送付先の電話番号です。
addressData

object (AddressVerificationData)

メソッドが 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

メールアドレスのドメイン名。例:"gmail.com"foo@gmail.com 内
user

string

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

boolean

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