索引
AccessControl
(インターフェース)(非推奨)Accounts
(インターフェース)(非推奨)BusinessCategories
(インターフェース)BusinessMessagingService
(インターフェース)Followers
(インターフェース)FoodMenuService
(インターフェース)GoogleLocations
(インターフェース)HealthProviderAttributesService
(インターフェース)Insights
(インターフェース)InsuranceNetworkService
(インターフェース)LocalPosts
(インターフェース)Locations
(インターフェース)Media
(インターフェース)QuestionsAndAnswers
(インターフェース)Reviews
(インターフェース)ServiceLists
(インターフェース)Verifications
(インターフェース)AcceptInvitationRequest
(メッセージ)Account
(メッセージ)(非推奨)Account.OrganizationInfo
(メッセージ)AccountRole
(列挙型)AccountState
(メッセージ)AccountState.AccountStatus
(列挙型)AccountType
(列挙型)AdWordsLocationExtensions
(メッセージ)AddressInput
(メッセージ)Admin
(メッセージ)Admin.AdminRole
(列挙型)AlertType
(列挙型)Allergen
(列挙型)Answer
(メッセージ)AssociateLocationRequest
(メッセージ)Attribute
(メッセージ)AttributeMetadata
(メッセージ)AttributeMetadata.AttributeValueMetadata
(メッセージ)AttributeValueType
(列挙型)Author
(メッセージ)Author.AuthorType
(列挙型)BasicMetricsRequest
(メッセージ)BatchGetBusinessCategoriesRequest
(メッセージ)BatchGetBusinessCategoriesResponse
(メッセージ)BatchGetLocationsRequest
(メッセージ)BatchGetLocationsResponse
(メッセージ)BatchGetReviewsRequest
(メッセージ)BatchGetReviewsResponse
(メッセージ)BusinessHours
(メッセージ)CallToAction
(メッセージ)CallToAction.ActionType
(列挙型)Category
(メッセージ)CategoryView
(列挙型)Chain
(メッセージ)Chain.ChainName
(メッセージ)Chain.ChainUrl
(メッセージ)ClearLocationAssociationRequest
(メッセージ)CompleteVerificationRequest
(メッセージ)CompleteVerificationResponse
(メッセージ)CreateAccountAdminRequest
(メッセージ)CreateAccountRequest
(メッセージ)CreateLocalPostRequest
(メッセージ)CreateLocationAdminRequest
(メッセージ)CreateLocationRequest
(メッセージ)CreateMediaItemRequest
(メッセージ)CreateQuestionRequest
(メッセージ)DeclineInvitationRequest
(メッセージ)DeleteAccountAdminRequest
(メッセージ)DeleteAnswerRequest
(メッセージ)DeleteLocalPostRequest
(メッセージ)DeleteLocationAdminRequest
(メッセージ)DeleteLocationRequest
(メッセージ)DeleteMediaItemRequest
(メッセージ)DeleteNotificationsRequest
(メッセージ)DeleteQuestionRequest
(メッセージ)DeleteReviewReplyRequest
(メッセージ)DietaryRestriction
(列挙型)DimensionalMetricValue
(メッセージ)DimensionalMetricValue.TimeDimension
(メッセージ)DrivingDirectionMetricsRequest
(メッセージ)DrivingDirectionMetricsRequest.NumDays
(列挙型)EmailInput
(メッセージ)ErrorDetail
(メッセージ)ErrorDetail.ErrorCode
(列挙型)FetchVerificationOptionsRequest
(メッセージ)FetchVerificationOptionsResponse
(メッセージ)FindMatchingLocationsRequest
(メッセージ)FindMatchingLocationsResponse
(メッセージ)FollowersMetadata
(メッセージ)FoodMenu
(メッセージ)FoodMenu.Cuisine
(列挙型)FoodMenuItem
(メッセージ)FoodMenuItemAttributes
(メッセージ)FoodMenuItemAttributes.Ingredient
(メッセージ)FoodMenuItemAttributes.PortionSize
(メッセージ)FoodMenuItemOption
(メッセージ)FoodMenuSection
(メッセージ)FoodMenus
(メッセージ)GenerateAccountNumberRequest
(メッセージ)GetAccountRequest
(メッセージ)GetChainRequest
(メッセージ)GetCustomerMediaItemRequest
(メッセージ)GetFollowersMetadataRequest
(メッセージ)GetFoodMenusRequest
(メッセージ)GetHealthProviderAttributesRequest
(メッセージ)GetLocalPostRequest
(メッセージ)GetLocationRequest
(メッセージ)GetMediaItemRequest
(メッセージ)GetNotificationsRequest
(メッセージ)GetReviewRequest
(メッセージ)GetServiceListRequest
(メッセージ)GoogleLocation
(メッセージ)GoogleUpdatedLocation
(メッセージ)HealthProviderAttributes
(メッセージ)InsuranceNetwork
(メッセージ)InternalError
(メッセージ)Invitation
(メッセージ)Invitation.TargetLocation
(メッセージ)ListAccountAdminsRequest
(メッセージ)ListAccountAdminsResponse
(メッセージ)ListAccountsRequest
(メッセージ)ListAccountsResponse
(メッセージ)ListAnswersRequest
(メッセージ)ListAnswersResponse
(メッセージ)ListAttributeMetadataRequest
(メッセージ)ListAttributeMetadataResponse
(メッセージ)ListBusinessCategoriesRequest
(メッセージ)ListBusinessCategoriesResponse
(メッセージ)ListCustomerMediaItemsRequest
(メッセージ)ListCustomerMediaItemsResponse
(メッセージ)ListInsuranceNetworksRequest
(メッセージ)ListInsuranceNetworksResponse
(メッセージ)ListInvitationsRequest
(メッセージ)ListInvitationsRequest.TargetType
(列挙型)ListInvitationsResponse
(メッセージ)ListLocalPostsRequest
(メッセージ)ListLocalPostsResponse
(メッセージ)ListLocationAdminsRequest
(メッセージ)ListLocationAdminsResponse
(メッセージ)ListLocationsRequest
(メッセージ)ListLocationsResponse
(メッセージ)ListMediaItemsRequest
(メッセージ)ListMediaItemsResponse
(メッセージ)ListQuestionsRequest
(メッセージ)ListQuestionsResponse
(メッセージ)ListRecommendedGoogleLocationsRequest
(メッセージ)ListRecommendedGoogleLocationsResponse
(メッセージ)ListReviewsRequest
(メッセージ)ListReviewsResponse
(メッセージ)ListVerificationsRequest
(メッセージ)ListVerificationsResponse
(メッセージ)LocalPost
(メッセージ)LocalPost.LocalPostState
(列挙型)LocalPostEvent
(メッセージ)LocalPostMetrics
(メッセージ)LocalPostOffer
(メッセージ)LocalPostTopicType
(列挙型)Location
(メッセージ)Location.Metadata
(メッセージ)Location.Metadata.Duplicate
(メッセージ)Location.Metadata.Duplicate.Access
(列挙型)Location.RelationshipData
(メッセージ)LocationDrivingDirectionMetrics
(メッセージ)LocationDrivingDirectionMetrics.TopDirectionSources
(メッセージ)LocationDrivingDirectionMetrics.TopDirectionSources.RegionCount
(メッセージ)LocationKey
(メッセージ)LocationMetrics
(メッセージ)LocationReview
(メッセージ)LocationState
(メッセージ)MatchedLocation
(メッセージ)MediaItem
(メッセージ)MediaItem.Attribution
(メッセージ)MediaItem.Dimensions
(メッセージ)MediaItem.LocationAssociation
(メッセージ)MediaItem.LocationAssociation.Category
(列挙型)MediaItem.MediaFormat
(列挙型)MediaItem.MediaInsights
(メッセージ)MediaItemDataRef
(メッセージ)MenuLabel
(メッセージ)Metric
(列挙型)MetricOption
(列挙型)MetricRequest
(メッセージ)MetricValue
(メッセージ)MoreHours
(メッセージ)MoreHoursType
(メッセージ)NetworkState
(列挙型)NotificationType
(列挙型)Notifications
(メッセージ)NutritionFacts
(メッセージ)NutritionFacts.CaloriesFact
(メッセージ)NutritionFacts.EnergyUnit
(列挙型)NutritionFacts.MassUnit
(列挙型)NutritionFacts.NutritionFact
(メッセージ)OpenInfo
(メッセージ)OpenInfo.OpenForBusiness
(列挙型)PermissionLevel
(列挙型)PhoneInput
(メッセージ)PlaceInfo
(メッセージ)Places
(メッセージ)PointRadius
(メッセージ)PreparationMethod
(列挙型)PriceList
(メッセージ)(非推奨)PriceList.Label
(メッセージ)PriceList.Section
(メッセージ)PriceList.Section.Item
(メッセージ)PriceList.Section.SectionType
(列挙型)Profile
(メッセージ)Question
(メッセージ)RepeatedEnumAttributeValue
(メッセージ)ReportGoogleLocationRequest
(メッセージ)ReportGoogleLocationRequest.BadLocationReason
(列挙型)ReportGoogleLocationRequest.BadRecommendationReason
(列挙型)ReportLocalPostInsightsRequest
(メッセージ)ReportLocalPostInsightsResponse
(メッセージ)ReportLocationInsightsRequest
(メッセージ)ReportLocationInsightsResponse
(メッセージ)Review
(メッセージ)Review.Reviewer
(メッセージ)Review.StarRating
(列挙型)ReviewReply
(メッセージ)SearchChainsRequest
(メッセージ)SearchChainsResponse
(メッセージ)SearchGoogleLocationsRequest
(メッセージ)SearchGoogleLocationsResponse
(メッセージ)ServiceAreaBusiness
(メッセージ)ServiceAreaBusiness.BusinessType
(列挙型)ServiceBusinessContext
(メッセージ)ServiceList
(メッセージ)ServiceList.ServiceItem
(メッセージ)ServiceList.ServiceItem.FreeFormServiceItem
(メッセージ)ServiceList.ServiceItem.StructuredServiceItem
(メッセージ)ServiceType
(メッセージ)SpecialHourPeriod
(メッセージ)SpecialHours
(メッセージ)Spiciness
(列挙型)StartUploadMediaItemDataRequest
(メッセージ)TimeInterval
(メッセージ)TimePeriod
(メッセージ)TimeRange
(メッセージ)TransferLocationRequest
(メッセージ)UpdateAccountAdminRequest
(メッセージ)UpdateAccountRequest
(メッセージ)UpdateFoodMenusRequest
(メッセージ)UpdateHealthProviderAttributesRequest
(メッセージ)UpdateLocalPostRequest
(メッセージ)UpdateLocationAdminRequest
(メッセージ)UpdateLocationRequest
(メッセージ)UpdateMediaItemRequest
(メッセージ)UpdateNotificationsRequest
(メッセージ)UpdateQuestionRequest
(メッセージ)UpdateReviewReplyRequest
(メッセージ)UpdateServiceListRequest
(メッセージ)UpsertAnswerRequest
(メッセージ)UrlAttributeValue
(メッセージ)ValidationError
(メッセージ)Verification
(メッセージ)Verification.VerificationState
(列挙型)VerificationMethod
(列挙型)VerificationOption
(メッセージ)VerificationOption.AddressVerificationData
(メッセージ)VerificationOption.EmailVerificationData
(メッセージ)VerificationOption.PhoneVerificationData
(メッセージ)VerifyLocationRequest
(メッセージ)VerifyLocationResponse
(メッセージ)
AccessControl
このサービスを使用すると、アカウントとビジネス情報にアクセスできるユーザーを管理できます。
AcceptInvitation | |
---|---|
指定した招待を承諾します。
|
CreateAccountAdmin | |
---|---|
指定したユーザーを、指定したアカウントの管理者として招待します。招待者がアカウントへのアクセス権を付与するには、招待を承諾する必要があります。プログラムで招待を承諾する方法については、[AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] をご覧ください。
|
CreateLocationAdmin | |
---|---|
指定したユーザーを、指定したビジネスの管理者として招待します。ビジネスへのアクセス権限を得るには、この招待状を受け入れる必要があります。プログラムで招待を承諾する方法については、[AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] をご覧ください。
|
DeclineInvitation | |
---|---|
指定した招待を辞退します。
|
DeleteAccountAdmin | |
---|---|
指定したアカウントから指定した管理者を削除します。
|
DeleteLocationAdmin | |
---|---|
指定したビジネスの管理者に指定した Admin を削除します。
|
ListAccountAdmins | |
---|---|
指定したアカウントの管理者を一覧表示します。
|
ListInvitations | |
---|---|
指定したアカウントで保留中の招待を一覧表示します。
|
ListLocationAdmins | |
---|---|
指定したビジネスのすべての管理者を一覧表示します。
|
UpdateAccountAdmin | |
---|---|
指定したアカウント管理者の Admin を更新します。更新できるのは管理者の AdminRole のみです。
|
UpdateLocationAdmin | |
---|---|
指定したビジネス情報の管理者について、Admin を更新します。更新できるのは管理者の AdminRole のみです。
|
アカウント
この API を使用すると、Google でビジネス アカウントを管理することができます。Account
リソースを管理できます。以下のリソースモデルを定義します。
API には、
accounts/*
という名前のAccount
リソースのコレクションがあります。認証された発信者の個人アカウントには、アカウント ID の代わりに「me」という類義語を使用できます。例: GET /v4/accounts/me GET /v4/accounts/me/locations
CreateAccount | |
---|---|
指定された親の下に、指定された名前とタイプでアカウントを作成します。
|
DeleteNotifications | |
---|---|
アカウントの Pub/Sub 通知設定を消去します。
|
GenerateAccountNumber | |
---|---|
このアカウントのアカウント番号を生成します。アカウント番号は、アカウントの作成時に提供されません。アカウント番号が必要な場合は、このリクエストを使用します。
|
GetAccount | |
---|---|
指定されたアカウントを取得します。アカウントが存在しない場合、または呼び出し元にアカウントへのアクセス権がない場合は、
|
GetNotifications | |
---|---|
アカウントの Pub/Sub 通知設定を返します。
|
ListAccounts | |
---|---|
認証されたユーザーのすべてのアカウントを一覧表示します。これには、ユーザーが所有するすべてのアカウントと、ユーザーが管理権限を持つすべてのアカウントが含まれます。
|
UpdateAccount | |
---|---|
指定したビジネス アカウントを更新します。この方法で個人アカウントを更新することはできません。
|
UpdateNotifications | |
---|---|
アカウントの Pub/Sub 通知設定を設定して、Pub/Sub 通知を送信するトピックをビジネス プロフィールに指定します。
各アカウントで使用できる通知設定リソースは 1 つだけです。また、設定できる Pub/Sub トピックは 1 つのみです。
|
BusinessCategories
この API を使用すると、Google においてビジネス拠点でサポートされているカテゴリを表示できます。利用可能なすべての業種の一覧をページ分けして表示したり、特定の語句で検索したりできます。詳しくは、こちらの記事(https://support.google.com/business/answer/3038177)のカテゴリに関するセクションをご覧ください。
BatchGetBusinessCategories | |
---|---|
指定された言語と GConcept ID に対応するビジネス カテゴリのリストを返します。
|
ListBusinessCategories | |
---|---|
業種のリストを返します。検索はカテゴリ名と一致しますが、カテゴリ ID とは一致しません。
|
BusinessMessagingService
店舗を Business Messaging に登録して、店舗を検索する消費者とのコミュニケーション チャネルを作成できます。ビジネスのビジネス メッセージに対する操作を表示、実行するには、ビジネスの MANAGER
または OWNER
である必要があります。
フォロワー
この API は、フォロワーの管理 API を公開します。
GetFollowersMetadata | |
---|---|
ビジネスのフォロワー設定を取得します。 アカウントまたはビジネスが存在しない場合は、NOT_FOUND が返されます。ビジネスのオーナー確認が行われていない場合や、マップに関連付けられていない場合は、PRECONDITION_FAILED が返されます。
|
FoodMenuService
この API を使って、ビジネス拠点のフードメニューを取得、更新できます。
Location.PriceList も、「メニュー」をタイプの一つで表しますが、フィールドが限られています。FoodMenus と同じダウンストリーム ストレージを共有します。FoodMenuService への移行が完了したら、Location.PriceList を使用してメニューデータを更新することを強くおすすめします。これにより、予期しないデータ損失が発生する可能性があります。
GetFoodMenus | |
---|---|
特定の場所のフードメニューを返します。location.location_state.can_have_food_menu が true の場合にのみ呼び出します。
|
UpdateFoodMenus | |
---|---|
特定の場所のフードメニューを更新します。location.location_state.can_have_food_menu が true の場合にのみ呼び出します。
|
GoogleLocations
この API は、GoogleLocation
へのアクセスと検索を許可します。
ListRecommendedGoogleLocations | |
---|---|
指定したビジネス プロフィール アカウントにおすすめされたすべての 個人アカウントに関する推奨事項は、ユーザーがビジネス プロフィールでアクセス権を持っているすべてのビジネス情報(ビジネス グループを通じてアクセスできるビジネス情報を含む)に基づいており、このユーザーに対して生成されるすべての推奨事項のスーパーセットです。
|
ReportGoogleLocation | |
---|---|
|
SearchGoogleLocations | |
---|---|
指定したリクエストに一致する可能性のあるすべてのビジネスを検索します。
|
HealthProviderAttributesService
このサービスでは、場所に関連付けられた医療従事者の属性(場所が受け入れている保険など)を管理できます。
GetHealthProviderAttributes | |
---|---|
特定の場所の医療従事者属性を返します。
|
UpdateHealthProviderAttributes | |
---|---|
特定の場所の医療機関の属性を更新します。
|
インサイト
Google サービスの 1 つ以上のリスティングについて、消費者インサイトの詳細を含むレポートを生成します。基本指標の集計データは、最長で 18 か月前についてクエリできます。内訳をサポートする指標では、この範囲の集計データを曜日または時間別に表示できます。運転ルートのリクエストは、指定した期間におけるスナップショットで報告できます。
ReportLocalPostInsights | |
---|---|
単一のリスティングに関連付けられている一連のローカル投稿の分析情報を返します。指標とその報告方法は、リクエスト プロトコルで指定されるオプションです。
|
ReportLocationInsights | |
---|---|
1 つ以上の指標に関する分析情報を含むレポートを返します。
|
InsuranceNetworkService
このサービスを使用すると、Google 上の医療関連ビジネスのロケーションでサポートされているすべての保険ネットワークを取得できます。
ListInsuranceNetworks | |
---|---|
Google がサポートするすべての保険ネットワークのリストを返します。
|
LocalPosts
この API は、ローカル投稿の管理 API を公開します。
CreateLocalPost | |
---|---|
指定したビジネスに関連付けられた新しいローカル投稿を作成して返します。
|
DeleteLocalPost | |
---|---|
ローカル投稿を削除します。ローカル投稿が存在しない場合は
|
GetLocalPost | |
---|---|
指定したローカル投稿を取得します。ローカル投稿が存在しない場合は
|
ListLocalPosts | |
---|---|
ビジネスに関連付けられているローカル投稿のリストを返します。
|
UpdateLocalPost | |
---|---|
指定したローカル投稿を更新し、更新されたローカル投稿を返します。
|
場所
この API を使用すると、Google でビジネス情報を管理できます。Location
リソースを管理できます。以下のリソースモデルを定義します。
AssociateLocation | |
---|---|
ビジネスをプレイス ID に関連付けます。以前の関連付けはすべて上書きされます。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。関連付けが有効である(
|
BatchGetLocations | |
---|---|
指定されたアカウントの指定されたすべてのビジネスを取得します。
|
ClearLocationAssociation | |
---|---|
ビジネスとそのプレイス ID の関連付けを解除します。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。
|
CreateLocation | |
---|---|
指定されたアカウントによって所有される新しい
|
DeleteLocation | |
---|---|
ビジネスを削除します。 |
FindMatchingLocations | |
---|---|
指定したビジネスに一致する可能性のあるすべてのビジネスを検索します。この操作は、ビジネスのオーナー確認が済んでいない場合にのみ有効です。
|
GetChain | |
---|---|
指定されたチェーンを取得します。チェーンが存在しない場合は
|
GetGoogleUpdatedLocation | |
---|---|
指定したビジネスの Google によって更新されたバージョンを取得します。ビジネスが存在しない場合は
|
GetLocation | |
---|---|
指定されたビジネスを取得します。ビジネスが存在しない場合は
|
ListAttributeMetadata | |
---|---|
指定したメインカテゴリと国のビジネスで使用可能な属性のリストを返します。
|
ListLocations | |
---|---|
指定したアカウントのビジネスを一覧表示します。
|
SearchChains | |
---|---|
チェーン名に基づいてチェーンを検索します。
|
TransferLocation | |
---|---|
ユーザーが所有するアカウントから、同じユーザーが管理する別のアカウントにビジネスを移動します。ユーザーは、ビジネスが現在関連付けられているアカウントの所有者であり、少なくとも移行先のアカウントの管理者である必要があります。新しいリソース名でビジネスを返します。
|
UpdateLocation | |
---|---|
指定したビジネスを更新します。 Google+ ページがあるビジネスでのみ写真を使用できます。 ビジネスが存在しない場合は
|
Media
ビジネス情報とリンクしたメディア(写真や動画)を管理できます。
CreateMediaItem | |
---|---|
ビジネスの新しいメディア アイテムを作成します。
|
DeleteMediaItem | |
---|---|
指定したメディア アイテムを削除します。
|
GetCustomerMediaItem | |
---|---|
リクエストされた顧客メディア アイテムのメタデータを返します。
|
GetMediaItem | |
---|---|
リクエストされたメディア アイテムのメタデータを返します。
|
ListCustomerMediaItems | |
---|---|
顧客から提供されたビジネスに関連付けられているメディア アイテムのリストを返します。
|
ListMediaItems | |
---|---|
ビジネスに関連付けられているメディア アイテムのリストを返します。
|
StartUploadMediaItemData | |
---|---|
メディア アイテムをアップロードするための
|
UpdateMediaItem | |
---|---|
指定したメディア アイテムのメタデータを更新します。メディア アイテムのカテゴリを更新する場合にのみ使用できます。ただし、新しいカテゴリを COVER または PROFILE にすることはできません。
|
QuestionsAndAnswers
このサービスを使って、ビジネスに関する質問と回答を管理できます。質問と回答の操作は、オーナー確認済みのビジネス拠点でのみ有効です。
CreateQuestion | |
---|---|
指定したビジネスに質問を追加します。
|
DeleteAnswer | |
---|---|
現在のユーザーが質問に対して作成した回答を削除します。
|
DeleteQuestion | |
---|---|
現在のユーザーが書いた特定の質問を削除します。
|
ListAnswers | |
---|---|
指定した質問に対する回答をページ分けしたリストを返します。
|
ListQuestions | |
---|---|
指定したビジネスに関する質問とその回答の一部について、ページ分けされたリストを返します。
|
UpdateQuestion | |
---|---|
現在のユーザーが書いた特定の質問を更新します。
|
UpsertAnswer | |
---|---|
指定した質問に対して回答を作成するか、ユーザーが記述した既存の回答を更新します。1 つの質問に対して作成できる回答は 1 つのみです。
|
クチコミ
この API は、クチコミの CRUD オペレーションを提供します。google.mybusiness.v4.Reviews
.
BatchGetReviews | |
---|---|
指定したすべてのビジネスについて、ページ分けされたクチコミのリストを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。
|
DeleteReviewReply | |
---|---|
指定したクチコミへの返信を削除します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。
|
GetReview | |
---|---|
指定したクチコミを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。クチコミが存在しないか削除されている場合は、
|
ListReviews | |
---|---|
指定したビジネスに対するクチコミのページ化されたリストを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。
|
UpdateReviewReply | |
---|---|
指定したクチコミへの返信を更新します。返信が存在しない場合は返信が作成されます。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。
|
ServiceLists
この API を使用すると、オペレーションは Google 上のビジネス拠点のサービスリストを取得して更新できます。サービスリストには、販売者が提供しているサービスであるサービス アイテムのリストが含まれます。サービスには、カットや給湯器の設置などがあります。
GetServiceList | |
---|---|
ビジネスの指定されたサービスリストを取得します。
|
UpdateServiceList | |
---|---|
ビジネスの指定されたサービスリストを更新します。
|
許認可
この API を使用すると、Google でのビジネスのオーナー確認を管理できます。Verification
リソースを管理できます。
各 Location
には、accounts/*/locations/*/verifications/*
という名前の Verification
リソースのコレクションがあります。
CompleteVerification | |
---|---|
|
FetchVerificationOptions | |
---|---|
ビジネスで有効なオーナー確認オプションをすべて特定の言語でレポートします。
|
ListVerifications | |
---|---|
ビジネスのオーナー確認を、作成時間順に一覧表示します。
|
VerifyLocation | |
---|---|
ビジネスのオーナー確認プロセスを開始します。
|
AcceptInvitationRequest
AccessControl.AcceptInvitation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
承認される招待の名前。 |
アカウント
アカウントは、ビジネス拠点を保存するためのコンテナです。ビジネス用のビジネス情報を管理しているユーザーがお客様のみの場合は、個人の Google アカウントを使用できます。複数のユーザーと共同でビジネス情報を管理するには、ビジネス アカウントを作成します。
フィールド | |
---|---|
name |
リソース名( |
account_name |
アカウントの名前。 |
type |
出力のみ。このアカウントの |
role |
出力のみ。呼び出し元がこのアカウントに対して持つ |
state |
出力のみ。このアカウントの |
account_number |
アカウントの参照番号(プロビジョニングされている場合)。 |
permission_level |
出力のみ。呼び出し元がこのアカウントに対して持つ |
organization_info |
組織に関する追加情報。組織アカウントにのみ入力されます。 |
OrganizationInfo
組織について保存されている追加情報。
フィールド | |
---|---|
registered_domain |
アカウントの登録済みドメイン。 |
postal_address |
アカウントの住所。 |
phone_number |
組織の連絡先電話番号。 |
AccountRole
認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。詳しくは、ヘルプセンターの記事をご覧ください。
列挙型 | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED |
指定されていません。 |
OWNER |
このアカウントはユーザーが所有しています。(UI では「メインのオーナー」として表示されます)。 |
CO_OWNER |
このアカウントの共同所有者である。(UI に「オーナー」と表示されます)。 |
MANAGER |
このユーザーはこのアカウントを管理できます。 |
COMMUNITY_MANAGER |
アカウントのソーシャル(Google+)ページを管理できます。(管理画面では「サイト管理者」と表示されます)。 |
AccountState
アカウントが Google によって確認済みかどうかなど、アカウントのステータスを示します。
フィールド | |
---|---|
status |
オーナー確認が完了すると、今後作成されるビジネス情報は自動的に Google マップに接続され、管理を必要とすることなく Google+ ページが作成されます。 |
AccountStatus
アカウントの確認ステータスを示します。
列挙型 | |
---|---|
ACCOUNT_STATUS_UNSPECIFIED |
指定されていません。 |
VERIFIED |
確認済みのアカウント。 |
UNVERIFIED |
確認が済んでおらず、確認がリクエストされていないアカウントです。 |
VERIFICATION_REQUESTED |
確認がリクエストされたものの、確認は済んでいないアカウント。 |
AccountType
アカウントの種類(個人用/ユーザー アカウント、ビジネス アカウント)を示します。
列挙型 | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED |
指定されていません。 |
PERSONAL |
エンドユーザー アカウント。 |
LOCATION_GROUP |
ビジネスのグループ。詳しくは、ヘルプセンターの記事をご覧ください。 |
USER_GROUP |
組織のスタッフをグループに分けるためのユーザー グループ。詳しくは、ヘルプセンターの記事をご覧ください。 |
ORGANIZATION |
会社を表す組織。詳しくは、ヘルプセンターの記事をご覧ください。 |
AdWordsLocationExtensions
AdWords に表示される追加情報。
フィールド | |
---|---|
ad_phone |
ビジネスのメインの電話番号の代わりに AdWords の住所表示オプションに表示される予備の電話番号です。 |
AddressInput
住所確認の入力です。
フィールド | |
---|---|
mailer_contact_name |
メールの送信先の担当者名。 |
管理者
フィールド | |
---|---|
name |
リソース名。アカウント管理者の場合は、 ビジネス管理者の場合は、 |
admin_name |
管理者の名前。これが、最初の招待を作成する招待者のメールアドレスです。招待が保留中の場合、 |
role |
この管理者が、指定した |
pending_invitation |
出力のみ。この管理者が、指定したリソースへの招待を保留にしているかどうかを表します。 |
AdminRole
管理者が持っているアクセスレベルを示します。詳しくは、ヘルプセンターの記事をご覧ください。
列挙型 | |
---|---|
ADMIN_ROLE_UNSPECIFIED |
指定されていません。 |
OWNER |
管理者はオーナー レベルのアクセス権を持ち、メインのオーナーです。(UI では「メインのオーナー」として表示されます)。 |
CO_OWNER |
オーナー アクセス権限を持っています。(UI に「オーナー」と表示されます)。 |
MANAGER |
管理者アクセス権限を持っています。 |
COMMUNITY_MANAGER |
この管理者はソーシャル(Google+)ページを管理できます。(管理画面では「サイト管理者」と表示されます)。 |
AlertType
アラート投稿が作成されたイベントの種類。
列挙型 | |
---|---|
ALERT_TYPE_UNSPECIFIED |
アラートが指定されていません。 |
COVID_19 |
2019 年の COVID-19(新型コロナウイルス感染症)のパンデミックに関連するアラート。COVID-19 に関する投稿では、概要フィールドと行動を促すフレーズのフィールドのみがサポートされています。これらのアラートの関連性がなくなると、COVID-19 に関するアラートの投稿を新たに作成できなくなります。ただし、ビジネス オーナーは引き続き既存の COVID-19 に関する投稿を管理できます。 |
アレルゲン
食品に関するアレルゲン情報。
列挙型 | |
---|---|
ALLERGEN_UNSPECIFIED |
アレルゲンの指定なし |
DAIRY |
乳製品関連アレルゲン |
EGG |
卵関連アレルゲン |
FISH |
魚介アレルゲン |
PEANUT |
ピーナッツ関連アレルゲン |
SHELLFISH |
貝類関連アレルゲン |
SOY |
大豆関連アレルゲン |
TREE_NUT |
木の実関連アレルゲン |
WHEAT |
小麦関連アレルゲン |
正解
質問に対する回答を表します。
フィールド | |
---|---|
name |
出力のみ。回答の一意の名前 accounts/*/locations/*/questions/*/answers/* |
author |
出力のみ。回答者。 |
upvote_count |
出力のみ。回答に対する賛成票の数。 |
text |
回答のテキスト。空白文字以外の文字を少なくとも 1 つ含める必要があります。最大文字数は 4,096 文字です。 |
create_time |
出力のみ。回答が作成されたときのタイムスタンプ。 |
update_time |
出力のみ。回答が最後に変更されたときのタイムスタンプです。 |
AssociateLocationRequest
Locations.AssociateLocationRequest に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
関連付けるビジネスのリソース名です。 |
place_id |
確立する関連付け。設定されていない場合は、一致がないことを示します。 |
属性
ビジネスの属性です。属性は、ビジネスに関する追加情報を提供します。ビジネスに設定できる属性は、そのビジネスのプロパティ(カテゴリなど)によって異なります。使用可能な属性は Google によって決定され、API の変更なしに追加、削除される場合があります。
フィールド | |
---|---|
attribute_id |
属性の ID です。属性 ID は Google によって提供されます。 |
value_type |
出力のみ。この属性に含まれる値の型です。これを使用して、値の解釈方法を決定する必要があります。 |
values[] |
この属性の値。提供される値の型は、その属性に想定されるものと一致する必要があります。AttributeValueType をご覧ください。複数の属性値を指定することができる繰り返しフィールドです。属性型がサポートできる値は 1 つのみです。 |
repeated_enum_value |
属性値の型が REPEATED_ENUM の場合、このフィールドには属性値が含まれ、その他の値のフィールドは空にする必要があります。 |
url_values[] |
属性値のタイプが URL の場合、このフィールドにはこの属性の値が含まれ、その他の値のフィールドは空にする必要があります。 |
AttributeMetadata
属性のメタデータ。ローカライズされた名前や関連属性をグループ化するための見出しなど、属性の表示情報が含まれます。
フィールド | |
---|---|
attribute_id |
属性の ID です。 |
value_type |
属性の値の型。設定および取得する値は、次のタイプにする必要があります。 |
display_name |
この属性のローカライズされた表示名(利用可能な場合)。それ以外の場合は、英語の表示名。 |
group_display_name |
この属性を含むグループのローカライズされた表示名(利用可能な場合)。それ以外の場合は、英語のグループ名。関連属性がグループにまとめられ、ここに示す見出しの下にまとめて表示されます。 |
is_repeatable |
true の場合、属性で複数の値がサポートされます。false の場合、値を 1 つだけ指定する必要があります。 |
value_metadata[] |
一部の属性タイプ(列挙型など)については、サポートされている値と、それらの値に対応する表示名のリストが提供されます。 |
is_deprecated |
true の場合、属性は非推奨であるため、使用しないでください。非推奨の場合、この属性を更新してもエラーにはなりませんが、更新は保存されません。この属性は、サポートが終了した後のある時点で完全に削除され、エラーになります。 |
AttributeValueMetadata
サポートされている属性値のメタデータ。
フィールド | |
---|---|
value |
属性値。 |
display_name |
この値の表示名。ローカライズ可能な場合はローカライズされます。それ以外の場合は英語です。値の表示名は、属性の表示名と一緒に使用することが意図されています。 たとえば、「Wi-Fi」列挙型属性には、有料 Wi-Fi を表す「有料」を含めることができます。 |
AttributeValueType
属性の値の型。
列挙型 | |
---|---|
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED |
指定されていません。 |
BOOL |
この属性の値はブール値です。 |
ENUM |
この属性には、使用可能な値を示した既定の一覧があります。この属性のメタデータでは、これらの値が一覧表示されます。 |
URL |
この属性の値は URL です。 |
REPEATED_ENUM |
この属性値は、明示的に設定または設定解除できる複数の有効な値を含む列挙型です。 |
作者
質問または回答の作成者を表します
フィールド | |
---|---|
display_name |
ユーザーの表示名 |
profile_photo_url |
ユーザーのプロフィール写真の URL。 |
type |
作成者のユーザーのタイプ。 |
AuthorType
作成者のユーザータイプの列挙型。
列挙型 | |
---|---|
AUTHOR_TYPE_UNSPECIFIED |
これは使用しないでください。 |
REGULAR_USER |
通常のユーザー。 |
LOCAL_GUIDE |
ローカルガイド |
MERCHANT |
ビジネスのオーナーまたは管理者 |
BasicMetricsRequest
基本的な指標の分析情報のリクエストです。
フィールド | |
---|---|
metric_requests[] |
データを返す方法のオプションを含む、値を返す指標のコレクション。 |
time_range |
指標を収集する範囲。指定できる期間はリクエスト日から 18 か月です。場合によっては、リクエスト日に近い日のデータが表示されないこともあります。欠落したデータはレスポンスの |
BatchGetBusinessCategoriesRequest
BusinessCategories.BatchGetBusinessCategories に対するリクエスト メッセージです。
フィールド | |
---|---|
language_code |
必須。カテゴリ名を返す言語の BCP 47 コードです。 |
category_ids[] |
必須。少なくとも 1 つの名前を設定する必要があります。ローカライズされたカテゴリ名を返す GConcept ID です。 |
region_code |
(省略可)標準以外の言語の推定に使用される ISO 3166-1 alpha-2 の国コード。 |
view |
必須。レスポンスでカテゴリ リソースのどの部分を返すかを指定します。 |
BatchGetBusinessCategoriesResponse
BusinessCategories.BatchGetBusinessCategories に対するレスポンス メッセージです。
フィールド | |
---|---|
categories[] |
リクエストで指定された GConcept ID に一致するカテゴリ。リクエスト内のカテゴリ ID と同じ順序ではありません。 |
BatchGetLocationsRequest
Locations.BatchGetLocations に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
ビジネスを取得するアカウントの名前です。 |
location_names[] |
取得するビジネスのコレクション。名前で指定します。 |
BatchGetLocationsResponse
Locations.BatchGetLocations に対するレスポンス メッセージです。
フィールド | |
---|---|
locations[] |
ビジネスのコレクション。 |
BatchGetReviewsRequest
Reviews.BatchGetReviews に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
複数のビジネス情報のクチコミのリストを取得するアカウントの名前。 |
location_names[] |
クチコミを取得するためのビジネスの集まり。ビジネスの名前で指定します。 |
page_size |
1 ページあたりで取得するクチコミ数です。デフォルト値は 50 です。 |
page_token |
指定すると、クチコミの次のページが取得されます。 |
order_by |
(省略可)クチコミの並べ替えの基準とするフィールドを指定します。指定されていない場合、返されるクチコミの順序はデフォルトの |
ignore_rating_only_reviews |
評価のみのレビューを無視するかどうか。 |
BatchGetReviewsResponse
Reviews.BatchGetReviews に対するレスポンス メッセージです。
フィールド | |
---|---|
location_reviews[] |
所在地情報を含むクチコミです。 |
next_page_token |
クチコミの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の呼び出しでクチコミの次のページを取得するためのトークンが入力されます。取得するクチコミがそれ以上ない場合、このフィールドはレスポンスに表示されません。 |
BusinessHours
ビジネスが営業している期間を表します。TimePeriod
インスタンスのコレクションを保持します。
フィールド | |
---|---|
periods[] |
ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
CallToAction
ユーザーが投稿をクリックしたときに実行されるアクション。
フィールド | |
---|---|
action_type |
実行されるアクションのタイプ。 |
url |
クリックしたときにユーザーに表示される URL です。電話による問い合わせを促すフレーズでは、このフィールドを未設定のままにする必要があります。 |
ActionType
実行されるアクションのタイプ。
列挙型 | |
---|---|
ACTION_TYPE_UNSPECIFIED |
未指定 |
BOOK |
お店やレストランなどの予約を促します。 |
ORDER |
注文を行うよう促します。 |
SHOP |
商品カタログを閲覧するよう促します。 |
LEARN_MORE |
ウェブサイトで詳細を確認するよう促します。 |
SIGN_UP |
登録、申し込み、参加を促します。 |
GET_OFFER |
非推奨です。 |
CALL |
お店やサービスへの電話による問い合わせを促します。 |
カテゴリ
カテゴリは業種を表すもので、事業内容を表すものではありません。有効なカテゴリ ID と、人が読める形式の名前へのマッピングについては、categories.list をご覧ください。
フィールド | |
---|---|
display_name |
。人間が読める形式のカテゴリ名です。ビジネスの読み取り時に設定されます。場所を変更する場合は、 注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。 |
category_id |
。このカテゴリの固定 ID(Google 提供)です。ビジネス情報の作成や更新の際にカテゴリを変更する場合は、 注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。 |
service_types[] |
この業種で利用できるすべてのサービスタイプのリスト。 注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。 |
more_hours_types[] |
出力のみ。この業種で利用可能なその他の営業時間タイプです。 |
CategoryView
サーバーから返されるデータの量の制限に役立つ列挙型。
列挙型 | |
---|---|
CATEGORY_VIEW_UNSPECIFIED |
指定しません。CATEGORY_METADATA_ONLY と同じです。 |
BASIC |
サーバー レスポンスには、カテゴリ フィールド display_name、category_id、language_code のみが含まれます。サービスタイプのメタデータに関連するフィールドは省略されます。 |
FULL |
レスポンス内のすべてのフィールドを返します。 |
チェーン
チェーンとは、ビジネス拠点をリンクできるブランドです。
フィールド | |
---|---|
name |
チェーンのリソース名( |
chain_names[] |
チェーンの名前。 |
websites[] |
チェーンのウェブサイト。 |
location_count |
このチェーンに含まれるビジネスの数です。 |
ChainName
チェーンの表示時に使用する名前。
フィールド | |
---|---|
display_name |
このチェーンの表示名。 |
language_code |
名前の言語の BCP 47 コード。 |
ChainUrl
チェーンの表示時に使用する URL。
フィールド | |
---|---|
url |
このチェーンの URL です。 |
ClearLocationAssociationRequest
Locations.ClearLocationAssociationRequest に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
関連付けを解除するビジネスのリソース名です。 |
CompleteVerificationRequest
Verifications.CompleteVerificationAction に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
完了するオーナー確認のリソース名。 |
pin |
オーナー確認を完了するために販売者が受け取った PIN コード。 |
CompleteVerificationResponse
Verifications.CompleteVerificationAction に対するレスポンス メッセージ。
フィールド | |
---|---|
verification |
オーナー確認が完了しました。 |
CreateAccountAdminRequest
AccessControl.CreateAccountAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
この管理者が作成されるアカウントのリソース名。 |
admin |
作成する管理者 |
CreateAccountRequest
Accounts.CreateAccount に対するリクエスト メッセージです。
フィールド | |
---|---|
primary_owner |
作成するアカウントのメインのオーナーとなるアカウントのリソース名。 |
account |
作成するアカウントのアカウント情報。使用できるフィールドは account_name と type のみです。 |
CreateLocalPostRequest
CreateLocalPost に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
このローカル投稿を作成するビジネスの名前です。 |
local_post |
新しいローカル投稿のメタデータ。 |
CreateLocationAdminRequest
AccessControl.CreateLocationAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
この管理者が作成されるビジネスのリソース名。 |
admin |
作成する管理者 |
CreateLocationRequest
Locations.CreateLocation に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
このビジネスを作成するアカウントの名前。 |
location |
新しい位置情報メタデータ。 |
validate_only |
true の場合、ビジネスが実際に作成されることなく、リクエストの検証のみが行われます。 |
request_id |
重複するリクエストを検出するための、サーバーの一意のリクエスト ID。UUID を使用することをおすすめします。最大長は 50 文字です。 |
CreateMediaItemRequest
Media.CreateMediaItem に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
このメディア アイテムが作成されるビジネスのリソース名です。 |
media_item |
作成するメディア アイテムです。 |
CreateQuestionRequest
QuestionsAndAnswers.CreateQuestion に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
質問を作成するビジネスの名前です。 |
question |
新しい問題です。 |
DeclineInvitationRequest
AccessControl.DeclineInvitation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
承認されなかったアカウント招待の名前。 |
DeleteAccountAdminRequest
AccessControl.DeleteAccountAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
アカウントから削除する管理者のリソース名。 |
DeleteAnswerRequest
QuestionsAndAnswers.DeleteAnswer に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
回答を削除する質問の名前です。 |
DeleteLocalPostRequest
DeleteLocalPost に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するローカル投稿の名前です。 |
DeleteLocationAdminRequest
AccessControl.DeleteLocationAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
ビジネスから削除する管理者のリソース名です。 |
DeleteLocationRequest
Locations.DeleteLocation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
削除するビジネスの名前。 |
DeleteMediaItemRequest
Media.DeleteMediaItem に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
削除するメディア アイテムの名前。 |
DeleteNotificationsRequest
Accounts.DeleteNotifications に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
クリアする通知設定のリソース名。 |
DeleteQuestionRequest
QuestionsAndAnswers.DeleteQuestion に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
削除する質問の名前。 |
DeleteReviewReplyRequest
Reviews.DeleteReviewReply に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するクチコミへの返信の名前です。 |
DietaryRestriction
食品の食事情報。
列挙型 | |
---|---|
DIETARY_RESTRICTION_UNSPECIFIED |
食事の種類が指定されていません |
HALAL |
料理をハラール料理として表す。 |
KOSHER |
食べ物をコーシャ料理として表す。 |
ORGANIC |
食べ物をオーガニック料理と表現すること。 |
VEGAN |
ヴィーガン料理としての食品の表現。 |
VEGETARIAN |
ベジタリアン料理としての食品の表示。 |
DimensionalMetricValue
指定された時間ディメンションを持つ 1 つの指標の値。
フィールド | |
---|---|
metric_option |
このディメンション値をリクエストしたオプション。 |
time_dimension |
値のディメンション。 |
value |
値です。値が設定されていない場合、リクエストされたデータが見つかりません。 |
TimeDimension
データを分割するディメンション。
フィールド | |
---|---|
day_of_week |
この値が対応する曜日(「MONDAY」~「SUNDAY」)。BREAKDOWN_DAY_OF_WEEK オプションに対して設定されます。 |
time_of_day |
この値が対応する時間(0 ~ 23)。BREAKDOWN_HOUR_OF_DAY オプションに対して設定されます。 |
time_range |
この値が適用される時間の範囲。AGGREGATED_TOTAL オプションと AGGREGATED_DAILY オプションに対して設定されます。 |
DrivingDirectionMetricsRequest
運転ルートの分析情報のリクエストです。
フィールド | |
---|---|
num_days |
データを集計する日数を指定します。返される結果には、過去数日間分のデータが含まれます。有効な値は 7、30、90 です。 |
language_code |
言語の BCP 47 コード。言語コードを指定しない場合は、デフォルトで英語が使用されます。 |
NumDays
このリクエストがサポートできる日数。
列挙型 | |
---|---|
SEVEN |
7 日間です。これがデフォルト値です。 |
THIRTY |
30 日間です。 |
NINETY |
90 日間です。 |
EmailInput
メールアドレスの確認の入力。
フィールド | |
---|---|
email_address |
PIN の送信先となるメールアドレスです。 メールアドレスは、FetchVerificationOptions によって提供されるアドレスのいずれかである場合にのみ指定できます。 |
ErrorDetail
検証エラーまたは内部エラーの原因となったエラーの詳細です。
フィールド | |
---|---|
code |
ステータス コード。 |
field |
リクエスト本文のフィールドへのパス。値は、プロトコル バッファ フィールドを識別する、ドットで区切られた識別子のシーケンスです。たとえば、error_details.field はこのフィールドを識別します。 |
message |
フィールドが失敗の原因となった理由の説明。メッセージは英語のため、ユーザーへの表示に適していない可能性があります。 |
value |
リクエストに失敗した値。 |
field_index |
このエラーを生成したリクエスト フィールドが繰り返される場合、検証が失敗する原因となった、そのフィールドのエントリのゼロから始まるインデックスが含まれます。 |
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 |
確認するビジネスのリソース名。 |
language_code |
確認プロセスに使用される言語を表す BCP 47 言語コード。使用できるオプションは言語によって異なります。 |
context |
サービス ビジネスのオーナー確認を行うための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY のビジネスの場合は必須です。他の業種の地域に対して INVALID_ARGUMENT が設定されている場合、スローされます。 |
FetchVerificationOptionsResponse
Verifications.FetchVerificationOptions に対するレスポンス メッセージ。
フィールド | |
---|---|
options[] |
利用可能なオーナー確認オプション。 |
FindMatchingLocationsRequest
Locations.FindMatchingLocations に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
一致を検索するビジネスのリソース名です。 |
language_code |
照合するビジネスの優先言語(BCP-47 形式)。 |
num_results |
返される一致の数。デフォルト値は 3、最大値は 10 です。さらにリクエストすると、レイテンシが増加する可能性があります。ページ分けはありません。 |
max_cache_duration |
非推奨です。このフィールドは、すべてのリクエストで無視されます。 |
FindMatchingLocationsResponse
Locations.FindMatchingLocations に対するレスポンス メッセージです。
フィールド | |
---|---|
matched_locations[] |
指定した場所に一致する可能性がある場所のコレクションです。一致度が高い順に表示されます。完全に一致するものがある場合は、そのページが最初の位置に表示されます。 |
match_time |
このビジネスに対して照合アルゴリズムが最後に実行された日時。 |
FollowersMetadata
ビジネス情報のフォロワーのメタデータ。
フィールド | |
---|---|
name |
このリソース名。 accounts/{account_id}/locations/{location_id}/followers/metadata |
count |
ビジネスのフォロワーの合計数。 |
FoodMenu
料理を提供しているビジネスのメニュー。
フィールド | |
---|---|
labels[] |
必須。メニューの言語タグを含むラベルです。例: 「メニュー」、「ランチ スペシャル」。表示名は半角 140 文字(全角 70 文字)、説明は半角 1,000 文字(全角 500 文字)以内にする必要があります。少なくとも 1 つのラベルセットが必要です。 |
source_url |
(省略可)メニューのソース URL(移動先のウェブページがある場合)。 |
sections[] |
必須。メニューのセクション。 |
cuisines[] |
(省略可)フードメニューの料理情報。このフィールドを指定することを強くおすすめします。 |
料理
レストランの料理情報。
列挙型 | |
---|---|
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[] |
必須。このメニュー項目の言語タグ付きラベルです。表示名は半角 140 文字(全角 70 文字)、説明は半角 1,000 文字(全角 500 文字)以内にする必要があります。少なくとも 1 つのラベルセットが必要です。 |
attributes |
必須。商品アイテムの詳細な属性です。アイテム オプションを指定すると基本属性とみなされ、各オプションに入力されます。 |
options[] |
(省略可)複数の異なるオプションがあり、ユーザーが選択を行うアイテムに使用します。(例: 「普通」と「大」のピザ)。オプションを指定すると、商品アイテムレベルのラベルと属性が、自動的に最初のオプションのラベルと属性になります。このフィールドで他の食品オプションを指定するだけで済みます。 |
FoodMenuItemAttributes
食品/料理の属性。
フィールド | |
---|---|
price |
必須。料理の価格。 |
spiciness |
(省略可)料理の辛さのレベル。 |
allergen[] |
(省略可)料理に関連するアレルゲン。このフィールドを指定することを強くおすすめします。 |
dietary_restriction[] |
(省略可)その料理の食事情報。このフィールドを指定することを強くおすすめします。 |
nutrition_facts |
(省略可)食事メニューの栄養成分表。このフィールドを指定することを強くおすすめします。 |
ingredients[] |
(省略可)料理オプションの材料。 |
serves_num_people |
(省略可)この料理オプションで提供できる人数です。 |
preparation_methods[] |
(省略可)料理オプションの調理方法。 |
portion_size |
(省略可)商品アイテムの単位で表した注文のサイズ。(例: 4「焼き串」、6「ピース」) |
media_keys[] |
(省略可)料理に関連付けられているメディアのメディアキー。写真メディアのみがサポートされています。複数の写真が関連付けられている場合、最初の写真が優先の写真と見なされます。 |
材料
このメッセージは、料理の食材情報を示します。
フィールド | |
---|---|
labels[] |
必須。材料を説明するラベル。表示名は半角 140 文字(全角 70 文字)、説明は半角 1,000 文字(全角 500 文字)以内にする必要があります。少なくとも 1 つのラベルセットが必要です。 |
PortionSize
1 皿の 1 人分の分量。
フィールド | |
---|---|
quantity |
必須。部分の番号。 |
unit[] |
必須。name_info フィールドは、複数の言語でユニットに対して繰り返されています。 |
FoodMenuItemOption
アイテムのオプション。ユーザーによる明示的な選択が必要です。
フィールド | |
---|---|
labels[] |
必須。このメニュー項目オプションの言語タグ付きラベル。E.g.: 「ビーフパッタイ」、「野菜パッドタイ」、「小ピザ」、「大ピザ」表示名は半角 140 文字(全角 70 文字)、説明は半角 1,000 文字(全角 500 文字)以内にする必要があります。少なくとも 1 つのラベルセットが必要です。 |
attributes |
必須。商品アイテム オプションの詳細な属性です。指定されていない個々の属性は、アイテムレベルの属性からベースとして継承されます。 |
FoodMenuSection
メニューのセクション。複数の料理やアイテムを含めることができます。
フィールド | |
---|---|
labels[] |
必須。このメニュー セクションの言語タグ付きラベル。表示名は半角 140 文字(全角 70 文字)、説明は半角 1,000 文字(全角 500 文字)以内にする必要があります。少なくとも 1 つのラベルセットが必要です。 |
items[] |
必須。セクションのアイテム。各セクションには少なくとも 1 つのアイテムが必要です。 |
FoodMenus
食事を提供するビジネスのメニュー。
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。 |
menus[] |
(省略可)フードメニューのコレクション。 |
GenerateAccountNumberRequest
Accounts.GenerateAccountNumber に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
アカウント番号を生成するアカウントの名前。 |
GetAccountRequest
Accounts.GetAccount に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
取得するアカウントの名前。 |
GetChainRequest
Locations.GetChain に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
チェーンのリソース名( |
GetCustomerMediaItemRequest
Media.GetCustomerMediaItem に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
リクエストされた顧客のメディア アイテムのリソース名です。 |
GetFollowersMetadataRequest
ビジネス情報のフォロワー メタデータを取得するリクエスト メッセージ。
フィールド | |
---|---|
name |
ビジネスのフォロワー メタデータのリソース名です。 accounts/{account_id}/locations/{location_id}/followers/metadata |
GetFoodMenusRequest
FoodMenu.GetFoodMenus に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。 |
read_mask |
(省略可)返される特定のフィールド。マスクが指定されていない場合は、FoodMenu 全体を返します(「*」と同じ)。繰り返しフィールドの項目を個別に指定することはできません。たとえば、「name」と「menus」は有効なマスクですが、「menus.sections」は無効です。 |
GetHealthProviderAttributesRequest
HealthProviderAttributes.GetHealthProviderAttributes に対するリクエスト メッセージ
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。形式は accounts/{account_id}/locations/{location_id}/healthProviderAttributes です。 |
language_code |
(省略可)言語の BCP 47 コード。言語コードを指定しない場合は、デフォルトで英語が使用されます。現時点では、「en」のみがサポートされています。 |
GetLocalPostRequest
LocalPosts.GetLocalPost に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
取得するローカル投稿の名前です。 |
GetLocationRequest
Locations.GetLocation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
取得するビジネスの名前です。 |
GetMediaItemRequest
Media.GetMediaItem に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
リクエストされたメディア アイテムの名前です。 |
GetNotificationsRequest
Accounts.GetNotifications に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
通知設定のリソース名。 |
GetReviewRequest
Reviews.GetReview に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
取得するクチコミの名前です。 |
GetServiceListRequest
サービスリスト リクエスト メッセージを取得します。
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。 |
GoogleLocation
Google に存在する Location
を表します。ユーザーまたは他のユーザーによって申請されたビジネス、または申請が未申請の可能性があるビジネスです。
フィールド | |
---|---|
name |
この GoogleLocation のリソース名。形式は |
location |
スパースに入力された |
request_admin_rights_url |
管理者権限のリクエスト UI にユーザーをリダイレクトする URL。このフィールドは、現在のユーザーを含むユーザーによってすでにビジネスが申請されている場合にのみ存在します。 |
GoogleUpdatedLocation
Google によって変更されたビジネスを表します。
フィールド | |
---|---|
location |
このビジネスの Google によって更新されたバージョンです。 |
diff_mask |
Google が更新されたフィールド。 |
HealthProviderAttributes
この場所にリンクされている医療機関の属性。
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。 |
insurance_networks[] |
(省略可)このビジネスで許可された保険ネットワークのリスト。 |
InsuranceNetwork
単一の保険ネットワーク。次の ID: 5
フィールド | |
---|---|
network_id |
必須。Google が生成したこの保険ネットワークの ID。 |
network_names |
出力のみ。リクエストされた言語のネットワーク表示名のマップ。言語がキーで、ローカライズされた表示名が値です。デフォルトでは英語の表示名が設定されています。 |
payer_names |
出力のみ。リクエストされた言語の支払人表示名のマップ。言語がキーで、ローカライズされた表示名が値です。デフォルトでは英語の表示名が設定されています。 |
state |
出力のみ。この保険ネットワークの状態。 |
InternalError
内部エラーについての説明です。
フィールド | |
---|---|
error_details[] |
個々のエラーに関する詳細です。 |
招待
出力のみ。保留中の招待を表します。
フィールド | ||
---|---|---|
name |
招待状のリソース名。 |
|
role |
招待されたロール。 |
|
共用体フィールド target 。この招待の対象となるターゲットを示します。target は次のいずれかになります。 |
||
target_account |
この招待状の対象となるアカウントです(データがほとんど入力されていません)。 |
|
target_location |
この招待状の対象となるビジネスです。 |
TargetLocation
保留中の招待の対象となるビジネスを表します。
フィールド | |
---|---|
location_name |
ユーザーが招待されているビジネスの名前。 |
location_address |
ユーザーが招待されているビジネスの住所。 |
ListAccountAdminsRequest
AccessControl.ListAccountAdmins に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
管理者のリストを取得するアカウントの名前。 |
ListAccountAdminsResponse
AccessControl.ListAccountAdmins に対するレスポンス メッセージです。
フィールド | |
---|---|
admins[] |
|
ListAccountsRequest
Accounts.ListAccounts に対するリクエスト メッセージです。
フィールド | |
---|---|
page_size |
1 ページあたりで取得するアカウント数。デフォルトは 20、最小値は 2、最大ページサイズは 20 です。 |
page_token |
指定すると、アカウントの次のページが取得されます。 |
name |
直接アクセス可能なアカウントのリストを取得するアカウントのリソース名。これは、組織とユーザー グループに対してのみ有効です。空の場合、認証されたユーザーの |
filter |
返されるアカウントを制限するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。 たとえば、フィルタ |
ListAccountsResponse
Accounts.ListAccounts に対するレスポンス メッセージです。
フィールド | |
---|---|
accounts[] |
ユーザーがアクセスできるアカウントのコレクション。クエリを実行したユーザーの個人アカウントが、フィルタで除外されていない限り、常に結果の最初の項目になります。 |
next_page_token |
アカウント数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
ListAnswersRequest
QuestionsAndAnswers.ListAnswers に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
回答を取得する質問の名前。 |
page_size |
1 ページあたりで取得する回答の数。 |
page_token |
指定すると、回答の次のページが取得されます。 |
order_by |
回答を返す順序。有効なオプションには「update_time desc」と「upvote_count desc」があり、リクエストしたフィールドを基準に降順で並べ替えられた回答が返されます。デフォルトの並べ替え順は「update_time desc」です。 |
ListAnswersResponse
QuestionsAndAnswers.ListAnswers に対するレスポンス メッセージです。
フィールド | |
---|---|
answers[] |
リクエストされた回答。 |
total_size |
すべてのページでこの質問に対して投稿された回答の合計数。 |
next_page_token |
回答の数がリクエストされた最大ページサイズを超えた場合、このフィールドには、後続の呼び出しで回答の次のページを取得するためのトークンが入力されます。取得する回答がそれ以上ない場合、このフィールドはレスポンスに含められません。 |
ListAttributeMetadataRequest
Locations.ListAttributeMetadata に対するリクエスト メッセージです。ビジネスのリソース名を指定すると、そのビジネスが残りの条件の入力に使用されます。存在しない場合は、カテゴリと国を指定する必要があります。
フィールド | |
---|---|
name |
使用可能な属性を検索するビジネスのリソース名。 |
category_id |
使用可能な属性を検索するメインカテゴリの固定の ID です。 |
country |
使用可能な属性を検索する ISO 3166-1 alpha-2 の国コードです。 |
language_code |
属性表示名を取得する言語の BCP 47 コード。この言語を利用できない場合は、英語で表示されます。 |
page_size |
1 ページあたりに含める属性数です。デフォルトは 200 で、最小値は 1 です。 |
page_token |
指定すると、属性メタデータの次のページが取得されます。 |
ListAttributeMetadataResponse
Locations.ListAttributeMetadata に対するレスポンス メッセージです。
フィールド | |
---|---|
attributes[] |
使用可能な属性の属性メタデータのコレクションです。 |
next_page_token |
属性数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
ListBusinessCategoriesRequest
フィールド | |
---|---|
region_code |
ISO 3166-1 alpha-2 の国コード。 |
language_code |
言語の BCP 47 コード。使用言語が利用できない場合、デフォルトで英語に設定されます。 |
search_term |
ユーザーのフィルタ文字列(省略可)。 |
page_size |
1 ページあたりで取得するカテゴリの数。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。 |
page_token |
指定すると、カテゴリの次のページが取得されます。 |
view |
(省略可)レスポンスでカテゴリ リソースのどの部分を返すかを指定します。 |
ListBusinessCategoriesResponse
フィールド | |
---|---|
categories[] |
カテゴリ。カテゴリはベーシック ビューです。ServiceType 情報は含まれません。 |
total_category_count |
リクエスト パラメータのカテゴリの合計数。 |
next_page_token |
カテゴリ数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
ListCustomerMediaItemsRequest
Media.ListCustomerMediaItems に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
顧客のメディア アイテムを一覧表示するビジネスの名前です。 |
page_size |
1 ページあたりで返すメディア アイテム数です。デフォルト値は 100、サポートされている最大ページサイズは 200 です。 |
page_token |
指定すると、メディア アイテムの次のページを返します。 |
ListCustomerMediaItemsResponse
Media.ListCustomerMediaItems に対するレスポンス メッセージです。
フィールド | |
---|---|
media_items[] |
返されるメディア アイテムの一覧です。 |
total_media_item_count |
このビジネスのメディア アイテムの合計数です。ページ分けとは無関係です。結果が複数ページにわたる場合は特に、この数値はおおよその値になります。 |
next_page_token |
リクエストしたページサイズを上回る数のメディア アイテムがある場合、このフィールドには、後続の ListCustomerMediaItems の呼び出しでメディア アイテムの次のページを取得するためのトークンが入力されます。 |
ListInsuranceNetworksRequest
InsuranceNetworkService.ListInsuranceNetworks に対するリクエスト メッセージ
フィールド | |
---|---|
parent |
必須。保険ネットワークをリストするビジネスの名前です。名前の形式は accounts/{account_id}/locations/{location_id} です。 |
language_code |
(省略可)言語の BCP 47 コード。言語コードを指定しない場合は、デフォルトで英語が使用されます。現時点では、「en」のみがサポートされています。 |
page_size |
1 ページあたりで返す保険ネットワークの数。デフォルト値は 5000 です。最大ページサイズは 10,000 です。 |
page_token |
指定すると、保険ネットワークの次のページが返されます。 |
ListInsuranceNetworksResponse
InsuranceNetworkService.ListInsuranceNetworks に対するレスポンス メッセージ
フィールド | |
---|---|
networks[] |
Google がサポートする保険ネットワークのリスト。 |
next_page_token |
リクエストされたページサイズよりも多くの保険ネットワークがある場合、このフィールドには、後続の ListInsuranceNetworks の呼び出しで保険ネットワークの次のページを取得するためのトークンが入力されます。 |
ListInvitationsRequest
AccessControl.ListInvitations に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
招待のリストを取得するアカウントの名前。 |
target_type |
レスポンスに含めるターゲット タイプを指定します。 |
TargetType
招待の対象となるターゲットのタイプ。
列挙型 | |
---|---|
ALL |
すべてのターゲット タイプの招待をリストします。これがデフォルトです。 |
ACCOUNTS_ONLY |
タイプが「アカウント」のターゲットに対してのみ、招待状をリストします。 |
LOCATIONS_ONLY |
タイプが「地域」のターゲットの招待のみをリストに表示します。 |
ListInvitationsResponse
AccessControl.ListInvitations に対するレスポンス メッセージです。
フィールド | |
---|---|
invitations[] |
アカウントで保留になっているビジネスへの招待のコレクションです。ここにリストされる招待の数は 1,000 を超えることはできません。 |
ListLocalPostsRequest
ListLocalPosts に対するリクエスト メッセージ
フィールド | |
---|---|
parent |
ローカル投稿を表示するビジネスの名前です。 |
page_size |
1 ページあたりで返すローカル投稿の数です。デフォルトは 20 です。最小値は 1、最大ページサイズは 100 です。 |
page_token |
指定すると、ローカル投稿の次のページが返されます。 |
ListLocalPostsResponse
ListLocalPosts に対するレスポンス メッセージ
フィールド | |
---|---|
local_posts[] |
返されるローカル投稿の一覧です。 |
next_page_token |
リクエストしたページサイズを上回る数のローカル投稿がある場合、このフィールドには、後続の |
ListLocationAdminsRequest
AccessControl.ListLocationAdmins に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
管理者の一覧を取得するビジネスの名前です。 |
ListLocationAdminsResponse
AccessControl.ListLocationAdmins に対するレスポンス メッセージです。
フィールド | |
---|---|
admins[] |
|
ListLocationsRequest
Locations.ListLocations に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
ビジネスを取得するアカウントの名前です。 |
page_size |
1 ページあたりで取得するビジネス情報の数。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。 |
page_token |
指定すると、ビジネスの次の |
filter |
返されるビジネス情報を限定するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。 有効なフィールドと使用例について詳しくは、位置情報の使用に関するガイドをご覧ください。 |
language_code |
位置情報のプロパティを表示する言語の BCP 47 コードです。この言語を利用できない場合は、地域の言語で提供されます。どちらも利用できない場合は、英語で提供されます。 非推奨です。2020 年 8 月 15 日を過ぎると、このフィールドは適用されません。代わりに、常に地域の言語が使用されます。 |
order_by |
リクエストの並べ替え順。複数のフィールドは、SQL 構文に従ってカンマで区切ってください。デフォルトの並べ替え順は昇順です。降順を指定するには、接尾辞「desc」を追加する必要があります。order_by の有効なフィールドは location_name と store_code です。例: 「location_name, store_code desc」、「location_name」、「store_code desc」 |
ListLocationsResponse
Locations.ListLocations に対するレスポンス メッセージです。
フィールド | |
---|---|
locations[] |
ビジネス情報。 |
next_page_token |
ビジネスの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
total_size |
ページ分けに関係なく、リスト内のビジネスのおおよその数です。 |
ListMediaItemsRequest
Media.ListMediaItems に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
メディア アイテムを一覧表示するビジネスの名前です。 |
page_size |
1 ページあたりで返すメディア アイテム数です。デフォルト値は 100 です。これは、Google My Business API でビジネスに追加できるメディア アイテムの最大数です。最大ページサイズは 2,500 です。 |
page_token |
指定すると、メディア アイテムの次のページを返します。 |
ListMediaItemsResponse
Media.ListMediaItems に対するレスポンス メッセージです。
フィールド | |
---|---|
media_items[] |
返されるメディア アイテムの一覧です。 |
total_media_item_count |
このビジネスのメディア アイテムの合計数です。ページ分けとは無関係です。 |
next_page_token |
リクエストしたページサイズを上回る数のメディア アイテムがある場合、このフィールドには、後続の ListMediaItems の呼び出しでメディア アイテムの次のページを取得するためのトークンが入力されます。 |
ListQuestionsRequest
QuestionsAndAnswers.ListQuestions に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
質問を取得するビジネスの名前です。 |
page_size |
1 ページあたりで取得する質問の数。 |
page_token |
指定すると、質問の次のページが取得されます。 |
answers_per_question |
質問ごとに取得する回答の数。 |
filter |
返される質問を制限するフィルタ。現在サポートされているフィルタは「ignore_answered=true」のみです。 |
order_by |
質問を返す順序。有効なオプションには「update_time desc」と「upvote_count desc」があり、これらはリクエストされたフィールドで降順で並べ替えられた質問を返します。デフォルトの並べ替え順は「update_time desc」です。 |
ListQuestionsResponse
QuestionsAndAnswers.ListQuestions に対するレスポンス メッセージです。
フィールド | |
---|---|
questions[] |
リクエストされた質問、 |
total_size |
この場所について投稿された質問の合計数(すべてのページ)。 |
next_page_token |
質問の数がリクエストされた最大ページサイズを超えた場合、このフィールドには、後続の呼び出しで質問の次のページを取得するためのトークンが入力されます。質問がそれ以上ない場合、このフィールドは回答に表示されません。 |
ListRecommendedGoogleLocationsRequest
ビジネス プロフィール アカウントに推奨されるビジネス拠点を一覧表示するリクエスト メッセージです。
フィールド | |
---|---|
name |
おすすめの Google ビジネスを取得するアカウント リソースの名前。 |
page_size |
1 ページあたりで取得するビジネス情報の数。デフォルトは 25 で、最小値は 1、最大ページサイズは 100 です。 |
page_token |
指定すると、ビジネスの次のページが取得されます。 |
ListRecommendedGoogleLocationsResponse
GoogleLocations.ListRecommendedGoogleLocations に対するレスポンス メッセージです。
また、前回このビジネス プロフィール アカウントにおすすめされた後で、他のビジネス プロフィール ユーザーが申請したビジネス情報も含まれます。
フィールド | |
---|---|
google_locations[] |
ビジネス プロフィール アカウントに推奨されるビジネス拠点。それぞれがマップに存在する |
total_size |
このビジネス プロフィール アカウントで推奨されるビジネス拠点の合計数です。ページ分けは考慮されません。 |
next_page_token |
ページ分けの際に、次のページで取得できるビジネス情報がある場合、このフィールドには、後続の呼び出しでビジネスの次のページを取得するためのトークンが入力されます。取得するビジネスがそれ以上ない場合、このフィールドはレスポンスに含められません。 |
ListReviewsRequest
Reviews.ListReviews に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
クチコミを取得するビジネスの名前です。 |
page_size |
1 ページあたりで取得するクチコミ数です。 |
page_token |
指定すると、クチコミの次のページが取得されます。 |
order_by |
クチコミの並べ替えの基準とするフィールドを指定します。指定されていない場合、返されるクチコミの順序はデフォルトの |
ListReviewsResponse
Reviews.ListReviews に対するレスポンス メッセージです。
フィールド | |
---|---|
reviews[] |
クチコミです。 |
average_rating |
このビジネスに対するすべてのクチコミの平均評価を 1 ~ 5 で示し、5 が最高評価です。 |
total_review_count |
このビジネスのクチコミの合計数。 |
next_page_token |
クチコミの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の ListReviews への呼び出しでクチコミの次のページを取得するためのトークンが入力されます。取得するクチコミがそれ以上ない場合、このフィールドはレスポンスに含められません。 |
ListVerificationsRequest
Verifications.ListVerifications に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
オーナー確認リクエストが属するビジネスのリソース名。 |
page_size |
1 ページあたりに含める確認事項の数。設定されていない場合は、すべてを返します。 |
page_token |
指定すると、オーナー確認の次のページが返されます。 |
ListVerificationsResponse
Verifications.ListVerifications に対するレスポンス メッセージです。
フィールド | |
---|---|
verifications[] |
オーナー確認のリスト。 |
next_page_token |
オーナー確認の数がリクエストしたページサイズを超えた場合、このフィールドには、後続の呼び出しでオーナー確認の次のページを取得するためのトークンが入力されます。取得する属性がそれ以上ない場合、このフィールドはレスポンスに含められません。 |
LocalPost
ビジネスのローカル投稿を表します。
フィールド | |
---|---|
name |
出力のみ。このローカル投稿の Google 識別子。 |
language_code |
ローカル投稿の言語。 |
summary |
ローカル投稿の説明/本文です。 |
call_to_action |
プロモーションをクリックしたユーザーが誘導される URL です。トピックタイプ |
create_time |
出力のみ。投稿が作成された時間です。 |
update_time |
出力のみ。ユーザーが最後に投稿を変更した時間です。 |
event |
イベント情報。トピックタイプ |
state |
出力のみ。投稿のライフサイクルのどの部分が含まれるかを示すステータスです。 |
media[] |
投稿に関連付けられているメディアです。LocalPost MediaItem でサポートされているデータ フィールドは source_url のみです。 |
search_url |
出力のみ。Google 検索のローカル投稿へのリンクです。このリンクを使用すると、ソーシャル メディア、メール、テキスト メッセージなどで投稿を共有できます。 |
topic_type |
必須。投稿のトピックタイプ(標準、イベント、特典、アラート)。 |
alert_type |
投稿を作成するアラートの種類。このフィールドは、topic_type Alert の投稿にのみ該当し、Alerts のサブタイプとして動作します。 |
offer |
特典に関する投稿の追加データです。topic_type が OFFER の場合にのみ設定する必要があります。 |
LocalPostState
投稿の状態を表します。
列挙型 | |
---|---|
LOCAL_POST_STATE_UNSPECIFIED |
ステータスが指定されていません。 |
REJECTED |
この投稿はコンテンツ ポリシー違反により拒否されました。 |
LIVE |
この投稿は公開され、現在検索結果に表示されています。 |
PROCESSING |
この投稿は処理中で、検索結果に表示されていません。 |
LocalPostEvent
ローカル投稿に掲載されるイベントに関連するすべての情報です。
フィールド | |
---|---|
title |
イベントの名前。 |
schedule |
イベントの開始日時と終了日時です。 |
LocalPostMetrics
ローカル投稿でリクエストされたすべての指標。
フィールド | |
---|---|
local_post_name |
|
metric_values[] |
リクエストされた指標の値のリスト。 |
LocalPostOffer
特典に関する投稿専用のフィールドです。
フィールド | |
---|---|
coupon_code |
(省略可)店舗またはオンラインで使用可能なクーポンコードです。 |
redeem_online_url |
(省略可)特典を利用するためのオンライン リンクです。 |
terms_conditions |
(省略可)特典の利用規約です。 |
LocalPostTopicType
ローカル投稿のトピックタイプです。さまざまなテンプレートを選択して投稿を作成、表示するために使用されます。
列挙型 | |
---|---|
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED |
投稿のタイプが指定されていません。 |
STANDARD |
投稿に概要や画像などの基本情報が含まれています。 |
EVENT |
投稿に基本情報とイベントが含まれています。 |
OFFER |
投稿に、基本情報、イベント、特典に関連するコンテンツ(クーポンコードなど)が含まれています |
ALERT |
進行中のイベントに関連する、優先度が高く、タイムリーなお知らせ。このタイプの投稿は、作成できない場合があります。 |
ロケーション
ビジネスです。これらのフィールドの詳細についてはヘルプセンター記事をご覧ください。有効な業種の一覧については、カテゴリ エンドポイントをご覧ください。
フィールド | |
---|---|
name |
このビジネスの Google 識別子。 一致のコンテキストで、このフィールドは入力されません。 |
language_code |
ビジネスの言語。作成時に設定され、更新できません。 |
store_code |
このビジネスの外部識別子。アカウント内で一意である必要があります。これにより、ビジネスとご自身の記録が関連付けられます。 |
location_name |
店舗、ウェブサイト、事務用品で一貫して使用され、顧客に知られている実際のビジネス拠点名を反映させてください。関連性のある追加情報は、リソースの他のフィールド(例: |
primary_phone |
個別のビジネス拠点に直接つながる電話番号を指定します。可能であれば、電話総合受付センターではなく、個々のお店の番号を使用します。 |
additional_phones[] |
電話番号に加えて、ビジネスの電話連絡先を最大 2 件登録できます(携帯電話でも固定電話でもかまいませんが、FAX 番号は指定できません)。 |
address |
ビジネス拠点を表す正確な住所。遠隔地にある私書箱は使用できません。現時点では、アドレスに最大 5 つの |
primary_category |
このビジネスの中核事業を最もよく表すカテゴリ。 |
additional_categories[] |
ビジネスを説明する追加のカテゴリ。カテゴリを選択すると、そのサービスを探しているユーザーに見つけてもらいやすくなります。ビジネス情報を正確かつ最新の状態に保つため、中核事業を表すカテゴリはできるだけ少なくします。できるだけ具体的で、なおかつ中心となる事業内容を示すカテゴリを選択します。 |
website_url |
このビジネスの URL。可能であれば、すべての拠点やブランドに共通する一般的なウェブサイトや URL ではなく、このビジネス拠点専用の URL を使用してください。 |
regular_hours |
ビジネスの営業時間。 |
special_hours |
ビジネスの特別営業時間。祝休日の営業時間など、通常の営業時間外の時間が含まれます。これらの設定は通常の営業時間よりも優先されます。 |
service_area |
非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです。ビジネスが非店舗型ビジネスである場合、このフィールドはそのビジネスがサービスを提供する地域を表します。 |
location_key |
このビジネスを他の Google サービス(Google+ ページや Google マップの場所など)にリンクするキーのコレクション。 |
labels[] |
ビジネスにタグを付けられるようにするための自由形式の文字列のコレクション。これらのラベルはユーザーには表示されず、自分だけが閲覧できます。ラベルあたり 255 文字の制限があります。 |
ad_words_location_extensions |
AdWords に表示される追加情報。 |
latlng |
ユーザー指定の緯度と経度。ビジネスの作成時に、提供された住所のジオコード処理が行われた場合は無視されます。このフィールドは、作成時にユーザーが指定した |
open_info |
ビジネスが現在営業しているかどうかを示すフラグ。 |
location_state |
出力のみ。ビジネスの状態を反映するブール値のセット。 |
attributes[] |
ビジネスの属性。 |
metadata |
出力のみ。ユーザーが編集できない追加情報。 |
price_lists[] |
非推奨: このビジネスの料金表情報です。 |
profile |
ご自身のビジネスについて自分の言葉で説明し、ビジネスや商品に関する独自のストーリーをユーザーと共有します。 |
relationship_data |
このビジネスに関連するすべてのビジネス拠点とチェーンです。 |
more_hours[] |
ビジネスの各部門や特定の顧客の営業時間の詳細。 |
メタデータ
ビジネスに関する、ユーザーが編集できない追加情報。
フィールド | |
---|---|
duplicate |
このビジネスと重複するビジネスに関する情報です。 |
maps_url |
マップ上のビジネスへのリンク。 |
new_review_url |
ユーザーがビジネスのクチコミを投稿できる Google 検索のページへのリンク。 |
Duplicate
このビジネスと重複するビジネスに関する情報です。
フィールド | |
---|---|
location_name |
重複するビジネスのリソース名です。認証されたユーザーに該当のビジネスへのアクセス権があり、ビジネスが削除されていない場合にのみ入力されます。 |
place_id |
重複するビジネスのプレイス ID です。 |
access |
ユーザーが重複するビジネスにアクセスできるかどうかを示します。 |
アクセス
重複しているビジネスに対するユーザーのアクセスレベル。これは「所有権」に代わるもので、代わりに使用する必要があります。
列挙型 | |
---|---|
ACCESS_UNSPECIFIED |
指定されていません。 |
ACCESS_UNKNOWN |
ユーザーが重複しているビジネス情報にアクセスできるかどうかを判断できません。 |
ALLOWED |
ユーザーは重複しているビジネス情報にアクセスできます。 |
INSUFFICIENT |
ユーザーには、重複しているビジネス情報へのアクセス権がありません。 |
RelationshipData
このページに関連するすべての親と子のビジネス情報。
フィールド | |
---|---|
parent_chain |
このビジネスがメンバーとなっているチェーンのリソース名です。 |
LocationDrivingDirectionMetrics
人々が通常居住する地域をインデックスに登録したビジネス。この数値は、このビジネスへの運転ルートのリクエスト数を地域ごとにカウントすることで取得されます。
フィールド | |
---|---|
location_name |
この指標値が属しているビジネスのリソース名。 |
top_direction_sources[] |
参照元の地域ごとの運転ルート リクエスト。慣例として、これらは件数で並べ替えられ、最大で 10 件の結果が得られます。 |
time_zone |
ビジネスのタイムゾーン(IANA タイムゾーン ID。「Europe/London」など)。 |
TopDirectionSources
運転ルートのリクエストの発信元となった上位の地域。
フィールド | |
---|---|
day_count |
データが集計される日数。 |
region_counts[] |
件数の降順で並べ替えられた地域。 |
RegionCount
関連するリクエスト数があるリージョン。
フィールド | |
---|---|
latlng |
地域の中心。 |
label |
人が読める形式の地域のラベル。 |
count |
この地域からの運転ルート リクエストの数。 |
LocationKey
ビジネスの代理キーまたはサロゲートキーの参照です。
フィールド | |
---|---|
plus_page_id |
出力のみ。このビジネスに関連付けられた Google+ ページがある場合は、このビジネスの Google+ ページ ID が入力されます。 |
place_id |
ビジネスのオーナー確認が済んでおり、Google マップに関連付けられているか表示されている場合は、そのビジネスのプレイス ID が入力されます。この ID はさまざまな Places API で使用できます。 ビジネスのオーナー確認が済んでいない場合でも、そのビジネスが Google マップに表示される場所に関連付けられていれば、このフィールドに値が入力されることがあります。 このフィールドは、Create の呼び出し時に設定できますが、Update の呼び出し時には設定できません。 追加の |
explicit_no_place_id |
出力のみ。値が true の場合は、関連付けがまだ行われていないケースとは異なり、プレイス ID が意図的に未設定となっていることを表します。 |
request_id |
出力のみ。このビジネスの作成に使用された |
LocationMetrics
一定期間にわたってビジネスに関連付けられた一連の Metrics と BreakdownMetrics。
フィールド | |
---|---|
location_name |
これらの値が属するビジネスのリソース名です。 |
time_zone |
ビジネスの IANA タイムゾーン。 |
metric_values[] |
リクエストされた指標の値のリスト。 |
LocationReview
位置情報を含むクチコミを表します。
フィールド | |
---|---|
name |
ビジネスのリソース名。 |
review |
ビジネスのクチコミです。 |
LocationState
ビジネスの状態を反映する一連のブール値を含みます。
フィールド | |
---|---|
is_google_updated |
出力のみ。このビジネスに関連付けられているプレイス ID に変更があるかどうかを表します。 |
is_duplicate |
出力のみ。ビジネスが別のビジネスと重複しているかどうかを表します。 |
is_suspended |
出力のみ。ビジネスが強制停止されているかどうかを表します。停止中のビジネスは、Google のサービスのエンドユーザーには表示されません。間違いであると思われる場合は、ヘルプセンターの記事をご覧ください。 |
can_update |
出力のみ。ビジネスが更新可能かどうかを表します。 |
can_delete |
出力のみ。Google My Business API を使用してビジネスを削除できるかどうかを示します。 |
is_verified |
出力のみ。ビジネスのオーナー確認が済んでいるかどうかを表します。 |
needs_reverification |
出力のみ。ビジネスの再確認が必要かどうかを示します。 |
is_pending_review |
出力のみ。ビジネスのクチコミが保留中かどうかを表します。 |
is_disabled |
出力のみ。ビジネスが無効になっているかどうかを示します。 |
is_published |
出力のみ。ビジネスが公開されているかどうかを表します。 |
is_disconnected |
出力のみ。ビジネスと Google マップ上の場所との接続が解除されているかどうかを示します。 |
is_local_post_api_disabled |
出力のみ。このビジネスで accounts.locations.localPosts が無効になっているかどうかを示します。 |
can_modify_service_list |
出力のみ。リスティングが ServiceList を変更できるかどうかを示します。 |
can_have_food_menus |
出力のみ。リスティングがフードメニューの対象となるかどうかを示します。 |
has_pending_edits |
出力のみ。このビジネスのプロパティのいずれかが「編集内容が審査中」かどうかを表します。 |
has_pending_verification |
出力のみ。ビジネスに保留中のオーナー確認リクエストがあるかどうかを表します。 |
can_operate_health_data |
出力のみ。ビジネスでヘルスデータを操作できるかどうかを示します。 |
can_operate_lodging_data |
出力のみ。ビジネスが宿泊施設データを操作できるかどうかを示します。 |
MatchedLocation
ビジネスに一致する可能性があることを示します。
フィールド | |
---|---|
location |
一致の可能性がある、データがまばらになっているビジネスです。未入力のフィールドには、名前( |
is_exact_match |
これは完全一致ですか? |
MediaItem
単一のメディア アイテムです。
フィールド | ||
---|---|---|
name |
このメディア アイテムのリソース名です。 |
|
media_format |
このメディア アイテムのフォーマットです。メディア アイテムの作成時に設定する必要があります。他のすべてのリクエストでは読み取り専用です。この設定は変更できません。 |
|
location_association |
これは、 |
|
google_url |
出力のみ。このメディア アイテムについて Google がホストする URL です。この URL は後で変更される可能性があるため、静的なものではありません。動画の場合は、再生アイコンが重ねて表示されるプレビュー画像になります。 |
|
thumbnail_url |
出力のみ。提供されている場合は、このメディア アイテムのサムネイル画像の URL になります。 |
|
create_time |
出力のみ。このメディア アイテムの作成時間です。 |
|
dimensions |
出力のみ。ピクセル単位のサイズ(幅と高さ)です。 |
|
insights |
出力のみ。このメディア アイテムに関する統計情報です。 |
|
attribution |
出力のみ。顧客メディア アイテムの帰属情報です。この帰属表示はユーザーに提供されたとおりに表示する必要があり、削除や変更は行わないでください。 |
|
description |
このメディア アイテムの説明です。説明は Google My Business API を使用して変更することはできませんが、カバー写真以外の新しいメディア アイテムの作成時に設定できます。 |
|
共用体フィールド
アップロードする写真はすべて、ビジネス プロフィールの写真に関するガイドラインに準拠している必要があります。 |
||
source_url |
メディア アイテムを取得可能な、一般公開されている URL です。 作成時に、source_url または data_ref を、メディア アイテムのソースを指定するよう設定する必要があります。 メディア アイテムの作成時に このフィールドは更新できません。 |
|
data_ref |
入力のみ。 メディア アイテムの作成時に、
または
を設定する必要があります。 |
帰属
投稿者の名前やプロフィール写真など、顧客メディア アイテムの帰属情報です。
フィールド | |
---|---|
profile_name |
メディア アイテムが帰属するユーザー名です。 |
profile_photo_url |
帰属先ユーザーのプロフィール写真のサムネイルの URL です。 |
takedown_url |
不適切なメディア アイテムを報告できる削除ページの URL です。 |
profile_url |
帰属先ユーザーの Google マップ プロフィール ページの URL。 |
ディメンション
メディア アイテムのサイズです。
フィールド | |
---|---|
width_pixels |
メディア アイテムの幅(ピクセル単位)です。 |
height_pixels |
メディア アイテムの高さ(ピクセル単位)です。 |
LocationAssociation
メディア アイテムがその場所とどのように関連付けられているかを示します。
フィールド | ||
---|---|---|
共用体フィールド location_attachment_type 。ビジネスのメディアには、カテゴリまたは関連付けられている価格表アイテムの ID が必要です。位置情報以外のメディア(ローカル投稿の写真など)には、どちらも指定しないでください。location_attachment_type は次のいずれかになります。 |
||
category |
このビジネス写真が属するカテゴリです。 |
|
price_list_item_id |
このビジネス写真が関連付けられている価格表アイテムの ID です。 |
カテゴリ
メディア アイテム カテゴリの列挙型です。
列挙型 | |
---|---|
CATEGORY_UNSPECIFIED |
カテゴリが指定されていません。 |
COVER |
カバー写真です。ビジネスに指定できるカバー写真は 1 枚のみです。 |
PROFILE |
プロフィール写真です。ビジネスに指定できるプロフィール写真は 1 枚のみです。 |
LOGO |
ロゴ写真。 |
EXTERIOR |
外観のメディアです。 |
INTERIOR |
内装のメディアです。 |
PRODUCT |
商品のメディアです。 |
AT_WORK |
「勤務中」のメディアです。 |
FOOD_AND_DRINK |
食べ物と飲み物のメディアです。 |
MENU |
メニューのメディアです。 |
COMMON_AREA |
共用エリアのメディアです。 |
ROOMS |
部屋のメディアです。 |
TEAMS |
チームのメディアです。 |
ADDITIONAL |
その他の未分類のメディアです。 |
MediaFormat
メディア フォーマットの列挙型です。
列挙型 | |
---|---|
MEDIA_FORMAT_UNSPECIFIED |
形式が指定されていません。 |
PHOTO |
メディア アイテムは写真です。このバージョンでは写真のみがサポートされています。 |
VIDEO |
メディア アイテムは動画です。 |
MediaInsights
メディア アイテムに関するインサイトと統計情報です。
フィールド | |
---|---|
view_count |
出力のみ。メディア アイテムが表示された回数です。 |
MediaItemDataRef
Google My Business API を介してアップロードされた MediaItem
の写真バイナリデータへの参照です。
StartUploadMediaItemData
を使用してデータ参照を作成し、[UpdateMedia] にバイトをアップロードし、その後 CreateMediaItem
を呼び出すときにこの参照を使用します。
フィールド | |
---|---|
resource_name |
このメディア アイテムのバイナリデータの一意の ID です。[UpdateMedia] で写真データをアップロードし、 バイトのアップロード例:
|
MenuLabel
メニューとその各種サブコンポーネントを表示するときに使用するラベル。
フィールド | |
---|---|
display_name |
必須。コンポーネントの表示名。 |
description |
(省略可)コンポーネントの補足情報。 |
language_code |
(省略可)言語の BCP 47 コード。使用言語が利用できない場合、デフォルトで英語に設定されます。 |
指標
リソースに関するデータの指標。
列挙型 | |
---|---|
METRIC_UNSPECIFIED |
指標が指定されていません。 |
ALL |
利用可能なすべての指標をリクエストするための省略形です。どの指標がすべての指標に含まれるかは、分析情報がリクエストされているリソースによって異なります。 |
QUERIES_DIRECT |
ビジネスを直接検索したときにリソースが表示された回数。 |
QUERIES_INDIRECT |
リソースがカテゴリ検索(例: レストラン)の結果として表示された回数。 |
QUERIES_CHAIN |
リソースが属するチェーンまたは販売しているブランドを検索した結果として、リソースが表示された回数。たとえば、スターバックス、アディダスなどです。これは QUERIES_INDIRECT のサブセットです。 |
VIEWS_MAPS |
Google マップでリソースが表示された回数。 |
VIEWS_SEARCH |
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 |
リクエストされた指標。 |
options[] |
返された値の表示方法。 |
MetricValue
開始時刻からの単一の指標の値。
フィールド | |
---|---|
metric |
値を適用する指標。 |
total_value |
この指標の集計値の合計です。AGGREGATED_TOTAL オプションに対して設定されます。 |
dimensional_values[] |
この指標のディメンション値。 |
MoreHours
ビジネスが特定のタイプのビジネスを営業している期間です。
フィールド | |
---|---|
hours_type_id |
必須。営業時間の種類。クライアントは、{#link businessCategories:BatchGet} を呼び出して、店舗のカテゴリでサポートされている営業時間のタイプを取得する必要があります。 |
periods[] |
必須。ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
MoreHoursType
通常の営業時間に加えて、ビジネスが提供できるその他の営業時間タイプ。
フィールド | |
---|---|
hours_type_id |
出力のみ。この営業時間タイプに対して Google が提供する固定 ID。 |
display_name |
出力のみ。時間タイプの、人が読める形式の英語の表示名。 |
localized_display_name |
出力のみ。時間タイプの、人が読める形式のローカライズされた表示名。 |
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 |
出力のみ。通知リソース名。 |
topic_name |
このアカウントで管理しているビジネスが更新されたときに通知を受け取る Google Cloud Pub/Sub トピック。未設定のままにした場合、通知は投稿されません。 アカウント mybusiness-api-pubsub@system.gserviceaccount.com には、Cloud Pub/Sub トピックに対する少なくとも Publish 権限が必要です。 |
notification_types[] |
Cloud Pub/Sub トピックに送信される通知の種類。少なくとも 1 つ指定する必要があります。通知の受信を完全に停止するには、 |
NutritionFacts
このメッセージは、料理の栄養情報を表しています。
フィールド | |
---|---|
calories |
(省略可)その料理のカロリー。 |
total_fat |
(省略可)特定の料理の脂肪情報。 |
cholesterol |
(省略可)特定の料理のコレステロール情報。 |
sodium |
(省略可)特定の料理のナトリウム情報。 |
total_carbohydrate |
(省略可)特定の料理の炭水化物に関する情報。 |
protein |
(省略可)特定の料理のタンパク質情報。 |
CaloriesFact
このメッセージには、カロリー情報が上限と下限の範囲で示されます。下限額を指定してください。下限額と上限額はどちらも負でない数値です。
フィールド | |
---|---|
lower_amount |
必須。カロリー量の減少 |
upper_amount |
(省略可)カロリーの上限 |
unit |
必須。指定されたカロリー情報の単位。 |
EnergyUnit
摂取可能エネルギー(カロリー)の単位。
列挙型 | |
---|---|
ENERGY_UNIT_UNSPECIFIED |
エネルギー単位が指定されていません |
CALORIE |
kcal |
JOULE |
ジュール |
MassUnit
有効な質量単位。
列挙型 | |
---|---|
MASS_UNIT_UNSPECIFIED |
質量単位が指定されていません |
GRAM |
Gram |
MILLIGRAM |
ミリグラム |
NutritionFact
このメッセージは、栄養情報を上限と下限の範囲で示し、質量単位で表すことができます。下限額を指定してください。下限額と上限額はどちらも負でない数値です。
フィールド | |
---|---|
lower_amount |
必須。栄養の摂取量が少ない |
upper_amount |
(省略可)栄養摂取量の上限 |
unit |
必須。指定された栄養情報の単位。 |
OpenInfo
ビジネスの営業状態に関する情報です。
フィールド | |
---|---|
status |
ビジネスが現在営業しているかどうかを表します。すべてのビジネスはデフォルトで営業中になります(休業中に変更された場合を除く)。 |
can_reopen |
出力のみ。このビジネスが営業再開の条件を満たしているかどうかを示します。 |
opening_date |
ビジネスが開業した日付。正確な日付が不明な場合は、年月のみを指定できます。過去の日付または今後 1 年以内の日付を指定する必要があります。 |
OpenForBusiness
ビジネスのステータスを示します。
列挙型 | |
---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
指定されていません。 |
OPEN |
ビジネスが営業していることを表します。 |
CLOSED_PERMANENTLY |
ビジネスが閉業したことを表します。 |
CLOSED_TEMPORARILY |
ビジネスが臨時休業していることを示します。この値は、公開済みのビジネスにのみ適用されます(location_state.is_published = true)。ステータス フィールドをこの値に更新する場合、クライアントは update_mask を明示的に open_info.status に設定する必要があります。この更新の呼び出し中は、他の更新マスクを設定できません。これは一時的な制限であり、まもなく緩和される予定です。 |
PermissionLevel
認証されたユーザーがこのアカウントに対して持っているアクセス権を示します。
列挙型 | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
指定されていません。 |
OWNER_LEVEL |
ユーザーにはオーナー レベルの権限があります。 |
MEMBER_LEVEL |
ユーザーはメンバーレベルの権限を持っています。 |
PhoneInput
PHONE_CALL/SMS 確認用の入力。
フィールド | |
---|---|
phone_number |
通話の発信または SMS の送信先となる電話番号。有効なオプションの電話番号のいずれかを指定する必要があります。 |
PlaceInfo
プレイス ID で表される地域を定義します。
フィールド | |
---|---|
name |
場所のローカライズされた名前ですたとえば、 |
place_id |
場所の ID です。リージョンに対応している必要があります。 |
プレイス
場所のセットで表される地域の和集合を定義します。
フィールド | |
---|---|
place_infos[] |
プレイス ID で表される地域です。場所は最大 20 か所に制限されています。 |
PointRadius
緯度と経度で特定される地点を中心とした半径です。
フィールド | |
---|---|
latlng |
半径で定義した地域の中心を指定する緯度と経度です。 |
radius_km |
その地域の中心地点からの距離です。キロメートルで表されます。 |
PreparationMethod
料理の調理方法。
列挙型 | |
---|---|
PREPARATION_METHOD_UNSPECIFIED |
準備方法が指定されていません |
BAKED |
ベイクされたメソッド |
BARBECUED |
バーベキュー方式 |
BASTED |
踏み台法 |
BLANCHED |
ブランチ メソッド |
BOILED |
ボイルメソッド |
BRAISED |
蒸し煮方式 |
CODDLED |
Coddled メソッド |
FERMENTED |
発酵方法 |
FRIED |
揚げ方法 |
GRILLED |
グリルを使った方法 |
KNEADED |
こねる方法 |
MARINATED |
マリネートする方法 |
PAN_FRIED |
フライパンで揚げる方法 |
PICKLED |
ピクルス化方法 |
PRESSURE_COOKED |
圧力調理法 |
ROASTED |
ロースト方法 |
SAUTEED |
ソテー法 |
SEARED |
シーリング方法 |
SIMMERED |
シマード方式 |
SMOKED |
スモーク法 |
STEAMED |
蒸気方式 |
STEEPED |
急勾配方式 |
STIR_FRIED |
炒め物 |
OTHER_METHOD |
その他の方法 |
PriceList
非推奨: アイテム価格情報のリスト。価格リストは 1 つ以上の価格リストとして構成され、各価格表には 1 つ以上の商品アイテムを含む 1 つ以上のセクションが含まれています。たとえば、料理の価格表は、朝食、ランチ、ディナーのメニューを表し、ハンバーガー、ステーキ、シーフードのセクションを設けることができます。
フィールド | |
---|---|
price_list_id |
必須。料金表の ID。価格表、セクション、商品アイテム ID をこのビジネス内で重複させることはできません。 |
labels[] |
必須。料金表の言語タグ付きのラベル。 |
source_url |
料金表の取得元のソース URL(省略可)。たとえば、メニュー情報を入力するために自動的にスクレイピングされたページの URL などがこれに該当します。 |
sections[] |
必須。この料金表のセクション。各料金表にはセクションを少なくとも 1 つ含める必要があります。 |
ラベル
価格表、セクション、アイテムの表示時に使用するラベル。
フィールド | |
---|---|
display_name |
必須。価格表、セクション、または商品アイテムの表示名です。 |
description |
(省略可)価格表、セクション、または商品アイテムの説明です。 |
language_code |
(省略可)これらの文字列に適用する BCP 47 言語コードです。言語ごとに設定できるラベルのセットは 1 つのみです。 |
セクション
1 つ以上の商品アイテムを含む価格表のセクション。
フィールド | |
---|---|
section_id |
必須。セクションの ID。価格表、セクション、商品アイテム ID をこのビジネス内で重複させることはできません。 |
labels[] |
必須。セクションの言語タグ付きラベルです。セクション名と説明は 140 文字以下にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。 |
section_type |
(省略可)現在の料金表セクションのタイプ。デフォルト値は FOOD です。 |
items[] |
料金リストのこのセクションに含まれるアイテム。 |
項目
単一のリストアイテム。価格表のアイテムの各バリエーションには、独自の価格データを持つ独自のアイテムが必要です。
フィールド | |
---|---|
item_id |
必須。商品アイテムの ID。価格表、セクション、商品アイテム ID をこのビジネス内で重複させることはできません。 |
labels[] |
必須。商品アイテムの言語タグを含むラベルです。アイテム名は半角 140 文字(全角 120 文字)、商品説明は半角 250 文字(全角 125 文字)以内にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。 |
price |
(省略可)商品アイテムの価格。 |
SectionType
セクションのタイプ。
列挙型 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
指定されていません。 |
FOOD |
セクションには、食品を表すアイテムが含まれています。 |
SERVICES |
セクションには、サービスを表すアイテムが含まれます。 |
プロファイル
ビジネスのプロフィールに関するすべての情報です。
フィールド | |
---|---|
description |
自分の言葉で場所の説明を記述し、他のユーザーは編集できないようにします。 |
問題
1 つの質問とその回答の一部を表します。
フィールド | |
---|---|
name |
出力のみ。質問の一意の名前。accounts/*/locations/*/questions/* |
author |
出力のみ。質問者。 |
upvote_count |
出力のみ。質問に対する賛成票の数。 |
text |
質問のテキスト。3 単語以上、合計 10 文字以上にする必要があります。最大文字数は 4,096 文字です。 |
create_time |
出力のみ。質問が作成されたときのタイムスタンプ。 |
update_time |
出力のみ。質問が最後に変更されたときのタイムスタンプです。 |
top_answers[] |
出力のみ。質問に対する回答のリスト(賛成票の多い順)。リクエスト パラメータによっては、このリストがすべての回答を網羅していない場合があります(answers_per_question) |
total_answer_count |
出力のみ。この質問に対して投稿された回答の合計数。 |
RepeatedEnumAttributeValue
value_type
が REPEATED_ENUM である属性の値。これは、値 ID の 2 つのリストで構成されます。設定されている(true)ものと未設定(false)の ID です。存在しない値は不明と見なされます。少なくとも 1 つの値を指定する必要があります。
フィールド | |
---|---|
set_values[] |
設定されている列挙値。 |
unset_values[] |
設定されていない列挙値です。 |
ReportGoogleLocationRequest
GoogleLocation
を報告するためのリクエスト メッセージ。
フィールド | ||
---|---|---|
name |
[GoogleLocation] のリソース名。形式は |
|
location_group_name |
(省略可)この Google ビジネス レポートの対象となるビジネス グループのリソース名です。形式は |
|
report_reason_elaboration |
(省略可)ユーザーがこの場所を報告する理由を詳しく説明するためのテキスト エントリ。最大長は 512 文字です。 |
|
report_reason_language_code |
(省略可) |
|
共用体フィールド report_reason 。このビジネスが報告される理由です。理由を入力する必要があります。report_reason は次のいずれかになります。 |
||
report_reason_bad_location |
場所自体に問題がある場合に、ユーザーがこの場所を報告した理由。 |
|
report_reason_bad_recommendation |
おすすめに問題がある場合に、ユーザーがこの場所を報告した理由。このレポートは、対象のビジネスがビジネス プロフィール アカウントに推奨されている場合に役立ちます。 |
BadLocationReason
ビジネス自体のデータの品質に問題がある場合に、そのビジネスをレポートする理由として考えられるもの。
列挙型 | |
---|---|
BAD_LOCATION_REASON_UNSPECIFIED |
指定されていません。 |
NOT_A_LOCATION |
推奨されている場所が実際の場所ではありません。 |
PERMANENTLY_CLOSED |
おすすめのビジネスは閉業しています。 |
DOES_NOT_EXIST |
推奨される場所が存在しません。 |
SPAM |
スパム、虚偽、または不適切な場所がおすすめの場所である。 |
NOT_A_BUSINESS |
おすすめの場所は、私有の場所または自宅です。 |
MOVED |
おすすめの場所が新しい場所に移転しました。 新しい住所を指定する |
DUPLICATE |
おすすめのビジネス情報が別のビジネス情報と重複しています。 |
BadRecommendationReason
おすすめの精度に問題がある場合に、そのビジネスを報告できる一連の理由です(そのビジネスがユーザーに推奨されている場合)。
列挙型 | |
---|---|
BAD_RECOMMENDATION_REASON_UNSPECIFIED |
指定されていません。 |
NOT_A_STORE_FRONT |
おすすめのビジネス拠点は実店舗ではありません。 |
NOT_PART_OF_SUGGESTED_CHAIN |
おすすめのビジネスが、返されたビジネスの 正しいチェーンの名前を指定する |
IRRELEVANT |
おすすめの場所がユーザーと無関係である。 推奨事項が無関係である理由を示す |
ReportLocalPostInsightsRequest
Insights.ReportLocalPostInsights に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
必須。分析情報を取得するビジネスの名前。 |
local_post_names[] |
必須。インサイト データを取得する投稿のリスト。すべての投稿は、 |
basic_request |
基本的な指標の分析情報をレポートに含めるためのリクエスト。このリクエストは、リクエストされたすべての投稿に適用されます。 |
ReportLocalPostInsightsResponse
Insights.ReportLocalPostInsights に対するレスポンス メッセージです。
フィールド | |
---|---|
name |
|
local_post_metrics[] |
この場所に対応するリクエストされた投稿ごとに 1 つのエントリ。 |
time_zone |
ビジネスのタイムゾーン(IANA タイムゾーン ID。「Europe/London」など)。 |
ReportLocationInsightsRequest
Insights.ReportLocationInsights に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
アカウントのリソース名。 |
location_names[] |
分析情報を取得するビジネスのコレクション。ビジネスの名前で指定します。 |
basic_request |
基本的な指標の分析情報をレポートに含めるためのリクエスト。 |
driving_directions_request |
運転ルートのリクエストに関する分析情報をレポートに含めるリクエスト。 |
ReportLocationInsightsResponse
Insights.ReportLocationInsights
に対するレスポンス メッセージです。
フィールド | |
---|---|
location_metrics[] |
ロケーション別の指標値のコレクション。 |
location_driving_direction_metrics[] |
運転ルートに関連する指標の値のコレクション。 |
復習
出力のみ。ビジネスについてのクチコミを表します。
フィールド | |
---|---|
name |
リソース名。レビューの場合は、 |
review_id |
暗号化された一意の識別子。 |
reviewer |
レビューを書いた人です。 |
star_rating |
レビューの評価です。 |
comment |
マークアップ付きの書式なしテキストによるレビューの本文です。 |
create_time |
クチコミが投稿されたときのタイムスタンプです。 |
update_time |
クチコミが最後に変更されたときのタイムスタンプです。 |
review_reply |
このクチコミに対するビジネスのオーナーまたは管理者による返信です。 |
審査担当者
レビューの投稿者を表します。
フィールド | |
---|---|
profile_photo_url |
クチコミ投稿者のプロフィール写真のリンクです。 |
display_name |
クチコミ投稿者の名前です。 |
is_anonymous |
クチコミ投稿者が匿名のままにするよう設定しているかどうかを表します。 |
StarRating
5 段階のうちの星評価(5 が最高評価)。
列挙型 | |
---|---|
STAR_RATING_UNSPECIFIED |
指定されていません。 |
ONE |
最高で星 5 つのうちの 1 つ星です。 |
TWO |
最高で星 5 つのうちの 2 つ星です。 |
THREE |
最高で星 5 つのうちの 3 つ星です。 |
FOUR |
最高で星 5 つのうちの 4 つ星です。 |
FIVE |
最高の評価です。 |
ReviewReply
クチコミに対するビジネスのオーナーまたは管理者による返信を表します。
フィールド | |
---|---|
comment |
マークアップ付きの書式なしテキストとしての返信の本文です。最大長は 4,096 バイトです。 |
update_time |
出力のみ。返信が最後に変更されたときのタイムスタンプです。 |
SearchChainsRequest
Locations.SearchChains に対するリクエスト メッセージです。
フィールド | |
---|---|
chain_display_name |
名前でチェーンを検索します。完全一致/部分/ファジー/関連クエリがサポートされています。例: 「walmart」、「wal-mart」、「walmmmart」、「省尔玛」 |
result_count |
このクエリから返される、一致したチェーンの最大数です。デフォルト値は 10 です。指定できる最大値は 500 です。 |
SearchChainsResponse
Locations.SearchChains に対するレスポンス メッセージ。
フィールド | |
---|---|
chains[] |
SearchChainsRequest でクエリされた chain_display_name と一致するチェーン。一致するものがない場合、このフィールドは空になります。結果は関連性の高い順に一覧表示されます。 |
SearchGoogleLocationsRequest
GoogleLocations.SearchGoogleLocations に対するリクエスト メッセージです。
フィールド | ||
---|---|---|
result_count |
返される一致の数。デフォルト値は 3、最大値は 10 です。さらにリクエストすると、レイテンシが増加する可能性があります。ページ分けはありません。 |
|
共用体フィールド search_query 。検索クエリ。位置情報オブジェクトまたは文字列クエリで指定できます。search_query は次のいずれかになります。 |
||
location |
検索対象の場所。指定すると、指定した場所の詳細に一致する場所が検索されます。 |
|
query |
検索するテキストクエリ。クエリ文字列から得られる検索結果は、正確な場所を指定する場合よりも精度は低くなりますが、完全一致しない一致の可能性は高くなります。 |
SearchGoogleLocationsResponse
GoogleLocations.SearchGoogleLocations に対するレスポンス メッセージです。
フィールド | |
---|---|
google_locations[] |
指定されたリクエストに一致する可能性がある GoogleLocations のコレクション。精度が高い順に表示されます。 |
ServiceAreaBusiness
非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです(鍵業者や配管業者など)。
フィールド | ||
---|---|---|
business_type |
非店舗型ビジネスの |
|
共用体フィールド coverageArea 。ビジネスがサービスを提供するサービス提供地域を表します。coverageArea は次のいずれかになります。 |
||
radius |
出力のみ。このビジネスがサービスを提供する地域を、中心からの半径で表します。 |
|
places |
そのビジネスがサービスを提供する地域を、場所のセットで定義します。 |
BusinessType
このビジネスが、顧客のもとに出向いてオンサイトのサービスのみを提供する(レッカー車など)か、住所とオンサイトの両方でサービスを提供する(ダイニング エリアを備えたピザ屋で、宅配もするピザ店など)かを示します。
列挙型 | |
---|---|
BUSINESS_TYPE_UNSPECIFIED |
出力のみ。指定されていません。 |
CUSTOMER_LOCATION_ONLY |
ビジネス拠点がある住所ではなく、周辺地域でのみサービスを提供します。 |
CUSTOMER_AND_BUSINESS_LOCATION |
ビジネスの住所とその周辺地域でサービスを提供します。 |
ServiceBusinessContext
サービスのビジネスのオーナー確認に使用する追加データです。
フィールド | |
---|---|
address |
ビジネスのオーナー確認用住所です。他の確認オプションを有効にするか、ハガキを郵送する場合に使用します。 |
ServiceList
1 つ以上のサービス項目を含むサービスリスト。
フィールド | |
---|---|
name |
必須。このビジネスの Google 識別子。 |
service_items[] |
このサービスリストに含まれるサービス アイテムです。重複するサービス項目は自動的に削除されます。 |
ServiceItem
1 つのサービス アイテムを説明するメッセージ。販売者が提供しているサービスの種類を表すために使用されます。たとえば、ヘアカットがサービスになりえます。
フィールド | ||
---|---|---|
is_offered |
(省略可)このフィールドは、販売者が入力サービスを提供するかどうかを決定します。 |
|
price |
(省略可)サービス アイテムの金額を表します。価格を含める場合は、currency_code と単位を設定することをおすすめします。 |
|
共用体フィールド service_item_info 。次のフィールドのいずれかを必ず設定する必要があります。service_item_info は次のいずれかになります。 |
||
structured_service_item |
このフィールドは、構造化データのデータの大文字 / 小文字に設定されます。 |
|
free_form_service_item |
このフィールドは、自由形式のサービスデータのケースに設定されます。 |
FreeFormServiceItem
販売者が提供する自由形式のサービスを表します。これらのサービスは、ストラクチャ サービス データの一部として公開されません。販売者は、販売者向けのサーフェスでサービスの名前を手動で入力します。
フィールド | |
---|---|
category_id |
必須。 |
label |
必須。商品アイテムの言語タグを含むラベルです。アイテム名は半角 140 文字(全角 120 文字)、商品説明は半角 250 文字(全角 125 文字)以内にすることをおすすめします。このフィールドは、入力がカスタム サービス アイテムである場合にのみ設定する必要があります。標準化されたサービスタイプは、service_type_id で更新する必要があります。 |
StructuredServiceItem
販売者が提供する構造化されたサービスを表します。(例: toilet_installation)。
フィールド | |
---|---|
service_type_id |
必須。 |
description |
(省略可)構造化されたサービス アイテムの説明。文字数制限は 300 文字です。 |
ServiceType
ビジネスが提供するサービスの種類を説明するメッセージ。
フィールド | |
---|---|
service_type_id |
出力のみ。このサービスタイプの不変の ID(Google 提供)です。 |
display_name |
出力のみ。人が読める形式のサービスタイプの表示名。 |
SpecialHourPeriod
ビジネスの営業時間が通常の営業時間と異なる単一の期間を表します。特別営業時間が表す期間は 24 時間未満でなければなりません。open_time
と start_date
は、close_time
と end_date
より前の日付にする必要があります。close_time
と end_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 |
この特別営業時間が始まる日付です。 |
open_time |
営業開始時の |
end_date |
この特別営業時間が終了する日付です。 |
close_time |
閉店時の |
is_closed |
true の場合、 |
SpecialHours
ビジネスの営業時間が通常の営業時間と異なる一連の期間を表します。
フィールド | |
---|---|
special_hour_periods[] |
ビジネスの通常の時間帯に対する例外の一覧です。 |
辛さ
食品の辛さレベル。
列挙型 | |
---|---|
SPICINESS_UNSPECIFIED |
レベルが指定されていません |
MILD |
ややスパイシーな感じ。 |
MEDIUM |
中程度の辛さを表す言葉。 |
HOT |
ホット スパイシーの記号。最もスパイシーなレベル。 |
StartUploadMediaItemDataRequest
Media.StartUploadMediaItemData に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
このメディア アイテムを追加するビジネスのリソース名です。 |
TimeInterval
時間間隔(この時間を含む)。有効にするには、すべてのフィールドが含まれている必要があります。
フィールド | |
---|---|
start_date |
この期間の開始日です。 |
start_time |
この期間の開始時間です。 |
end_date |
この期間の終了日です。 |
end_time |
この期間の終了時間です。 |
TimePeriod
ビジネスが営業している期間を表します。指定した営業開始日時から始まり、指定した営業終了日時で終わります。営業終了時間は、営業開始時間の後、たとえば同じ日の後の時間か翌日に設定する必要があります。
フィールド | |
---|---|
open_day |
この期間が始まる |
open_time |
24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
close_day |
この期間が終了する |
close_time |
24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
TimeRange
期間。その範囲のデータは、半開探索(つまり [start_time, end_time)] として pull されます。
フィールド | |
---|---|
start_time |
範囲の開始時点のエポック タイムスタンプ(その時点を含む)。 |
end_time |
期間終了時のエポック タイムスタンプ(その時刻を除く)。 |
TransferLocationRequest
Locations.TransferLocation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
移管するビジネスの名前。 |
to_account |
ビジネスの移管先となるアカウント リソースの名前(例: 「accounts/8675309」)。 |
UpdateAccountAdminRequest
AccessControl.UpdateAccountAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新する管理者のリソース名。 |
admin |
更新された管理者。注: 編集可能なフィールドは |
UpdateAccountRequest
Accounts.UpdateAccount に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新するアカウントの名前です。 |
account |
更新されたアカウント情報。注: 編集可能なフィールドは |
validate_only |
true の場合、アカウントが実際に更新されることなく、リクエストの検証のみが行われます。 |
UpdateFoodMenusRequest
FoodMenu.UpdateFoodMenus に対するリクエスト メッセージです。
フィールド | |
---|---|
food_menus |
必須。更新されたフードメニューの情報。メニュー セクションなしで更新することで、メニューの設定を解除できます。 |
update_mask |
(省略可)更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエストに含まれる未設定の空のフィールドもこの対象となる場合があります。繰り返しフィールドの項目を個別に更新することはできません。注: FoodMenus の「name」はリソース識別子であり、更新できません。 |
UpdateHealthProviderAttributesRequest
HealthProviderAttributes.UpdateHealthProviderAttributes に対するリクエスト メッセージ
フィールド | |
---|---|
health_provider_attributes |
必須。更新された医療従事者の属性。 |
update_mask |
(省略可)更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエストに含まれる未設定の空のフィールドもこの対象となる場合があります。V1 では、insurance_networks フィールドのみ更新する必要があります。今後、その他の属性もサポートされる予定です。 |
UpdateLocalPostRequest
UpdateLocalPost に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新するローカル投稿の名前です。 |
local_post |
更新されたローカル投稿の情報です。 |
update_mask |
更新するフィールドです。マスクで更新する各フィールドを指定する必要があります。 |
UpdateLocationAdminRequest
AccessControl.UpdateLocationAdmin に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新する管理者のリソース名。 |
admin |
更新された管理者。注: 編集可能なフィールドは |
UpdateLocationRequest
Locations.UpdateLocation に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新するビジネスの名前です。 |
location |
更新されたビジネスに関する情報です。 |
update_mask |
更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエストに含まれる未設定の空のフィールドもこの対象となる場合があります。 |
validate_only |
true の場合、ビジネスが実際に更新されることなく、リクエストの検証のみが行われます。 |
attribute_mask |
更新する属性の ID です。マスクで指定した属性のみが更新されます。マスクにのみ含まれ、ビジネスには含まれない属性は削除されます。空のマスクを使用すると、すべての属性が更新されます。 このフィールドを設定する際は、更新するフィールドの 1 つとして update_mask の属性を含める必要があります。 |
UpdateMediaItemRequest
Media.UpdateMediaItem に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新するメディア アイテムの名前です。 |
media_item |
更新するメディア アイテムです。 更新できるのは、カテゴリまたは価格表アイテム ID のみです。 |
update_mask |
更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、編集可能なすべてのフィールドは渡された値に設定されます。 |
UpdateNotificationsRequest
Accounts.UpdateNotifications に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
通知設定のリソース名。 |
notifications |
更新された通知設定。 |
UpdateQuestionRequest
QuestionsAndAnswers.UpdateQuestion に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
更新する質問の名前です。 |
question |
更新された質問。 |
UpdateReviewReplyRequest
Reviews.UpdateReviewReply に対するリクエスト メッセージです。
フィールド | |
---|---|
name |
返信するクチコミの名前です。 |
review_reply |
クチコミへの返信です。返信がすでに存在する場合は、古い返信が更新されます。 |
UpdateServiceListRequest
サービスリスト リクエスト メッセージの更新。
フィールド | |
---|---|
service_list |
(省略可)更新されたサービスリストの情報。このフィールドを空のままにすると、API は ServiceList を削除します。ServiceList が設定されている場合、API は元の ServiceList を設定された ServiceList に置き換えます。 |
update_mask |
(省略可)更新するフィールドです。マスクが指定されていない場合は、完全な更新として処理され、すべてのフィールドは渡された値に設定されます。リクエストに含まれる未設定の空のフィールドもこの対象となる場合があります。繰り返しフィールドの項目を個別に更新することはできません。 |
UpsertAnswerRequest
QuestionsAndAnswers.UpsertAnswer に対するリクエスト メッセージです。
フィールド | |
---|---|
parent |
回答を書く質問の名前です。 |
answer |
新しい答えです。 |
UrlAttributeValue
value_type
が URL である属性の値。
フィールド | |
---|---|
url |
URL。 |
ValidationError
クライアント リクエストの検証エラーについて説明します。
フィールド | |
---|---|
error_details[] |
個々の検証エラーを整数のエラーコードで詳細に説明します。 |
検証
オーナー確認とは、ビジネスのオーナー確認の試行を指します。
フィールド | |
---|---|
name |
オーナー確認のリソース名。 |
method |
オーナー確認の方法。 |
state |
オーナー確認の状態です。 |
create_time |
オーナー確認がリクエストされたときのタイムスタンプ。 |
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 |
ビジネスのオーナー確認方法。 |
|
共用体フィールド DisplayData 。表示データの 1 つ。データはメソッドと一致する必要があります。対応するメソッドに表示データがない場合は空になります。DisplayData は次のいずれかになります。 |
||
phone_data |
メソッドが PHONE_CALL または SMS の場合にのみ設定します。 |
|
address_data |
メソッドが mail の場合にのみ設定します。 |
|
email_data |
メソッドが EMAIL の場合にのみ設定します。 |
AddressVerificationData
ハガキでオーナー確認を行うためのデータを表示します。
フィールド | |
---|---|
business_name |
販売者のお店やサービスの名前。 |
address |
ハガキの送付先の住所です。 |
EmailVerificationData
メールでオーナー確認を行うためのデータを表示します。
フィールド | |
---|---|
domain_name |
メールアドレスのドメイン名。foo@gmail.com の「gmail.com」など |
user_name |
メールアドレスのユーザー名。foo@gmail.com の「foo」など |
is_user_name_editable |
クライアントが別のユーザー名を指定できるかどうか。 |
PhoneVerificationData
電話によるオーナー確認(電話、SMS など)のためのデータの表示。
フィールド | |
---|---|
phone_number |
PIN が送信される電話番号。 |
VerifyLocationRequest
Verifications.VerifyLocation に対するリクエスト メッセージ。
フィールド | ||
---|---|---|
name |
確認するビジネスのリソース名。 |
|
method |
確認方法。 |
|
language_code |
確認プロセスに使用される言語を表す BCP 47 言語コード。 |
|
context |
サービス ビジネスのオーナー確認を行うための追加のコンテキスト情報です。業種が CUSTOMER_LOCATION_ONLY のビジネスの場合は必須です。住所確認では、この住所を使用してハガキの送付が行われます。他のメソッドの場合は、FetchVerificationOptions に渡されるメソッドと同じにする必要があります。他のタイプのビジネス拠点に対して INVALID_ARGUMENT が設定されている場合、スローされます。 |
|
共用体フィールド RequestData 。表示データ以外の、特定の方法のユーザー入力データ。データはリクエストされた方法と一致する必要があります。データが不要な場合は空欄のままにしておきます。RequestData は次のいずれかになります。 |
||
email_input |
EMAIL メソッドの入力。 |
|
address_input |
ADDRESS メソッドの入力。 |
|
phone_input |
PHONE_CALL/SMS メソッドの入力 |
VerifyLocationResponse
Verifications.VerifyLocation に対するレスポンス メッセージ。
フィールド | |
---|---|
verification |
作成された確認リクエスト。 |