Package google.mybusiness.v4

インデックス

AccessControl

このサービスを使用すると、アカウントとビジネス情報にアクセスできるユーザーを管理できます。

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

指定した招待を承諾します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

指定したユーザーを、指定したアカウントの管理者に招待します。招待されたユーザーがアカウントへのアクセスを許可するには、招待を承諾する必要があります。[AcceptInvite] をご覧ください。 プログラムで招待を承諾する [google.mybusiness.v4.AcceptInvite]。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

指定したユーザーを、指定したビジネスの管理者として招待します。ビジネスへのアクセス権限を得るには、招待を承諾する必要があります。[AcceptInvite] をご覧ください。 プログラムで招待を承諾する [google.mybusiness.v4.AcceptInvite]。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

指定した招待を辞退します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

指定したアカウントから指定した管理者を削除します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

指定したビジネスの管理者として指定した管理者を削除します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

指定したアカウントの管理者を一覧表示します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

指定したアカウントについて、承認待ちとなっている招待の一覧を取得します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

指定したビジネスのすべての管理者の一覧を取得します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

指定されたアカウント管理者について管理者を更新します。更新できるのは管理者の AdminRole のみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

指定したビジネスの管理者について、Admin を更新します。更新できるのは管理者の AdminRole のみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

アカウント

この API を使用すると、Google 上のビジネス アカウントを管理できます。Account リソースを管理できます。以下のリソースモデルを定義します。

  • API には、accounts/* という名前の Account リソースのコレクションがあります。

  • 便宜上、類義語「me」を使用してもかまいません。(認証された呼び出し元の個人アカウントのアカウント ID の代わりに使用されます)。例: GET /v4/accounts/me GET /v4/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

指定した親の下に、指定した名前とタイプでアカウントを作成します。

  • 個人アカウントや組織は作成できません。
  • 個人アカウントをメインの所有者としてユーザー グループを作成することはできません。
  • 個人アカウントが組織に属している場合、個人アカウントのメインのオーナーでビジネス グループを作成することはできません。
  • 地域グループは地域グループを所有できません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteNotifications

rpc DeleteNotifications(DeleteNotificationsRequest) returns (Empty)

アカウントの Pub/Sub 通知設定を消去します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GenerateAccountNumber

rpc GenerateAccountNumber(GenerateAccountNumberRequest) returns (Account)

このアカウントのアカウント番号を生成します。アカウントの作成時にアカウント番号はプロビジョニングされません。必要に応じて、このリクエストを使用してアカウント番号を作成します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

指定されたアカウントを取得します。アカウントが存在しない場合、または呼び出し元にアカウントへのアクセス権がない場合は、NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetNotifications

rpc GetNotifications(GetNotificationsRequest) returns (Notifications)

アカウントの Pub/Sub 通知設定を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

認証されたユーザーのすべてのアカウントを一覧表示します。これには、ユーザーが所有するすべてのアカウントと、ユーザーが管理権限を持つすべてのアカウントが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

指定したビジネス アカウントを更新します。この方法では個人アカウントを更新できません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateNotifications

rpc UpdateNotifications(UpdateNotificationsRequest) returns (Notifications)

アカウントの Pub/Sub 通知設定を行い、Pub/Sub 通知を送信するトピックをビジネス プロフィールに知らせます。

  • アカウントで管理しているビジネスに関する新しいクチコミ。
  • アカウントで管理しているビジネス情報のクチコミが更新されました。
  • アカウントで管理するビジネス情報の新しい GoogleUpdates

1 つのアカウントに設定できる通知設定リソースは 1 つだけで、設定できるのは 1 つの Pub/Sub トピックのみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

BusinessCategories

この API を使用すると、Google に表示されているビジネス拠点についてサポートされている業種を確認できます。利用可能なすべてのビジネス カテゴリをページ分けしたリストで取得したり、特定のキーワードで検索したりできます。詳しくは、この記事のカテゴリに関するセクションをご覧ください(https://support.google.com/business/answer/3038177)。

BatchGetBusinessCategories

rpc BatchGetBusinessCategories(BatchGetBusinessCategoriesRequest) returns (BatchGetBusinessCategoriesResponse)

指定された言語と GConcept ID に対応する業種のリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListBusinessCategories

rpc ListBusinessCategories(ListBusinessCategoriesRequest) returns (ListBusinessCategoriesResponse)

業種のリストを返します。検索ではカテゴリ名は一致しますが、カテゴリ ID とは一致しません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

BusinessMessagingService

ビジネス メッセージ用に店舗を登録することで、店舗を検索したユーザーとのコミュニケーション チャネルを呼び込むことができます。ビジネスの Business Messaging を表示、操作するには、そのビジネスの MANAGEROWNER である必要があります。

フォロワー

この API は、フォロワーの管理 API を公開します。

GetFollowersMetadata

rpc GetFollowersMetadata(GetFollowersMetadataRequest) returns (FollowersMetadata)

ビジネスのフォロワー設定を取得します。

アカウントまたはビジネスが存在しない場合は、NOT_FOUND が返されます。ビジネスのオーナー確認が済んでおらず、マップに関連付けられていない場合は、PRECONDITION_FAILED が返されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

FoodMenuService

この API を使用すると、ビジネス拠点のフードメニューを取得、更新できます。

Location.PriceList は「メニュー」も表していることに注意してください。データ型は 1 つですが フィールドは制限されていますFoodMenus と同じダウンストリーム ストレージを共有します。FoodMenuService への移行が完了したら、Location.PriceList を使用してメニューデータを更新することを強くおすすめします。これにより、予期しないデータ損失が発生する可能性があります。

GetFoodMenus

rpc GetFoodMenus(GetFoodMenusRequest) returns (FoodMenus)

特定のビジネスのフードメニューを返します。location.location_state.can_have_food_menu が true の場合にのみ呼び出します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateFoodMenus

rpc UpdateFoodMenus(UpdateFoodMenusRequest) returns (FoodMenus)

特定のビジネスのフードメニューを更新します。location.location_state.can_have_food_menu が true の場合にのみ呼び出します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GoogleLocations

この API を使用すると、GoogleLocation へのアクセスと検索が可能になります。

ListRecommendedGoogleLocations

rpc ListRecommendedGoogleLocations(ListRecommendedGoogleLocationsRequest) returns (ListRecommendedGoogleLocationsResponse)

指定したビジネス プロフィール アカウントに推奨されたすべてのGoogleLocationを一覧表示します。最適化案が提示されるのは、個人アカウントとビジネス グループのみです。その他のアカウント タイプをリクエストするとエラーが発生します。地域グループのおすすめは、そのグループ内の地域に基づいて表示されます。

個人アカウント向けの最適化案は、ユーザーがビジネス プロフィールでアクセスできるすべてのビジネス情報(地域グループを通じてアクセスできるビジネス情報を含む)に基づいており、ユーザー向けに生成されるすべての最適化案のスーパーセットです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ReportGoogleLocation

rpc ReportGoogleLocation(ReportGoogleLocationRequest) returns (Empty)

GoogleLocation を報告します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

SearchGoogleLocations

rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse)

指定したリクエストに一致する可能性のあるすべてのビジネスを検索します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

HealthProviderAttributesService

このサービスを使用すると、特定のビジネスに関連付けられた医療機関の属性(特定のビジネスで受け入れられている保険など)を管理できます。

GetHealthProviderAttributes

rpc GetHealthProviderAttributes(GetHealthProviderAttributesRequest) returns (HealthProviderAttributes)

特定の場所のヘルス プロバイダの属性を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateHealthProviderAttributes

rpc UpdateHealthProviderAttributes(UpdateHealthProviderAttributesRequest) returns (HealthProviderAttributes)

特定のビジネスのヘルス プロバイダの属性を更新します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

分析情報

Google サービスの 1 つ以上のリスティングに関する消費者インサイトの詳細を示すレポートを生成します。基本的な指標の集計データは、最大 18 か月前までクエリできます。内訳をサポートする指標では、この範囲の集計データを曜日や時間帯で分類して表示できます。運転ルートのリクエストは、指定した日数分のスナップショットでレポートできます。

ReportLocalPostInsights

rpc ReportLocalPostInsights(ReportLocalPostInsightsRequest) returns (ReportLocalPostInsightsResponse)

1 つのリスティングに関連付けられている一連のローカル投稿に関する分析情報を返します。どの指標とその報告方法は、リクエスト プロトコルで指定されたオプションです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ReportLocationInsights

rpc ReportLocationInsights(ReportLocationInsightsRequest) returns (ReportLocationInsightsResponse)

1 つ以上の指標に関するビジネスごとの分析情報を含むレポートを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

InsuranceNetworkService

このサービスを使用すると、Google で医療 / 健康ビジネスの拠点でサポートされているすべての保険ネットワークを取得できます。

ListInsuranceNetworks

rpc ListInsuranceNetworks(ListInsuranceNetworksRequest) returns (ListInsuranceNetworksResponse)

Google でサポートされているすべての保険ネットワークのリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

LocalPosts

この API は、ローカル投稿の管理 API を公開します。

CreateLocalPost

rpc CreateLocalPost(CreateLocalPostRequest) returns (LocalPost)

指定したビジネスに関連付けられた新しいローカル投稿を作成して返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteLocalPost

rpc DeleteLocalPost(DeleteLocalPostRequest) returns (Empty)

ローカル投稿を削除します。ローカル投稿が存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetLocalPost

rpc GetLocalPost(GetLocalPostRequest) returns (LocalPost)

指定したローカル投稿を取得します。ローカル投稿が存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListLocalPosts

rpc ListLocalPosts(ListLocalPostsRequest) returns (ListLocalPostsResponse)

ビジネスに関連付けられたローカル投稿のリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateLocalPost

rpc UpdateLocalPost(UpdateLocalPostRequest) returns (LocalPost)

指定したローカル投稿を更新し、更新されたローカル投稿を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ロケーション

この API を使用すると、Google 上のビジネス拠点を管理できます。Location リソースを管理できます。以下のリソースモデルを定義します。

  • API には、accounts/* という名前の Account リソースのコレクションがあります。

  • 便宜上、類義語「me」を使用してもかまいません。(認証された呼び出し元の個人アカウントのアカウント ID の代わりに使用されます)。例: GET /v4/accounts/me GET /v4/accounts/me/locations

  • Account には、accounts/*/locations/* という名前の Location リソースのコレクションがあります。

AssociateLocation

rpc AssociateLocation(AssociateLocationRequest) returns (Empty)

ビジネスをプレイス ID に関連付けます。以前の関連付けは上書きされます。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。関連付けは有効である、つまり FindMatchingLocations のリストに含まれている必要があります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

BatchGetLocations

rpc BatchGetLocations(BatchGetLocationsRequest) returns (BatchGetLocationsResponse)

指定されたアカウントの指定されたビジネスをすべて取得します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ClearLocationAssociation

rpc ClearLocationAssociation(ClearLocationAssociationRequest) returns (Empty)

ビジネスとプレイス ID の関連付けをクリアします。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

CreateLocation

rpc CreateLocation(CreateLocationRequest) returns (Location)

指定されたアカウントが所有する新しい location を作成して返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty)

ビジネスを削除します。

FindMatchingLocations

rpc FindMatchingLocations(FindMatchingLocationsRequest) returns (FindMatchingLocationsResponse)

指定したビジネスと一致する可能性のあるすべてのビジネスを検索します。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetChain

rpc GetChain(GetChainRequest) returns (Chain)

指定されたチェーンを取得します。チェーンが存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetLocationRequest) returns (GoogleUpdatedLocation)

指定したビジネスの Google によって変更されたバージョンを取得します。ビジネスが存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

指定したビジネスを取得します。ビジネスが存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse)

指定されたメインカテゴリと国のビジネスで使用できる属性のリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

指定したアカウントのビジネスを一覧表示します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

SearchChains

rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse)

チェーン名に基づいてチェーンを検索します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Location)

ユーザーが所有するアカウントから同じユーザーが管理する別のアカウントにビジネスを移動します。ユーザーはビジネスが現在関連付けられているアカウントの所有者であり、少なくとも移行先のアカウントの管理者である必要があります。ビジネスを新しいリソース名で返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location)

指定したビジネスを更新します。

写真は、Google+ ページがある場所でのみ許可されます。

ビジネスが存在しない場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

メディア

このサービスを使用すると、ビジネス情報にリンクされたメディア(写真や動画)を管理できます。

CreateMediaItem

rpc CreateMediaItem(CreateMediaItemRequest) returns (MediaItem)

ビジネスの新しいメディア アイテムを作成します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteMediaItem

rpc DeleteMediaItem(DeleteMediaItemRequest) returns (Empty)

指定したメディア アイテムを削除します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetCustomerMediaItem

rpc GetCustomerMediaItem(GetCustomerMediaItemRequest) returns (MediaItem)

リクエストされた顧客メディア アイテムのメタデータを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetMediaItem

rpc GetMediaItem(GetMediaItemRequest) returns (MediaItem)

リクエストされたメディア アイテムのメタデータを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListCustomerMediaItems

rpc ListCustomerMediaItems(ListCustomerMediaItemsRequest) returns (ListCustomerMediaItemsResponse)

顧客によって提供されたビジネスに関連付けられたメディア アイテムのリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListMediaItems

rpc ListMediaItems(ListMediaItemsRequest) returns (ListMediaItemsResponse)

ビジネスに関連付けられたメディア アイテムのリストを返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

StartUploadMediaItemData

rpc StartUploadMediaItemData(StartUploadMediaItemDataRequest) returns (MediaItemDataRef)

メディア アイテムをアップロードするための MediaItemDataRef を生成します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateMediaItem

rpc UpdateMediaItem(UpdateMediaItemRequest) returns (MediaItem)

指定したメディア アイテムのメタデータを更新します。メディア アイテムのカテゴリの更新にのみ使用できます。ただし、新しいカテゴリを COVER または PROFILE にすることはできません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

QuestionsAndAnswers

このサービスでは、ビジネスに関する質問と回答を管理できます。質問と回答の操作は、オーナー確認済みのビジネスでのみ有効です。

CreateQuestion

rpc CreateQuestion(CreateQuestionRequest) returns (Question)

指定したビジネスに関する質問を追加します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteAnswer

rpc DeleteAnswer(DeleteAnswerRequest) returns (Empty)

現在のユーザーが質問に書き込んだ回答を削除します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteQuestion

rpc DeleteQuestion(DeleteQuestionRequest) returns (Empty)

現在のユーザーが投稿した特定の質問を削除します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListAnswers

rpc ListAnswers(ListAnswersRequest) returns (ListAnswersResponse)

指定した質問に対する回答を、ページ分けされたリストで返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListQuestions

rpc ListQuestions(ListQuestionsRequest) returns (ListQuestionsResponse)

指定したビジネスに関する質問と回答の一部を、ページ分けされたリストで返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateQuestion

rpc UpdateQuestion(UpdateQuestionRequest) returns (Question)

現在のユーザーが書いた特定の質問を更新します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpsertAnswer

rpc UpsertAnswer(UpsertAnswerRequest) returns (Answer)

指定された質問に対して、回答を作成するか、ユーザーが書いた既存の回答を更新します。ユーザーが作成できる回答は質問ごとに 1 つのみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

レビュー

この API では、レビューの CRUD 操作を行うことができます。google.mybusiness.v4.Reviews

BatchGetReviews

rpc BatchGetReviews(BatchGetReviewsRequest) returns (BatchGetReviewsResponse)

指定したすべてのビジネスについて、ページ分けされたクチコミの一覧を返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

DeleteReviewReply

rpc DeleteReviewReply(DeleteReviewReplyRequest) returns (Empty)

指定したクチコミへの返信を削除します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

GetReview

rpc GetReview(GetReviewRequest) returns (Review)

指定したクチコミを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。クチコミが存在しないか削除されている場合は NOT_FOUND を返します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListReviews

rpc ListReviews(ListReviewsRequest) returns (ListReviewsResponse)

指定したビジネスに関するクチコミのページ分けされたリストを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateReviewReply

rpc UpdateReviewReply(UpdateReviewReplyRequest) returns (ReviewReply)

指定したクチコミへの返信を更新します。返信が存在しない場合は返信が作成されます。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ServiceLists

この API を使用すると、Google 上のビジネス拠点のサービスリストを取得および更新できます。サービスリストには、販売者が提供するサービスであるサービス アイテムのリストが含まれます。散髪、給湯器の設置など

GetServiceList

rpc GetServiceList(GetServiceListRequest) returns (ServiceList)

ビジネスの指定されたサービスリストを取得します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

UpdateServiceList

rpc UpdateServiceList(UpdateServiceListRequest) returns (ServiceList)

ビジネスの指定したサービスリストを更新します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

許認可

この API を使用すると、Google でのビジネスのオーナー確認を管理できます。Verification リソースを管理できます。

Location には、accounts/*/locations/*/verifications/* という名前の Verification リソースのコレクションがあります。

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

PENDING のオーナー確認を完了します。

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

AcceptInvitationRequest

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

フィールド
name

string

承諾する招待の名前。

アカウント

アカウントとは、ビジネス拠点を格納するコンテナです。ビジネス情報を管理しているユーザーが自分だけの場合は、個人の Google アカウントを使用できます。ビジネス情報を複数のユーザーと共同で管理するには、ビジネス アカウントを作成してください。

フィールド
name

string

リソース名(accounts/{account_id} 形式)。

account_name

string

アカウントの名前です。

type

AccountType

出力専用。このアカウントの AccountType を指定します。

role

AccountRole

出力専用。発信者がこのアカウントに対して持っている AccountRole を指定します。

state

AccountState

出力専用。このアカウントの AccountState を示します。

account_number

string

アカウントの参照番号(プロビジョニングされている場合)。

permission_level

PermissionLevel

出力専用。発信者がこのアカウントに対して持っている PermissionLevel を指定します。

organization_info

OrganizationInfo

組織の追加情報。組織アカウントについてのみ入力されます。

OrganizationInfo

組織用に保存されている追加情報。

フィールド
registered_domain

string

アカウントの登録済みドメイン。

postal_address

PostalAddress

アカウントの住所。

phone_number

string

組織の連絡先電話番号。

AccountRole

認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。詳しくは、ヘルプセンターの記事をご覧ください。

列挙型
ACCOUNT_ROLE_UNSPECIFIED 指定されていません。
OWNER ユーザーがこのアカウントの所有者です。(UI では「メインのオーナー」として表示されます)。
CO_OWNER 対象ユーザーがアカウントの共同オーナーである。(UI では「オーナー」と表示されます)。
MANAGER ユーザーはこのアカウントを管理できます。
COMMUNITY_MANAGER アカウントのソーシャル(Google+)ページを管理できます。(UI では「サイト管理者」と表示されます)。

AccountState

Google による確認が完了したかどうかなど、アカウントのステータスを示します。

フィールド
status

AccountStatus

オーナー確認を行うと、今後作成される場所は自動的に Google マップに接続され、Google+ ページも作成されるため、管理は必要ありません。

AccountStatus

アカウントの確認ステータスを示します。

列挙型
ACCOUNT_STATUS_UNSPECIFIED 指定されていません。
VERIFIED 確認済みアカウント。
UNVERIFIED 確認が完了しておらず、確認がリクエストされていないアカウントです。
VERIFICATION_REQUESTED 確認されていないが、確認がリクエストされているアカウント。

AccountType

アカウントの種類(個人用アカウントまたはユーザー アカウント、ビジネス アカウント)を示します。

列挙型
ACCOUNT_TYPE_UNSPECIFIED 指定されていません。
PERSONAL エンドユーザー アカウント。
LOCATION_GROUP ビジネスのグループです。詳しくは、ヘルプセンターの記事をご覧ください。
USER_GROUP 組織のスタッフをグループに分けるためのユーザー グループ。詳しくは、ヘルプセンターの記事をご覧ください。
ORGANIZATION 会社を表す組織。詳しくは、ヘルプセンターの記事をご覧ください。

AdWordsLocationExtensions

AdWords に表示される追加情報。

フィールド
ad_phone

string

ビジネスのメインの電話番号の代わりに AdWords の住所表示オプションに表示される予備の電話番号です。

AddressInput

住所確認用の入力です。

フィールド
mailer_contact_name

string

メールの送信先となる連絡先の名前。

管理者

Account または Location の管理者。

フィールド
name

string

リソース名。アカウント管理者の場合は、accounts/{account_id}/admins/{admin_id} の形式になります。

ビジネス管理者の場合は、accounts/{account_id}/locations/{location_id}/admins/{admin_id} の形式になります。

admin_name

string

管理者の名前。最初の招待を行うとき、これは招待者のメールアドレスです。招待が保留中の場合、GET の呼び出しでは、ユーザーのメールアドレスが返されます。それ以外の場合は、ユーザーの姓名が返されます。

role

AdminRole

この管理者が指定された Account リソースまたは Location リソースで使用する AdminRole を指定します。

pending_invitation

bool

出力専用。この管理者が、指定したリソースへの招待を保留にしているかどうかを表します。

AdminRole

管理者が持っているアクセスレベルを示します。詳しくは、ヘルプセンターの記事をご覧ください。

列挙型
ADMIN_ROLE_UNSPECIFIED 指定されていません。
OWNER この管理者はオーナー レベルのアクセス権を持ち、メインのオーナーです。(UI では「メインのオーナー」として表示されます)。
CO_OWNER オーナー レベルのアクセス権がある。(UI では「オーナー」と表示されます)。
MANAGER 管理者アクセス権限を持っています。
COMMUNITY_MANAGER この管理者はソーシャル(Google+)ページを管理できます。(UI では「サイト管理者」と表示されます)。

AlertType

アラート投稿が作成されたイベントの種類。

列挙型
ALERT_TYPE_UNSPECIFIED アラートが指定されていません。
COVID_19 2019 年の新型コロナウイルス感染症のパンデミックに関連するアラート。COVID の投稿でサポートされているのは、概要フィールドと行動を促すフレーズのフィールドのみです。これらのアラートの関連性がなくなると、COVID-19 タイプの新しいアラート投稿の作成が無効になります。ただし、既存の COVID-19 関連の投稿は引き続き管理できます。

アレルゲン

食品のアレルゲン情報。

列挙型
ALLERGEN_UNSPECIFIED アレルゲンが指定されていません
DAIRY 乳製品アレルゲン
EGG 卵関連アレルゲン
FISH 魚類アレルゲン
PEANUT ピーナッツ関連アレルゲン
SHELLFISH 貝類アレルゲン
SOY 大豆関連アレルゲン
TREE_NUT 木の実関連アレルゲン
WHEAT 小麦アレルゲン

回答

質問への回答を表します。

フィールド
name

string

出力専用。回答の一意の名前 accounts/*/locations/*/questions/*/answers/*

author

Author

出力専用。回答者。

upvote_count

int32

出力専用。回答に対する賛成票の数。

text

string

回答のテキスト。空白以外の文字を少なくとも 1 つ含める必要があります。最大長は 4,096 文字です。

create_time

Timestamp

出力専用。回答が書き込まれたときのタイムスタンプ。

update_time

Timestamp

出力専用。回答が最後に変更されたときのタイムスタンプ。

AssociateLocationRequest

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

フィールド
name

string

関連付けるビジネスのリソース名。

place_id

string

確立する関連付け。設定しない場合は、一致がないことを示します。

属性

ビジネスの属性。属性は、ビジネスに関する追加情報を提供します。ビジネスに設定できる属性は、そのビジネスのプロパティ(カテゴリなど)によって異なります。使用可能な属性は Google によって決定され、API の変更なしに追加、削除される場合があります。

フィールド
attribute_id

string

属性の ID。属性 ID は Google から提供されます。

value_type

AttributeValueType

出力専用。この属性に含まれる値の型。この値をどのように解釈するかを決定するために使用します。

values[]

Value

この属性の値。指定する値の型は、その属性に想定される型と一致する必要があります。AttributeValueType をご覧ください。複数の属性値を指定できる繰り返しフィールドです。属性型では 1 つの値のみがサポートされます。

repeated_enum_value

RepeatedEnumAttributeValue

属性値の型が REPEATED_ENUM の場合、この属性には属性値が含まれ、他の値フィールドは空にする必要があります。

url_values[]

UrlAttributeValue

属性値の型が URL の場合、このフィールドにはこの属性の値が含まれ、他の値フィールドは空にする必要があります。

AttributeMetadata

属性のメタデータ。ローカライズされた名前や関連する属性をグループ化するための見出しなど、属性の表示情報が含まれます。

フィールド
attribute_id

string

属性の ID。

value_type

AttributeValueType

属性の値の型。設定および取得される値は、この型である必要があります。

display_name

string

属性のローカライズされた表示名です(利用可能な場合)。それ以外の場合は英語の表示名を使用します。

group_display_name

string

この属性を含むグループのローカライズされた表示名です(利用可能な場合)。それ以外の場合は英語のグループ名を使用します。関連する属性が 1 つのグループにまとめられ、ここに示す見出しでまとめて表示されます。

is_repeatable

bool

true の場合、この属性は複数の値をサポートします。false の場合は、値を 1 つだけ指定する必要があります。

value_metadata[]

AttributeValueMetadata

一部のタイプの属性(列挙型など)については、サポートされている値と、それらの値に対応する表示名のリストが提供されます。

is_deprecated

bool

true の場合、この属性はサポートが終了しているため、使用しないでください。サポートが終了している場合、この属性を更新してもエラーは発生しませんが、更新は保存されません。サポートの終了後に、この属性は完全に削除され、エラーになります。

AttributeValueMetadata

サポートされている属性値のメタデータ。

フィールド
value

Value

属性値。

display_name

string

この値の表示名(利用可能な場合はローカライズ)。答えは英語になります値の表示名は、属性の表示名とのコンテキストで使用されることを想定しています。

たとえば、「Wi-Fi」とenum 属性です。これには「Paid」が含まれる場合があります。(有料 Wi-Fi を表す)

AttributeValueType

属性の値の型。

列挙型
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED 指定されていません。
BOOL この属性の値はブール値です。
ENUM この属性には、使用可能な値のリストが事前に定義されています。この属性のメタデータでは、これらの値が一覧表示されます。
URL この属性の値は URL です。
REPEATED_ENUM この属性値は、明示的に設定または設定解除できる複数の有効な値を含む列挙型です。

著者

質問または回答の作成者を表します。

フィールド
display_name

string

ユーザーの表示名

profile_photo_url

string

ユーザーのプロフィール写真の URL。

type

AuthorType

作成者のユーザータイプ。

AuthorType

作成者のユーザータイプの列挙型。

列挙型
AUTHOR_TYPE_UNSPECIFIED 使用できません。
REGULAR_USER 通常のユーザー。
LOCAL_GUIDE ローカルガイド
MERCHANT ビジネスのオーナーまたは管理者

BasicMetricsRequest

基本的な指標の分析情報のリクエスト。

フィールド
metric_requests[]

MetricRequest

データを返す方法のオプションを含む値を返す指標のコレクション。

time_range

TimeRange

指標を収集する範囲。最大範囲はリクエスト日から 18 か月です。場合によっては、リクエスト日に近い日までデータが見つからないことがあります。欠落データは、レスポンスの metricValues で指定されます。

BatchGetBusinessCategoriesRequest

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

フィールド
language_code

string

必須。カテゴリ名を返す言語の BCP 47 コード。

category_ids[]

string

必須。少なくとも 1 つの名前を設定する必要があります。ローカライズされたカテゴリ名を返す必要がある GConcept ID です。

region_code

string

省略可。非標準言語を推測するために使用される ISO 3166-1 alpha-2 国コード。

view

CategoryView

必須。レスポンスで Category リソースに返すパートを指定します。

BatchGetBusinessCategoriesResponse

BusinessCategories.BatchGetBusinessCategories に対するレスポンス メッセージ。

フィールド
categories[]

Category

リクエストで指定された GConcept ID に一致するカテゴリ。リクエストのカテゴリ ID と同じ順序になることはありません。

BatchGetLocationsRequest

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

フィールド
name

string

ビジネスを取得するアカウントの名前です。

location_names[]

string

取得するビジネスのコレクションで、名前で指定します。

BatchGetLocationsResponse

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

フィールド
locations[]

Location

ビジネスのコレクションです。

BatchGetReviewsRequest

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

フィールド
name

string

複数のビジネスにまたがるクチコミの一覧を取得するアカウントの名前です。

location_names[]

string

クチコミを取得するビジネスのコレクションで、名前で指定します。

page_size

int32

1 ページあたりで取得するクチコミ数です。デフォルト値は 50 です。

page_token

string

指定すると、クチコミの次のページが取得されます。

order_by

string

省略可。クチコミの並べ替えの基準とするフィールドを指定します。指定しない場合、返されるクチコミの順序はデフォルトの update_time desc になります。並べ替えで有効な順序は ratingrating descupdate_time desc です。rating はクチコミを昇順で返します。update_time(昇順)はサポートされていません。

ignore_rating_only_reviews

bool

評価のみのレビューを無視するかどうか。

BatchGetReviewsResponse

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

フィールド
location_reviews[]

LocationReview

位置情報を含むクチコミ。

next_page_token

string

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

BusinessHours

ビジネスが営業している期間を表します。TimePeriod インスタンスのコレクションを保持します。

フィールド
periods[]

TimePeriod

ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。

CallToAction

ユーザーが投稿をクリックしたときに実行されるアクション。

フィールド
action_type

ActionType

実行されるアクションのタイプ。

url

string

クリックしたときにユーザーに表示される URL です。電話による問い合わせを促すフレーズでは、このフィールドを未設定のままにする必要があります。

ActionType

実行されるアクションのタイプ。

列挙型
ACTION_TYPE_UNSPECIFIED 未指定
BOOK お店やレストランなどの予約を促します。
ORDER 注文するよう促します。
SHOP 商品カタログを閲覧するよう促します。
LEARN_MORE ウェブサイトで詳細を確認するよう促します。
SIGN_UP 登録、申し込み、参加を促します。
GET_OFFER

非推奨です。LocalPostTopicTypeOFFER を使用して、特典のコンテンツを含む投稿を作成します。

CALL ビジネスへの電話による問い合わせを促します。

カテゴリ

カテゴリは業種を表すもので、事業内容を表すものではありません。有効なカテゴリ ID のリストと、人が読める形式のカテゴリ名へのマッピングについては、categories.list をご覧ください。

フィールド
display_name

string

をタップします。人が読める形式のカテゴリ名。ビジネスを読み取るときに設定されます。ロケーションを変更する場合は、category_id を設定する必要があります。

注: このフィールドはレスポンスのみで使用されます。リクエストでここに指定された値は、すべて無視されます。

category_id

string

をタップします。このカテゴリの固定 ID(Google 提供)です。ビジネス情報を作成または更新する際にカテゴリを変更する場合は、category_id を指定する必要があります。

注: このフィールドはレスポンスのみで使用されます。リクエストでここに指定された値は、すべて無視されます。

service_types[]

ServiceType

をタップします。この業種で利用可能なすべてのサービスタイプのリスト。

注: このフィールドはレスポンスのみで使用されます。リクエストでここに指定された値は、すべて無視されます。

more_hours_types[]

MoreHoursType

出力専用。この業種で利用できるその他の営業時間タイプです。

CategoryView

サーバーから返されるデータの量を制限する列挙型。

列挙型
CATEGORY_VIEW_UNSPECIFIED 指定されていません。CATEGORY_METADATA_ONLY と同等です。
BASIC サーバーのレスポンスには、Category フィールド(display_name、category_id、language_code)のみが含まれます。サービスタイプのメタデータに関連するフィールドはすべて省略されます。
FULL レスポンスに含まれるすべてのフィールドを返します。

チェーン

チェーンとは、ビジネス拠点を提携できるブランドです。

フィールド
name

string

チェーンのリソース名(chains/{chain_place_id} 形式)。

chain_names[]

ChainName

チェーン名です。

websites[]

ChainUrl

チェーンのウェブサイトです。

location_count

int32

このチェーンに含まれるビジネスの数です。

ChainName

チェーンを表示するときに使用する名前。

フィールド
display_name

string

このチェーンの表示名。

language_code

string

名前の言語の BCP 47 コード。

ChainUrl

チェーンを表示するときに使用する URL。

フィールド
url

string

このチェーンの URL。

ClearLocationAssociationRequest

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

フィールド
name

string

関連付けを解除するビジネスのリソース名。

CompleteVerificationRequest

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

フィールド
name

string

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

pin

string

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

CompleteVerificationResponse

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

フィールド
verification

Verification

完了したオーナー確認。

CreateAccountAdminRequest

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

フィールド
parent

string

この管理者が作成されるアカウントのリソース名。

admin

Admin

作成する管理者

CreateAccountRequest

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

フィールド
primary_owner

string

作成されるアカウントのメインの所有者となるアカウントのリソース名。形式は accounts/{account_id}/ です。

account

Account

作成されるアカウントのアカウント情報。使用できるフィールドは account_name と type のみです。

CreateLocalPostRequest

CreateLocalPost に対するリクエスト メッセージ。

フィールド
parent

string

このローカル投稿を作成するビジネスの名前です。

local_post

LocalPost

新しいローカル投稿のメタデータ。

CreateLocationAdminRequest

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

フィールド
parent

string

この管理者が作成されたビジネスのリソース名。

admin

Admin

作成する管理者

CreateLocationRequest

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

フィールド
parent

string

このビジネスを作成するアカウントの名前です。

location

Location

新しい位置情報のメタデータ。

validate_only

bool

true の場合、ビジネスを実際に作成せずにリクエストの検証のみが行われます。

request_id

string

サーバーが重複リクエストを検出するための一意のリクエスト ID。UUID の使用をおすすめします。最大長は 50 文字です。

CreateMediaItemRequest

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

フィールド
parent

string

このメディア アイテムが作成されるビジネスのリソース名です。

media_item

MediaItem

作成するメディア アイテムです。

CreateQuestionRequest

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

フィールド
parent

string

質問を作成するビジネスの名前です。

question

Question

新しい質問です。

DeclineInvitationRequest

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

フィールド
name

string

拒否するアカウント招待の名前。

DeleteAccountAdminRequest

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

フィールド
name

string

アカウントから削除する管理者のリソース名。

DeleteAnswerRequest

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

フィールド
parent

string

回答を削除する質問の名前。

DeleteLocalPostRequest

DeleteLocalPost に対するリクエスト メッセージ。

フィールド
name

string

削除するローカル投稿の名前です。

DeleteLocationAdminRequest

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

フィールド
name

string

ビジネスから削除する管理者のリソース名です。

DeleteLocationRequest

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

フィールド
name

string

削除するビジネスの名前です。

DeleteMediaItemRequest

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

フィールド
name

string

削除するメディア アイテムの名前です。

DeleteNotificationsRequest

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

フィールド
name

string

通知設定を消去するリソース名。

DeleteQuestionRequest

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

フィールド
name

string

削除する質問の名前。

DeleteReviewReplyRequest

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

フィールド
name

string

削除するクチコミへの返信の名前。

DietaryRestriction

食品の食事に関する情報。

列挙型
DIETARY_RESTRICTION_UNSPECIFIED 食事の種類が指定されていません
HALAL ハラール料理であることを示す表現。
KOSHER コーシャー料理としての食品の表示。
ORGANIC 有機食品としての食品の表示。
VEGAN ビーガン料理としての料理の表示。
VEGETARIAN ベジタリアン料理としての食品の表示。

DimensionalMetricValue

特定の時間ディメンションを持つ単一の指標の値。

フィールド
metric_option

MetricOption

このディメンション値をリクエストしたオプション。

time_dimension

TimeDimension

値のディメンション。

value

Int64Value

値です。値が設定されていない場合、リクエストされたデータはありません。

TimeDimension

データの分割に使用されるディメンション。

フィールド
day_of_week

DayOfWeek

この値が対応する曜日(「MONDAY」~「SUNDAY」)。BREAKDOWN_DAY_OF_WEEK オプションに対して設定されます。

time_of_day

TimeOfDay

この値が対応する時間(0 ~ 23)。BREAKDOWN_HOUR_OF_DAY オプションに対して設定されます。

time_range

TimeRange

この値に含まれる時間の範囲。AGGREGATED_TOTAL オプションと AGGREGATED_DAILY オプションに対して設定されます。

DrivingDirectionMetricsRequest

運転ルートの分析情報のリクエストです。

フィールド
num_days

NumDays

データを集計する日数。返された結果は、直近にリクエストした日数分のデータです。有効な値は 7、30、90 です。

language_code

string

言語の BCP 47 コード。言語コードが指定されていない場合、デフォルトで英語に設定されます。

NumDays

このリクエストに対応できる日数。

列挙型
SEVEN 7 日間。これがデフォルト値です。
THIRTY 30 日間
NINETY 90 日間。

EmailInput

メール確認用の入力です。

フィールド
email_address

string

PIN の送付先メールアドレスです。

メールアドレスは、FetchVerificationOptions で指定されたアドレスのいずれかである場合にのみ受け入れられます。EmailVerificationData で is_user_name_ editing が true に設定されている場合、クライアントは別のユーザー名(local-part)を指定できますが、ドメイン名と一致している必要があります。

ErrorDetail

検証エラーまたは内部エラーの原因となったエラーの詳細です。

フィールド
code

int32

ステータス コード。ErrorCode の列挙値である必要があります。

field

string

リクエスト本文のフィールドへのパス。値は、プロトコル バッファ フィールドを識別する、ドットで区切られた識別子のシーケンスです。例: error_details.fieldこのフィールドを識別します

message

string

フィールドがエラーの原因となった理由の説明。メッセージは英語であり、ユーザーへの表示には適さない可能性があります。

value

string

リクエストに失敗した値。

field_index

int32

このエラーを生成したリクエスト フィールドが繰り返される場合、検証が失敗する原因となった、そのフィールドのエントリのゼロベースのインデックスが含まれます。

ErrorCode

ErrorDetail のエラーコード:

  • 1 ~ 199: すべてのフィールドに適用される一般的なエラーコード。
  • 1000 ~ 1099: 写真関連のエラーコード。
  • 1100 ~ 1199: 住所および緯度/経度に関連するエラーコード。
  • 1200 ~ 1299: カテゴリ関連のエラーコード。
  • 1300 ~ 1399: オペレーション関連のエラーコード。

列挙型
ERROR_CODE_UNSPECIFIED キャッチオール エラーコード。
MISSING_VALUE 必須項目が指定されていません。
INVALID_VALUE 無効な値が指定されました。
INVALID_CHARACTERS 無効な文字が見つかりました。
TOO_MANY_ITEMS 繰り返しフィールドで指定されたアイテムの数が上限を超えています。
READ_ONLY 読み取り専用フィールドは変更できません。
OVERLAPPING_RANGES 繰り返しフィールドのアイテムは、互いに重複する範囲です。
INVERTED_RANGE 指定した範囲が逆になっています。これには空の範囲の場合も含まれます。
VALUE_OUTSIDE_ALLOWED_RANGE 指定した値が許容範囲外です。
MISSING_DEPENDENT_FIELD 必須の依存フィールドがありません。
FIELD_HAS_DEPENDENCIES 依存フィールドに必要なフィールドです。削除できません。
UNSUPPORTED_VALUE 指定した値は有効な可能性もありますが、他の制約によりサポートされていません。
EXPIRED_VALUE 指定された値は有効期限が切れたため、無効になりました。
PHOTO_FETCH_FAILED 指定された URL から写真を取得できませんでした。
PHOTO_UPLOAD_FAILED 指定された URL から写真をアップロードできませんでした。
GEOCODE_ERROR 緯度と経度の自動判定中にエラーが発生しました。
LAT_LNG_OUTSIDE_COUNTRY 入力された緯度/経度は、入力された国では一致しません。
LAT_LNG_REQUIRED 緯度と経度を指定する必要があります。
LAT_LNG_TOO_FAR_FROM_ADDRESS 緯度と経度と住所のペアが離れすぎています。
CATEGORY_NOT_VERIFIED 指定されたカテゴリは確認されていません。
OPERATION_EXECUTION_ERROR 一般的なオペレーションの実行エラーです。
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION アカウントの状態が原因で、操作がサポートされていません。
LOCATION_DISABLED_FOR_LOCAL_POST_API Local Post API でビジネス情報が無効です。

FetchVerificationOptionsRequest

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

フィールド
name

string

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

language_code

string

適格性の確認に使用する言語を表す BCP 47 言語コード。利用可能なオプションは言語によって異なります。

context

ServiceBusinessContext

サービスのビジネスを確認するための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY の場合は必須です。他の業種のビジネス情報に設定されている場合は、INVALID_ARGUMENT がスローされます。

FetchVerificationOptionsResponse

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

フィールド
options[]

VerificationOption

利用可能なオーナー確認の方法。

FindMatchingLocationsRequest

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

フィールド
name

string

一致するビジネスのリソース名。

language_code

string

一致するビジネスの優先言語(BCP-47 形式)。

num_results

int32

返される一致の数です。デフォルト値は 3 で、最大値は 10 です。リクエストされる回数が多いと、レイテンシが増加する可能性があるので注意してください。ページ分けはありません。

max_cache_duration

Duration

非推奨です。このフィールドはすべてのリクエストで無視されます。

FindMatchingLocationsResponse

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

フィールド
matched_locations[]

MatchedLocation

指定したビジネスと一致する可能性のあるビジネスのリスト。一致度が最も高いものから順にリストされます。完全一致がある場合は、それが最初の掲載順位になります。

match_time

Timestamp

このビジネスに対して照合アルゴリズムが最後に実行された日時。

FollowersMetadata

ビジネスのフォロワー メタデータ。

フィールド
name

string

このリソース名。accounts/{account_id}/locations/{location_id}/followers/metadata

count

uint64

ビジネスのフォロワーの合計数です。

FoodMenu

食事を提供するビジネスのメニュー。

フィールド
labels[]

MenuLabel

必須。メニューの言語タグ付きラベル。例:「メニュー」、「ランチ スペシャル」などです。表示名は 140 文字以下、説明は 1,000 文字以下にする必要があります。少なくとも 1 つのラベルセットが必要です。

source_url

string

省略可。アクセスするウェブページがある場合のメニューのソース URL。

sections[]

FoodMenuSection

必須。メニューのセクション。

cuisines[]

Cuisine

省略可。フードメニューの料理情報。このフィールドを指定することを強くおすすめします。

料理

レストランの料理情報。

列挙型
CUISINE_UNSPECIFIED 料理が指定されていません
AMERICAN アメリカ料理
ASIAN アジア料理
BRAZILIAN ブラジル料理
BREAK_FAST 朝食
BRUNCH ブランチ
CHICKEN ニワトリ
CHINESE 中華料理
FAMILY ファミリー スタイルの料理
FAST_FOOD ファストフード
FRENCH フランス料理
GREEK ギリシャ料理
GERMAN ドイツ料理
HAMBURGER ハンバーガー
INDIAN インド料理
INDONESIAN インドネシア料理
ITALIAN イタリア料理
JAPANESE 日本料理
KOREAN 韓国料理
LATIN_AMERICAN ラテンアメリカ料理
MEDITERRANEAN 地中海料理
MEXICAN メキシコ料理
PAKISTANI パキスタン料理
PIZZA ピザ
SEAFOOD シーフード
SPANISH スペイン料理
SUSHI 寿司
THAI タイ料理
TURKISH トルコ料理
VEGETARIAN ベジタリアン料理
VIETNAMESE ベトナム料理
OTHER_CUISINE その他の料理

FoodMenuItem

セクションの項目。料理自体にすることも、複数の FoodMenuItemOption を含めることもできます。

フィールド
labels[]

MenuLabel

必須。このメニュー項目の言語タグ付きラベル。表示名は 140 文字以下、説明は 1,000 文字以下にする必要があります。少なくとも 1 つのラベルセットが必要です。

attributes

FoodMenuItemAttributes

必須。商品アイテムの詳細な属性。アイテムのオプションを指定すると、これは基本属性とみなされ、各オプションに入力されます。

options[]

FoodMenuItemOption

省略可。これは、複数の異なるオプションがあるアイテムを対象とし、ユーザーは選択する必要があります。例:「レギュラー サイズ」「大」との比較。オプションを指定すると、商品アイテムレベルのラベルと属性が自動的に最初のオプションのラベルと属性になります。クライアントは、このフィールドで他の追加の食事オプションを指定するだけで済みます。

FoodMenuItemAttributes

食品や料理の属性。

フィールド
price

Money

必須。料理の価格。

spiciness

Spiciness

省略可。料理の辛さレベル。

allergen[]

Allergen

省略可。料理に関連するアレルゲンです。このフィールドを指定することを強くおすすめします。

dietary_restriction[]

DietaryRestriction

省略可。料理の食事に関する情報。このフィールドを指定することを強くおすすめします。

nutrition_facts

NutritionFacts

省略可。フードメニューの栄養成分表。このフィールドを指定することを強くおすすめします。

ingredients[]

Ingredient

省略可。料理の選択肢の材料。

serves_num_people

int32

省略可。この料理オプションには人数を指定してサービングできます。

preparation_methods[]

PreparationMethod

省略可。料理の調理方法。

portion_size

PortionSize

省略可。商品アイテムの単位で表される注文のサイズ。(例: 4 個の「スキューワー」、6 個の「ピース」)

media_keys[]

string

省略可。料理に関連付けられたメディアのメディアキー。サポートされているのは写真メディアのみです。複数の写真が関連付けられている場合は、最初に作成された写真が優先写真と見なされます。

材料

このメッセージは、料理の材料情報を示しています。

フィールド
labels[]

MenuLabel

必須。材料を説明するラベル。表示名は 140 文字以下、説明は 1,000 文字以下にする必要があります。少なくとも 1 つのラベルセットが必要です。

PortionSize

料理の分量(分量)を表します。

フィールド
quantity

int32

必須。部分の数。

unit[]

MenuLabel

必須。繰り返しの name_info フィールドは、このユニットに複数の言語で使用されています。

FoodMenuItemOption

アイテムのオプション。ユーザーの明示的な選択が必要です。

フィールド
labels[]

MenuLabel

必須。このメニュー項目のオプションの言語タグ付きラベルです。例: 「ビーフパッタイ」、「野菜パッド タイ」、「小ピザ」、「大ピザ」表示名は 140 文字以下、説明は 1,000 文字以下にする必要があります。少なくとも 1 つのラベルセットが必要です。

attributes

FoodMenuItemAttributes

必須。商品アイテム オプションの詳細な属性。指定されていない個々の属性は、商品アイテム単位の属性からベースとして継承されます。

FoodMenuSection

メニューのセクション。複数のアイテムや料理を入れることができます。

フィールド
labels[]

MenuLabel

必須。このメニュー セクションの言語タグ付きラベル。表示名は 140 文字以下、説明は 1,000 文字以下にする必要があります。少なくとも 1 つのラベルセットが必要です。

items[]

FoodMenuItem

必須。セクションの項目。各セクションには少なくとも 1 つの項目が必要です。

FoodMenus

料理を提供するビジネスのメニュー。

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/foodMenus です。

menus[]

FoodMenu

省略可。フードメニューのコレクション。

GenerateAccountNumberRequest

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

フィールド
name

string

アカウント番号を生成するアカウントの名前です。

GetAccountRequest

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

フィールド
name

string

取得するアカウントの名前です。

GetChainRequest

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

フィールド
name

string

チェーンのリソース名(chains/{chain_place_id} 形式)。

GetCustomerMediaItemRequest

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

フィールド
name

string

リクエストされた顧客メディア アイテムのリソース名です。

GetFollowersMetadataRequest

ビジネスのフォロワー メタデータを取得するためのリクエスト メッセージ。

フィールド
name

string

ビジネスのフォロワー メタデータのリソース名。accounts/{account_id}/locations/{location_id}/followers/metadata

GetFoodMenusRequest

FoodMenu.GetFoodMenus に対するリクエスト メッセージ

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/foodMenus です。

read_mask

FieldMask

省略可。返される特定のフィールド。マスクが指定されていない場合は、完全な FoodMenu が返されます(「*」と同じ場合)。繰り返しフィールドの項目を個別に指定することはできません。例: "name"と「menus」は有効なマスクですが、「menus.sections」は有効なマスクです。は無効です。

GetHealthProviderAttributesRequest

HealthProviderAttributes.GetHealthProviderAttributes に対するリクエスト メッセージ

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/healthProviderAttributes です。

language_code

string

省略可。言語の BCP 47 コード。言語コードが指定されていない場合、デフォルトで英語に設定されます。現在、「en」のみサポートされています。

GetLocalPostRequest

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

フィールド
name

string

取得するローカル投稿の名前です。

GetLocationRequest

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

フィールド
name

string

取得するビジネスの名前です。

GetMediaItemRequest

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

フィールド
name

string

リクエストされたメディア アイテムの名前です。

GetNotificationsRequest

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

フィールド
name

string

通知設定のリソース名。

GetReviewRequest

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

フィールド
name

string

取得するクチコミの名前です。

GetServiceListRequest

サービスリスト取得リクエスト メッセージ。

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/servicelist です。

GoogleLocation

Google に存在する Location を表します。ユーザーや他の誰かがオーナーとなっているビジネス情報のほか、オーナー未申請のビジネス情報も該当します。

フィールド
name

string

この GoogleLocation のリソース名(googleLocations/{googleLocationId} 形式)。

location

Location

スパースに格納される Location の情報。このフィールドは、現在ユーザーによって申請されていない場合、CreateLocation で再利用できます。

request_admin_rights_url

string

管理者権限のリクエスト UI にユーザーをリダイレクトする URL。このフィールドは、ユーザー(現在のユーザーを含む)によってビジネス情報がすでに申請されている場合にのみ表示されます。

GoogleUpdatedLocation

Google によって変更されたビジネスを表します。

フィールド
location

Location

このビジネスの Google によって変更されたバージョン。

diff_mask

FieldMask

Google によって更新されたフィールド。

HealthProviderAttributes

このビジネスにリンクされている医療機関の属性。

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/healthProviderAttributes です。

insurance_networks[]

InsuranceNetwork

省略可。この地域で認可されている保険ネットワークのリスト。

InsuranceNetwork

単一の保険ネットワーク。次の ID: 5

フィールド
network_id

string

必須。Google によって生成されたこの保険ネットワークの ID。

network_names

map<string, string>

出力専用。リクエストされた言語でのネットワーク表示名のマップ。言語がキー、ローカライズされた表示名が値です。デフォルトでは英語の表示名が設定されています。

payer_names

map<string, string>

出力専用。リクエストされた言語での支払人の表示名のマップ。言語がキー、ローカライズされた表示名が値です。デフォルトでは英語の表示名が設定されています。

state

NetworkState

出力専用。この保険ネットワークの状態。

InternalError

内部エラーについて説明します。

フィールド
error_details[]

ErrorDetail

個々のエラーの詳細です。

招待

出力専用。保留中の招待を表します。

フィールド
name

string

招待状のリソース名。

role

AdminRole

アカウントに対する招待されたロール。

共用体フィールド target。この招待のターゲットを示します。target は次のいずれかになります。
target_account

Account

この招待の対象となる、データがわずかに入力されているアカウント。

target_location

TargetLocation

この招待の対象地域。

TargetLocation

保留中の招待の対象地域を表します。

フィールド
location_name

string

ユーザーが招待されているビジネスの名前。

location_address

string

ユーザーが招待されているビジネスの住所。

ListAccountAdminsRequest

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

フィールド
parent

string

管理者のリストを取得するアカウントの名前です。

ListAccountAdminsResponse

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

フィールド
admins[]

Admin

Admin インスタンスのコレクション。

ListAccountsRequest

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

フィールド
page_size

int32

ページあたりで取得するアカウントの数です。デフォルトは 20 で、最小値は 2、最大ページサイズは 20 です。

page_token

string

指定すると、アカウントの次のページが取得されます。accounts.list の呼び出しが、リクエストしたページサイズを上回る数の結果を返すと、pageToken が返されます。

name

string

直接アクセス可能なアカウントのリストを取得するアカウントのリソース名。これは組織とユーザー グループに対してのみ有効です。空の場合、認証されたユーザーに対して ListAccounts が返されます。

filter

string

返されるアカウントを制限するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。filter が空の場合、制約は適用されず、リクエストされたアカウントのすべてのアカウント(ページ分けあり)が取得されます。

たとえば、リクエストとフィルタ type=USER_GROUP は、ユーザー グループのみを返します。

ListAccountsResponse

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

フィールド
accounts[]

Account

ユーザーがアクセスできるアカウントのコレクション。クエリを実行しているユーザーの個人アカウントが、除外されていない限り、常に結果の最初の項目になります。

next_page_token

string

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

ListAnswersRequest

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

フィールド
parent

string

回答を取得する質問の名前。

page_size

int32

ページごとに取得する回答の数。page_size のデフォルト値と最大値は 10 です。

page_token

string

指定すると、回答の次のページが取得されます。

order_by

string

回答を返す順序。有効なオプションには「update_time desc」があります「upvote_count desc」は、リクエストされたフィールドの降順で並べ替えられた回答を返します。デフォルトの並べ替え順は「update_time desc」です。

ListAnswersResponse

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

フィールド
answers[]

Answer

リクエストされた回答。

total_size

int32

すべてのページにわたって、この質問に対して投稿された回答の合計数。

next_page_token

string

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

ListAttributeMetadataRequest

Locations.ListAttributeMetadata に対するリクエスト メッセージです。ビジネスのリソース名を指定すると、そのビジネス情報に基づいて残りの条件が入力されます。存在しない場合は、カテゴリと国を指定する必要があります。

フィールド
name

string

使用可能な属性を検索するビジネスのリソース名。

category_id

string

使用可能な属性を検索するメインカテゴリの固定の ID。

country

string

使用可能な属性を検索する ISO 3166-1 alpha-2 国コード。

language_code

string

属性の表示名を取得する言語の BCP 47 コード。この言語を使用できない場合は英語で提供されます。

page_size

int32

1 ページあたりに含める属性数です。デフォルトは 200、最小値は 1 です。

page_token

string

指定すると、属性メタデータの次のページが取得されます。attributes.list の呼び出しが、リクエストしたページサイズを上回る数の結果を返すと、pageToken が返されます。

ListAttributeMetadataResponse

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

フィールド
attributes[]

AttributeMetadata

使用可能な属性の属性メタデータのコレクション。

next_page_token

string

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

ListBusinessCategoriesRequest

フィールド
region_code

string

ISO 3166-1 alpha-2 の国コード。

language_code

string

言語の BCP 47 コード。利用できない言語は、デフォルトで英語に設定されます。

search_term

string

ユーザーからのフィルタ文字列(省略可)。

page_size

int32

1 ページあたりで取得するカテゴリの数です。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。

page_token

string

指定すると、カテゴリの次のページが取得されます。

view

CategoryView

省略可。レスポンスで Category リソースに返すパートを指定します。

ListBusinessCategoriesResponse

フィールド
categories[]

Category

カテゴリ。カテゴリは基本的なビューです。ServiceType 情報は含まれません。

total_category_count

int32

リクエスト パラメータのカテゴリの合計数。

next_page_token

string

カテゴリの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の ListBusinessCategories の呼び出しでカテゴリの次のページを取得するためのトークンが入力されます。

ListCustomerMediaItemsRequest

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

フィールド
parent

string

ユーザーのメディア アイテムを一覧表示するビジネスの名前です。

page_size

int32

1 ページあたりで返すメディア アイテム数です。デフォルト値は 100、サポートされる最大ページサイズは 200 です。

page_token

string

指定すると、メディア アイテムの次のページを返します。

ListCustomerMediaItemsResponse

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

フィールド
media_items[]

MediaItem

返されるメディア アイテムのリストです。

total_media_item_count

int32

このビジネスのメディア アイテムの合計数です。ページ分けとは無関係です。結果が複数ページにわたる場合は特に、この数値はおおよその値になります。

next_page_token

string

リクエストしたページサイズを上回る数のメディア アイテムがある場合、このフィールドには、後続の ListCustomerMediaItems の呼び出しでメディア アイテムの次のページを取得するためのトークンが入力されます。

ListInsuranceNetworksRequest

InsuranceNetworkService.ListInsuranceNetworks に対するリクエスト メッセージ

フィールド
parent

string

必須。保険ネットワークがリストされる場所の名前です。名前の形式は、accounts/{account_id}/locations/{location_id} です。

language_code

string

省略可。言語の BCP 47 コード。言語コードが指定されていない場合、デフォルトで英語に設定されます。現在、「en」のみサポートされています。

page_size

int32

1 ページあたりで返す保険ネットワークの数。デフォルト値は 5000 です。ページの最大サイズは 10,000 です。

page_token

string

指定すると、保険ネットワークの次のページが返されます。

ListInsuranceNetworksResponse

InsuranceNetworkService.ListInsuranceNetworks に対するレスポンス メッセージ

フィールド
networks[]

InsuranceNetwork

Google がサポートする保険ネットワークのリスト。

next_page_token

string

リクエストしたページサイズよりも多くの保険ネットワークがある場合、このフィールドには、後続の ListInsuranceNetworks の呼び出しで保険ネットワークの次のページを取得するためのトークンが入力されます。

ListInvitationsRequest

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

フィールド
parent

string

招待のリストを取得するアカウントの名前です。

target_type

TargetType

レスポンスに表示するターゲット タイプを指定します。

TargetType

招待の対象となるターゲットのタイプ。

列挙型
ALL すべてのターゲット タイプの招待を一覧表示します。これがデフォルトです。
ACCOUNTS_ONLY アカウント タイプの招待のみをリストします。
LOCATIONS_ONLY Location タイプの招待のみを一覧表示します。

ListInvitationsResponse

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

フィールド
invitations[]

Invitation

アカウントで保留になっているビジネス情報の招待状のコレクションです。ここに表示される招待の数は 1,000 以下にしてください。

ListLocalPostsRequest

ListLocalPosts に対するリクエスト メッセージ

フィールド
parent

string

ローカル投稿を一覧表示するビジネスの名前です。

page_size

int32

1 ページあたりで返すローカル投稿数です。デフォルトは 20 です。最小値は 1、最大ページサイズは 100 です。

page_token

string

指定すると、ローカル投稿の次のページが返されます。

ListLocalPostsResponse

ListLocalPosts に対するレスポンス メッセージ

フィールド
local_posts[]

LocalPost

返されるローカル投稿のリストです。

next_page_token

string

リクエストしたページサイズを上回る数のローカル投稿がある場合、このフィールドには、後続の ListLocalPosts の呼び出しでローカル投稿の次のページを取得するためのトークンが入力されます。

ListLocationAdminsRequest

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

フィールド
parent

string

管理者を一覧表示するビジネスの名前です。

ListLocationAdminsResponse

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

フィールド
admins[]

Admin

Admin インスタンスのコレクション。

ListLocationsRequest

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

フィールド
parent

string

ビジネスを取得するアカウントの名前です。AccountAccountType 個人用の場合、そのアカウントが直接所有しているビジネス情報のみが返されます。それ以外の場合は、アカウントからアクセスできるすべてのビジネス情報が、直接的または間接的に返されます。

page_size

int32

ページあたりで取得するビジネス情報の数です。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。

page_token

string

指定すると、次の page 個のビジネスが取得されます。以前の ListLocations の呼び出しによって、リクエストしたページサイズを超える場所があったときにページトークンが返されます。

filter

string

返されるビジネスを制限するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。filter が空の場合、制約が適用され、リクエストされたアカウントのすべてのビジネス情報(ページ分けあり)が取得されます。

有効なフィールドと使用例について詳しくは、位置情報の使用に関するガイドをご覧ください。

language_code
(deprecated)

string

表示位置のプロパティを取得する言語の BCP 47 コード。この言語を使用できない場合は、その場所の言語で提供されます。どちらも使用できない場合は、英語で提供されます。

非推奨です。2020 年 8 月 15 日以降、このフィールドは適用されなくなります。代わりに、場所の言語が常に使用されます。

order_by

string

リクエストの並べ替え順序。複数のフィールドは、SQL 構文に従ってカンマで区切る必要があります。デフォルトの並べ替え順は昇順です。降順を指定するには、末尾に「desc"追加する必要があります。order_by で有効なフィールドは location_name と store_code です。例: 「location_name, store_code desc」または「location_name」または「store_code desc」

ListLocationsResponse

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

フィールド
locations[]

Location

ロケーション。

next_page_token

string

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

total_size

int32

ページ分けに関係なく、リスト内のビジネスのおおよその数。

ListMediaItemsRequest

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

フィールド
parent

string

メディア アイテムを一覧表示するビジネスの名前です。

page_size

int32

1 ページあたりで返すメディア アイテム数です。デフォルト値は 100 です。この値は、Google My Business API でビジネス情報に追加できるメディア アイテムの最大数でもあります。ページの最大サイズは 2,500 です。

page_token

string

指定すると、メディア アイテムの次のページを返します。

ListMediaItemsResponse

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

フィールド
media_items[]

MediaItem

返されるメディア アイテムのリストです。

total_media_item_count

int32

このビジネスのメディア アイテムの合計数です。ページ分けとは無関係です。

next_page_token

string

リクエストしたページサイズを上回る数のメディア アイテムがある場合、このフィールドには、後続の ListMediaItems の呼び出しでメディア アイテムの次のページを取得するためのトークンが入力されます。

ListQuestionsRequest

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

フィールド
parent

string

質問を取得するビジネスの名前です。

page_size

int32

ページあたりで取得する質問の数。page_size のデフォルト値と最大値は 10 です。

page_token

string

指定すると、質問の次のページが取得されます。

answers_per_question

int32

質問ごとに取得する回答の数。answers_per_question のデフォルト値と最大値は 10 です。

filter

string

返される質問を制限するフィルタ。現在サポートされているフィルタは「ignore_answered=true」のみです。

order_by

string

質問を返す順序。有効なオプションには「update_time desc」があります「upvote_count desc」は、リクエストされたフィールドを基準に降順で並べ替えられた質問を返します。デフォルトの並べ替え順は「update_time desc」です。

ListQuestionsResponse

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

フィールド
questions[]

Question

求められた質問は、

total_size

int32

すべてのページでこのビジネスについて投稿された質問の合計数です。

next_page_token

string

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

ListRecommendedGoogleLocationsRequest

ビジネス プロフィール アカウントに適した店舗拠点のリストを取得するリクエスト メッセージです。

フィールド
name

string

推奨される Google ビジネスを取得するアカウント リソースの名前。

page_size

int32

ページあたりで取得するビジネス情報の数です。デフォルトは 25 で、最小値は 1、最大ページサイズは 100 です。

page_token

string

指定すると、ビジネスの次のページが取得されます。

ListRecommendedGoogleLocationsResponse

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

また、このビジネス プロフィール アカウントに最後におすすめされてから、他のビジネス プロフィール ユーザーによって申請されたビジネス情報も含まれます。

フィールド
google_locations[]

GoogleLocation

ビジネス プロフィール アカウントに推奨される地域です。これらはそれぞれ、マップに存在する GoogleLocation を表します。ビジネス情報は、ビジネス プロフィール アカウントとの関連性が高い順に並べ替えられています。

total_size

int32

このビジネス プロフィール アカウントに推奨されるビジネスの合計数です。ページ分けとは無関係です。

next_page_token

string

ページ分けの際に、次のページでフェッチできるビジネス情報がさらにある場合、このフィールドには、後続の呼び出しでビジネスの次のページを取得するためのトークンが入力されます。取得するビジネス情報がそれ以上ない場合、このフィールドはレスポンスに含まれません。

ListReviewsRequest

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

フィールド
parent

string

クチコミを取得するビジネスの名前です。

page_size

int32

1 ページあたりで取得するクチコミ数です。page_size の最大値は 50 です。

page_token

string

指定すると、クチコミの次のページが取得されます。

order_by

string

クチコミの並べ替えの基準とするフィールドを指定します。指定しない場合、返されるクチコミの順序はデフォルトの update_time desc になります。並べ替えで有効な順序は ratingrating descupdate_time desc です。

ListReviewsResponse

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

フィールド
reviews[]

Review

クチコミ。

average_rating

double

このビジネスに対するすべてのクチコミの平均評価を 1 ~ 5 の 5 段階で表します。最高評価は 5 です。

total_review_count

int32

このビジネスのクチコミの総数です。

next_page_token

string

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

ListVerificationsRequest

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

フィールド
parent

string

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

page_size

int32

1 ページあたりに含めるオーナー確認の件数。設定しない場合、すべてを返します。

page_token

string

指定すると、検証の次のページが返されます。

ListVerificationsResponse

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

フィールド
verifications[]

Verification

オーナー確認のリスト。

next_page_token

string

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

LocalPost

ビジネスのローカル投稿を表します。

フィールド
name

string

出力専用。このローカル投稿の Google 識別子は、accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id} の形式です。

language_code

string

ローカル投稿の言語です。

summary

string

ローカル投稿の説明/本文です。

call_to_action

CallToAction

プロモーションをクリックしたユーザーが誘導される URL。トピックタイプ OFFER では無視されます。

create_time

Timestamp

出力専用。投稿が作成された時刻です。

update_time

Timestamp

出力専用。ユーザーが最後に投稿を変更した時刻です。

event

LocalPostEvent

イベント情報。トピックタイプが EVENTOFFER の場合は必須です。

state

LocalPostState

出力専用。投稿のライフサイクルのどの段階にあるかを示す、投稿の状態。

media[]

MediaItem

投稿に関連付けられているメディア。LocalPost MediaItem でサポートされているデータ フィールドは source_url のみです。

search_url

string

出力専用。Google 検索のローカル投稿へのリンクです。このリンクを使用して、ソーシャル メディア、メール、テキストなどで投稿を共有できます。

topic_type

LocalPostTopicType

必須。投稿のトピックタイプ(標準、イベント、特典、アラート)。

alert_type

AlertType

投稿を作成するアラートの種類。このフィールドは、topic_type Alert の投稿にのみ適用され、Alerts のサブタイプとして動作します。

offer

LocalPostOffer

特典に関する投稿の追加データです。topic_type が OFFER の場合にのみ設定する必要があります。

LocalPostState

投稿の状態を示します

列挙型
LOCAL_POST_STATE_UNSPECIFIED 状態が指定されていません。
REJECTED コンテンツ ポリシーに違反しているため、この投稿は拒否されました。
LIVE この投稿は公開されており、現在検索結果に表示されています。
PROCESSING この投稿は処理中で、検索結果に表示されていません。

LocalPostEvent

ローカル投稿に掲載されるイベントに関連するすべての情報です。

フィールド
title

string

イベントの名前。

schedule

TimeInterval

イベントの開始日時と終了日時。

LocalPostMetrics

ローカル投稿に対してリクエストされたすべての指標です。

フィールド
local_post_name

string

metric_values[]

MetricValue

リクエストされた指標の値のリスト。

LocalPostOffer

特典に関する投稿専用のフィールドです。

フィールド
coupon_code

string

省略可。店舗またはオンラインで使用できるクーポンコード。

redeem_online_url

string

省略可。特典を利用するためのオンライン リンクです。

terms_conditions

string

省略可。特典の利用規約。

LocalPostTopicType

ローカル投稿のトピックタイプです。さまざまなテンプレートを選択して投稿を作成、表示するために使用されます。

列挙型
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED 投稿の種類が指定されていません。
STANDARD 投稿に概要や画像などの基本情報が含まれています。
EVENT 投稿に基本情報とイベントが含まれています。
OFFER 投稿に基本情報、イベント、特典に関連するコンテンツ(クーポンコードなど)が含まれている
ALERT 進行中のイベントに関連する、優先度が高くタイムリーなお知らせです。このタイプの投稿は、作成できない場合があります。

場所

ビジネスです。これらの項目の詳細については、ヘルプセンター記事をご覧ください。有効な業種の一覧については、カテゴリのエンドポイントをご覧ください。

フィールド
name

string

このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id} です。

一致のコンテキストでは、このフィールドには値が入力されません。

language_code

string

ビジネスの言語。作成時に設定され、更新できません。

store_code

string

このビジネスの外部識別子。アカウント内で一意である必要があります。これにより、ビジネスとご自身の記録が関連付けられます。

location_name

string

ビジネス拠点の名前は、店舗、ウェブサイト、事務用品で一貫して使用されており、顧客に知られている実際のビジネスの名称である必要があります。関連する追加情報は、リソースの他のフィールド(AddressCategories など)に含めることができます。名前に不要な情報を追加しないでください(たとえば、「Google Inc. - Mountain View Corporate 本社」よりも「Google」と表記します)。マーケティング タグライン、店舗コード、特殊文字、営業時間、営業中 / 営業状況、電話番号、ウェブサイトの URL、サービス / 商品情報、場所 / 住所 / 経路、出店先情報(例: 「Duane Reade にある Chase ATM」)は含めないでください。

primary_phone

string

個別のビジネス拠点に直接つながる電話番号を指定します。可能であれば、電話総合受付センターではなく、個々のお店の番号を使用します。

additional_phones[]

string

電話番号に加えて、ビジネスの電話連絡先を最大 2 件登録できます(携帯電話でも固定電話でもかまいませんが、FAX 番号は指定できません)。

address

PostalAddress

ビジネス拠点を表す正確な住所。遠隔地にある私書箱は使用できません。現時点では、アドレスに最大 5 つの address_lines 値を指定できます。

primary_category

Category

このビジネスの中核事業を最もよく表すカテゴリ。

additional_categories[]

Category

ビジネスを説明する追加のカテゴリです。カテゴリを指定すると、そのサービスを探しているユーザーに見つけてもらいやすくなります。ビジネス情報を正確かつ最新の状態に保つため、中核事業を表すカテゴリはできるだけ少なくします。できるだけ具体的で、なおかつ中心となるビジネスを表すカテゴリを選択します。

website_url

string

このビジネスの URL。可能であれば、すべての拠点やブランドに共通する一般的なウェブサイトや URL ではなく、このビジネス拠点専用の URL を使用してください。

regular_hours

BusinessHours

ビジネスの営業時間。

special_hours

SpecialHours

ビジネスの特別営業時間。祝休日の営業時間など、通常の営業時間外の時間が含まれます。これらの設定は、通常の営業時間よりも優先されます。

service_area

ServiceAreaBusiness

非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです。ビジネスが非店舗型ビジネスの場合、このフィールドはそのビジネスがサービスを提供する地域を表します。

location_key

LocationKey

このビジネスを他の Google サービス(Google+ ページや Google マップの場所など)にリンクするキーのコレクション。

labels[]

string

ビジネスにタグを付けられるようにするための自由形式の文字列のコレクション。ユーザーにはこれらのラベルは表示されません。自分だけが閲覧できます。ラベルあたり最大 255 文字です。

ad_words_location_extensions

AdWordsLocationExtensions

AdWords に表示される追加情報。

latlng

LatLng

ユーザー指定の緯度と経度。ビジネスの作成時に、提供された住所のジオコード処理が成功した場合、このフィールドは無視されます。このフィールドは、作成時にユーザーが指定した latlng 値が受け入れられた場合、またはビジネス プロフィールのウェブサイトで latlng 値が更新された場合にのみ、get リクエストで返されます。このフィールドは更新できません。

open_info

OpenInfo

ビジネスが現在営業しているかどうかを示すフラグ。

location_state

LocationState

出力専用。ビジネスの状態を反映する一連のブール値。

attributes[]

Attribute

ビジネスの属性。

metadata

Metadata

出力専用。ユーザーが編集できない追加情報。

price_lists[]
(deprecated)

PriceList

非推奨: このロケーションの料金リスト情報。

profile

Profile

ご自身のビジネスについて自分の言葉で説明し、ビジネスや商品に関する独自のストーリーをユーザーと共有できます。

relationship_data

RelationshipData

これに関連するすべてのビジネスとチェーンです。

more_hours[]

MoreHours

ビジネスの各部門や特定の顧客の営業時間を増やす。

メタデータ

ビジネスに関する、ユーザーが編集できない追加情報。

フィールド
duplicate
(deprecated)

Duplicate

このビジネスと重複しているビジネスに関する情報です。location_state.is_duplicate が true の場合にのみ存在します。非推奨: 重複に関する詳細情報はサポートされなくなりました。

maps_url

string

マップ上のビジネスへのリンク。

new_review_url

string

ユーザーがビジネスのクチコミを投稿できる、Google 検索のページへのリンク。

複製

このビジネスと重複しているビジネスに関する情報です。

フィールド
location_name

string

重複するビジネスのリソース名。認証されたユーザーがそのビジネスへのアクセス権を持ち、そのビジネスが削除されていない場合にのみ入力されます。

place_id

string

重複するビジネスのプレイス ID です。

access

Access

重複しているビジネスにユーザーがアクセスできるかどうかを示します。

アクセス

重複しているビジネスに対するユーザーのアクセス権。これは所有権に代わるもので、代わりに使用する必要があります。

列挙型
ACCESS_UNSPECIFIED 指定されていません。
ACCESS_UNKNOWN 重複しているビジネス情報にユーザーがアクセスできるかどうかを判断できません。
ALLOWED ユーザーが重複しているビジネス情報にアクセスできる。
INSUFFICIENT ユーザーは重複しているビジネス情報にアクセスできません。

RelationshipData

このビジネスに関連するすべての親と子のビジネス情報の情報。

フィールド
parent_chain

string

このビジネスが所属するチェーンのリソース名。How to find Chain ID

LocationDrivingDirectionMetrics

ユーザーが普段訪れる地域ごとにインデックスに登録されたビジネスです。これは、各地域からこのビジネスへの運転ルートのリクエスト数をカウントすることで取得されます。

フィールド
location_name

string

この指標値が属するビジネス リソース名。

top_direction_sources[]

TopDirectionSources

ソース地域ごとの運転ルート リクエスト。慣例により、これらは件数で並べ替えられ、最大 10 件の結果が表示されます。

time_zone

string

ビジネスのタイムゾーン(「Europe/London」などの IANA タイムゾーン ID)です。

TopDirectionSources

運転ルートのリクエスト元となった上位の地域。

フィールド
day_count

int32

データを集計する日数。

region_counts[]

RegionCount

件数の降順で並べ替えられた地域。

RegionCount

リクエスト数が関連付けられているリージョン。

フィールド
latlng

LatLng

地域の中心。

label

string

人が読める形式のリージョンのラベル。

count

int64

この地域からの運転ルート リクエストの数。

LocationKey

ビジネスの代替キーまたはサロゲートキーの参照です。

フィールド
plus_page_id

string

出力専用。このビジネスに関連付けられた Google+ ページがある場合は、このビジネスの Google+ ページ ID が入力されます。

place_id

string

ビジネスのオーナー確認が済んでおり、Google マップに関連付けられているか表示されている場合は、そのビジネスのプレイス ID が入力されます。この ID はさまざまな Places API で使用できます。

ビジネスのオーナー確認が済んでいない場合でも、そのビジネスが Google マップに表示される場所に関連付けられていれば、このフィールドに値が入力されることがあります。

このフィールドは、Create の呼び出し時に設定できますが、Update の呼び出し時には設定できません。

追加の explicit_no_place_id ブール値は、プレイス ID が意図的に未設定になっているかどうかを表します。

explicit_no_place_id

bool

出力専用。値が true の場合、関連付けがまだ行われていない状態とは異なり、プレイス ID が意図的に未設定となっていることを示します。

request_id

string

出力専用。このビジネスの作成に使用された request_id。このビジネスが Google My Business API または Business Profile Locations 以外で作成された場合は、空になることがあります。

LocationMetrics

一定期間にビジネスに関連付けられた一連の Metrics と BreakdownMetrics。

フィールド
location_name

string

これらの値が属するビジネスのリソース名。

time_zone

string

ビジネスの IANA タイムゾーン。

metric_values[]

MetricValue

リクエストされた指標の値のリスト。

LocationReview

ビジネス情報を含むクチコミを表します。

フィールド
name

string

ビジネスのリソース名。

review

Review

ビジネスのクチコミです。

LocationState

ビジネスの状態を反映する一連のブール値を含みます。

フィールド
is_google_updated

bool

出力専用。このビジネスに関連付けられているプレイス ID に変更があるかどうかを表します。

is_duplicate

bool

出力専用。ビジネスが別のビジネスと重複しているかどうかを示します。

is_suspended

bool

出力専用。ビジネスが強制停止されているかどうかを表します。停止中のビジネスは、Google サービスのエンドユーザーには表示されません。間違いであると思われる場合は、ヘルプセンターの記事をご覧ください。

can_update

bool

出力専用。ビジネスが更新可能かどうかを示します。

can_delete

bool

出力専用。ビジネスが Google My Business API を使用して削除できるかどうかを示します。

is_verified

bool

出力専用。ビジネスのオーナー確認が済んでいるかどうかを表します。

needs_reverification

bool

出力専用。ビジネスの再オーナー確認が必要かどうかを示します。

is_pending_review

bool

出力専用。ビジネスのクチコミが保留中かどうかを示します。

is_disabled

bool

出力専用。ビジネスが無効になっているかどうかを示します。

is_published

bool

出力専用。ビジネスが公開されているかどうかを示します。

is_disconnected

bool

出力専用。ビジネスと Google マップ上の場所との接続が解除されているかどうかを示します。

is_local_post_api_disabled

bool

出力専用。このビジネスの accounts.locations.localPosts が無効になっているかどうかを示します。

can_modify_service_list

bool

出力専用。リスティングが ServiceList を変更できるかどうかを示します。

can_have_food_menus

bool

出力専用。リスティングがフードメニューの対象となるかどうかを示します。

has_pending_edits

bool

出力専用。このビジネスのプロパティのいずれかが「編集待ち」状態かどうかを示します。

has_pending_verification

bool

出力専用。ビジネスに保留中のオーナー確認リクエストがあるかどうかを示します。

can_operate_health_data

bool

出力専用。ビジネスが健康に関するデータを利用できるかどうかを示します。

can_operate_lodging_data

bool

出力専用。ビジネスが宿泊施設データを利用できるかどうかを示します。

MatchedLocation

ビジネスと一致する可能性のあるビジネスを表します。

フィールド
location

Location

一致の可能性がある、データがスパースに分布するロケーション。未入力のフィールドには、名前(名前と一致した地域は GetLocationBatchGetLocations では取得できません)が含まれますが、これらに限定されません。store_codeservice_area のサポート エリアの詳細labelsad_words_location_extensionsphotos

is_exact_match

bool

これは完全一致ですか?

MediaItem

1 つのメディア アイテムです。

フィールド
name

string

このメディア アイテムのリソース名です。accounts/{account_id}/locations/{location_id}/media/{media_key}

media_format

MediaFormat

このメディア アイテムのフォーマットです。メディア アイテムの作成時に設定する必要があります。他のすべてのリクエストでは読み取り専用です。この設定は変更できません。

location_association

LocationAssociation

CreatePhoto を呼び出す場合は必須です。このメディア アイテムがビジネスにどのように関連付けられているかを表します。カテゴリ(EXTERIOR など)または価格表アイテムの ID のいずれかを指定します。

これは、CreateMediaItem で新しいメディアをビジネスに追加する場合に必要です。ローカル投稿の写真など、他の種類のメディアの場合、このフィールドはありません。

google_url

string

出力専用。このメディア アイテムについて Google がホストする URL です。この URL は、時間の経過とともに変更される可能性があるため、静的なものではありません。動画の場合は再生アイコンがオーバーレイされたプレビュー画像になります。

thumbnail_url

string

出力専用。提供されている場合は、このメディア アイテムのサムネイル画像の URL です。

create_time

Timestamp

出力専用。このメディア アイテムの作成時刻です。

dimensions

Dimensions

出力専用。ピクセル単位のサイズ(幅と高さ)です。

insights

MediaInsights

出力専用。このメディア アイテムに関する統計情報です。

attribution

Attribution

出力専用。顧客メディア アイテムの帰属情報です。この帰属情報は、ユーザーに提示されたとおりに表示する必要があり、帰属情報を削除または変更してはなりません。

description

string

このメディア アイテムの説明です。説明は Google My Business API では変更できませんが、カバー写真以外の新しいメディア アイテムを作成するときに設定できます。

共用体フィールド data。メディア アイテムのデータソースです。新しいメディア アイテムを作成するときに、URL またはデータ参照を指定する必要があります。

PROFILE および COVER カテゴリを除き、すべての写真は短辺が 250 ピクセル以上で、ファイルサイズが 10,240 バイト以上である必要があります。

アップロードする写真はすべて、ビジネス プロフィールの写真に関するガイドラインに準拠している必要があります。data は次のいずれかになります。

source_url

string

メディア アイテムを取得できる、一般公開されている URL です。

作成時に、このパラメータまたは data_ref を設定して、メディア アイテムのソースを指定する必要があります。

メディア アイテムの作成時に source_url を使用した場合は、メディア アイテムの取得時にそのソース URL が入力されます。

このフィールドは更新できません。

data_ref

MediaItemDataRef

入力のみのStartUploadMediaItemData メソッドで取得したメディア アイテムのバイナリデータへの参照。

メディア アイテムの作成時に、

sourceUrl

または

dataRef

を設定する必要があります。

帰属

投稿者の名前やプロフィール写真など、顧客メディア アイテムの帰属情報です。

フィールド
profile_name

string

メディア アイテムが帰属するユーザー名です。

profile_photo_url

string

帰属先ユーザーのプロフィール写真のサムネイルの URL です。

takedown_url

string

不適切なメディア アイテムを報告できる削除ページの URL です。

profile_url

string

帰属先ユーザーの Google マップのプロフィール ページの URL。

ディメンション

メディア アイテムのサイズです。

フィールド
width_pixels

int32

メディア アイテムの幅(ピクセル単位)です。

height_pixels

int32

メディア アイテムの高さ(ピクセル単位)。

LocationAssociation

メディア アイテムがその場所とどのように関連付けられているかを示します。

フィールド
共用体フィールド location_attachment_type。ビジネスのメディアには、カテゴリまたは関連付けられている価格表アイテムの ID が必要です。位置情報のないメディア(ローカル投稿の写真など)には、どちらの ID も指定しないでください。location_attachment_type は次のいずれかになります。
category

Category

このビジネス写真が属するカテゴリです。

price_list_item_id

string

このビジネス写真が関連付けられている価格表アイテムの ID です。

カテゴリ

メディア アイテム カテゴリの列挙型です。

列挙型
CATEGORY_UNSPECIFIED カテゴリが指定されていません。
COVER カバー写真です。ビジネスに指定できるカバー写真は 1 枚のみです。
PROFILE プロフィール写真です。ビジネスに指定できるプロフィール写真は 1 枚のみです。
EXTERIOR 外観のメディアです。
INTERIOR 内装のメディアです。
PRODUCT 商品のメディアです。
AT_WORK '勤務中'できます。
FOOD_AND_DRINK 食べ物や飲み物のメディアです。
MENU メニューのメディアです。
COMMON_AREA 共用エリアのメディアです。
ROOMS 部屋のメディアです。
TEAMS チームのメディアです。
ADDITIONAL その他の未分類のメディアです。

MediaFormat

メディア フォーマットの列挙型です。

列挙型
MEDIA_FORMAT_UNSPECIFIED 形式が指定されていません。
PHOTO メディア アイテムは写真です。このバージョンでは、写真のみがサポートされています。
VIDEO メディア アイテムは動画です。

MediaInsights

メディア アイテムに関するインサイトと統計情報です。

フィールド
view_count

int64

出力専用。メディア アイテムが表示された回数です。

MediaItemDataRef

Google My Business API を介してアップロードされた MediaItem の写真バイナリデータへの参照です。

StartUploadMediaItemData を使用してデータ参照を作成します。この参照は、[UpdateMedia] にバイトをアップロードし、その後 CreateMediaItem を呼び出すときに使用します。

フィールド
resource_name

string

このメディア アイテムのバイナリデータの一意の ID です。[UpdateMedia] で写真データをアップロードし、CreateMediaItem でこれらのバイトから新しいメディア アイテムを作成するときに使用されます。

バイトのアップロード例: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resource_name}?upload_type=media"

CreateMediaItem 呼び出しの場合は、MediaItem data_ref に設定します。

メニューとその各種サブコンポーネントを表示するときに使用されるラベル。

フィールド
display_name

string

必須。コンポーネントの表示名。

description

string

省略可。コンポーネントの補足情報。

language_code

string

省略可。言語の BCP 47 コード。利用できない言語は、デフォルトで英語に設定されます。

指標

リソースに関するデータの指標。

列挙型
METRIC_UNSPECIFIED 指標が指定されていません。
ALL 利用可能なすべての指標をリクエストする省略形。「ALL」に含まれる指標はさまざまであり、インサイトのリクエスト対象のリソースによって異なります。
QUERIES_DIRECT ビジネスを直接検索したときにリソースが表示された回数です。
QUERIES_INDIRECT カテゴリ検索(レストランなど)の結果としてリソースが表示された回数。
QUERIES_CHAIN 所属するチェーンまたは販売しているブランドの検索結果としてリソースが表示された回数。(例: スターバックス、アディダス)。これは QUERIES_INDIRECT のサブセットです。
VIEWS_MAPS リソースが Google マップで閲覧された回数。
ACTIONS_WEBSITE ウェブサイトがクリックされた回数。
ACTIONS_PHONE 電話番号がクリックされた回数。
ACTIONS_DRIVING_DIRECTIONS 運転ルートがリクエストされた回数。
PHOTOS_VIEWS_MERCHANT 販売者がアップロードしたメディア アイテムの表示回数。
PHOTOS_VIEWS_CUSTOMERS ユーザーがアップロードしたメディア アイテムの表示回数。
PHOTOS_COUNT_MERCHANT 販売者がアップロードした、現在公開中のメディア アイテムの合計数です。
PHOTOS_COUNT_CUSTOMERS 顧客によってアップロードされた、現在公開中のメディア アイテムの合計数。
LOCAL_POST_VIEWS_SEARCH ローカル投稿が Google 検索で閲覧された回数。
LOCAL_POST_ACTIONS_CALL_TO_ACTION Google で行動を促すフレーズのボタンがクリックされた回数。

MetricOption

レスポンスでのデータの表示方法を指定するオプション。

列挙型
METRIC_OPTION_UNSPECIFIED 指標オプションが指定されていません。リクエストのデフォルトは AGGREGATED_TOTAL です。
AGGREGATED_TOTAL 時間枠全体で集計された戻り値。これがデフォルト値です。
AGGREGATED_DAILY 期間全体における毎日のタイムスタンプ付き値を返します。
BREAKDOWN_DAY_OF_WEEK 値は曜日ごとの内訳として返されます。ACTIONS_PHONE でのみ有効です。
BREAKDOWN_HOUR_OF_DAY 値は時間別の内訳として返されます。ACTIONS_PHONE でのみ有効です。

MetricRequest

1 つの指標の値を返すリクエストと、それらの値を返す方法のオプション。

フィールド
metric

Metric

リクエストされた指標。

options[]

MetricOption

返された値の表示方法。

MetricValue

開始時間の 1 つの指標の値。

フィールド
metric

Metric

値が適用される指標。

total_value

DimensionalMetricValue

この指標の合計集計値。AGGREGATED_TOTAL オプションに対して設定されます。

dimensional_values[]

DimensionalMetricValue

この指標のディメンション値。

MoreHours

特定の種類のビジネスで営業している期間。

フィールド
hours_type_id

string

必須。営業時間の種類です。クライアントは、{#link businessCategories:BatchGet} を呼び出して、ビジネスの業種でサポートされている営業時間タイプを取得する必要があります。

periods[]

TimePeriod

必須。ビジネスの営業時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。

MoreHoursType

通常の営業時間に加えて、ビジネスが提供できる営業時間の種類を増やします。

フィールド
hours_type_id

string

出力専用。この営業時間タイプに対して Google から提供される固定の ID。

display_name

string

出力専用。時間タイプの、人が読める形式の英語の表示名。

localized_display_name

string

出力専用。時間タイプのローカライズされた、人が読める形式の表示名。

NetworkState

このビジネスに関する保険ネットワークの状態。

列挙型
NETWORK_STATE_UNSPECIFIED デフォルト値。
ACCEPTED このネットワークはこのロケーションで許可されています。
PENDING_ADD このネットワークを承認済みリストに追加するための保留中のリクエストがあります。
PENDING_DELETE 承認済みリストからこのネットワークを削除するという保留中のリクエストがあります。
NOT_ACCEPTED このネットワークは、この場所では承認されていません。

NotificationType

Cloud Pub/Sub トピックに送信される通知のタイプ。

列挙型
NOTIFICATION_TYPE_UNSPECIFIED 通知タイプがありません。どの通知とも一致しません。
GOOGLE_UPDATE ビジネス情報には Google による変更があり、確認が必要です。通知の location_name フィールドには、Google による変更がある場所のリソース名が表示されます。
NEW_REVIEW ビジネス情報に新しいクチコミが追加されました。通知の review_name フィールドには追加されたクチコミのリソース名が示され、location_name にはビジネスのリソース名が含まれます。
UPDATED_REVIEW ビジネスに関するクチコミが更新されました。通知の review_name フィールドには追加されたクチコミのリソース名が示され、location_name にはビジネスのリソース名が含まれます。
NEW_CUSTOMER_MEDIA Google マップのユーザーによって、新しいメディア アイテムがビジネスに追加されました。通知には、新しいメディア アイテムのリソース名が表示されます。
NEW_QUESTION 新しい質問がビジネスに追加されます。通知には、質問のリソース名が表示されます。
UPDATED_QUESTION 場所に関する質問が更新されました。通知には、質問のリソース名が表示されます。
NEW_ANSWER 新しい回答がビジネスに追加されます。通知には、質問と回答のリソース名が表示されます。
UPDATED_ANSWER ビジネスの回答が更新される。通知には、質問と回答のリソース名が表示されます。
UPDATED_LOCATION_STATE ビジネスの LocationState が更新されました。通知には、更新された LocationState フィールドのフィールド マスクが含まれます。

通知

ビジネスが更新された場合や新しいクチコミがある場合に通知を発行できる Google Cloud Pub/Sub トピックです。通知設定リソースはアカウントごとに 1 つだけです。

フィールド
name

string

出力専用。通知リソース名。

topic_name

string

このアカウントで管理しているビジネスが更新されたときに通知を受け取る Google Cloud Pub/Sub トピックです。未設定のままにした場合、通知は投稿されません。

アカウント mybusiness-api-pubsub@system.gserviceaccount.com には、Cloud Pub/Sub トピックに対する公開権限が必要です。

notification_types[]

NotificationType

Cloud Pub/Sub トピックに送信される通知のタイプ。少なくとも 1 つ指定する必要があります。通知の受信を完全に停止するには、DeleteNotifications を使用します。

NutritionFacts

このメッセージは、食品の栄養成分を表しています。

フィールド
calories

CaloriesFact

省略可。料理のカロリー。

total_fat

NutritionFact

省略可。特定の料理の脂肪情報。

cholesterol

NutritionFact

省略可。特定の料理のコレステロール情報。

sodium

NutritionFact

省略可。特定の料理のナトリウム情報。

total_carbohydrate

NutritionFact

省略可。特定の料理の炭水化物情報。

protein

NutritionFact

省略可。特定の料理のタンパク質情報。

CaloriesFact

このメッセージは、上限と下限の範囲があるカロリー情報を示しています。これより小さい値を指定する必要があります。下限と上限はどちらも負でない数値です。

フィールド
lower_amount

int32

必須。カロリーが少ない

upper_amount

int32

省略可。高カロリー

unit

EnergyUnit

必須。指定されたカロリー情報の単位。

EnergyUnit

エネルギーの取り得る単位(カロリー)。

列挙型
ENERGY_UNIT_UNSPECIFIED エネルギー単位が指定されていません
CALORIE カロリー
JOULE Joule

MassUnit

取り得る質量単位。

列挙型
MASS_UNIT_UNSPECIFIED 質量単位が指定されていません
GRAM Gram
MILLIGRAM ミリグラム

NutritionFact

このメッセージは、上限と下限の範囲がある栄養情報を示し、質量単位で表すことができます。これより小さい値を指定する必要があります。下限と上限はどちらも負でない数値です。

フィールド
lower_amount

double

必須。栄養の不足

upper_amount

double

省略可。高い栄養量

unit

MassUnit

必須。与えられた栄養情報の単位。

OpenInfo

ビジネスの営業状態に関する情報です。

フィールド
status

OpenForBusiness

ビジネスが現在営業中かどうかを示します。すべてのビジネスはデフォルトで営業中になります(休業中に変更された場合を除く)。

can_reopen

bool

出力専用。このビジネスが営業再開の条件を満たしているかどうかを示します。

opening_date

Date

ビジネスが開業した日付です。正確な日付が不明な場合は、年月のみを指定できます。過去の日付か、今後 1 年以内の日付を指定してください。

OpenForBusiness

ビジネスのステータスを示します。

列挙型
OPEN_FOR_BUSINESS_UNSPECIFIED 指定されていません。
OPEN ビジネスが営業していることを表します。
CLOSED_PERMANENTLY ビジネスが閉業したことを表します。
CLOSED_TEMPORARILY ビジネスが臨時休業していることを表します。この値は、公開されているビジネス情報にのみ適用できます(location_state.is_published = true)。ステータス フィールドをこの値に更新する場合、クライアントは update_mask を明示的に open_info.status に設定する必要があります。この update 呼び出し中は、他の更新マスクを設定できません。これは一時的な制限であり、まもなく緩和される予定です。

PermissionLevel

認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。

列挙型
PERMISSION_LEVEL_UNSPECIFIED 指定されていません。
OWNER_LEVEL ユーザーがオーナー レベルの権限を持っている。
MEMBER_LEVEL ユーザーがメンバーレベルの権限を持っている。

PhoneInput

PHONE_CALL/SMS での確認用の入力。

フィールド
phone_number

string

発信または SMS の送信先となる電話番号。有効なオプションに記載されている電話番号のいずれかである必要があります。

PlaceInfo

プレイス ID で表される地域を定義します。

フィールド
name

string

場所のローカライズされた名前です。たとえば、Scottsdale, AZ です。

place_id

string

場所の ID。リージョンに対応している必要があります。

場所

場所のセットで表される地域の和集合を定義します。

フィールド
place_infos[]

PlaceInfo

プレイス ID で表される地域です。場所は最大 20 か所に制限されます。

PointRadius

緯度と経度で特定される地点を中心とした半径です。

フィールド
latlng

LatLng

半径で定義した地域の中心を指定する緯度と経度です。

radius_km

float

その地域の中心地点からの距離(キロメートル)。

PreparationMethod

料理の調理方法。

列挙型
PREPARATION_METHOD_UNSPECIFIED 準備方法が指定されていません
BAKED Baked メソッド
BARBECUED バーベキュー方式
BASTED 踏み台メソッド
BLANCHED ブランチ方式
BOILED Boiled メソッド
BRAISED 水切り方法
CODDLED 連結方法
FERMENTED 発酵方法
FRIED 揚げる方法
GRILLED グリル焼きの方法
KNEADED こねる方法
MARINATED マリネされた方法
PAN_FRIED フライパンで焼く方法
PICKLED ピクルス方式
PRESSURE_COOKED 圧力調理方法
ROASTED ロースト方法
SAUTEED ソテー法
SEARED Seared メソッド
SIMMERED シマー方式
SMOKED スモーク方式
STEAMED スチーム方式
STEEPED スティープ法
STIR_FRIED 炒め物
OTHER_METHOD その他の方法

PriceList

非推奨: アイテムの価格情報のリスト。価格リストは 1 つ以上の価格リストとして構成され、それぞれに 1 つ以上のアイテムを含む 1 つ以上のセクションが含まれています。たとえば、食品の価格リストに、朝食、ランチ、ディナーのメニューを加えて、ハンバーガー、ステーキ、シーフードをセクションにまとめます。

フィールド
price_list_id

string

必須。料金リストの ID。価格表、セクション、商品アイテム ID をこのビジネス情報内で重複させることはできません。

labels[]

Label

必須。料金リストの言語タグ付きラベル。

source_url

string

料金リストの取得元となるソース URL(省略可)。たとえば、メニュー情報を入力するために自動的にスクレイピングされたページの URL などです。

sections[]

Section

必須。この料金表のセクション。各料金表には、少なくとも 1 つのセクションが含まれている必要があります。

ラベル

価格表、セクション、またはアイテムを表示するときに使用されるラベル。

フィールド
display_name

string

必須。価格表、セクション、または商品アイテムの表示名。

description

string

省略可。価格表、セクション、または商品アイテムの説明です。

language_code

string

省略可。これらの文字列が適用される BCP-47 言語コード。言語ごとに設定できるラベルのセットは 1 つのみです。

セクション

1 つ以上のアイテムを含む価格表のセクション。

フィールド
section_id

string

必須。セクションの ID。価格表、セクション、商品アイテム ID をこのビジネス情報内で重複させることはできません。

labels[]

Label

必須。セクションの言語タグが付いたラベルです。セクション名と説明は 140 文字以下にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。

section_type

SectionType

省略可。現在の料金表セクションのタイプ。デフォルト値は FOOD です。

items[]

Item

価格表のこのセクションに含まれる商品アイテム。

項目

単一のリストアイテム。価格表の商品アイテムの各バリエーションには、独自の価格データを持つ独自の商品アイテムが必要です。

フィールド
item_id

string

必須。商品アイテムの ID。価格表、セクション、商品アイテム ID をこのビジネス情報内で重複させることはできません。

labels[]

Label

必須。商品アイテムの言語タグ付きのラベルです。商品アイテム名は半角 140 文字(全角 70 文字)、説明は半角 250 文字(全角 125 文字)以下にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。

price

Money

省略可。商品アイテムの価格。

SectionType

セクションのタイプ。

列挙型
SECTION_TYPE_UNSPECIFIED 指定されていません。
FOOD セクションには食品を表すアイテムが含まれています。
SERVICES セクションには、サービスを表すアイテムが含まれています。

プロフィール

ビジネスのプロフィールに関するすべての情報です。

フィールド
description

string

場所の説明を自分の声で記述します。他のユーザーは編集できません。

質問

1 つの質問とその回答の一部を表します。

フィールド
name

string

出力専用。質問の一意の名前。accounts/*/locations/*/questions/*

author

Author

出力専用。質問者。

upvote_count

int32

出力専用。質問に対する賛成票の数。

text

string

質問のテキスト。少なくとも 3 つの単語を含み、長さは 10 文字以上にする必要があります。最大長は 4,096 文字です。

create_time

Timestamp

出力専用。質問が投稿されたときのタイムスタンプ。

update_time

Timestamp

出力専用。質問が最後に変更されたときのタイムスタンプ。

top_answers[]

Answer

出力専用。質問への回答の一覧。賛成票の多い順に表示されます。リクエスト パラメータ(answers_per_question)によっては、このリストがすべての回答を網羅しているとは限りません

total_answer_count

int32

出力専用。この質問に対して投稿された回答の合計数。

RepeatedEnumAttributeValue

value_type が REPEATED_ENUM の属性の値。これは、設定済みの(true)と設定されていない(false)の値 ID の 2 つのリストで構成されます。存在しない値は不明とみなされます。少なくとも 1 つの値を指定する必要があります。

フィールド
set_values[]

string

設定されている列挙値。

unset_values[]

string

設定されていない列挙値。

ReportGoogleLocationRequest

GoogleLocation を報告するためのリクエスト メッセージ。

フィールド
name

string

[GoogleLocation] のリソース名(形式: googleLocations/{googleLocationId})。

location_group_name

string

省略可。この Google ビジネスが報告されているビジネス グループのリソース名(形式: accounts/{account_id})。

report_reason_elaboration

string

省略可。ユーザーがこの場所を報告した理由を詳述するテキスト入力。最大長は 512 文字です。

report_reason_language_code

string

省略可。report_reason_elaboration で使用される言語の BCP 47 コード。

共用体フィールド report_reason。この場所を報告する理由です。理由を指定してください。report_reason は次のいずれかになります。
report_reason_bad_location

BadLocationReason

ビジネス自体に問題がある場合に、ユーザーがこの場所を報告した理由です。

report_reason_bad_recommendation

BadRecommendationReason

最適化案に問題がある場合に、ユーザーがこの場所を報告した理由。このレポートは、ビジネス プロフィール アカウントにビジネス情報が推奨されている場合に便利です。

BadLocationReason

ビジネス自体のデータの品質に問題がある場合に、ビジネスを報告する理由として考えられるもの。

列挙型
BAD_LOCATION_REASON_UNSPECIFIED 指定されていません。
NOT_A_LOCATION 推奨される場所は実際の場所ではありません。
PERMANENTLY_CLOSED おすすめのビジネスは閉業しています。
DOES_NOT_EXIST 推奨されるロケーションが存在しません。
SPAM スパム、偽装、または不適切な場所が推奨されています。
NOT_A_BUSINESS おすすめの場所が私有地または私有地である。
MOVED

おすすめの場所が新しい場所に移転しました。

新しい住所を指定する report_reason_elaboration と一緒に指定する必要があります。

DUPLICATE おすすめのビジネス情報が別のビジネス情報と重複しています。

BadRecommendationReason

おすすめ情報の品質に問題がある場合(この場所がユーザーにおすすめされている場合)、ビジネスを報告する理由として考えられるもの。

列挙型
BAD_RECOMMENDATION_REASON_UNSPECIFIED 指定されていません。
NOT_A_STORE_FRONT 推奨される場所が店舗ではありません。
NOT_PART_OF_SUGGESTED_CHAIN

おすすめのビジネスが、返されたビジネスの chain_display_name で提案されたチェーンに属していません。

正しいチェーンの名前を指定する report_reason_elaboration も添付する必要があります。

IRRELEVANT

おすすめの場所とユーザーに関連性がありません。

推奨事項が無関係である理由を示す report_reason_elaboration も添付する必要があります。

ReportLocalPostInsightsRequest

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

フィールド
name

string

必須。インサイトを取得するビジネスの名前。

local_post_names[]

string

必須。インサイト データを取得する投稿のリスト。すべての投稿は、name フィールドで名前が指定されているビジネスに属している必要があります。

basic_request

BasicMetricsRequest

基本的な指標の分析情報をレポートに含めるためのリクエスト。このリクエストは、リクエストされたすべての投稿に適用されます。

ReportLocalPostInsightsResponse

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

フィールド
name

string

local_post_metrics[]

LocalPostMetrics

このビジネスに対応する、リクエストされた投稿ごとに 1 つのエントリ。

time_zone

string

ビジネスのタイムゾーン(「Europe/London」などの IANA タイムゾーン ID)です。

ReportLocationInsightsRequest

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

フィールド
name

string

アカウントのリソース名。

location_names[]

string

インサイトを取得するビジネスのコレクションで、名前で指定します。

basic_request

BasicMetricsRequest

基本的な指標の分析情報をレポートに含めるためのリクエスト。

driving_directions_request

DrivingDirectionMetricsRequest

運転ルート リクエストに関する分析情報をレポートに含めるためのリクエスト。

ReportLocationInsightsResponse

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

フィールド
location_metrics[]

LocationMetrics

ロケーション別の指標値のコレクション。

location_driving_direction_metrics[]

LocationDrivingDirectionMetrics

運転ルート関連の指標の値のコレクション。

確認

出力専用。ビジネスのクチコミを表します。

フィールド
name

string

リソース名。レビューの場合は accounts/{account_id}/locations/{location_id}/reviews/{review_id} の形式です。

review_id

string

暗号化された一意の識別子。

reviewer

Reviewer

レビューを書いた人です。

star_rating

StarRating

クチコミの評価です。

comment

string

マークアップ付きの書式なしテキストとしてのレビューの本文です。

create_time

Timestamp

クチコミが投稿されたときのタイムスタンプです。

update_time

Timestamp

クチコミが最後に変更されたときのタイムスタンプです。

review_reply

ReviewReply

このクチコミに対するビジネスのオーナーまたは管理者による返信です。

審査担当者

レビューの投稿者を表します。

フィールド
profile_photo_url

string

クチコミ投稿者のプロフィール写真へのリンクです。is_anonymous が false の場合にのみ入力されます。

display_name

string

クチコミ投稿者の名前です。is_anonymous が false の場合にのみクチコミ投稿者の実名が入力されます。

is_anonymous

bool

クチコミ投稿者が匿名のままにするよう設定しているかどうかを表します。

StarRating

5 段階中の評価です。最高評価が 5 です。

列挙型
STAR_RATING_UNSPECIFIED 指定されていません。
ONE 最高で星 5 つのうちの 1 つ星です。
TWO 最高で星 5 つのうちの 2 つ星です。
THREE 最高で星 5 つのうちの 3 つ星です。
FOUR 最高で星 5 つのうちの 4 つ星です。
FIVE 最高評価です。

ReviewReply

クチコミに対するビジネスのオーナーまたは管理者による返信を表します。

フィールド
comment

string

マークアップ付きの書式なしテキストとしての返信の本文。最大長は 4,096 バイトです。

update_time

Timestamp

出力専用。返信が最後に変更されたときのタイムスタンプです。

SearchChainsRequest

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

フィールド
chain_display_name

string

チェーン名でチェーンを検索します。完全一致クエリ、部分クエリ、ファジークエリ、関連クエリがサポートされています。例: "walmart"、"wal-mart"、"walmmmart"、"ウォルマート"

result_count

int32

このクエリから返される一致チェーンの最大数。デフォルト値は 10 です。指定できる最大値は 500 です。

SearchChainsResponse

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

フィールド
chains[]

Chain

SearchChainsRequest でクエリされた chain_display_name に一致するチェーン。一致するものがない場合、このフィールドは空になります。検索結果は関連性の高い順に表示されます。

SearchGoogleLocationsRequest

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

フィールド
result_count

int32

返される一致の数です。デフォルト値は 3 で、最大値は 10 です。リクエストされる回数が多いと、レイテンシが増加する可能性があるので注意してください。ページ分けはありません。

共用体フィールド search_query。検索語句。これは、location オブジェクトまたは文字列クエリとして指定できます。search_query は次のいずれかになります。
location

Location

検索する場所。指定すると、指定した場所の詳細に一致する場所が検出されます。

query

string

検索するテキストクエリ。クエリ文字列による検索結果は、正確な位置情報を指定した場合よりも精度は落ちますが、完全一致しないケースは多くなります。

SearchGoogleLocationsResponse

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

フィールド
google_locations[]

GoogleLocation

指定されたリクエストと一致する可能性のある GoogleLocations のコレクション。精度の高い順に一覧表示されます。

ServiceAreaBusiness

非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです(鍵業者や配管業者など)。

フィールド
business_type

BusinessType

非店舗型ビジネスの type を示します。

共用体フィールド coverageArea。ビジネスがサービスを提供する対象範囲を示します。coverageArea は次のいずれかになります。
radius

PointRadius

出力専用。このビジネスがサービスを提供する地域を、中心からの半径で表します。

places

Places

このビジネスがサービスを提供する地域を、場所のセットで定義します。

BusinessType

このビジネスが、顧客の場所(レッカー車など)でオンサイトでのみサービスを提供するのか、住所とオンサイトの両方でサービスを提供するのか(食事も宅配も行うピザ店など)を示します。

列挙型
BUSINESS_TYPE_UNSPECIFIED 出力専用。指定されていません。
CUSTOMER_LOCATION_ONLY ビジネス拠点がある住所ではなく、周辺地域でのみサービスを提供します。
CUSTOMER_AND_BUSINESS_LOCATION ビジネス拠点の住所とその周辺地域でサービスを提供します。

ServiceBusinessContext

サービス ビジネスのオーナー確認のための追加データ。

フィールド
address

PostalAddress

ビジネスのオーナー確認用の住所。他のオーナー確認方法を有効にしたり、ハガキを郵送したりするために使用します。

ServiceList

1 つ以上のサービス項目を含むサービスリスト。

フィールド
name

string

必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/serviceList です。

service_items[]

ServiceItem

このサービスリストに含まれるサービス アイテム。重複するサービス アイテムは自動的に削除されます。

ServiceItem

1 つのサービス アイテムを説明するメッセージ。販売者が提供しているサービスの種類を記述するために使用されます。たとえば、ヘアカットはサービスの一例です。

フィールド
is_offered

bool

省略可。このフィールドは、販売者が入力サービスを提供するかどうかを決定します。

price

Money

省略可。サービス アイテムの金額を表します。価格を含める場合は、currency_code と unit を設定することをおすすめします。

共用体フィールド service_item_info。次のいずれかのフィールドを必ず設定する必要があります。service_item_info は次のいずれかになります。
structured_service_item

StructuredServiceItem

このフィールドは、構造化サービスデータの大文字と小文字を設定します。

free_form_service_item

FreeFormServiceItem

このフィールドは、自由形式のサービスデータの大文字 / 小文字が設定されます。

FreeFormServiceItem

販売者が提供している自由形式のサービスを表します。これらは、Google の構造サービスデータの一部として公開されないサービスです。販売者は、地理上の販売者サーフェスからそのようなサービスの名前を手動で入力します。

フィールド
category_id

string

必須。category_idservice_type_id は、Category メッセージで指定されている可能な組み合わせと一致している必要があります。

label

Label

必須。商品アイテムの言語タグ付きのラベルです。商品アイテム名は半角 140 文字(全角 70 文字)、説明は半角 250 文字(全角 125 文字)以下にすることをおすすめします。このフィールドは、入力がカスタム サービス項目である場合にのみ設定する必要があります。標準化されたサービスタイプは service_type_id で更新する必要があります。

StructuredServiceItem

販売者が提供する構造化サービスを表します。例: toilet_installation

フィールド
service_type_id

string

必須。service_type_id フィールドは Google 提供の一意の ID で、ServiceTypeMetadata で確認できます。この情報は、BatchGetBusinessCategories rpc サービスによって提供されます。

description

string

省略可。構造化サービス項目の説明。最大文字数は 300 文字です。

ServiceType

ビジネスが提供するサービスタイプを説明するメッセージ。

フィールド
service_type_id

string

出力専用。このサービスタイプの固定 ID(Google 提供)。

display_name

string

出力専用。人が読める形式のサービスタイプの表示名。

SpecialHourPeriod

ビジネスの営業時間が通常の営業時間と異なる単一の期間を表します。特別営業時間の期間は 24 時間未満で指定してください。open_timestart_date は、close_timeend_date より前の日付にする必要があります。close_timeend_date は、指定した start_date の翌日の午前 11 時 59 分まで延長できます。たとえば、次の入力は有効です。

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

次の入力は無効です。

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
フィールド
start_date

Date

この特別営業時間が始まる日付です。

open_time

string

開店時の start_date の経過時間です。24 時間の ISO 8601 拡張形式で表されます。有効な値は 00:00 ~ 24:00 です。24:00 は、曜日フィールドで指定した日が終了する深夜 0 時を表します。is_closed が false の場合は指定する必要があります。

end_date

Date

この特別営業時間が終了する日付です。end_date フィールドが設定されていない場合、デフォルトは start_date で指定した日付になります。設定する場合は、start_date と同じ日か翌日を指定する必要があります。

close_time

string

閉店時の end_date の経過時間です。24 時間の ISO 8601 拡張形式で表されます。有効な値は 00:00 ~ 24:00 です。24:00 は、曜日フィールドで指定した日が終了する深夜 0 時を表します。is_closed が false の場合は指定する必要があります。

is_closed

bool

true の場合、end_dateopen_timeclose_time は無視され、start_date で指定した日付は、ビジネスが終日休業する日として扱われます。

SpecialHours

ビジネスの営業時間が通常の営業時間と異なる一連の期間を表します。

フィールド
special_hour_periods[]

SpecialHourPeriod

ビジネスの通常の営業時間に対する例外の一覧です。

辛さ

食品の辛さレベル。

列挙型
SPICINESS_UNSPECIFIED レベルが指定されていません
MILD やや辛みの効いた表現。
MEDIUM 中程度の辛さを表す表現。
HOT 辛いことを表す言葉。最も辛いレベル。

StartUploadMediaItemDataRequest

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

フィールド
parent

string

このメディア アイテムを追加するビジネスのリソース名です。

TimeInterval

時間間隔(この値を含む)。有効なすべてのフィールドが含まれている必要があります。

フィールド
start_date

Date

この期間の開始日です。

start_time

TimeOfDay

この期間の開始時間です。

end_date

Date

この期間の終了日です。

end_time

TimeOfDay

この期間の終了時間です。

TimePeriod

ビジネスが営業している期間を表します。指定した営業開始日時から始まり、指定した営業終了日時で終わります。営業終了時間は、営業開始時間の後、たとえば同じ日の後の時間か翌日に設定する必要があります。

フィールド
open_day

DayOfWeek

この期間が始まる day of the week を示します。

open_time

string

24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。

close_day

DayOfWeek

この期間が終了する day of the week を示します。

close_time

string

24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。

TimeRange

期間。範囲のデータは、半開間隔([start_time, end_time)] として pull されます。

フィールド
start_time

Timestamp

範囲の開始時点のエポック タイムスタンプ(両端を含む)。

end_time

Timestamp

範囲の終わりのエポック タイムスタンプ(その時間を含まない)。

TransferLocationRequest

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

フィールド
name

string

移管するビジネスの名前。

to_account

string

ビジネスの移管先となるアカウント リソースの名前(例: accounts/8675309)。

UpdateAccountAdminRequest

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

フィールド
name

string

更新する管理者のリソース名。

admin

Admin

更新された管理者。注: 編集可能なフィールドは role のみです。その他のフィールドはすべて無視されます。

UpdateAccountRequest

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

フィールド
name

string

更新するアカウントの名前です。

account

Account

更新されたアカウント情報。注: 編集可能なフィールドは account_name のみです。

validate_only

bool

true の場合、アカウントを実際に更新することなく、リクエストを検証します。

UpdateFoodMenusRequest

FoodMenu.UpdateFoodMenus に対するリクエスト メッセージ

フィールド
food_menus

FoodMenus

必須。更新されたフードメニューの情報。メニュー セクションなしで更新することで、Menu の設定を解除できます。

update_mask

FieldMask

省略可。更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエスト内の設定解除された空のフィールドも含まれる場合があります。繰り返しフィールドの項目は、個別に更新できません。注: 「name」of FoodMenus はリソース ID で、更新できません。

UpdateHealthProviderAttributesRequest

HealthProviderAttributes.UpdateHealthProviderAttributes に対するリクエスト メッセージ

フィールド
health_provider_attributes

HealthProviderAttributes

必須。更新されたヘルスプロバイダの属性。

update_mask

FieldMask

省略可。更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエスト内の設定解除された空のフィールドも含まれる場合があります。V1 では、更新の対象となるのは insurance_networks フィールドのみです。その他の属性は、今後サポートされる予定です。

UpdateLocalPostRequest

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

フィールド
name

string

更新するローカル投稿の名前です。

local_post

LocalPost

更新されたローカル投稿の情報。

update_mask

FieldMask

更新するフィールドです。マスクで更新する各フィールドを指定する必要があります。

UpdateLocationAdminRequest

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

フィールド
name

string

更新する管理者のリソース名。

admin

Admin

更新された管理者。注: 編集可能なフィールドは role のみです。その他のフィールドはすべて無視されます。

UpdateLocationRequest

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

フィールド
name

string

更新するビジネスの名前です。

location

Location

更新されたビジネスの情報です。

update_mask

FieldMask

更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエスト内の設定解除された空のフィールドも含まれる場合があります。

validate_only

bool

true の場合、ビジネスが実際に更新されることなく、リクエストの検証のみが行われます。

attribute_mask

FieldMask

更新する属性の ID。マスクで指定した属性のみが更新されます。マスクにのみ含まれ、ビジネスには含まれない属性は削除されます。マスクを空にすると、すべての属性が更新されます。

このフィールドを設定する場合は常に、update_mask に、更新するフィールドの 1 つとして属性を含める必要があります。

UpdateMediaItemRequest

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

フィールド
name

string

更新するメディア アイテムの名前です。

media_item

MediaItem

更新するメディア アイテムです。

更新できるのは、カテゴリ ID または価格表アイテム ID のみです。

update_mask

FieldMask

更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、編集可能なすべてのフィールドは渡された値に設定されます。

UpdateNotificationsRequest

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

フィールド
name

string

通知設定のリソース名。

notifications

Notifications

更新された通知設定。

UpdateQuestionRequest

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

フィールド
name

string

更新する質問の名前。

question

Question

更新された質問。

UpdateReviewReplyRequest

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

フィールド
name

string

返信するクチコミの名前です。

review_reply

ReviewReply

クチコミへの返信です。返信がすでに存在する場合は、古い返信と置き換えられます。

UpdateServiceListRequest

サービスリスト更新リクエスト メッセージ。

フィールド
service_list

ServiceList

省略可。更新されたサービスリストの情報。このフィールドを空のままにすると、API によって ServiceList が削除されます。ServiceList が設定されている場合、API は元の ServiceList を設定された ServiceList に置き換えます。

update_mask

FieldMask

省略可。更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエスト内の設定解除された空のフィールドも含まれる場合があります。繰り返しフィールドの項目は、個別に更新できません。

UpsertAnswerRequest

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

フィールド
parent

string

回答を作成する質問の名前。

answer

Answer

新しい回答。

UrlAttributeValue

URL が value_type である属性の値。

フィールド
url

string

URL。

ValidationError

クライアント リクエストの検証エラーについて説明します。

フィールド
error_details[]

ErrorDetail

個々の検証エラーを整数のエラーコードで詳細に説明します。

確認

オーナー確認とは、ビジネスでオーナー確認を試みたことを指します。

フィールド
name

string

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

method

VerificationMethod

オーナー確認の方法。

state

VerificationState

オーナー確認のステータス。

create_time

Timestamp

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

VerificationState

オーナー確認のステータスがすべて表示されます。

列挙型
VERIFICATION_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 ユーザーによる追加の操作なしでビジネスのオーナー確認を行ってください。このオプションは、地域によってはご利用いただけない場合があります。

VerificationOption

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

フィールド
verification_method

VerificationMethod

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

共用体フィールド DisplayData。表示データの 1 つ。データはメソッドと一致する必要があります。対応するメソッドに表示データがない場合は空になります。DisplayData は次のいずれかになります。
phone_data

PhoneVerificationData

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

address_data

AddressVerificationData

メソッドが Mail の場合にのみ設定されます。

email_data

EmailVerificationData

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

AddressVerificationData

オーナー確認用のデータをハガキで表示します。

フィールド
business_name

string

販売者のビジネス名。

address

PostalAddress

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

EmailVerificationData

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

フィールド
domain_name

string

メールアドレスのドメイン名。例:&quot;gmail.com&quot;foo@gmail.com

user_name

string

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

is_user_name_editable

bool

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

PhoneVerificationData

電話によるオーナー確認のデータの表示(例:電話、SMS。

フィールド
phone_number

string

PIN の送付先の電話番号です。

VerifyLocationRequest

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

フィールド
name

string

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

method

VerificationMethod

確認方法

language_code

string

適格性の確認に使用する言語を表す BCP 47 言語コード。

context

ServiceBusinessContext

サービスのビジネスを確認するための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY の場合は必須です。住所確認の場合、その住所はハガキの発送に使用されます。他のメソッドの場合は、FetchVerificationOptions に渡されるメソッドと同じにする必要があります。他の種類のビジネス拠点に対して設定されている場合、INVALID_ARGUMENT がスローされます。

共用体フィールド RequestData。表示データに加え、特定の方法に関するユーザー入力データ。データはリクエストされたメソッドと一致している必要があります。データが必要ない場合は空欄のままにします。RequestData は次のいずれかになります。
email_input

EmailInput

EMAIL メソッドの入力。

address_input

AddressInput

ADDRESS メソッドの入力。

phone_input

PhoneInput

PHONE_CALL/SMS メソッドの入力

VerifyLocationResponse

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

フィールド
verification

Verification

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