Package google.mybusiness.verifications.v1

索引

許認可

この API を使用すると、Google でのビジネスのオーナー確認を管理できます。これにより、[確認] の [google.mybusiness.v1.Verification] リソースを管理できるようになります。

各 [Location] [google.mybusiness.businessinformation.locations.v1.Location] には、それぞれ locations/*/verifications/* という名前の [確認] [google.mybusiness.verifications] リソースのコレクションがあります。

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

PENDING の適格性確認を完了する。

AUTO 以外のオーナー確認方法にのみ必要です。AUTO の確認リクエストは、作成するとすぐに VERIFIED になります。

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。
FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

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

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。
ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

ビジネスのオーナー確認を、作成時間順に一覧表示します。

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。
VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

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

認可スコープ

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

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

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

VoiceOfMerchant

このサービスを使用すると、サードパーティ ユーザーは販売者の声の状態に関する詳細をリクエストできます。

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

VoiceOfMerchant の状態を取得します。

認可スコープ

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

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

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

CompleteVerificationRequest

Verifications.CompleteVerificationAction に対するリクエスト メッセージです。

フィールド
name

string

必須。完了するオーナー確認のリソース名。
pin

string

必須。オーナー確認を完了するために販売者が受け取った PIN コード。

CompleteVerificationResponse

Verifications.CompleteVerificationAction に対するレスポンス メッセージ。

フィールド
verification

Verification

オーナー確認が完了しました。

ComplyWithGuidelines

ビジネスが Google のガイドラインに準拠していないことを示します。

フィールド
recommendation_reason

RecommendationReason

ガイドラインに準拠するようビジネスが推奨されている理由。

RecommendationReason

ビジネスが ComplyWithGuidelines に推奨された理由を示します。

列挙型
RECOMMENDATION_REASON_UNSPECIFIED 指定されていません。
BUSINESS_LOCATION_SUSPENDED ビジネス拠点が強制停止されている。この問題を解決するには、ヘルプセンターの記事をご覧ください。
BUSINESS_LOCATION_DISABLED ビジネス拠点が無効になっています。この問題を解決するには、ヘルプセンターの記事をご覧ください。

FetchVerificationOptionsRequest

Verifications.FetchVerificationOptions に対するリクエスト メッセージです。

フィールド
location

string

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

string

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

ServiceBusinessContext

（省略可）サービス ビジネスのオーナー確認を行うための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY のビジネスにのみ適用されます。正確な住所を指定すると、利用できるオプションが増えます。他の業種の地域に対して INVALID_ARGUMENT が設定されている場合、スローされます。

FetchVerificationOptionsResponse

Verifications.FetchVerificationOptions に対するレスポンス メッセージ。

フィールド
options[]

VerificationOption

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

GetVoiceOfMerchantStateRequest

VoiceOfMerchant.GetVoiceOfMerchantState に対するリクエスト メッセージです。

フィールド
name

string

必須。ビジネスのリソース名。

ListVerificationsRequest

Verifications.ListVerifications に対するリクエスト メッセージです。

フィールド
parent

string

必須。オーナー確認リクエストが属するビジネスのリソース名。
page_size

int32

1 ページあたりに含める確認事項の数。最小値は 1、デフォルトおよび最大ページサイズは 100 です。
page_token

string

指定すると、オーナー確認の次のページが返されます。

ListVerificationsResponse

Verifications.ListVerifications に対するレスポンス メッセージです。

フィールド
verifications[]

Verification

オーナー確認のリスト。
next_page_token

string

オーナー確認の数がリクエストしたページサイズを超えた場合、このフィールドには、後続の呼び出しでオーナー確認の次のページを取得するためのトークンが入力されます。取得する属性がそれ以上ない場合、このフィールドはレスポンスに含められません。

ResolveOwnershipConflict

このタイプにはフィールドがありません。

良好な状態の別のビジネスと重複していることを示します。

ServiceBusinessContext

サービスのビジネスのオーナー確認に使用する追加データです。

フィールド
address

PostalAddress

ビジネスのオーナー確認用住所です。他の確認オプションを有効にするか、ハガキを郵送する場合に使用します。

検証

オーナー確認とは、ビジネスのオーナー確認の試行を指します。

フィールド
name

string

オーナー確認のリソース名。
method

VerificationMethod

オーナー確認の方法。
state

State

オーナー確認の状態です。
create_time

Timestamp

オーナー確認がリクエストされたときのタイムスタンプ。
announcement

string

（省略可）メソッドが VETTED_PARTNER の場合にのみ、レスポンスの通知が設定されます。

状態

考えられるすべてのオーナー確認のステータス。

列挙型
STATE_UNSPECIFIED デフォルト値。エラーになります。
PENDING 確認待ちです。
COMPLETED 確認が完了しました。
FAILED 確認に失敗しました。

VerificationMethod

Google がビジネスのオーナー確認に使用するプロセスを指定します。

列挙型
VERIFICATION_METHOD_UNSPECIFIED デフォルト値。エラーになります。
ADDRESS 確認用の PIN が記載されたハガキを特定の送付先住所に送付します。PIN は Google との認証を完了するために使用されます。
EMAIL 確認用 PIN を記載したメールを特定のメールアドレスに送信します。PIN は Google との認証を完了するために使用されます。
PHONE_CALL 確認用 PIN を使って、特定の電話番号に電話をかけます。PIN は Google との認証を完了するために使用されます。
SMS 確認用の PIN を含む SMS を特定の電話番号に送信します。PIN は Google との認証を完了するために使用されます。
AUTO 追加のユーザー操作なしでビジネス拠点のオーナー確認を行います。地域によっては、このオプションをご利用いただけない場合があります。
VETTED_PARTNER 地域によっては、このオプションをご利用いただけない場合があります。

VerificationOption

オーナー確認のオプションは、ビジネスのオーナー確認を行う方法（オーナー確認方法で指定）と、オーナー確認の送信先（ディスプレイ データで指定）を表します。

フィールド
verification_method

VerificationMethod

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

string

メソッドが PHONE_CALL または SMS の場合にのみ設定します。PIN が送信される電話番号。
address_data

AddressVerificationData

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

EmailVerificationData

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

string

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

AddressVerificationData

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

フィールド
business

string

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

PostalAddress

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

int32

住所の地域にハガキが配達されるまでの予想日数。

EmailVerificationData

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

フィールド
domain

string

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

string

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

bool

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

VerificationToken

審査済みのパートナーによって生成されたトークン。

フィールド
token_string

string

トークン文字列。

確認

ビジネスのオーナー確認が必要であることを示します。ビジネスに対して現在実施されているオーナー確認操作に関する情報が含まれます。

フィールド
has_pending_verification

bool

オーナー確認プロセスがすでに開始されており、ビジネスで完了できるかどうかを示します。

VerifyLocationRequest

Verifications.VerifyLocation に対するリクエスト メッセージ。

フィールド
name

string

必須。確認するビジネスのリソース名。
method

VerificationMethod

必須。確認方法。
language_code

string

（省略可）確認プロセスに使用される言語を表す BCP 47 言語コード。
context

ServiceBusinessContext

（省略可）サービス ビジネスのオーナー確認を行うための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY のビジネスでのみ必須です。住所確認では、この住所を使用してハガキの送付が行われます。他のメソッドでは、GetVerificationOptions に渡されるメソッドと同じにする必要があります。他のタイプのビジネス拠点に対して INVALID_ARGUMENT が設定されている場合、スローされます。
共用体フィールド RequestData。表示データ以外の、特定の方法のユーザー入力データ。データはリクエストされた方法と一致する必要があります。データが不要な場合は空欄のままにしておきます。RequestData は次のいずれかになります。
email_address

string

（省略可）EMAIL メソッドの入力。PIN の送信先となるメールアドレスです。

メールアドレスは、FetchVerificationOptions によって提供されるアドレスのいずれかである場合にのみ指定できます。[EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] で is_user_name_editing が true に設定されている場合、クライアントは別のユーザー名（local-part）を指定できますが、ドメイン名と一致する必要があります。
mailer_contact

string

（省略可）ADDRESS メソッドの入力。メールの送信先の担当者名。
phone_number

string

（省略可）PHONE_CALL/SMS メソッドの入力。発信する、または SMS を送信する電話番号。有効なオプションの電話番号のいずれかを指定する必要があります。
token

VerificationToken

（省略可）一部のpartners.が利用できる VETTED_PARTNER メソッドの入力。審査済みのアカウントの場合、入力は必要ありません。ビジネスに関連付けられているトークン。ビジネスに関連付けられているトークン。

VerifyLocationResponse

Verifications.VerifyLocation に対するレスポンス メッセージ。

フィールド
verification

Verification

作成された確認リクエスト。

VoiceOfMerchantState

VoiceOfMerchant.GetVoiceOfMerchantState に対するレスポンス メッセージです。

フィールド
has_voice_of_merchant

bool

ビジネスが良好な状態であり、Google 上でビジネスを管理できるかどうかを示します。ビジネスに加えた変更は、審査の段階に合格した後でマップに反映されます。
has_business_authority

bool

ビジネスが Google 上でのビジネスに対する権限（所有権）を持っているかどうかを示します。true の場合、別のビジネスが乗っ取り、マップの主要なリスティングになることはできません。ただし、販売者の声を取得（has_voice_of_merchant が true の場合）しない限り、編集内容は公開されません。
共用体フィールド gain_voice_of_merchant_action。Google でビジネスを管理できるようにするために、ビジネス情報に推奨される対応です。gain_voice_of_merchant_action は次のいずれかになります。
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

「販売者の声」を手に入れましょう。ビジネスは品質向上のため審査中です。
verify

Verify

オーナー確認プロセスを開始または続行します。
resolve_ownership_conflict

ResolveOwnershipConflict

この場所は、良好な状態の別のビジネス情報と重複しています。良好な状態でビジネス情報にアクセスできる場合は、そのビジネスの ID を使用してオペレーションを実行します。それ以外の場合は、現在のオーナーにアクセス権をリクエストしてください。
comply_with_guidelines

ComplyWithGuidelines

ビジネスが Google のガイドラインに準拠していないため、回復するための追加の手順が必要です。この問題を解決するには、ヘルプセンター記事をご覧ください。

WaitForVoiceOfMerchant

このタイプにはフィールドがありません。

審査に合格すると、ビジネスに販売者の声が反映されることを示します。