Package google.mybusiness.v4

Index

• AccessControl (interface) (deprecated)
• Accounts (interface) (deprecated)
• BusinessCategories (interface)
• BusinessMessagingService (interface)
• Followers (interface)
• FoodMenuService (interface)
• GoogleLocations (interface)
• HealthProviderAttributesService (interface)
• Insights (interface)
• InsuranceNetworkService (interface)
• LocalPosts (interface)
• Locations (interface)
• Media (interface)
• QuestionsAndAnswers (interface)
• Reviews (interface)
• ServiceLists (interface)
• Verifications (interface)
• AcceptInvitationRequest (message)
• Account (message) (deprecated)
• Account.OrganizationInfo (message)
• AccountRole (enum)
• AccountState (message)
• AccountState.AccountStatus (enum)
• AccountType (enum)
• AdWordsLocationExtensions (message)
• AddressInput (message)
• Admin (message)
• Admin.AdminRole (enum)
• AlertType (enum)
• Allergen (enum)
• Answer (message)
• AssociateLocationRequest (message)
• Attribute (message)
• AttributeMetadata (message)
• AttributeMetadata.AttributeValueMetadata (message)
• AttributeValueType (enum)
• Author (message)
• Author.AuthorType (enum)
• BasicMetricsRequest (message)
• BatchGetBusinessCategoriesRequest (message)
• BatchGetBusinessCategoriesResponse (message)
• BatchGetLocationsRequest (message)
• BatchGetLocationsResponse (message)
• BatchGetReviewsRequest (message)
• BatchGetReviewsResponse (message)
• BusinessHours (message)
• CallToAction (message)
• CallToAction.ActionType (enum)
• Category (message)
• CategoryView (enum)
• Chain (message)
• Chain.ChainName (message)
• Chain.ChainUrl (message)
• ClearLocationAssociationRequest (message)
• CompleteVerificationRequest (message)
• CompleteVerificationResponse (message)
• CreateAccountAdminRequest (message)
• CreateAccountRequest (message)
• CreateLocalPostRequest (message)
• CreateLocationAdminRequest (message)
• CreateLocationRequest (message)
• CreateMediaItemRequest (message)
• CreateQuestionRequest (message)
• DeclineInvitationRequest (message)
• DeleteAccountAdminRequest (message)
• DeleteAnswerRequest (message)
• DeleteLocalPostRequest (message)
• DeleteLocationAdminRequest (message)
• DeleteLocationRequest (message)
• DeleteMediaItemRequest (message)
• DeleteNotificationsRequest (message)
• DeleteQuestionRequest (message)
• DeleteReviewReplyRequest (message)
• DietaryRestriction (enum)
• DimensionalMetricValue (message)
• DimensionalMetricValue.TimeDimension (message)
• DrivingDirectionMetricsRequest (message)
• DrivingDirectionMetricsRequest.NumDays (enum)
• EmailInput (message)
• ErrorDetail (message)
• ErrorDetail.ErrorCode (enum)
• FetchVerificationOptionsRequest (message)
• FetchVerificationOptionsResponse (message)
• FindMatchingLocationsRequest (message)
• FindMatchingLocationsResponse (message)
• FollowersMetadata (message)
• FoodMenu (message)
• FoodMenu.Cuisine (enum)
• FoodMenuItem (message)
• FoodMenuItemAttributes (message)
• FoodMenuItemAttributes.Ingredient (message)
• FoodMenuItemAttributes.PortionSize (message)
• FoodMenuItemOption (message)
• FoodMenuSection (message)
• FoodMenus (message)
• GenerateAccountNumberRequest (message)
• GetAccountRequest (message)
• GetChainRequest (message)
• GetCustomerMediaItemRequest (message)
• GetFollowersMetadataRequest (message)
• GetFoodMenusRequest (message)
• GetHealthProviderAttributesRequest (message)
• GetLocalPostRequest (message)
• GetLocationRequest (message)
• GetMediaItemRequest (message)
• GetNotificationsRequest (message)
• GetReviewRequest (message)
• GetServiceListRequest (message)
• GoogleLocation (message)
• GoogleUpdatedLocation (message)
• HealthProviderAttributes (message)
• InsuranceNetwork (message)
• InternalError (message)
• Invitation (message)
• Invitation.TargetLocation (message)
• ListAccountAdminsRequest (message)
• ListAccountAdminsResponse (message)
• ListAccountsRequest (message)
• ListAccountsResponse (message)
• ListAnswersRequest (message)
• ListAnswersResponse (message)
• ListAttributeMetadataRequest (message)
• ListAttributeMetadataResponse (message)
• ListBusinessCategoriesRequest (message)
• ListBusinessCategoriesResponse (message)
• ListCustomerMediaItemsRequest (message)
• ListCustomerMediaItemsResponse (message)
• ListInsuranceNetworksRequest (message)
• ListInsuranceNetworksResponse (message)
• ListInvitationsRequest (message)
• ListInvitationsRequest.TargetType (enum)
• ListInvitationsResponse (message)
• ListLocalPostsRequest (message)
• ListLocalPostsResponse (message)
• ListLocationAdminsRequest (message)
• ListLocationAdminsResponse (message)
• ListLocationsRequest (message)
• ListLocationsResponse (message)
• ListMediaItemsRequest (message)
• ListMediaItemsResponse (message)
• ListQuestionsRequest (message)
• ListQuestionsResponse (message)
• ListRecommendedGoogleLocationsRequest (message)
• ListRecommendedGoogleLocationsResponse (message)
• ListReviewsRequest (message)
• ListReviewsResponse (message)
• ListVerificationsRequest (message)
• ListVerificationsResponse (message)
• LocalPost (message)
• LocalPost.LocalPostState (enum)
• LocalPostEvent (message)
• LocalPostMetrics (message)
• LocalPostOffer (message)
• LocalPostTopicType (enum)
• Location (message)
• Location.Metadata (message)
• Location.Metadata.Duplicate (message)
• Location.Metadata.Duplicate.Access (enum)
• Location.RelationshipData (message)
• LocationDrivingDirectionMetrics (message)
• LocationDrivingDirectionMetrics.TopDirectionSources (message)
• LocationDrivingDirectionMetrics.TopDirectionSources.RegionCount (message)
• LocationKey (message)
• LocationMetrics (message)
• LocationReview (message)
• LocationState (message)
• MatchedLocation (message)
• MediaItem (message)
• MediaItem.Attribution (message)
• MediaItem.Dimensions (message)
• MediaItem.LocationAssociation (message)
• MediaItem.LocationAssociation.Category (enum)
• MediaItem.MediaFormat (enum)
• MediaItem.MediaInsights (message)
• MediaItemDataRef (message)
• MenuLabel (message)
• Metric (enum)
• MetricOption (enum)
• MetricRequest (message)
• MetricValue (message)
• MoreHours (message)
• MoreHoursType (message)
• NetworkState (enum)
• NotificationType (enum)
• Notifications (message)
• NutritionFacts (message)
• NutritionFacts.CaloriesFact (message)
• NutritionFacts.EnergyUnit (enum)
• NutritionFacts.MassUnit (enum)
• NutritionFacts.NutritionFact (message)
• OpenInfo (message)
• OpenInfo.OpenForBusiness (enum)
• PermissionLevel (enum)
• PhoneInput (message)
• PlaceInfo (message)
• Places (message)
• PointRadius (message)
• PreparationMethod (enum)
• PriceList (message) (deprecated)
• PriceList.Label (message)
• PriceList.Section (message)
• PriceList.Section.Item (message)
• PriceList.Section.SectionType (enum)
• Profile (message)
• Question (message)
• RepeatedEnumAttributeValue (message)
• ReportGoogleLocationRequest (message)
• ReportGoogleLocationRequest.BadLocationReason (enum)
• ReportGoogleLocationRequest.BadRecommendationReason (enum)
• ReportLocalPostInsightsRequest (message)
• ReportLocalPostInsightsResponse (message)
• ReportLocationInsightsRequest (message)
• ReportLocationInsightsResponse (message)
• Review (message)
• Review.Reviewer (message)
• Review.StarRating (enum)
• ReviewReply (message)
• SearchChainsRequest (message)
• SearchChainsResponse (message)
• SearchGoogleLocationsRequest (message)
• SearchGoogleLocationsResponse (message)
• ServiceAreaBusiness (message)
• ServiceAreaBusiness.BusinessType (enum)
• ServiceBusinessContext (message)
• ServiceList (message)
• ServiceList.ServiceItem (message)
• ServiceList.ServiceItem.FreeFormServiceItem (message)
• ServiceList.ServiceItem.StructuredServiceItem (message)
• ServiceType (message)
• SpecialHourPeriod (message)
• SpecialHours (message)
• Spiciness (enum)
• StartUploadMediaItemDataRequest (message)
• TimeInterval (message)
• TimePeriod (message)
• TimeRange (message)
• TransferLocationRequest (message)
• UpdateAccountAdminRequest (message)
• UpdateAccountRequest (message)
• UpdateFoodMenusRequest (message)
• UpdateHealthProviderAttributesRequest (message)
• UpdateLocalPostRequest (message)
• UpdateLocationAdminRequest (message)
• UpdateLocationRequest (message)
• UpdateMediaItemRequest (message)
• UpdateNotificationsRequest (message)
• UpdateQuestionRequest (message)
• UpdateReviewReplyRequest (message)
• UpdateServiceListRequest (message)
• UpsertAnswerRequest (message)
• UrlAttributeValue (message)
• ValidationError (message)
• Verification (message)
• Verification.VerificationState (enum)
• VerificationMethod (enum)
• VerificationOption (message)
• VerificationOption.AddressVerificationData (message)
• VerificationOption.EmailVerificationData (message)
• VerificationOption.PhoneVerificationData (message)
• VerifyLocationRequest (message)
• VerifyLocationResponse (message)

AccessControl

This resource is deprecated!

This service allows management of the users that have access to accounts and locations.

AcceptInvitation
Deprecated. Please use the Account Management API instead. rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty) Accepts the specified invitation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

CreateAccountAdmin

Deprecated. Please use the Account Management API instead. rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin) Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] to programmatically accept an invitation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

CreateLocationAdmin

Deprecated. Please use the Account Management API instead. rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin) Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] to programmatically accept an invitation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeclineInvitation
Deprecated. Please use the Account Management API instead. rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty) Declines the specified invitation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteAccountAdmin
Deprecated. Please use the Account Management API instead. rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty) Removes the specified admin from the specified account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteLocationAdmin

Deprecated. Please use the Account Management API instead. rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty) Removes the specified admin as a manager of the specified location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListAccountAdmins

Deprecated. Please use the Account Management API instead. rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse) Lists the admins for the specified account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListInvitations

Deprecated. Please use the Account Management API instead. rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse) Lists pending invitations for the specified account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListLocationAdmins

Deprecated. Please use the Account Management API instead. rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse) Lists all of the admins for the specified location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateAccountAdmin

Deprecated. Please use the Account Management API instead. rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin) Updates the Admin for the specified Account Admin. Only the AdminRole of the Admin can be updated. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateLocationAdmin

Deprecated. Please use the Account Management API instead. rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin) Updates the Admin for the specified Location Admin. Only the AdminRole of the Admin can be updated. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Accounts

This resource is deprecated!

This API allows management of business accounts on Google. It lets you manage Account resources. It defines the following resource model:

• The API has a collection of Account resources, named accounts/*

• As a convenience, you may use the synonym "me" instead of the account id for the personal account of the authenticated caller. Examples: GET /v4/accounts/me GET /v4/accounts/me/locations

CreateAccount

Deprecated. Please use the Account Management API instead. rpc CreateAccount(CreateAccountRequest) returns (Account) Creates an account with the specified name and type under the given parent. Personal accounts and Organizations cannot be created. User Groups cannot be created with a Personal account as primary owner. Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. Location Groups cannot own Location Groups. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteNotifications
Deprecated. Please use the Notifications API instead. rpc DeleteNotifications(DeleteNotificationsRequest) returns (Empty) Clears the pubsub notification settings for the account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GenerateAccountNumber

This endpoint is deprecated. rpc GenerateAccountNumber(GenerateAccountNumberRequest) returns (Account) Generates an account number for this account. The account number is not provisioned when an account is created. Use this request to create an account number when it is required. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetAccount

Deprecated. Please use the Account Management API instead. rpc GetAccount(GetAccountRequest) returns (Account) Gets the specified account. Returns NOT_FOUND if the account does not exist or if the caller does not have access rights to it. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetNotifications
Deprecated. Please use the Notifications API instead. rpc GetNotifications(GetNotificationsRequest) returns (Notifications) Returns the pubsub notification settings for the account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListAccounts

Deprecated. Please use the Account Management API instead. rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateAccount

Deprecated. Please use the Account Management API instead. rpc UpdateAccount(UpdateAccountRequest) returns (Account) Updates the specified business account. Personal accounts cannot be updated using this method. Note: The only editable field for an account is account_name. Any other fields passed in (such as type or role) are ignored. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateNotifications

Deprecated. Please use the Notifications API instead. rpc UpdateNotifications(UpdateNotificationsRequest) returns (Notifications) Sets the pubsub notification settings for the account informing Business Profile which topic to send pubsub notifications for: New reviews for locations administered by the account. Updated reviews for locations administered by the account. New GoogleUpdates for locations administered by the account. An account will only have one notification settings resource, and only one pubsub topic can be set. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

BusinessCategories

This API enables visibility of supported categories for business locations on Google. You can obtain paginated lists of all available business categories, or search by a specific term. For reference, see the categories section of this article: https://support.google.com/business/answer/3038177

BatchGetBusinessCategories

rpc BatchGetBusinessCategories(BatchGetBusinessCategoriesRequest) returns (BatchGetBusinessCategoriesResponse) Returns a list of business categories for the provided language and GConcept ids. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListBusinessCategories

rpc ListBusinessCategories(ListBusinessCategoriesRequest) returns (ListBusinessCategoriesResponse) Returns a list of business categories. Search will match the category name but not the category ID. Note: Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant'). Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

BusinessMessagingService

Allows businesses to register their locations for business messaging to enable a communication channel from consumers who search for their locations. To view and perform actions on a location's business messaging, you need to be a MANAGER or OWNER of the location.

Followers

This API exposes the management API of followers.

GetFollowersMetadata

rpc GetFollowersMetadata(GetFollowersMetadataRequest) returns (FollowersMetadata) Get the followers settings for a location. NOT_FOUND is returned if either the account or the location doesn't exist. PRECONDITION_FAILED is returned if the location is not verified nor connected to Maps. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

FoodMenuService

This API allows get and update the food menus of business locations.

Note that the Location.PriceList also represents "menus" in one of its type but with limited fields. It shares the same downstream storage as FoodMenus. Once migration to FoodMenuService is done, clients are strongly discouraged to use Location.PriceList to update menu data anymore, which may result in unexpected data loss.

GetFoodMenus
rpc GetFoodMenus(GetFoodMenusRequest) returns (FoodMenus) Returns the food menus of a specific location. Only call this if location.location_state.can_have_food_menu is true. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateFoodMenus
rpc UpdateFoodMenus(UpdateFoodMenusRequest) returns (FoodMenus) Updates the food menus of a specific location. Only call this if location.location_state.can_have_food_menu is true. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GoogleLocations

This API allows access and search GoogleLocation.

ListRecommendedGoogleLocations

rpc ListRecommendedGoogleLocations(ListRecommendedGoogleLocationsRequest) returns (ListRecommendedGoogleLocationsResponse) List all the GoogleLocations that have been recommended to the specified Business Profile account. Recommendations are provided for personal accounts and location groups only, requests for all other account types will result in an error. The recommendations for location groups are based on the locations in that group. The recommendations for personal accounts are based on all of the locations that the user has access to on Business Profile (which includes locations they can access through location groups), and is a superset of all recommendations generated for the user. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ReportGoogleLocation
rpc ReportGoogleLocation(ReportGoogleLocationRequest) returns (Empty) Report a GoogleLocation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

SearchGoogleLocations
rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse) Search all of the possible locations that are a match to the specified request. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

HealthProviderAttributesService

This service allows the management of Health provider attributes (e.g. insurance accepted by a location) linked with a location.

GetHealthProviderAttributes
rpc GetHealthProviderAttributes(GetHealthProviderAttributesRequest) returns (HealthProviderAttributes) Returns the Health provider attributes of a specific location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateHealthProviderAttributes
rpc UpdateHealthProviderAttributes(UpdateHealthProviderAttributesRequest) returns (HealthProviderAttributes) Updates the Health provider attributes of a specific location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Insights

Generates reports detailing consumer insights for one or more listings on Google services. Aggregated data for basic metrics can be queried over a range of up to 18 months old. Metrics that support a breakdown can show aggregated data over this range broken down by day of the week or hour of the day. Driving direction requests can be reported in snapshots over a select number of days.

ReportLocalPostInsights

rpc ReportLocalPostInsights(ReportLocalPostInsightsRequest) returns (ReportLocalPostInsightsResponse) Returns insights for a set of local posts associated with a single listing. Which metrics and how they are reported are options specified in the request proto. Note: Insight reports are limited to 100 local_post_names per call. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ReportLocationInsights

rpc ReportLocationInsights(ReportLocationInsightsRequest) returns (ReportLocationInsightsResponse) Returns a report containing insights on one or more metrics by location. Note: Insight reports are limited to a batch size of 10 location_names per call. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

InsuranceNetworkService

This service allows to get all supported insurance networks for Health business locations on Google.

ListInsuranceNetworks
rpc ListInsuranceNetworks(ListInsuranceNetworksRequest) returns (ListInsuranceNetworksResponse) Returns a list of all insurance networks supported by Google. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

LocalPosts

This API exposes the management API of local posts.

CreateLocalPost
rpc CreateLocalPost(CreateLocalPostRequest) returns (LocalPost) Creates a new local post associated with the specified location, and returns it. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteLocalPost
rpc DeleteLocalPost(DeleteLocalPostRequest) returns (Empty) Deletes a local post. Returns NOT_FOUND if the local post does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetLocalPost
rpc GetLocalPost(GetLocalPostRequest) returns (LocalPost) Gets the specified local post. Returns NOT_FOUND if the local post does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListLocalPosts
rpc ListLocalPosts(ListLocalPostsRequest) returns (ListLocalPostsResponse) Returns a list of local posts associated with a location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateLocalPost
rpc UpdateLocalPost(UpdateLocalPostRequest) returns (LocalPost) Updates the specified local post and returns the updated local post. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Locations

This API allows management of business locations on Google. It lets you manage Location resources. It defines the following resource model:

• The API has a collection of Account resources, named accounts/*

• As a convenience, you may use the synonym "me" instead of the account id for the personal account of the authenticated caller. Examples: GET /v4/accounts/me GET /v4/accounts/me/locations

• Each Account has a collection of Location resources, named accounts/*/locations/*

AssociateLocation

rpc AssociateLocation(AssociateLocationRequest) returns (Empty) Associates a location to a place ID. Any previous association is overwritten. This operation is only valid if the location is unverified. The association must be valid, that is, it appears in the list of FindMatchingLocations. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

BatchGetLocations
rpc BatchGetLocations(BatchGetLocationsRequest) returns (BatchGetLocationsResponse) Gets all of the specified locations in the given account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ClearLocationAssociation

rpc ClearLocationAssociation(ClearLocationAssociationRequest) returns (Empty) Clears an association between a location and its place ID. This operation is only valid if the location is unverified. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

CreateLocation
rpc CreateLocation(CreateLocationRequest) returns (Location) Creates a new location owned by the specified account, and returns it. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty) Deletes a location. Note: If this location cannot be deleted using the API as marked in the LocationState, use the Business Profile website. Returns NOT_FOUND if the location does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

FindMatchingLocations

rpc FindMatchingLocations(FindMatchingLocationsRequest) returns (FindMatchingLocationsResponse) Finds all of the possible locations that are a match to the specified location. This operation is only valid if the location is unverified. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetChain
rpc GetChain(GetChainRequest) returns (Chain) Gets the specified chain. Returns NOT_FOUND if the chain does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetLocationRequest) returns (GoogleUpdatedLocation) Gets the Google-updated version of the specified location. Returns NOT_FOUND if the location does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetLocation
rpc GetLocation(GetLocationRequest) returns (Location) Gets the specified location. Returns NOT_FOUND if the location does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse) Returns the list of available attributes that would be available for a location with the given primary category and country. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListLocations
rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) Lists the locations for the specified account. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

SearchChains
rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse) Searches the chain based on chain name. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

TransferLocation

Deprecated. Please use the Account Management API instead. rpc TransferLocation(TransferLocationRequest) returns (Location) Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account. Returns the Location with its new resource name. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location) Updates the specified location. Photos are only allowed on a location that has a Google+ page. Returns NOT_FOUND if the location does not exist. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Media

This service allows the management of media (photos and video) linked with a location.

CreateMediaItem
rpc CreateMediaItem(CreateMediaItemRequest) returns (MediaItem) Creates a new media item for the location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteMediaItem
rpc DeleteMediaItem(DeleteMediaItemRequest) returns (Empty) Deletes the specified media item. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetCustomerMediaItem
rpc GetCustomerMediaItem(GetCustomerMediaItemRequest) returns (MediaItem) Returns metadata for the requested customer media item. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetMediaItem
rpc GetMediaItem(GetMediaItemRequest) returns (MediaItem) Returns metadata for the requested media item. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListCustomerMediaItems

rpc ListCustomerMediaItems(ListCustomerMediaItemsRequest) returns (ListCustomerMediaItemsResponse) Returns a list of media items associated with a location that have been contributed by customers. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListMediaItems
rpc ListMediaItems(ListMediaItemsRequest) returns (ListMediaItemsResponse) Returns a list of media items associated with a location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

StartUploadMediaItemData
rpc StartUploadMediaItemData(StartUploadMediaItemDataRequest) returns (MediaItemDataRef) Generates a MediaItemDataRef for media item uploading. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateMediaItem

rpc UpdateMediaItem(UpdateMediaItemRequest) returns (MediaItem) Updates metadata of the specified media item. This can only be used to update the Category of a media item, with the exception that the new category cannot be COVER or PROFILE. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

QuestionsAndAnswers

This service allows the management of a location's questions and answers. Question and answer operations are only valid for verified locations.

CreateQuestion
rpc CreateQuestion(CreateQuestionRequest) returns (Question) Adds a question for the specified location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteAnswer
rpc DeleteAnswer(DeleteAnswerRequest) returns (Empty) Deletes the answer written by the current user to a question. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteQuestion
rpc DeleteQuestion(DeleteQuestionRequest) returns (Empty) Deletes a specific question written by the current user. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListAnswers
rpc ListAnswers(ListAnswersRequest) returns (ListAnswersResponse) Returns the paginated list of answers for a specified question. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListQuestions
rpc ListQuestions(ListQuestionsRequest) returns (ListQuestionsResponse) Returns the paginated list of questions and some of its answers for a specified location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateQuestion
rpc UpdateQuestion(UpdateQuestionRequest) returns (Question) Updates a specific question written by the current user. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpsertAnswer

rpc UpsertAnswer(UpsertAnswerRequest) returns (Answer) Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Reviews

This API provides CRUD operations for Reviews. google.mybusiness.v4.Reviews.

BatchGetReviews

rpc BatchGetReviews(BatchGetReviewsRequest) returns (BatchGetReviewsResponse) Returns the paginated list of reviews for all specified locations. This operation is only valid if the specified locations are verified. Note: Reviews are limited to a batch size of 50 location_names per call. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

DeleteReviewReply
rpc DeleteReviewReply(DeleteReviewReplyRequest) returns (Empty) Deletes the response to the specified review. This operation is only valid if the specified location is verified. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

GetReview

rpc GetReview(GetReviewRequest) returns (Review) Returns the specified review. This operation is only valid if the specified location is verified. Returns NOT_FOUND if the review does not exist, or has been deleted. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListReviews

rpc ListReviews(ListReviewsRequest) returns (ListReviewsResponse) Returns the paginated list of reviews for the specified location. This operation is only valid if the specified location is verified. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateReviewReply

rpc UpdateReviewReply(UpdateReviewReplyRequest) returns (ReviewReply) Updates the reply to the specified review. A reply is created if one does not exist. This operation is only valid if the specified location is verified. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ServiceLists

This API allows operations to get and update service list of business locations on Google. A service list contains a list of service items that are services provided by merchants. A service can be haircut, install water heater, etc.

GetServiceList
rpc GetServiceList(GetServiceListRequest) returns (ServiceList) Get the specified service list of a location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

UpdateServiceList
rpc UpdateServiceList(UpdateServiceListRequest) returns (ServiceList) Updates the specified service list of a location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

Verifications

This API allows management of Location verifications on Google. It lets you manage Verification resources.

Each Location has a collection of Verification resources, named accounts/*/locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse) Completes a PENDING verification. It is only necessary for non AUTO verification methods. AUTO verification request is instantly VERIFIED upon creation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse) Reports all eligible verification options for a location in a specific language. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

ListVerifications
rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse) List verifications of a location, ordered by create time. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

VerifyLocation
rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse) Starts the verification process for a location. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/plus.business.manage https://www.googleapis.com/auth/business.manage For more information, see the OAuth 2.0 Overview.

AcceptInvitationRequest

Request message for AccessControl.AcceptInvitation.

Fields
name	string The name of the invitation that is being accepted.

Account

This resource is deprecated! Please refer to the Account Management API instead.

An account is a container for your business's locations. If you are the only user who manages locations for your business, you can use your personal Google Account. To share management of locations with multiple users, create a business account.

Fields
name	string The resource name, in the format accounts/{account_id}.
account_name	string The name of the account. Note: For an account with AccountType PERSONAL, this is the first and last name of the user account.
type	AccountType Output only. Specifies the AccountType of this account.
role	AccountRole Output only. Specifies the AccountRole the caller has for this account.
state	AccountState Output only. Indicates the AccountState of this account.
account_number	string Account reference number if provisioned.
permission_level	PermissionLevel Output only. Specifies the PermissionLevel the caller has for this account.
organization_info	OrganizationInfo Additional info for an organization. This is populated only for an organization account.

OrganizationInfo

Additional Info stored for an organization.

Fields
registered_domain	string The registered domain for the account.
postal_address	PostalAddress The postal address for the account.
phone_number	string The contact number for the organization.

AccountRole

Indicates the access level that the authenticated user has for this account. For more information, see the help center article

Enums
ACCOUNT_ROLE_UNSPECIFIED	Not specified.
OWNER	The user owns this account. (Displays as 'Primary Owner' in UI).
CO_OWNER	The user is a co-owner of the account. (Displays as 'Owner' in UI).
MANAGER	The user can manage this account.
COMMUNITY_MANAGER	The user can manage social (Google+) pages for the account. (Displays as 'Site Manager' in UI).

AccountState

Indicates status of the account, such as whether the account has been verified by Google.

Fields
status	AccountStatus If verified, future locations that are created are automatically connected to Google Maps, and have Google+ pages created, without requiring moderation.

AccountStatus

Indicates the verification status of the account.

Enums
ACCOUNT_STATUS_UNSPECIFIED	Not specified.
VERIFIED	Verified account.
UNVERIFIED	Account that is not verified, and verification has not been requested.
VERIFICATION_REQUESTED	Account that is not verified, but verification has been requested.

AccountType

Indicates what kind of account this is: either a personal/user account or a business account.

Enums
ACCOUNT_TYPE_UNSPECIFIED	Not specified.
PERSONAL	An end-user account.
LOCATION_GROUP	A group of Locations. For more information, see the help center article
USER_GROUP	A User Group for segregating organization staff in groups. For more information, see the help center article
ORGANIZATION	An organization representing a company. For more information, see the help center article

AdWordsLocationExtensions

Additional information that is surfaced in AdWords.

Fields
ad_phone	string An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.

AddressInput

Input for ADDRESS verification.

Fields
mailer_contact_name	string Contact name the mail should be sent to.

Admin

An administrator of an Account or a Location.

Fields
name	string The resource name. For account admins, this is in the form: accounts/{account_id}/admins/{admin_id} For location admins, this is in the form: accounts/{account_id}/locations/{location_id}/admins/{admin_id}
admin_name	string The name of the admin. When making the initial invitation, this is the invitee's email address. On GET calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names.
role	AdminRole Specifies the AdminRole that this admin uses with the specified Account or Location resource.
pending_invitation	bool Output only. Indicates whether this admin has a pending invitation for the specified resource.

AdminRole

Indicates the access level that an admin has. For more information, see the help center article

Enums
ADMIN_ROLE_UNSPECIFIED	Not specified.
OWNER	The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI).
CO_OWNER	The admin has owner-level access. (Displays as 'Owner' in UI).
MANAGER	The admin has managerial access.
COMMUNITY_MANAGER	The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI).

AlertType

The type of event for which the alert post was created.

Enums
ALERT_TYPE_UNSPECIFIED	No alert is specified.
COVID_19	Alerts related to the 2019 Coronavirus Disease pandemic. Covid posts only support a summary field and a call to action field. When these alerts are no longer relevant, new Alert post creation for type COVID-19 will be disabled. However, merchant will still be able to manage their existing COVID-19 posts.

Allergen

Allergen information regarding a food item.

Enums
ALLERGEN_UNSPECIFIED	Allergen unspecified
DAIRY	Dairy related allergen
EGG	Egg related allergen
FISH	Fish related allergen
PEANUT	Peanut related allergen
SHELLFISH	Shellfish related allergen
SOY	Soy related allergen
TREE_NUT	Tree nut related allergen
WHEAT	Wheat related allergen

Answer

Represents an answer to a question

Fields
name	string Output only. The unique name for the answer accounts/*/locations/*/questions/*/answers/*
author	Author Output only. The author of the answer.
upvote_count	int32 Output only. The number of upvotes for the answer.
text	string The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
create_time	Timestamp Output only. The timestamp for when the answer was written.
update_time	Timestamp Output only. The timestamp for when the answer was last modified.

AssociateLocationRequest

Request message for Locations.AssociateLocationRequest.

Fields
name	string The resource name of the location to associate.
place_id	string The association to establish. If not set, it indicates no match.

Attribute

A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.

Fields
attribute_id	string The ID of the attribute. Attribute IDs are provided by Google.
value_type	AttributeValueType Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
values[]	Value The values for this attribute. The type of the values supplied must match that expected for that attribute; see AttributeValueType. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
repeated_enum_value	RepeatedEnumAttributeValue When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
url_values[]	UrlAttributeValue When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.

AttributeMetadata

Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.

Fields
attribute_id	string The ID of the attribute.
value_type	AttributeValueType The value type for the attribute. Values set and retrieved should be expected to be of this type.
display_name	string The localized display name for the attribute, if available; otherwise, the English display name.
group_display_name	string The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.
is_repeatable	bool If true, the attribute supports multiple values. If false, only a single value should be provided.
value_metadata[]	AttributeValueMetadata For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
is_deprecated	bool If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.

AttributeValueMetadata

Metadata for supported attribute values.

Fields
value	Value The attribute value.
display_name	string The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name. For example, for a "WiFi" enum attribute, this could contain "Paid" to represent paid Wi-Fi.

AttributeValueType

The value type of the attribute.

Enums
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED	Not specified.
BOOL	The values for this attribute are boolean values.
ENUM	The attribute has a predetermined list of available values that can be used. Metadata for this attribute will list these values.
URL	The values for this attribute are URLs.
REPEATED_ENUM	The attribute value is an enum with multiple possible values that can be explicitly set or unset.

Author

Represents the author of a question or answer

Fields
display_name	string The display name of the user
profile_photo_url	string The profile photo URL of the user.
type	AuthorType The type of user the author is.

AuthorType

Enum for the type of user the author is.

Enums
AUTHOR_TYPE_UNSPECIFIED	This should not be used.
REGULAR_USER	A regular user.
LOCAL_GUIDE	A Local Guide
MERCHANT	The owner/manager of the location

BasicMetricsRequest

A request for basic metric insights.

Fields
metric_requests[]	MetricRequest A collection of metrics to return values for including the options for how the data should be returned.
time_range	TimeRange The range to gather metrics for. The maximum range is 18 months from the request date. In some cases, the data may still be missing for days close to the request date. Missing data will be specified in the metricValues in the response.

BatchGetBusinessCategoriesRequest

Request message for BusinessCategories.BatchGetBusinessCategories.

Fields
language_code	string Required. The BCP 47 code of language that the category names should be returned in.
category_ids[]	string Required. At least one name must be set. The GConcept ids the localized category names should be returned for.
region_code	string Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.
view	CategoryView Required. Specifies which parts to the Category resource should be returned in the response.

BatchGetBusinessCategoriesResponse

Response message for BusinessCategories.BatchGetBusinessCategories.

Fields
categories[]	Category Categories that match the GConcept ids provided in the request. They will not come in the same order as category ids in the request.

BatchGetLocationsRequest

Request message for Locations.BatchGetLocations.

Fields
name	string The name of the account from which to fetch locations.
location_names[]	string A collection of locations to fetch, specified by their names.

BatchGetLocationsResponse

Response message for Locations.BatchGetLocations.

Fields
locations[]	Location A collection of locations.

BatchGetReviewsRequest

Request message for Reviews.BatchGetReviews.

Fields
name	string The name of the account from which to retrieve a list of reviews across multiple locations.
location_names[]	string A collection of locations to fetch reviews for, specified by their names.
page_size	int32 How many reviews to fetch per page. The default value is 50.
page_token	string If specified, it fetches the next page of reviews.
order_by	string Optional. Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to update_time desc. Valid orders to sort by are rating, rating desc and update_time desc. rating will return reviews in ascending order. update_time(i.e. ascending order) is not supported.
ignore_rating_only_reviews	bool Whether to ignore rating-only reviews.

BatchGetReviewsResponse

Response message for Reviews.BatchGetReviews.

Fields
location_reviews[]	LocationReview Reviews with location information.
next_page_token	string If the number of reviews exceeded the requested page size, this field is populated with a token to fetch the next page of reviews on a subsequent calls. If there are no more reviews, this field will not be present in the response.

BusinessHours

Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances.

Fields
periods[]	TimePeriod A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.

CallToAction

An action that is performed when the user clicks through the post

Fields
action_type	ActionType The type of action that will be performed.
url	string The URL the user will be directed to upon clicking. This field should be left unset for Call CTA.

ActionType

The type of action that will be performed.

Enums
ACTION_TYPE_UNSPECIFIED	Type unspecified.
BOOK	This post wants a user to book an appointment/table/etc.
ORDER	This post wants a user to order something.
SHOP	This post wants a user to browse a product catalog.
LEARN_MORE	This post wants a user to learn more (at their website).
SIGN_UP	This post wants a user to register/sign up/join something.
GET_OFFER	Deprecated. Use OFFER in LocalPostTopicType to create a post with offer content. This item is deprecated!
CALL	This post wants a user to call the business.

Category

A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see categories.list.

Fields
display_name	string . The human-readable name of the category. This is set when reading the location. When modifying the location, category_id must be set. Note: This field is used in responses only. Any value specified here in a request is ignored.
category_id	string . A stable ID (provided by Google) for this category. The category_id must be specified when modifying the category (when creating or updating a location). Note: This field is used in responses only. Any value specified here in a request is ignored.
service_types[]	ServiceType . A list of all the service types that are available for this business category. Note: This field is used in responses only. Any value specified here in a request is ignored.
more_hours_types[]	MoreHoursType Output only. More hours types that are available for this business category.

CategoryView

An enum to help limit the amount of data returned by the server.

Enums
CATEGORY_VIEW_UNSPECIFIED	Not specified, equivalent to CATEGORY_METADATA_ONLY.
BASIC	The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.
FULL	Returns all the fields in the response.

Chain

A chain is a brand that your business's locations can be affiliated with.

Fields
name	string The chain's resource name, in the format chains/{chain_place_id}.
chain_names[]	ChainName Names of the chain.
websites[]	ChainUrl Websites of the chain.
location_count	int32 Number of locations that are part of this chain.

ChainName

Name to be used when displaying the chain.

Fields
display_name	string The display name for this chain.
language_code	string The BCP 47 code of language of the name.

ChainUrl

Url to be used when displaying the chain.

Fields
url	string The url for this chain.

ClearLocationAssociationRequest

Request message for Locations.ClearLocationAssociationRequest.

Fields
name	string The resource name of the location to disassociate.

CompleteVerificationRequest

Request message for Verifications.CompleteVerificationAction.

Fields
name	string Resource name of the verification to complete.
pin	string PIN code received by the merchant to complete the verification.

CompleteVerificationResponse

Response message for Verifications.CompleteVerificationAction.

Fields
verification	Verification The completed verification.

CreateAccountAdminRequest

Request message for AccessControl.CreateAccountAdmin.

Fields
parent	string The resource name of the account this admin is created for.
admin	Admin The admin to create

CreateAccountRequest

Request message for Accounts.CreateAccount.

Fields
primary_owner	string The resource name of the account which will be the primary owner of the account being created. It should be of the form accounts/{account_id}/.
account	Account Account information for the account that is to be created. The only allowed fields are account_name and type.

CreateLocalPostRequest

Request message for CreateLocalPost.

Fields
parent	string The name of the location in which to create this local post.
local_post	LocalPost The new local post metadata.

CreateLocationAdminRequest

Request message for AccessControl.CreateLocationAdmin.

Fields
parent	string The resource name of the location this admin is created for.
admin	Admin The admin to create

CreateLocationRequest

Request message for Locations.CreateLocation.

Fields
parent	string The name of the account in which to create this location.
location	Location The new location metadata.
validate_only	bool If true, the request is validated without actually creating the location.
request_id	string A unique request ID for the server to detect duplicated requests. We recommend using UUIDs. Max length is 50 characters.

CreateMediaItemRequest

Request message for Media.CreateMediaItem.

Fields
parent	string The resource name of the location where this media item will be created.
media_item	MediaItem The media item to be created.

CreateQuestionRequest

Request message for QuestionsAndAnswers.CreateQuestion

Fields
parent	string The name of the location to write a question for.
question	Question The new question.

DeclineInvitationRequest

Request message for AccessControl.DeclineInvitation.

Fields
name	string The name of the account invitation that is being declined.

DeleteAccountAdminRequest

Request message for AccessControl.DeleteAccountAdmin.

Fields
name	string The resource name of the admin to remove from the account.

DeleteAnswerRequest

Request message for QuestionsAndAnswers.DeleteAnswer

Fields
parent	string The name of the question to delete an answer for.

DeleteLocalPostRequest

Request message for DeleteLocalPost.

Fields
name	string The name of the local post to delete.

DeleteLocationAdminRequest

Request message for AccessControl.DeleteLocationAdmin.

Fields
name	string The resource name of the admin to remove from the location.

DeleteLocationRequest

Request message for Locations.DeleteLocation.

Fields
name	string The name of the location to delete.

DeleteMediaItemRequest

Request message for Media.DeleteMediaItem.

Fields
name	string The name of the media item to be deleted.

DeleteNotificationsRequest

Request message for Accounts.DeleteNotifications.

Fields
name	string The resource name for the notification settings to be cleared.

DeleteQuestionRequest

Request message for QuestionsAndAnswers.DeleteQuestion

Fields
name	string The name of the question to delete.

DeleteReviewReplyRequest

Request message for Reviews.DeleteReviewReply.

Fields
name	string The name of the review reply to delete.

DietaryRestriction

Dietary information of a food item.

Enums
DIETARY_RESTRICTION_UNSPECIFIED	Dietary type unspecified
HALAL	Denotion of the food as a halal dish.
KOSHER	Denotion of the food as a kosher dish.
ORGANIC	Denotion of the food as an organic dish.
VEGAN	Denotion of the food as a vegan dish.
VEGETARIAN	Denotion of the food as a vegetarian dish.

DimensionalMetricValue

A value for a single metric with a given time dimension.

Fields
metric_option	MetricOption The option that requested this dimensional value.
time_dimension	TimeDimension The dimension for the value.
value	Int64Value The value. If no value is set, then the requested data is missing.

TimeDimension

The dimension for which data is divided over.

Fields
day_of_week	DayOfWeek The day of the week ("MONDAY" to "SUNDAY") this value corresponds to. Set for BREAKDOWN_DAY_OF_WEEK option.
time_of_day	TimeOfDay The hour of the day (0 to 23) this value corresponds to. Set for BREAKDOWN_HOUR_OF_DAY option.
time_range	TimeRange The range of time this value covers. Set for AGGREGATED_TOTAL and AGGREGATED_DAILY options.

DrivingDirectionMetricsRequest

A request for driving direction insights.

Fields
num_days	NumDays The number of days to aggregate data for. Results returned will be available data over the last number of requested days. Valid values are 7, 30, and 90.
language_code	string The BCP 47 code for the language. If a language code is not provided, it defaults to English.

NumDays

Number of days that this request can support.

Enums
SEVEN	7 days. This is the default value.
THIRTY	30 days.
NINETY	90 days.

EmailInput

Input for EMAIL verification.

Fields
email_address	string Email address where the PIN should be sent to. An email address is accepted only if it is one of the addresses provided by FetchVerificationOptions. If the EmailVerificationData has is_user_name_editable set to true, the client may specify a different user name (local-part) but must match the domain name.

ErrorDetail

Details an error that resulted in a validation or internal failure.

Fields
code	int32 The status code, which should be an enum value of ErrorCode.
field	string A path leading to a field in the request body. The value is a sequence of dot-separated identifiers that identify a protocol buffer field. For example, "error_details.field" would identify this field.
message	string A description of why the field caused a failure. The message is in English and may not be suitable for display to users.
value	string The value that failed the request.
field_index	int32 If the request field that generated this error is repeated, this will contain the zero based index of the entry in that field which caused validation to fail.

ErrorCode

Error codes for ErrorDetail:

• 1 to 199: common error codes that apply to all fields.
• 1000 to 1099: photos-related error codes.
• 1100 to 1199: address- and latitude/longitude-related error codes.
• 1200 to 1299: category-related error codes.
• 1300 to 1399: operation related error codes.

Enums
ERROR_CODE_UNSPECIFIED	Catch-all error code.
MISSING_VALUE	A required value was not provided.
INVALID_VALUE	An invalid value was provided.
INVALID_CHARACTERS	Invalid characters were found.
TOO_MANY_ITEMS	More than the maximum number of items was provided in a repeated field.
READ_ONLY	Read-only field cannot be modified.
OVERLAPPING_RANGES	Items in a repeated field are ranges that overlap with one another.
INVERTED_RANGE	The range provided is inverted. This also includes the case of an empty range.
VALUE_OUTSIDE_ALLOWED_RANGE	The value provided is outside of its allowed range.
MISSING_DEPENDENT_FIELD	Required dependent field not present.
FIELD_HAS_DEPENDENCIES	Field required by dependent field and cannot be removed.
UNSUPPORTED_VALUE	The provided value, although possibly valid, is unsupported due to other constraints.
EXPIRED_VALUE	The provided value has expired and is no longer valid.
PHOTO_FETCH_FAILED	Fetch photo from the specified URL failed.
PHOTO_UPLOAD_FAILED	Upload photo from the specified URL failed.
GEOCODE_ERROR	There was an error automatically determining latitude/longitude.
LAT_LNG_OUTSIDE_COUNTRY	The latitude/longitude provided does not lie in the country provided.
LAT_LNG_REQUIRED	Latitude and Longitude must be provided.
LAT_LNG_TOO_FAR_FROM_ADDRESS	The latitude/longitude and address pair are too far apart.
CATEGORY_NOT_VERIFIED	Category provided is not verified.
OPERATION_EXECUTION_ERROR	Generic operation execution error.
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION	Operation is not supported due to account condition.
LOCATION_DISABLED_FOR_LOCAL_POST_API	Location Disabled for Local Post API.

FetchVerificationOptionsRequest

Request message for Verifications.FetchVerificationOptions.

Fields
name	string Resource name of the location to verify.
language_code	string The BCP 47 language code representing the language that is to be used for the verification process. Available options vary by language.
context	ServiceBusinessContext Extra context information for the verification of service businesses. Required for the locations whose business type is CUSTOMER_LOCATION_ONLY. INVALID_ARGUMENT will be thrown if it is set for other business types of locations.

FetchVerificationOptionsResponse

Response message for Verifications.FetchVerificationOptions.

Fields
options[]	VerificationOption The available verification options.

FindMatchingLocationsRequest

Request message for Locations.FindMatchingLocations.

Fields
name	string The resource name of the location to find matches for.
language_code	string The preferred language for the matching location (in BCP-47 format).
num_results	int32 The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.
max_cache_duration	Duration Deprecated. This field is ignored for all requests.

FindMatchingLocationsResponse

Response message for Locations.FindMatchingLocations.

Fields
matched_locations[]	MatchedLocation A collection of locations that are potential matches to the specified location, listed in order from best to least match. If there is an exact match, it will be in the first position.
match_time	Timestamp When the matching algorithm was last executed for this location.

FollowersMetadata

Follower metadata for a location.

Fields
name	string The resource name for this. accounts/{account_id}/locations/{location_id}/followers/metadata
count	uint64 Total number of followers for the location.

FoodMenu

Menu of a business that serves food dishes.

Fields
labels[]	MenuLabel Required. Language-tagged labels for the menu. E.g. "menu", "lunch special". Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.
source_url	string Optional. Source URL of menu if there is a webpage to go to.
sections[]	FoodMenuSection Required. Sections of the menu.
cuisines[]	Cuisine Optional. Cuisine information for the food menu. It is highly recommended to provide this field.

Cuisine

Cuisine information of a resturant.

Enums
CUISINE_UNSPECIFIED	Cuisine unspecified
AMERICAN	American food
ASIAN	Asian food
BRAZILIAN	Brazilian food
BREAK_FAST	Breakfast
BRUNCH	Brunch
CHICKEN	Chicken
CHINESE	Chinese food
FAMILY	Family style cuisine
FAST_FOOD	Fast food
FRENCH	French food
GREEK	Greek food
GERMAN	German food
HAMBURGER	Hamburger
INDIAN	Indian food
INDONESIAN	Indonesian food
ITALIAN	Italian food
JAPANESE	Japanese food
KOREAN	Korean food
LATIN_AMERICAN	Latin American food
MEDITERRANEAN	Mediterranean food
MEXICAN	Mexican food
PAKISTANI	Pakistani food
PIZZA	Pizza
SEAFOOD	Seafood
SPANISH	Spanish food
SUSHI	Sushi
THAI	Thai food
TURKISH	Turkish food
VEGETARIAN	Vegetarian Food
VIETNAMESE	Vietnamese food
OTHER_CUISINE	Other cuisine

FoodMenuItem

Item of a Section. It can be the dish itself, or can contain multiple FoodMenuItemOption.

Fields
labels[]	MenuLabel Required. Language tagged labels for this menu item. Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.
attributes	FoodMenuItemAttributes Required. Detailed attributes of the item. When item options are specified, this is considered as the base attributes and populate to each options.
options[]	FoodMenuItemOption Optional. This is for an item that comes in multiple different options, and users are required to make choices. E.g. "regular" vs. "large" pizza. When options are specified, labels and attributes at item level will automatically become the first option's labels and attributes. Clients only need to specify other additional food options in this field.

FoodMenuItemAttributes

Attributes of a food item/dish.

Fields
price	Money Required. Price of the food dish.
spiciness	Spiciness Optional. Spiciness level of the food dish.
allergen[]	Allergen Optional. Allergens associated with the food dish. It is highly recommended to provide this field.
dietary_restriction[]	DietaryRestriction Optional. Dietary information of the food dish. It is highly recommended to provide this field.
nutrition_facts	NutritionFacts Optional. Nutrition facts of the food dish option. It is highly recommended to provide this field.
ingredients[]	Ingredient Optional. Ingredients of the food dish option.
serves_num_people	int32 Optional. Number of people can be served by this food dish option.
preparation_methods[]	PreparationMethod Optional. Methods on how the food dish option is prepared.
portion_size	PortionSize Optional. Size of the order, represented in units of items. (e.g. 4 "skewers", 6 "pieces")
media_keys[]	string Optional. The media keys of the media associated with the dish. Only photo media is supported. When there are multiple photos associated, the first photo is considered as the preferred photo.

Ingredient

This message denotes an ingredient information of a food dish.

Fields
labels[]	MenuLabel Required. Labels to describe ingredient. Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.

PortionSize

Serving portion size of a food dish.

Fields
quantity	int32 Required. Number of the portion.
unit[]	MenuLabel Required. The repeated name_info field is for the unit in multiple languages.

FoodMenuItemOption

Option of an Item. It requires an explicit user selection.

Fields
labels[]	MenuLabel Required. Language tagged labels for this menu item option. E.g.: "beef pad thai", "veggie pad thai", "small pizza", "large pizza". Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.
attributes	FoodMenuItemAttributes Required. Detailed attributes of the item option. Individual unspecified attributes will be inherited from the item-level attibutes as the base.

FoodMenuSection

Section of a menu. It can contain multiple items/dishes.

Fields
labels[]	MenuLabel Required. Language tagged labels for this menu section. Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.
items[]	FoodMenuItem Required. Items of the section. Each Section must have at least an item.

FoodMenus

Menus of a business that serve food dishes.

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/foodMenus
menus[]	FoodMenu Optional. A collection of food menus.

GenerateAccountNumberRequest

Request message for Accounts.GenerateAccountNumber.

Fields
name	string The name of the account to generate an account number for.

GetAccountRequest

Request message for Accounts.GetAccount.

Fields
name	string The name of the account to fetch.

GetChainRequest

Request message for Locations.GetChain.

Fields
name	string The chain's resource name, in the format chains/{chain_place_id}.

GetCustomerMediaItemRequest

Request message for Media.GetCustomerMediaItem.

Fields
name	string The resource name of the requested customer media item.

GetFollowersMetadataRequest

Request message to get the followers metadata for a location.

Fields
name	string The resource name of the location's followers metadata. accounts/{account_id}/locations/{location_id}/followers/metadata

GetFoodMenusRequest

Request message for FoodMenu.GetFoodMenus

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/foodMenus
read_mask	FieldMask Optional. The specific fields to return. If no mask is specified, then it returns the full FoodMenu (same as "*"). Repeated field items can not be individually specified. For example: "name" and "menus" are valid masks, while "menus.sections" is invalid.

GetHealthProviderAttributesRequest

Request message for HealthProviderAttributes.GetHealthProviderAttributes

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/healthProviderAttributes
language_code	string Optional. The BCP 47 code for the language. If a language code is not provided, it defaults to English. Right now only 'en' is supported.

GetLocalPostRequest

Request message for LocalPosts.GetLocalPost.

Fields
name	string The name of the local post to fetch.

GetLocationRequest

Request message for Locations.GetLocation.

Fields
name	string The name of the location to fetch.

GetMediaItemRequest

Request message for Media.GetMediaItem.

Fields
name	string The name of the requested media item.

GetNotificationsRequest

Request message for Accounts.GetNotifications.

Fields
name	string The notification settings resource name.

GetReviewRequest

Request message for Reviews.GetReview.

Fields
name	string The name of the review to fetch.

GetServiceListRequest

Get service list request message.

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/servicelist

GoogleLocation

Represents a Location that is present on Google. This can be a location that has been claimed by the user, someone else, or could be unclaimed.

Fields
name	string Resource name of this GoogleLocation, in the format googleLocations/{googleLocationId}.
location	Location The sparsely populated Location information. This field can be re-used in CreateLocation if it is not currently claimed by a user.
request_admin_rights_url	string A URL that will redirect the user to the request admin rights UI. This field is only present if the location has already been claimed by any user, including the current user.

GoogleUpdatedLocation

Represents a location that was modified by Google.

Fields
location	Location The Google-updated version of this location.
diff_mask	FieldMask The fields that Google updated.

HealthProviderAttributes

The Health provider attributes linked with this location.

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/healthProviderAttributes
insurance_networks[]	InsuranceNetwork Optional. A list of insurance networks accpected by this location.

InsuranceNetwork

A single insurance network. Next id: 5

Fields
network_id	string Required. The id of this insurance network generated by Google.
network_names	map<string, string> Output only. A map of network display names in requested languages where the language is the key and localized display name is the value. The display name in English is set by default.
payer_names	map<string, string> Output only. A map of payer display names in requested languages where the language is the key and localized display name is the value. The display name in English is set by default.
state	NetworkState Output only. The state of this insurance network.

InternalError

Describes internal failures.

Fields
error_details[]	ErrorDetail Details individual failures.

Invitation

Output only. Represents a pending invitation.

Fields
name	string The resource name for the invitation.
role	AdminRole The invited role on the account.
Union field target. Indicates the target this invitation is for. target can be only one of the following:
target_account	Account The sparsely populated account this invitation is for.
target_location	TargetLocation The target location this invitation is for.

TargetLocation

Represents a target location for a pending invitation.

Fields
location_name	string The name of the location to which the user is invited.
location_address	string The address of the location to which the user is invited.

ListAccountAdminsRequest

Request message for AccessControl.ListAccountAdmins.

Fields
parent	string The name of the account from which to retrieve a list of admins.

ListAccountAdminsResponse

Response message for AccessControl.ListAccountAdmins.

Fields
admins[]	Admin A collection of Admin instances.

ListAccountsRequest

Request message for Accounts.ListAccounts.

Fields
page_size	int32 How many accounts to fetch per page. Default is 20, minimum is 2, and maximum page size is 20.
page_token	string If specified, the next page of accounts is retrieved. The pageToken is returned when a call to accounts.list returns more results than can fit into the requested page size.
name	string The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return ListAccounts for the authenticated user.
filter	string A filter constraining the accounts to return. The response includes only entries that match the filter. If filter is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter type=USER_GROUP will only return user groups.

ListAccountsResponse

Response message for Accounts.ListAccounts.

Fields
accounts[]	Account A collection of accounts to which the user has access. The personal account of the user doing the query will always be the first item of the result, unless it is filtered out.
next_page_token	string If the number of accounts exceeds the requested page size, this field is populated with a token to fetch the next page of accounts on a subsequent call to accounts.list. If there are no more accounts, this field is not present in the response.

ListAnswersRequest

Request message for QuestionsAndAnswers.ListAnswers

Fields
parent	string The name of the question to fetch answers for.
page_size	int32 How many answers to fetch per page. The default and maximum page_size values are 10.
page_token	string If specified, the next page of answers is retrieved.
order_by	string The order to return the answers. Valid options include 'update_time desc' and 'upvote_count desc', which will return the answers sorted descendingly by the requested field. The default sort order is 'update_time desc'.

ListAnswersResponse

Response message for QuestionsAndAnswers.ListAnswers

Fields
answers[]	Answer The requested answers.
total_size	int32 The total number of answers posted for this question across all pages.
next_page_token	string If the number of answers exceeds the requested max page size, this field is populated with a token to fetch the next page of answers on a subsequent call. If there are no more answers, this field is not present in the response.

ListAttributeMetadataRequest

Request message for Locations.ListAttributeMetadata. If the location resource name is provided then that location will be used to populate the rest of the criteria. If not present, the category and country should be provided.

Fields
name	string Resource name of the location to look up available attributes.
category_id	string The primary category stable ID to find available attributes.
country	string The ISO 3166-1 alpha-2 country code to find available attributes.
language_code	string The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
page_size	int32 How many attributes to include per page. Default is 200, minimum is 1.
page_token	string If specified, the next page of attribute metadata is retrieved. The pageToken is returned when a call to attributes.list returns more results than can fit into the requested page size.

ListAttributeMetadataResponse

Response message for Locations.ListAttributeMetadata.

Fields
attributes[]	AttributeMetadata A collection of attribute metadata for the available attributes.
next_page_token	string If the number of attributes exceeded the requested page size, this field will be populated with a token to fetch the next page of attributes on a subsequent call to attributes.list. If there are no more attributes, this field will not be present in the response.

ListBusinessCategoriesRequest

Fields
region_code	string The ISO 3166-1 alpha-2 country code.
language_code	string The BCP 47 code of language. If the language is not available, it will default to English.
search_term	string Optional filter string from user.
page_size	int32 How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
page_token	string If specified, the next page of categories will be fetched.
view	CategoryView Optional. Specifies which parts to the Category resource should be returned in the response.

ListBusinessCategoriesResponse

Fields
categories[]	Category The categories. Categories are BASIC view. They don't contain any ServiceType information.
total_category_count	int32 The total number of categories for the request parameters.
next_page_token	string If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to ListBusinessCategories.

ListCustomerMediaItemsRequest

Request message for Media.ListCustomerMediaItems.

Fields
parent	string The name of the location whose customer media items will be listed.
page_size	int32 How many media items to return per page. The default value is 100, the maximum supported page size is 200.
page_token	string If specified, returns the next page of media items.

ListCustomerMediaItemsResponse

Response message for Media.ListCustomerMediaItems.

Fields
media_items[]	MediaItem The returned list of media items.
total_media_item_count	int32 The total number of media items for this location, irrespective of pagination. This number is approximate, particularly when there are multiple pages of results.
next_page_token	string If there are more media items than the requested page size, then this field is populated with a token to fetch the next page of media items on a subsequent call to ListCustomerMediaItems.

ListInsuranceNetworksRequest

Request message for InsuranceNetworkService.ListInsuranceNetworks

Fields
parent	string Required. The name of the location whose insurance networks will be listed. The name is in the form: accounts/{account_id}/locations/{location_id}
language_code	string Optional. The BCP 47 code for the language. If a language code is not provided, it defaults to English. Right now only 'en' is supported.
page_size	int32 How many insurance networks to return per page. The default value is 5000. Maximum page size is 10000.
page_token	string If specified, returns the next page of insurance networks.

ListInsuranceNetworksResponse

Response message for InsuranceNetworkService.ListInsuranceNetworks

Fields
networks[]	InsuranceNetwork A list of insurance networks that are supported by Google.
next_page_token	string If there are more insurance networks than the requested page size, then this field is populated with a token to fetch the next page of insurance networks on a subsequent call to ListInsuranceNetworks.

ListInvitationsRequest

Request message for AccessControl.ListInvitations.

Fields
parent	string The name of the account from which the list of invitations is being retrieved.
target_type	TargetType Specifies which target types should appear in the response.

TargetType

The type of target an invitation is for.

Enums
ALL	List invitations for all target types. This is the default.
ACCOUNTS_ONLY	List invitations only for targets of type Account.
LOCATIONS_ONLY	List invitations only for targets of type Location.

ListInvitationsResponse

Response message for AccessControl.ListInvitations.

Fields
invitations[]	Invitation A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000.

ListLocalPostsRequest

Request message for ListLocalPosts

Fields
parent	string The name of the location whose local posts will be listed.
page_size	int32 How many local posts to return per page. Default of 20. The minimum is 1, and maximum page size is 100.
page_token	string If specified, returns the next page of local posts.

ListLocalPostsResponse

Response message for ListLocalPosts

Fields
local_posts[]	LocalPost The returned list of local posts.
next_page_token	string If there are more local posts than the requested page size, then this field is populated with a token to fetch the next page of local posts on a subsequent call to ListLocalPosts.

ListLocationAdminsRequest

Request message for AccessControl.ListLocationAdmins.

Fields
parent	string The name of the location to list admins of.

ListLocationAdminsResponse

Response message for AccessControl.ListLocationAdmins.

Fields
admins[]	Admin A collection of Admin instances.

ListLocationsRequest

Request message for Locations.ListLocations.

Fields
parent	string The name of the account to fetch locations from. If the Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.
page_size	int32 How many locations to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
page_token	string If specified, it fetches the next page of locations. The page token is returned by previous calls to ListLocations when there were more locations than could fit in the requested page size.
filter	string A filter constraining the locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see Work with Location Data Guide.
language_code (deprecated)	string This item is deprecated! The BCP 47 code of language to get display location properties in. If this language is not available, they will be provided in the language of the location. If neither is available, they will be provided in English. Deprecated. After August 15th, 2020, this field will no longer be applied. Instead, the language of the location will always be used.
order_by	string Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are location_name and store_code. For example: "location_name, store_code desc" or "location_name" or "store_code desc"

ListLocationsResponse

Response message for Locations.ListLocations.

Fields
locations[]	Location The locations.
next_page_token	string If the number of locations exceeded the requested page size, this field is populated with a token to fetch the next page of locations on a subsequent call to ListLocations. If there are no more locations, this field is not present in the response.
total_size	int32 The approximate number of Locations in the list irrespective of pagination.

ListMediaItemsRequest

Request message for Media.ListMediaItems.

Fields
parent	string The name of the location whose media items will be listed.
page_size	int32 How many media items to return per page. The default value is 100, which is also the maximum supported number of media items able to be added to a location with the Google My Business API. Maximum page size is 2500.
page_token	string If specified, returns the next page of media items.

ListMediaItemsResponse

Response message for Media.ListMediaItems.

Fields
media_items[]	MediaItem The returned list of media items.
total_media_item_count	int32 The total number of media items for this location, irrespective of pagination.
next_page_token	string If there are more media items than the requested page size, then this field is populated with a token to fetch the next page of media items on a subsequent call to ListMediaItems.

ListQuestionsRequest

Request message for QuestionsAndAnswers.ListQuestions

Fields
parent	string The name of the location to fetch questions for.
page_size	int32 How many questions to fetch per page. The default and maximum page_size values are 10.
page_token	string If specified, the next page of questions is retrieved.
answers_per_question	int32 How many answers to fetch per question. The default and maximum answers_per_question values are 10.
filter	string A filter constraining the questions to return. The only filter currently supported is "ignore_answered=true"
order_by	string The order to return the questions. Valid options include 'update_time desc' and 'upvote_count desc', which will return the questions sorted descendingly by the requested field. The default sort order is 'update_time desc'.

ListQuestionsResponse

Response message for QuestionsAndAnswers.ListQuestions

Fields
questions[]	Question The requested questions,
total_size	int32 The total number of questions posted for this location across all pages.
next_page_token	string If the number of questions exceeds the requested max page size, this field is populated with a token to fetch the next page of questions on a subsequent call. If there are no more questions, this field is not present in the response.

ListRecommendedGoogleLocationsRequest

Request message to list recommended locations for a Business Profile account.

Fields
name	string Name of the account resource to fetch recommended Google locations for.
page_size	int32 How many locations to fetch per page. Default is 25, minimum is 1, and maximum page size is 100.
page_token	string If specified, the next page of locations is retrieved.

ListRecommendedGoogleLocationsResponse

Response message for GoogleLocations.ListRecommendedGoogleLocations.

It also contains some locations that have been claimed by other Business Profile users since the last time they were recommended to this Business Profile account.

Fields
google_locations[]	GoogleLocation The locations recommended to a Business Profile account. Each of these represents a GoogleLocation that is present on Maps. The locations are sorted in decreasing order of relevance to the Business Profile account.
total_size	int32 The total number of recommended locations for this Business Profile account, irrespective of pagination.
next_page_token	string During pagination, if there are more locations available to be fetched in the next page, this field is populated with a token to fetch the next page of locations in a subsequent call. If there are no more locations to be fetched, this field is not present in the response.

ListReviewsRequest

Request message for Reviews.ListReviews.

Fields
parent	string The name of the location to fetch reviews for.
page_size	int32 How many reviews to fetch per page. The maximum page_size is 50.
page_token	string If specified, it fetches the next page of reviews.
order_by	string Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to update_time desc. Valid orders to sort by are rating, rating desc and update_time desc.

ListReviewsResponse

Response message for Reviews.ListReviews.

Fields
reviews[]	Review The reviews.
average_rating	double The average star rating of all reviews for this location on a scale of 1 to 5, where 5 is the highest rating.
total_review_count	int32 The total number of reviews for this location.
next_page_token	string If the number of reviews exceeded the requested page size, this field is populated with a token to fetch the next page of reviews on a subsequent call to ListReviews. If there are no more reviews, this field is not present in the response.

ListVerificationsRequest

Request message for Verifications.ListVerifications.

Fields
parent	string Resource name of the location that verification requests belong to.
page_size	int32 How many verification to include per page. If not set, return all.
page_token	string If specified, returns the next page of verifications.

ListVerificationsResponse

Response message for Verifications.ListVerifications.

Fields
verifications[]	Verification List of the verifications.
next_page_token	string If the number of verifications exceeded the requested page size, this field will be populated with a token to fetch the next page of verification on a subsequent call. If there are no more attributes, this field will not be present in the response.

LocalPost

Represents a local post for a location.

Fields
name	string Output only. Google identifier for this local post in the form: accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id}
language_code	string The language of the local post.
summary	string Description/body of the local post.
call_to_action	CallToAction The URL that users are sent to when clicking through the promotion. Ignored for topic type OFFER.
create_time	Timestamp Output only. Time of the creation of the post.
update_time	Timestamp Output only. Time of the last modification of the post made by the user.
event	LocalPostEvent Event information. Required for topic types EVENT and OFFER.
state	LocalPostState Output only. The state of the post, indicating what part of its lifecycle it is in.
media[]	MediaItem The media associated with the post. source_url is the only supported data field for a LocalPost MediaItem.
search_url	string Output only. The link to the local post in Google search. This link can be used to share the post via social media, email, text, etc.
topic_type	LocalPostTopicType Required. The topic type of the post: standard, event, offer, or alert.
alert_type	AlertType The type of alert the post is created for. This field is only applicable for posts of topic_type Alert, and behaves as a sub-type of Alerts.
offer	LocalPostOffer Additional data for offer posts. This should only be set when the topic_type is OFFER.

LocalPostState

Indicates what state the post is in

Enums
LOCAL_POST_STATE_UNSPECIFIED	State not specified.
REJECTED	This post was rejected due to content policy violation.
LIVE	This post is published and is currently appearing in search results.
PROCESSING	This post is being processed and is not appearing in search results.

LocalPostEvent

All the information pertaining to an event featured in a local post.

Fields
title	string Name of the event.
schedule	TimeInterval Event start and end date/time.

LocalPostMetrics

All the metrics requested for a Local Post.

Fields
local_post_name	string
metric_values[]	MetricValue A list of values for the requested metrics.

LocalPostOffer

Specific fields for offer posts.

Fields
coupon_code	string Optional. Offer code that is usable in store or online.
redeem_online_url	string Optional. Online link to redeem offer.
terms_conditions	string Optional. Offer terms and conditions.

LocalPostTopicType

The topic type of the local post, which is used to select different templates to create and render a post.

Enums
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED	No post type is specified.
STANDARD	Post contains basic information, like summary and images.
EVENT	Post contains basic information and an event.
OFFER	Post contains basic information, an event and offer related content (e.g. coupon code)
ALERT	High-priority, and timely announcements related to an ongoing event. These types of posts are not always available for authoring.

Location

A location. See the help center article for a detailed description of these fields, or the category endpoint for a list of valid business categories.

Fields
name	string Google identifier for this location in the form: accounts/{account_id}/locations/{location_id} In the context of matches, this field will not be populated.
language_code	string The language of the location. Set during creation and not updateable.
store_code	string External identifier for this location, which must be unique inside a given account. This is a means of associating the location with your own records.
location_name	string Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, Address, Categories). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
primary_phone	string A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
additional_phones[]	string Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
address	PostalAddress A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five address_lines values in the address.
primary_category	Category Category that best describes the core business this location engages in.
additional_categories[]	Category Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
website_url	string A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
regular_hours	BusinessHours Operating hours for the business.
special_hours	SpecialHours Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours.
service_area	ServiceAreaBusiness Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
location_key	LocationKey A collection of keys that link this business to other Google properties, such as a Google+ page and Google Maps Places.
labels[]	string A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Limited to 255 characters (per label).
ad_words_location_extensions	AdWordsLocationExtensions Additional information that is surfaced in AdWords.
latlng	LatLng User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided latlng value was accepted during create, or the latlng value was updated through the Business Profile website. This field cannot be updated.
open_info	OpenInfo A flag that indicates whether the location is currently open for business.
location_state	LocationState Output only. A set of booleans that reflects the state of a location.
attributes[]	Attribute Attributes for this location.
metadata	Metadata Output Only. Additional non-user-editable information.
price_lists[] (deprecated)	PriceList Service edits made via this field may be subject to propagation delays. Please refer to Business Information API v1 instead. Deprecated: Price list information for this location.
profile	Profile Describes your business in your own voice and shares with users the unique story of your business and offerings.
relationship_data	RelationshipData All locations and chain related to this one.
more_hours[]	MoreHours More hours for a business's different departments or specific customers.

Metadata

Additional non-user-editable information about the location.

Fields
duplicate (deprecated)	Duplicate This item is deprecated! Information about the location that this location duplicates. Only present when location_state.is_duplicate is true. Deprecated: We are no longer supporting detailed information for duplicates.
maps_url	string A link to the location on Maps.
new_review_url	string A link to the page on Google Search where a customer can leave a review for the location.

Duplicate

Information about the location that this location duplicates.

Fields
location_name	string The resource name of the location that this duplicates. Only populated if the authenticated user has access rights to that location and that location is not deleted.
place_id	string The place ID of the location that this duplicates.
access	Access Indicates whether the user has access to the location it duplicates.

Access

User's access level to the location that it duplicates. This replaces Ownership and should be used instead.

Enums
ACCESS_UNSPECIFIED	Not specified.
ACCESS_UNKNOWN	Unable to determine whether the user has access to the location that it duplicates.
ALLOWED	User has access to the location that it duplicates.
INSUFFICIENT	User doesn't have access to the location that it duplicates.

RelationshipData

Information of all parent and children locations related to this one.

Fields
parent_chain	string The resource name of the Chain that this location is member of. How to find Chain ID

LocationDrivingDirectionMetrics

A location indexed with the regions that people usually come from. This is captured by counting how many driving-direction requests to this location are from each region.

Fields
location_name	string The location resource name this metric value belongs to.
top_direction_sources[]	TopDirectionSources Driving-direction requests by source region. By convention, these are sorted by count with at most 10 results.
time_zone	string Time zone (IANA timezone IDs, for example, 'Europe/London') of the location.

TopDirectionSources

Top regions where driving-direction requests originated from.

Fields
day_count	int32 The number of days data is aggregated over.
region_counts[]	RegionCount Regions sorted in descending order by count.

RegionCount

A region with its associated request count.

Fields
latlng	LatLng Center of region.
label	string Human-readable label for the region.
count	int64 Number of driving-direction requests from this region.

LocationKey

Alternate/surrogate key references for a location.

Fields
plus_page_id	string Output only. If this location has a Google+ page associated with it, this is populated with the Google+ page ID for this location.
place_id	string If this location has been verified and is connected to/appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. If this location is unverified, this field may be populated if the location has been associated with a place that appears on Google Maps. This field can be set during Create calls, but not for Update. The additional explicit_no_place_id bool qualifies whether an unset place ID is deliberate or not.
explicit_no_place_id	bool Output only. A value of true indicates that an unset place ID is deliberate, which is different from no association being made yet.
request_id	string Output only. The request_id used to create this location. May be empty if this location was created outside of the Google My Business API or Business Profile Locations.

LocationMetrics

A series of Metrics and BreakdownMetrics associated with a Location over some time range.

Fields
location_name	string The location resource name these values belong to.
time_zone	string IANA timezone for the location.
metric_values[]	MetricValue A list of values for the requested metrics.

LocationReview

Represents a review with location information.

Fields
name	string Location resource name.
review	Review A review for the location.

LocationState

Contains a set of booleans that reflect the state of a Location.

Fields
is_google_updated	bool Output only. Indicates whether the place ID associated with this location has updates.
is_duplicate	bool Output only. Indicates whether the location is a duplicate of another location.
is_suspended	bool Output only. Indicates whether the location is suspended. Suspended locations are not visible to end users in Google products. If you believe this was a mistake, see the help center article.
can_update	bool Output only. Indicates whether the location can be updated.
can_delete	bool Output only. Indicates whether the location can be deleted using the Google My Business API.
is_verified	bool Output only. Indicates whether the location is verified.
needs_reverification	bool Output only. Indicates whether the location requires reverification.
is_pending_review	bool Output only. Indicates whether the review of the location is pending.
is_disabled	bool Output only. Indicates whether the location is disabled.
is_published	bool Output only. Indicates whether the location is published.
is_disconnected	bool Output only. Indicates whether the location is disconnected from a place on Google Maps.
is_local_post_api_disabled	bool Output only. Indicates whether accounts.locations.localPosts is disabled for this location.
can_modify_service_list	bool Output only. Indicates if the listing can modify a ServiceList.
can_have_food_menus	bool Output only. Indicates if the listing is eligible for food menu.
has_pending_edits	bool Output only. Indicates whether any of this Location's properties are in the edit pending state.
has_pending_verification	bool Output only. Indicates whether the location has pending verification requests.
can_operate_health_data	bool Output only. Indicates whether the location can operate on Health data.
can_operate_lodging_data	bool Output only. Indicates whether the location can operate on Lodging data.

MatchedLocation

Represents a possible match to a location.

Fields
location	Location The sparsely populated location that is a potential match. Unpopulated fields include, but may not be limited to: name (the matched location cannot be retrieved via GetLocation nor BatchGetLocations); store_code; service_area coverage area details; labels; ad_words_location_extensions; photos
is_exact_match	bool Is this an exact match?

MediaItem

A single media item.

Fields
name	string The resource name for this media item. accounts/{account_id}/locations/{location_id}/media/{media_key}
media_format	MediaFormat The format of this media item. Must be set when the media item is created, and is read-only on all other requests. Cannot be updated.
location_association	LocationAssociation Required when calling CreatePhoto. Describes how this media item is connected to its location. Must be either a category (for example, EXTERIOR) or the ID of a price list item. This is required when adding new media to a location with CreateMediaItem. For other types of media, for example, photos on local posts, this will not be present.
google_url	string Output only. Google-hosted URL for this media item. This URL is not static since it may change over time. For video this will be a preview image with an overlaid play icon.
thumbnail_url	string Output only. Where provided, the URL of a thumbnail image for this media item.
create_time	Timestamp Output only. Creation time of this media item.
dimensions	Dimensions Output only. The dimensions (width and height) in pixels.
insights	MediaInsights Output only. Statistics for this media item.
attribution	Attribution Output only. Attribution information for customer media items. You must display this attribution as provided to your users and must not delete or alter the attribution.
description	string Description for this media item. Descriptions cannot be modified through the Google My Business API, but can be set when creating a new media item that is not a cover photo.
Union field data. The media item's data source. When creating a new media item, either a URL or data ref must be provided. With the exception of PROFILE and COVER category, all photos must measure a minimum of 250px on the short edge, with a file size of at least 10240 bytes. All uploaded photos should follow the Business Profile guidelines for photos. data can be only one of the following:
source_url	string A publicly accessible URL where the media item can be retrieved from. When creating one of this or data_ref must be set to specify the source of the media item. If source_url was used when creating a media item, it will be populated with that source URL when the media item is retrieved. This field cannot be updated.
data_ref	MediaItemDataRef Input only. A reference to media item binary data as obtained by the StartUploadMediaItemData method. When creating a media item, either sourceUrl or dataRef must be set.

Attribution

Attribution information for customer media items, such as the contributor's name and profile picture.

Fields
profile_name	string The user name to attribute the media item to.
profile_photo_url	string URL of the attributed user's profile photo thumbnail.
takedown_url	string The URL of the takedown page, where the media item can be reported if it is inappropriate.
profile_url	string The URL of the attributed user's Google Maps profile page.

Dimensions

Dimensions of the media item.

Fields
width_pixels	int32 Width of the media item, in pixels.
height_pixels	int32 Height of the media item, in pixels.

LocationAssociation

How the media item is associated with its location.

Fields
Union field location_attachment_type. Location media must either have a category or the ID of a price list item that they are associated with. Non-location media (for example, local post photos) must have neither. location_attachment_type can be only one of the following:
category	Category The category that this location photo belongs to.
price_list_item_id	string The ID of a price list item that this location photo is associated with.

Category

Enum for media item category.

Enums
CATEGORY_UNSPECIFIED	Unspecified category.
COVER	Cover photo. A location has only one cover photo.
PROFILE	Profile photo. A location has only one profile photo.
LOGO	Logo photo.
EXTERIOR	Exterior media.
INTERIOR	Interior media.
PRODUCT	Product media.
AT_WORK	'At-work' media.
FOOD_AND_DRINK	Food and drink media.
MENU	Menu media.
COMMON_AREA	Common area media.
ROOMS	Rooms media.
TEAMS	Teams media.
ADDITIONAL	Additional, uncategorized media.

MediaFormat

Enum for media format.

Enums
MEDIA_FORMAT_UNSPECIFIED	Format unspecified.
PHOTO	Media item is a photo. In this version, only photos are supported.
VIDEO	Media item is a video.

MediaInsights

Insights and statistics for the media item.

Fields
view_count	int64 Output only. The number of times the media item has been viewed.

MediaItemDataRef

Reference to the photo binary data of a MediaItem uploaded through the Google My Business API.

Create a data ref using StartUploadMediaItemData, and use this ref when uploading bytes to [UpdateMedia] and subsequently calling CreateMediaItem.

Fields
resource_name	string The unique ID for this media item's binary data. Used to upload the photo data with [UpdateMedia] and when creating a new media item from those bytes with CreateMediaItem. Example of uploading bytes: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resource_name}?upload_type=media" For CreateMediaItem calls, set this as the MediaItem data_ref.

MenuLabel

Label to be used when displaying the menu and its various sub-components.

Fields
display_name	string Required. Display name of the component.
description	string Optional. Supplementary information of the component.
language_code	string Optional. The BCP 47 code of language. If the language is not available, it will default to English.

Metric

A metric of data about a resource.

Enums
METRIC_UNSPECIFIED	No metric specified.
ALL	Shorthand to request all available metrics. Which metrics are included in ALL varies, and depends on the resource for which insights are being requested.
QUERIES_DIRECT	The number of times the resource was shown when searching for the location directly.
QUERIES_INDIRECT	The number of times the resource was shown as a result of a categorical search (for example, restaurant).
QUERIES_CHAIN	The number of times a resource was shown as a result of a search for the chain it belongs to, or a brand it sells. For example, Starbucks, Adidas. This is a subset of QUERIES_INDIRECT.
VIEWS_MAPS	The number of times the resource was viewed on Google Maps.
VIEWS_SEARCH	The number of times the resource was viewed on Google Search.
ACTIONS_WEBSITE	The number of times the website was clicked.
ACTIONS_PHONE	The number of times the phone number was clicked.
ACTIONS_DRIVING_DIRECTIONS	The number of times driving directions were requested.
PHOTOS_VIEWS_MERCHANT	The number of views on media items uploaded by the merchant.
PHOTOS_VIEWS_CUSTOMERS	The number of views on media items uploaded by customers.
PHOTOS_COUNT_MERCHANT	The total number of media items that are currently live that have been uploaded by the merchant.
PHOTOS_COUNT_CUSTOMERS	The total number of media items that are currently live that have been uploaded by customers.
LOCAL_POST_VIEWS_SEARCH	The number of times the local post was viewed on Google Search.
LOCAL_POST_ACTIONS_CALL_TO_ACTION	The number of times the call to action button was clicked on Google.

MetricOption

Option to specify how data should be displayed in the response.

Enums
METRIC_OPTION_UNSPECIFIED	No metric option specified. Will default to AGGREGATED_TOTAL in a request.
AGGREGATED_TOTAL	Return values aggregated over the entire time frame. This is the default value.
AGGREGATED_DAILY	Return daily timestamped values across time range.
BREAKDOWN_DAY_OF_WEEK	Values will be returned as a breakdown by day of the week. Only valid for ACTIONS_PHONE.
BREAKDOWN_HOUR_OF_DAY	Values will be returned as a breakdown by hour of the day. Only valid for ACTIONS_PHONE.

MetricRequest

A request to return values for one metric and the options for how those values should be returned.

Fields
metric	Metric The requested metric.
options[]	MetricOption How the values should appear when returned.

MetricValue

A value for a single Metric from a starting time.

Fields
metric	Metric The metric for which the value applies.
total_value	DimensionalMetricValue The total aggregated value for this metric. Set for the AGGREGATED_TOTAL option.
dimensional_values[]	DimensionalMetricValue Dimensional values for this metric.

MoreHours

The time periods during which a location is open for certain types of business.

Fields
hours_type_id	string Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
periods[]	TimePeriod Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.

MoreHoursType

More hours types that a business can offers, in addition to its regular hours.

Fields
hours_type_id	string Output only. A stable ID provided by Google for this hours type.
display_name	string Output only. The human-readable English display name for the hours type.
localized_display_name	string Output only. The human-readable localized display name for the hours type.

NetworkState

The state of an insurance network regarding this location.

Enums
NETWORK_STATE_UNSPECIFIED	Default value.
ACCEPTED	This network is accepted by this location.
PENDING_ADD	There is a pending request to add this network to the accepted list.
PENDING_DELETE	There is a pending request to remove this network from the accepted list.
NOT_ACCEPTED	This network is not accepted by this location.

NotificationType

Type of notification sent to the Cloud Pub/Sub topic.

Enums
NOTIFICATION_TYPE_UNSPECIFIED	No notification type. Will not match any notifications.
GOOGLE_UPDATE	The location has Google updates for review. The location_name field on the notification will provide the resource name of the location with Google updates.
NEW_REVIEW	A new review has been added to the location. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.
UPDATED_REVIEW	A review on the location has been updated. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.
NEW_CUSTOMER_MEDIA	A new media item has been added to the location by a Google Maps user. The notification will provide the resource name of the new media item.
NEW_QUESTION	A new question is added to the location. The notification will provide the resource name of question.
UPDATED_QUESTION	A question of the location is updated. The notification will provide the resource name of question.
NEW_ANSWER	A new answer is added to the location. The notification will provide the resource name of question and answer.
UPDATED_ANSWER	An answer of the location is updated. The notification will provide the resource name of question and answer.
UPDATED_LOCATION_STATE	The LocationState of the Location was updated. The Notification will contain the field mask of the updated LocationState fields.

Notifications

A Google Cloud Pub/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification settings resource per-account.

Fields
name	string Output only. The notifications resource name.
topic_name	string The Google Cloud Pub/Sub topic that will receive notifications when locations managed by this account are updated. If unset, no notifications will be posted. The account [e-mail] must have at least Publish permissions on the Cloud Pub/Sub topic.
notification_types[]	NotificationType The types of notifications that will be sent to the Cloud Pub/Sub topic. At least one must be specified. To stop receiving notifications entirely, use DeleteNotifications.

NutritionFacts

This message represents nutrition facts for a food dish.

Fields
calories	CaloriesFact Optional. Calories of the dish.
total_fat	NutritionFact Optional. Fat information for a given food dish.
cholesterol	NutritionFact Optional. Cholesterol information for a given food dish.
sodium	NutritionFact Optional. Sodium information for a given food dish.
total_carbohydrate	NutritionFact Optional. Carbohydrate information for a given food dish.
protein	NutritionFact Optional. Protein information for a given food dish.

CaloriesFact

This message denotes calories information with an upper bound and lower bound range. Lower amount must be specified. Both lower and upper amounts are non-negative numbers.

Fields
lower_amount	int32 Required. Lower amount of calories
upper_amount	int32 Optional. Upper amount of calories
unit	EnergyUnit Required. Unit of the given calories information.

EnergyUnit

Possible units of food energy (calories).

Enums
ENERGY_UNIT_UNSPECIFIED	Energy unit unspecified
CALORIE	Calorie
JOULE	Joule

MassUnit

Possible units of mass.

Enums
MASS_UNIT_UNSPECIFIED	Mass unit unspecified
GRAM	Gram
MILLIGRAM	Milligram

NutritionFact

This message denotes nutrition information with an upper bound and lower bound range and can be represented by mass unit. Lower amount must be specified. Both lower and upper amounts are non-negative numbers.

Fields
lower_amount	double Required. Lower amount of nutrition
upper_amount	double Optional. Upper amount of nutrition
unit	MassUnit Required. Unit of the given nutrition information.

OpenInfo

Information related to the opening state of the business.

Fields
status	OpenForBusiness Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
can_reopen	bool Output only. Indicates whether this business is eligible for re-open.
opening_date	Date The date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.

OpenForBusiness

Indicates the status of a location.

Enums
OPEN_FOR_BUSINESS_UNSPECIFIED	Not specified.
OPEN	Indicates that the location is open.
CLOSED_PERMANENTLY	Indicates that the location has been permanently closed.
CLOSED_TEMPORARILY	Indicates that the location has been temporarily closed. This value may only be applied to published locations (i.e. location_state.is_published = true). When updating the status field to this value, clients are required to set the update_mask explicitly to open_info.status. No other update masks can be set during this update call. This is a temporary restriction which will be relaxed soon.

PermissionLevel

Indicates the access level that the authenticated user has for this account.

Enums
PERMISSION_LEVEL_UNSPECIFIED	Not specified.
OWNER_LEVEL	The user has owner level permission.
MEMBER_LEVEL	The user has member level permission.

PhoneInput

Input for PHONE_CALL/SMS verification.

Fields
phone_number	string The phone number that should be called or be sent SMS to. It must be one of the phone numbers in the eligible options.

PlaceInfo

Defines an area that's represented by a place ID.

Fields
name	string The localized name of the place. For example, Scottsdale, AZ.
place_id	string The ID of the place. Must correspond to a region.

Places

Defines the union of areas represented by a set of places.

Fields
place_infos[]	PlaceInfo The areas represented by place IDs. Limited to a maximum of 20 places.

PointRadius

A radius around a particular point (latitude/longitude).

Fields
latlng	LatLng The latitude/longitude that specifies the center of an area defined by the radius.
radius_km	float The distance in kilometers of the area around the point.

PreparationMethod

Preparation method of a food dish.

Enums
PREPARATION_METHOD_UNSPECIFIED	Preparation method unspecified
BAKED	Baked method
BARBECUED	Barbecued method
BASTED	Basted method
BLANCHED	Blanched method
BOILED	Boiled method
BRAISED	Braised method
CODDLED	Coddled method
FERMENTED	Fermented method
FRIED	Fried method
GRILLED	Grilled method
KNEADED	Kneaded method
MARINATED	Marinated method
PAN_FRIED	Pan fried method
PICKLED	Pickled method
PRESSURE_COOKED	Pressure cooked method
ROASTED	Roasted method
SAUTEED	Sauteed method
SEARED	Seared method
SIMMERED	Simmered method
SMOKED	Smoked method
STEAMED	Steamed method
STEEPED	Steeped method
STIR_FRIED	Stir fried method
OTHER_METHOD	Other method

PriceList

This resource is deprecated. Please refer to Business Information API v1 for the latest representation of this resource.

Please note an upcoming migration will result in certain services being added to some merchants' service lists without being actively accepted via Owner Review. While we have high confidence that these services are accurate, if merchants find specific services that are incorrect, removing them from a business profile's service list will permanently fix the issue.

Deprecated: A list of item price information. Price lists are structured as one or more price lists, each containing one or more sections with one or more items. For example, food price lists may represent breakfast/lunch/dinner menus, with sections for burgers/steak/seafood.

Fields
price_list_id	string Required. ID for the price list. Price list, section, and item IDs cannot be duplicated within this Location.
labels[]	Label Required. Language-tagged labels for the price list.
source_url	string Optional source URL of where the price list was retrieved from. For example, this could be the URL of the page that was automatically scraped to populate the menu information.
sections[]	Section Required. Sections for this price list. Each price list must contain at least one section.

Label

Label to be used when displaying the price list, section, or item.

Fields
display_name	string Required. Display name for the price list, section, or item.
description	string Optional. Description of the price list, section, or item.
language_code	string Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.

Section

A section of the price list containing one or more items.

Fields
section_id	string Required. ID for the section. Price list, section, and item IDs cannot be duplicated within this Location.
labels[]	Label Required. Language-tagged labels for the section. We recommend that section names and descriptions be 140 characters or less. At least one set of labels is required.
section_type	SectionType Optional. Type of the current price list section. Default value is FOOD.
items[]	Item Items that are contained within this section of the price list.

Item

A single list item. Each variation of an item in the price list should have its own Item with its own price data.

Fields
item_id	string Required. ID for the item. Price list, section, and item IDs cannot be duplicated within this Location.
labels[]	Label Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. At least one set of labels is required.
price	Money Optional. Price of the item.

SectionType

Type of the section.

Enums
SECTION_TYPE_UNSPECIFIED	Not specified.
FOOD	Section contains items that represent food.
SERVICES	Section contains items that represent services.

Profile

All information pertaining to the location's profile.

Fields
description	string Description of the location in your own voice, not editable by anyone else.

Question

Represents a single question and some of its answers.

Fields
name	string Output only. The unique name for the question. accounts/*/locations/*/questions/*
author	Author Output only. The author of the question.
upvote_count	int32 Output only. The number of upvotes for the question.
text	string The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
create_time	Timestamp Output only. The timestamp for when the question was written.
update_time	Timestamp Output only. The timestamp for when the question was last modified.
top_answers[]	Answer Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
total_answer_count	int32 Output only. The total number of answers posted for this question.

RepeatedEnumAttributeValue

Values for an attribute with a value_type of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified.

Fields
set_values[]	string Enum values that are set.
unset_values[]	string Enum values that are unset.

ReportGoogleLocationRequest

Request message for reporting a GoogleLocation.

Fields
name	string Resource name of a [GoogleLocation], in the format googleLocations/{googleLocationId}.
location_group_name	string Optional. The resource name of the location group that this Google Location is being reported for, in the format accounts/{account_id}.
report_reason_elaboration	string Optional. A text entry for elaborating on the reason for which the user is reporting this location. The maximum length is 512 characters.
report_reason_language_code	string Optional. The BCP 47 code of language used in report_reason_elaboration.
Union field report_reason. Reason why this location is being reported. A reason must be provided. report_reason can be only one of the following:
report_reason_bad_location	BadLocationReason The reason for which the user is reporting this location when the issue is with the location itself.
report_reason_bad_recommendation	BadRecommendationReason The reason for which the user is reporting this location when the issue is with the recommendation. This report is useful if the location has been recommended to the Business Profile account.

BadLocationReason

A set of possible reasons for reporting a location when there is an issue with the quality of data in the location itself.

Enums
BAD_LOCATION_REASON_UNSPECIFIED	Not specified.
NOT_A_LOCATION	The recommended location is not an actual location.
PERMANENTLY_CLOSED	The recommended location is permanently closed.
DOES_NOT_EXIST	The recommended location does not exist.
SPAM	The recommended location is spam, fake or offensive.
NOT_A_BUSINESS	The recommended location is a private place or home.
MOVED	The recommended location has moved to a new location. Should be accompanied by a report_reason_elaboration specifying the new address.
DUPLICATE	The recommended location is a duplicate of another location.

BadRecommendationReason

A set of possible reasons for reporting a location when there is an issue with the quality of recommendation (when this location is recommended to the user).

Enums
BAD_RECOMMENDATION_REASON_UNSPECIFIED	Not specified.
NOT_A_STORE_FRONT	The recommended location is not a store front.
NOT_PART_OF_SUGGESTED_CHAIN	The recommended location doesn't belong to the chain suggested in the chain_display_name in the returned location. Should be accompanied by a report_reason_elaboration specifying the name of the correct chain.
IRRELEVANT	The recommended location is not relevant to the user. Should be accompanied by a report_reason_elaboration for why the recommendation is irrelevant.

ReportLocalPostInsightsRequest

Request message for Insights.ReportLocalPostInsights

Fields
name	string Required. The name of the location for which to fetch insights.
local_post_names[]	string Required. The list of posts for which to fetch insights data. All posts have to belong to the location whose name is specified in the name field.
basic_request	BasicMetricsRequest A request to include basic metric insights in the report. This request applies to all posts requested.

ReportLocalPostInsightsResponse

Response message for Insights.ReportLocalPostInsights

Fields
name	string
local_post_metrics[]	LocalPostMetrics One entry per requested post corresponding to this location.
time_zone	string Time zone (IANA timezone IDs, eg, 'Europe/London') of the location.

ReportLocationInsightsRequest

Request message for Insights.ReportLocationInsights.

Fields
name	string The account resource name.
location_names[]	string A collection of locations to fetch insights for, specified by their names.
basic_request	BasicMetricsRequest A request to include basic metric insights in the report.
driving_directions_request	DrivingDirectionMetricsRequest A request to include insights about driving-direction requests in the report.

ReportLocationInsightsResponse

Response message for Insights.ReportLocationInsights.

Fields
location_metrics[]	LocationMetrics A collection of metric values by location.
location_driving_direction_metrics[]	LocationDrivingDirectionMetrics A collection of values for driving direction-related metrics.

Review

Output only. Represents a review for a location.

Fields
name	string The resource name. For Review it is of the form accounts/{account_id}/locations/{location_id}/reviews/{review_id}
review_id	string The encrypted unique identifier.
reviewer	Reviewer The author of the review.
star_rating	StarRating The star rating of the review.
comment	string The body of the review as plain text with markups.
create_time	Timestamp The timestamp for when the review was written.
update_time	Timestamp The timestamp for when the review was last modified.
review_reply	ReviewReply The owner/manager of this location's reply to this review.

Reviewer

Represents the author of the review.

Fields
profile_photo_url	string The profile photo link of the reviewer. Only populated if is_anonymous is false.
display_name	string The name of the reviewer. Only populated with the reviewer's real name if is_anonymous is false.
is_anonymous	bool Indicates whether the reviewer has opted to remain anonymous.

StarRating

The star rating out of five, where five is the highest rated.

Enums
STAR_RATING_UNSPECIFIED	Not specified.
ONE	One star out of a maximum of five.
TWO	Two stars out of a maximum of five.
THREE	Three stars out of a maximum of five.
FOUR	Four stars out of a maximum of five.
FIVE	The maximum star rating.

ReviewReply

Represents the location owner/manager's reply to a review.

Fields
comment	string The body of the reply as plain text with markups. The maximum length is 4096 bytes.
update_time	Timestamp Output only. The timestamp for when the reply was last modified.

SearchChainsRequest

Request message for Locations.SearchChains.

Fields
chain_display_name	string Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
result_count	int32 The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.

SearchChainsResponse

Response message for Locations.SearchChains.

Fields
chains[]	Chain Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.

SearchGoogleLocationsRequest

Request message for GoogleLocations.SearchGoogleLocations.

Fields
result_count	int32 The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.
Union field search_query. Search query. This can be provided either as a location object or as a string query. search_query can be only one of the following:
location	Location Location to search for. If provided, will find locations which match the provided location details.
query	string Text query to search for. The search results from a query string will be less accurate than if providing an exact location, but can provide more inexact matches.

SearchGoogleLocationsResponse

Response message for GoogleLocations.SearchGoogleLocations.

Fields
google_locations[]	GoogleLocation A collection of GoogleLocations that are potential matches to the specified request, listed in order from most to least accuracy.

ServiceAreaBusiness

Service area businesses provide their service at the customer's location (for example, a locksmith or plumber).

Fields
business_type	BusinessType Indicates the type of the service area business.
Union field coverageArea. Indicates the coverage area where the business offers service. coverageArea can be only one of the following:
radius	PointRadius Output only. The area that this business serves centered around a point.
places	Places The area that this business serves defined through a set of places.

BusinessType

Indicates whether this business only offers services onsite at a customer location (for example, a tow truck), or at both an address and onsite (for example, a pizza store with a dining area, that also delivers to customers).

Enums
BUSINESS_TYPE_UNSPECIFIED	Output only. Not specified.
CUSTOMER_LOCATION_ONLY	Offers service only in the surrounding area (not at the business address).
CUSTOMER_AND_BUSINESS_LOCATION	Offers service at the business address and the surrounding area.

ServiceBusinessContext

Additional data for service business verification.

Fields
address	PostalAddress The verification address of the location. It is used to either enable more verification options or send a postcard.

ServiceList

A service list containing one or more service items.

Fields
name	string Required. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/serviceList
service_items[]	ServiceItem Service items that are contained within this service list. Duplicated service items will be removed automatically.

ServiceItem

A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.

Fields
is_offered	bool Optional. This field decides whether or not the input service is offered by the merchant.
price	Money Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price.
Union field service_item_info. One of the following fields should always be set. service_item_info can be only one of the following:
structured_service_item	StructuredServiceItem This field will be set case of structured services data.
free_form_service_item	FreeFormServiceItem This field will be set case of free-form services data.

FreeFormServiceItem

Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface.

Fields
category_id	string Required. The category_id and service_type_id should match the possible combinations provided in the Category message.
label	Label Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id.

StructuredServiceItem

Represents a structured service offered by the merchant. For eg: toilet_installation.

Fields
service_type_id	string Required. The service_type_id field is a Google provided unique ID that can be found in ServiceTypeMetadata. This information is provided by BatchGetBusinessCategories rpc service.
description	string Optional. Description of structured service item. The character limit is 300.

ServiceType

A message describing a service type that the business offers.

Fields
service_type_id	string Output only. A stable ID (provided by Google) for this service type.
display_name	string Output only. The human-readable display name for the service type.

SpecialHourPeriod

Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The open_time and start_date must predate the close_time and end_date. The close_time and end_date can extend to 11:59 a.m. on the day after the specified start_date. For example, the following inputs are valid:

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

The following inputs are not valid:

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

Fields
start_date	Date The calendar date this special hour period starts on.
open_time	string The wall time on start_date when a location opens, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if is_closed is false.
end_date	Date The calendar date this special hour period ends on. If end_date field is not set, default to the date specified in start_date. If set, this field must be equal to or at most 1 day after start_date.
close_time	string The wall time on end_date when a location closes, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if is_closed is false.
is_closed	bool If true, end_date, open_time, and close_time are ignored, and the date specified in start_date is treated as the location being closed for the entire day.

SpecialHours

Represents a set of time periods when a location's operational hours differ from its normal business hours.

Fields
special_hour_periods[]	SpecialHourPeriod A list of exceptions to the business's regular hours.

Spiciness

The spiciness level of a food item.

Enums
SPICINESS_UNSPECIFIED	Level unspecified
MILD	Denotion of mild spicy.
MEDIUM	Denotion of medium spicy.
HOT	Denotion of hot spicy. The most spiciest level.

StartUploadMediaItemDataRequest

Request message for Media.StartUploadMediaItemData.

Fields
parent	string The resource name of the location this media item is to be added to.

TimeInterval

An interval of time, inclusive. It must contain all fields to be valid.

Fields
start_date	Date The start date of this period.
start_time	TimeOfDay The start time of this period.
end_date	Date The end date of this period.
end_time	TimeOfDay The end time of this period.

TimePeriod

Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.

Fields
open_day	DayOfWeek Indicates the day of the week this period starts on.
open_time	string Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
close_day	DayOfWeek Indicates the day of the week this period ends on.
close_time	string Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

TimeRange

A range of time. Data will be pulled over the range as a half-open inverval (that is, [start_time, end_time)).

Fields
start_time	Timestamp Epoch timestamp for the start of the range (inclusive).
end_time	Timestamp Epoch timestamp for the end of the range (exclusive).

TransferLocationRequest

Request message for Locations.TransferLocation.

Fields
name	string The name of the location to transfer.
to_account	string Name of the account resource to transfer the location to (for example, "accounts/8675309").

UpdateAccountAdminRequest

Request message for AccessControl.UpdateAccountAdmin.

Fields
name	string The resource name of the admin to update.
admin	Admin The updated admin. Note: The only editable field is role. All other fields are ignored.

UpdateAccountRequest

Request message for Accounts.UpdateAccount.

Fields
name	string The name of the account to update.
account	Account The updated account information. Note: The only editable field is account_name.
validate_only	bool If true, the request is validated without actually updating the account.

UpdateFoodMenusRequest

Request message for FoodMenu.UpdateFoodMenus

Fields
food_menus	FoodMenus Required. The updated food menu information. Menu can be unset by updating without any menu sections.
update_mask	FieldMask Optional. The specific fields to update. If no mask is specified, then this is treated as a full update and all fields are set to the values passed in, which may include unsetting empty fields in the request. Repeated field items can not be individually updated. Note: "name" of FoodMenus is the resource identifier which is not updatable.

UpdateHealthProviderAttributesRequest

Request message for HealthProviderAttributes.UpdateHealthProviderAttributes

Fields
health_provider_attributes	HealthProviderAttributes Required. The updated health provider attributes.
update_mask	FieldMask Optional. The specific fields to update. If no mask is specified, then this is treated as a full update and all fields are set to the values passed in, which may include unsetting empty fields in the request. In V1, there is only the insurance_networks field to update. More attributes will be supported later.

UpdateLocalPostRequest

Request message for UpdateLocalPost.

Fields
name	string The name of the local post to update.
local_post	LocalPost The updated local post information.
update_mask	FieldMask The specific fields to update. You must specify each field that is being updated in the mask.

UpdateLocationAdminRequest

Request message for AccessControl.UpdateLocationAdmin.

Fields
name	string The resource name of the admin to update.
admin	Admin The updated admin. Note: The only editable field is role. All other fields are ignored.

UpdateLocationRequest

Request message for Locations.UpdateLocation.

Fields
name	string The name of the location to update.
location	Location The updated location information.
update_mask	FieldMask The specific fields to update. If no mask is specified, then this is treated as a full update and all fields are set to the values passed in, which may include unsetting empty fields in the request.
validate_only	bool If true, the request is validated without actually updating the location.
attribute_mask	FieldMask The IDs of the attributes to update. Only attributes noted in the mask will be updated. If an attribute is present in the mask and not in the location, it will be removed. An empty mask will update all attributes. Whenever this field is set, the update_mask should include attributes as one of the fields to update.

UpdateMediaItemRequest

Request message for Media.UpdateMediaItem.

Fields
name	string The name of the media item to be updated.
media_item	MediaItem The media item to be updated. Only the category or price list item id can be updated.
update_mask	FieldMask The specific fields to update. If no mask is specified, then this is treated as a full update and all editable fields are set to the values passed in.

UpdateNotificationsRequest

Request message for Accounts.UpdateNotifications.

Fields
name	string The notification settings resource name.
notifications	Notifications The updated notification settings.

UpdateQuestionRequest

Request message for QuestionsAndAnswers.UpdateQuestion

Fields
name	string The name of the question to update.
question	Question The updated question.

UpdateReviewReplyRequest

Request message for Reviews.UpdateReviewReply.

Fields
name	string The name of the review to respond to.
review_reply	ReviewReply The reply to the review. If a reply already exists, this will replace the old reply.

UpdateServiceListRequest

Update service list request message.

Fields
service_list	ServiceList Optional. The updated service list information. If leave this field empty, the api will delete the ServiceList. If a ServiceList is set, the api will replace the original ServiceList with the set one.
update_mask	FieldMask Optional. The specific fields to update. If no mask is specified, then this is treated as a full update and all fields are set to the values passed in, which may include unsetting empty fields in the request. Repeated field items can not be individually updated.

UpsertAnswerRequest

Request message for QuestionsAndAnswers.UpsertAnswer

Fields
parent	string The name of the question to write an answer for.
answer	Answer The new answer.

UrlAttributeValue

Values for an attribute with a value_type of URL.

Fields
url	string The URL.

ValidationError

Describes validation failures in a client request.

Fields
error_details[]	ErrorDetail Details individual validation failures with integer error codes.

Verification

A verification represents a verification attempt on a location.

Fields
name	string Resource name of the verification.
method	VerificationMethod The method of the verification.
state	VerificationState The state of the verification.
create_time	Timestamp The timestamp when the verification is requested.

VerificationState

All possible verification states.

Enums
VERIFICATION_STATE_UNSPECIFIED	Default value, will result in errors.
PENDING	The verification is pending.
COMPLETED	The verification is completed.
FAILED	The verification is failed.

VerificationMethod

Specifies the processes used by Google to verify a location.

Enums
VERIFICATION_METHOD_UNSPECIFIED	Default value, will result in errors.
ADDRESS	Send a postcard with a verification PIN to a specific mailing address. The PIN is used to complete verification with Google.
EMAIL	Send an email with a verification PIN to a specific email address. The PIN is used to complete verification with Google.
PHONE_CALL	Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.
SMS	Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.
AUTO	Verify the location without additional user action. This option may not be available for all locations.

VerificationOption

The verification option represents how to verify the location (indicated by verification method) and where the verification will be sent to (indicated by display data).

Fields
verification_method	VerificationMethod Method to verify the location.
Union field DisplayData. One of the display data. The data must match the method. Empty if the corresponding method doesn't have any display data. DisplayData can be only one of the following:
phone_data	PhoneVerificationData Set only if the method is PHONE_CALL or SMS.
address_data	AddressVerificationData Set only if the method is MAIL.
email_data	EmailVerificationData Set only if the method is EMAIL.

AddressVerificationData

Display data for verifications through postcard.

Fields
business_name	string Merchant's business name.
address	PostalAddress Address that a postcard can be sent to.

EmailVerificationData

Display data for verifications through email.

Fields
domain_name	string Domain name in the email address. e.g. "gmail.com" in [e-mail]
user_name	string User name in the email address. e.g. "foo" in [e-mail]
is_user_name_editable	bool Whether client is allowed to provide a different user name.

PhoneVerificationData

Display Data for verifications through phone, e.g. phone call, sms.

Fields
phone_number	string Phone number that the PIN will be sent to.

VerifyLocationRequest

Request message for Verifications.VerifyLocation.

Fields
name	string Resource name of the location to verify.
method	VerificationMethod Verification method.
language_code	string The BCP 47 language code representing the language that is to be used for the verification process.
context	ServiceBusinessContext Extra context information for the verification of service businesses. Required for the locations whose business type is CUSTOMER_LOCATION_ONLY. For ADDRESS verification, the address will be used to send out postcard. For other methods, it should be the same as the one that is passed to FetchVerificationOptions. INVALID_ARGUMENT will be thrown if it is set for other types of business locations.
Union field RequestData. User input data for specific method in addition to the display data. The data must match the requested method. Leave it empty if no data is needed. RequestData can be only one of the following:
email_input	EmailInput The input for EMAIL method.
address_input	AddressInput The input for ADDRESS method.
phone_input	PhoneInput The input for PHONE_CALL/SMS method

VerifyLocationResponse

Response message for Verifications.VerifyLocation.

Fields
verification	Verification The created verification request.