Method: accounts.locations.fetchVerificationOptions

ビジネスで有効なオーナー確認オプションをすべて特定の言語でレポートします。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

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/plus.business.manage
  • 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:
  "phoneData": {
    object (PhoneVerificationData)
  },
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  }
  // End of list of possible types for union field DisplayData.
}
フィールド
verificationMethod

enum (VerificationMethod)

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

object (PhoneVerificationData)

メソッドが PHONE_CALL または SMS の場合にのみ設定します。
addressData

object (AddressVerificationData)

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

object (EmailVerificationData)

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

PhoneVerificationData

電話によるオーナー確認（電話、SMS など）のためのデータの表示。

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

string

PIN が送信される電話番号。

AddressVerificationData

ハガキでオーナー確認を行うためのデータを表示します。

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

string

販売者のお店やサービスの名前。
address

object (PostalAddress)

ハガキの送付先の住所です。

EmailVerificationData

メールでオーナー確認を行うためのデータを表示します。

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

string

メールアドレスのドメイン名。foo@gmail.com の「gmail.com」など
userName

string

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

boolean

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