Índice
AccessControl
(interface) (descontinuado)Accounts
(interface) (descontinuado)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
(mensagem)Account
(mensagem) (descontinuado)Account.OrganizationInfo
(mensagem)AccountRole
(enum)AccountState
(mensagem)AccountState.AccountStatus
(enum)AccountType
(enum)AdWordsLocationExtensions
(mensagem)AddressInput
(mensagem)Admin
(mensagem)Admin.AdminRole
(enum)AlertType
(enum)Allergen
(enum)Answer
(mensagem)AssociateLocationRequest
(mensagem)Attribute
(mensagem)AttributeMetadata
(mensagem)AttributeMetadata.AttributeValueMetadata
(mensagem)AttributeValueType
(enum)Author
(mensagem)Author.AuthorType
(enum)BasicMetricsRequest
(mensagem)BatchGetBusinessCategoriesRequest
(mensagem)BatchGetBusinessCategoriesResponse
(mensagem)BatchGetLocationsRequest
(mensagem)BatchGetLocationsResponse
(mensagem)BatchGetReviewsRequest
(mensagem)BatchGetReviewsResponse
(mensagem)BusinessHours
(mensagem)CallToAction
(mensagem)CallToAction.ActionType
(enum)Category
(mensagem)CategoryView
(enum)Chain
(mensagem)Chain.ChainName
(mensagem)Chain.ChainUrl
(mensagem)ClearLocationAssociationRequest
(mensagem)CompleteVerificationRequest
(mensagem)CompleteVerificationResponse
(mensagem)CreateAccountAdminRequest
(mensagem)CreateAccountRequest
(mensagem)CreateLocalPostRequest
(mensagem)CreateLocationAdminRequest
(mensagem)CreateLocationRequest
(mensagem)CreateMediaItemRequest
(mensagem)CreateQuestionRequest
(mensagem)DeclineInvitationRequest
(mensagem)DeleteAccountAdminRequest
(mensagem)DeleteAnswerRequest
(mensagem)DeleteLocalPostRequest
(mensagem)DeleteLocationAdminRequest
(mensagem)DeleteLocationRequest
(mensagem)DeleteMediaItemRequest
(mensagem)DeleteNotificationsRequest
(mensagem)DeleteQuestionRequest
(mensagem)DeleteReviewReplyRequest
(mensagem)DietaryRestriction
(enum)DimensionalMetricValue
(mensagem)DimensionalMetricValue.TimeDimension
(mensagem)DrivingDirectionMetricsRequest
(mensagem)DrivingDirectionMetricsRequest.NumDays
(enum)EmailInput
(mensagem)ErrorDetail
(mensagem)ErrorDetail.ErrorCode
(enum)FetchVerificationOptionsRequest
(mensagem)FetchVerificationOptionsResponse
(mensagem)FindMatchingLocationsRequest
(mensagem)FindMatchingLocationsResponse
(mensagem)FollowersMetadata
(mensagem)FoodMenu
(mensagem)FoodMenu.Cuisine
(enum)FoodMenuItem
(mensagem)FoodMenuItemAttributes
(mensagem)FoodMenuItemAttributes.Ingredient
(mensagem)FoodMenuItemAttributes.PortionSize
(mensagem)FoodMenuItemOption
(mensagem)FoodMenuSection
(mensagem)FoodMenus
(mensagem)GenerateAccountNumberRequest
(mensagem)GetAccountRequest
(mensagem)GetChainRequest
(mensagem)GetCustomerMediaItemRequest
(mensagem)GetFollowersMetadataRequest
(mensagem)GetFoodMenusRequest
(mensagem)GetHealthProviderAttributesRequest
(mensagem)GetLocalPostRequest
(mensagem)GetLocationRequest
(mensagem)GetMediaItemRequest
(mensagem)GetNotificationsRequest
(mensagem)GetReviewRequest
(mensagem)GetServiceListRequest
(mensagem)GoogleLocation
(mensagem)GoogleUpdatedLocation
(mensagem)HealthProviderAttributes
(mensagem)InsuranceNetwork
(mensagem)InternalError
(mensagem)Invitation
(mensagem)Invitation.TargetLocation
(mensagem)ListAccountAdminsRequest
(mensagem)ListAccountAdminsResponse
(mensagem)ListAccountsRequest
(mensagem)ListAccountsResponse
(mensagem)ListAnswersRequest
(mensagem)ListAnswersResponse
(mensagem)ListAttributeMetadataRequest
(mensagem)ListAttributeMetadataResponse
(mensagem)ListBusinessCategoriesRequest
(mensagem)ListBusinessCategoriesResponse
(mensagem)ListCustomerMediaItemsRequest
(mensagem)ListCustomerMediaItemsResponse
(mensagem)ListInsuranceNetworksRequest
(mensagem)ListInsuranceNetworksResponse
(mensagem)ListInvitationsRequest
(mensagem)ListInvitationsRequest.TargetType
(enum)ListInvitationsResponse
(mensagem)ListLocalPostsRequest
(mensagem)ListLocalPostsResponse
(mensagem)ListLocationAdminsRequest
(mensagem)ListLocationAdminsResponse
(mensagem)ListLocationsRequest
(mensagem)ListLocationsResponse
(mensagem)ListMediaItemsRequest
(mensagem)ListMediaItemsResponse
(mensagem)ListQuestionsRequest
(mensagem)ListQuestionsResponse
(mensagem)ListRecommendedGoogleLocationsRequest
(mensagem)ListRecommendedGoogleLocationsResponse
(mensagem)ListReviewsRequest
(mensagem)ListReviewsResponse
(mensagem)ListVerificationsRequest
(mensagem)ListVerificationsResponse
(mensagem)LocalPost
(mensagem)LocalPost.LocalPostState
(enum)LocalPostEvent
(mensagem)LocalPostMetrics
(mensagem)LocalPostOffer
(mensagem)LocalPostTopicType
(enum)Location
(mensagem)Location.Metadata
(mensagem)Location.Metadata.Duplicate
(mensagem)Location.Metadata.Duplicate.Access
(enum)Location.RelationshipData
(mensagem)LocationDrivingDirectionMetrics
(mensagem)LocationDrivingDirectionMetrics.TopDirectionSources
(mensagem)LocationDrivingDirectionMetrics.TopDirectionSources.RegionCount
(mensagem)LocationKey
(mensagem)LocationMetrics
(mensagem)LocationReview
(mensagem)LocationState
(mensagem)MatchedLocation
(mensagem)MediaItem
(mensagem)MediaItem.Attribution
(mensagem)MediaItem.Dimensions
(mensagem)MediaItem.LocationAssociation
(mensagem)MediaItem.LocationAssociation.Category
(enum)MediaItem.MediaFormat
(enum)MediaItem.MediaInsights
(mensagem)MediaItemDataRef
(mensagem)MenuLabel
(mensagem)Metric
(enum)MetricOption
(enum)MetricRequest
(mensagem)MetricValue
(mensagem)MoreHours
(mensagem)MoreHoursType
(mensagem)NetworkState
(enum)NotificationType
(enum)Notifications
(mensagem)NutritionFacts
(mensagem)NutritionFacts.CaloriesFact
(mensagem)NutritionFacts.EnergyUnit
(enum)NutritionFacts.MassUnit
(enum)NutritionFacts.NutritionFact
(mensagem)OpenInfo
(mensagem)OpenInfo.OpenForBusiness
(enum)PermissionLevel
(enum)PhoneInput
(mensagem)PlaceInfo
(mensagem)Places
(mensagem)PointRadius
(mensagem)PreparationMethod
(enum)PriceList
(mensagem) (descontinuado)PriceList.Label
(mensagem)PriceList.Section
(mensagem)PriceList.Section.Item
(mensagem)PriceList.Section.SectionType
(enum)Profile
(mensagem)Question
(mensagem)RepeatedEnumAttributeValue
(mensagem)ReportGoogleLocationRequest
(mensagem)ReportGoogleLocationRequest.BadLocationReason
(enum)ReportGoogleLocationRequest.BadRecommendationReason
(enum)ReportLocalPostInsightsRequest
(mensagem)ReportLocalPostInsightsResponse
(mensagem)ReportLocationInsightsRequest
(mensagem)ReportLocationInsightsResponse
(mensagem)Review
(mensagem)Review.Reviewer
(mensagem)Review.StarRating
(enum)ReviewReply
(mensagem)SearchChainsRequest
(mensagem)SearchChainsResponse
(mensagem)SearchGoogleLocationsRequest
(mensagem)SearchGoogleLocationsResponse
(mensagem)ServiceAreaBusiness
(mensagem)ServiceAreaBusiness.BusinessType
(enum)ServiceBusinessContext
(mensagem)ServiceList
(mensagem)ServiceList.ServiceItem
(mensagem)ServiceList.ServiceItem.FreeFormServiceItem
(mensagem)ServiceList.ServiceItem.StructuredServiceItem
(mensagem)ServiceType
(mensagem)SpecialHourPeriod
(mensagem)SpecialHours
(mensagem)Spiciness
(enum)StartUploadMediaItemDataRequest
(mensagem)TimeInterval
(mensagem)TimePeriod
(mensagem)TimeRange
(mensagem)TransferLocationRequest
(mensagem)UpdateAccountAdminRequest
(mensagem)UpdateAccountRequest
(mensagem)UpdateFoodMenusRequest
(mensagem)UpdateHealthProviderAttributesRequest
(mensagem)UpdateLocalPostRequest
(mensagem)UpdateLocationAdminRequest
(mensagem)UpdateLocationRequest
(mensagem)UpdateMediaItemRequest
(mensagem)UpdateNotificationsRequest
(mensagem)UpdateQuestionRequest
(mensagem)UpdateReviewReplyRequest
(mensagem)UpdateServiceListRequest
(mensagem)UpsertAnswerRequest
(mensagem)UrlAttributeValue
(mensagem)ValidationError
(mensagem)Verification
(mensagem)Verification.VerificationState
(enum)VerificationMethod
(enum)VerificationOption
(mensagem)VerificationOption.AddressVerificationData
(mensagem)VerificationOption.EmailVerificationData
(mensagem)VerificationOption.PhoneVerificationData
(mensagem)VerifyLocationRequest
(mensagem)VerifyLocationResponse
(mensagem)
AccessControl
Esse serviço permite o gerenciamento dos usuários que têm acesso a contas e locais.
AcceptInvitation | |
---|---|
Aceita o convite especificado.
|
CreateAccountAdmin | |
---|---|
Convida o usuário especificado para se tornar um administrador da conta especificada. A pessoa convidada precisa aceitar o convite para ter acesso à conta. Consulte [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] para aceitar um convite programaticamente.
|
CreateLocationAdmin | |
---|---|
Convida o usuário especificado para se tornar um administrador do local especificado. A pessoa convidada precisa aceitar o convite para ter acesso ao local. Consulte [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] para aceitar um convite programaticamente.
|
DeclineInvitation | |
---|---|
Recusa o convite especificado.
|
DeleteAccountAdmin | |
---|---|
Remove o administrador especificado da conta especificada.
|
DeleteLocationAdmin | |
---|---|
Remove o administrador especificado como administrador do local especificado.
|
ListAccountAdmins | |
---|---|
Lista os administradores da conta especificada.
|
ListInvitations | |
---|---|
Lista os convites pendentes da conta especificada.
|
ListLocationAdmins | |
---|---|
Lista todos os administradores do local especificado.
|
UpdateAccountAdmin | |
---|---|
Atualiza o administrador do administrador da conta especificado. Somente o AdminRole do administrador pode ser atualizado.
|
UpdateLocationAdmin | |
---|---|
Atualiza o administrador do administrador de local especificado. Somente o AdminRole do administrador pode ser atualizado.
|
Contas
Essa API permite o gerenciamento de contas do negócio no Google. Ela permite que você gerencie recursos de Account
. Ele define o seguinte modelo de recurso:
A API tem um conjunto de recursos
Account
, chamadosaccounts/*
Para sua conveniência, é possível usar o sinônimo "eu" em vez do ID da conta pessoal do autor da chamada autenticado. Exemplos: GET /v4/accounts/me GET /v4/accounts/me/locations
CreateAccount | |
---|---|
Cria uma conta com o nome e o tipo especificados no pai informado.
|
DeleteNotifications | |
---|---|
Limpa as configurações de notificação do Pub/Sub da conta.
|
GenerateAccountNumber | |
---|---|
Gera um número para essa conta. O número da conta não é provisionado quando uma conta é criada. Use esta solicitação para criar um número de conta quando for necessário.
|
GetAccount | |
---|---|
Extrai a conta especificada. Retorna
|
GetNotifications | |
---|---|
Retorna as configurações de notificação do Pub/Sub para a conta.
|
ListAccounts | |
---|---|
Lista todas as contas do usuário autenticado. Isso inclui todas as contas do usuário e todas as contas em que o usuário tem direitos de gerenciamento.
|
UpdateAccount | |
---|---|
Atualiza a conta comercial especificada. Não é possível atualizar contas pessoais com esse método.
|
UpdateNotifications | |
---|---|
Define as configurações de notificação do Pub/Sub para a conta que informa o Perfil da Empresa para qual tópico enviar notificações do Pub/Sub:
Uma conta terá apenas um recurso de configurações de notificação, e apenas um tópico do Pub/Sub poderá ser definido.
|
BusinessCategories
Essa API permite a visibilidade das categorias compatíveis com locais da empresa no Google. É possível acessar listas paginadas de todas as categorias de negócios disponíveis ou pesquisar um termo específico. Para referência, consulte a seção de categorias deste artigo: https://support.google.com/business/answer/3038177
BatchGetBusinessCategories | |
---|---|
Retorna uma lista de categorias de negócios para o idioma e os IDs de GConcept fornecidos.
|
ListBusinessCategories | |
---|---|
Retorna uma lista de categorias de negócios. A busca corresponderá ao nome da categoria, mas não ao ID dela.
|
BusinessMessagingService
Permite que as empresas registrem os locais para enviar mensagens. Assim, é possível ter um canal de comunicação com os consumidores que pesquisam a localização deles. Para acessar e realizar ações nas mensagens comerciais de um local, você precisa ter MANAGER
ou OWNER
do local.
Seguidores
Essa API expõe a API de gerenciamento de seguidores.
GetFollowersMetadata | |
---|---|
Acessa as configurações de seguidores de um local. NOT_FOUND é retornado se a conta ou o local não existir. PRECondition_FAILED é retornado se o local não foi verificado nem conectado ao Maps.
|
FoodMenuService
Essa API permite buscar e atualizar os cardápios dos restaurantes.
Location.PriceList também representa "menus" em um de seu tipo, mas com campos limitados. Ele compartilha o mesmo armazenamento downstream que os FoodMenus. Depois que a migração para o FoodMenuService for concluída, não é recomendado que os clientes usem Location.PriceList para atualizar os dados do cardápio, o que pode resultar em perda inesperada de dados.
GetFoodMenus | |
---|---|
Retorna os cardápios de alimentos de um local específico. Chame esse método apenas se location.location_state.can_have_food_menu for true.
|
UpdateFoodMenus | |
---|---|
Atualiza os cardápios de um local específico. Chame esse método apenas se location.location_state.can_have_food_menu for true.
|
GoogleLocations
Essa API permite acessar e pesquisar GoogleLocation
.
ListRecommendedGoogleLocations | |
---|---|
Lista todos os As recomendações para contas pessoais se baseiam em todos os locais a que o usuário tem acesso no Perfil da Empresa (incluindo aqueles que podem ser acessados pelos grupos de locais) e são um superconjunto de todas as recomendações geradas para o usuário.
|
ReportGoogleLocation | |
---|---|
Denuncie um
|
SearchGoogleLocations | |
---|---|
Pesquisar todos os locais possíveis que correspondem à solicitação especificada.
|
HealthProviderAttributesService
Este serviço permite o gerenciamento de atributos do provedor de saúde (por exemplo, seguro aceito por um local) vinculados a um local.
GetHealthProviderAttributes | |
---|---|
Retorna os atributos do provedor de saúde de um local específico.
|
UpdateHealthProviderAttributes | |
---|---|
Atualiza os atributos do provedor de saúde de um local específico.
|
Insights
Gera relatórios que detalham os insights do consumidor para uma ou mais fichas nos Serviços do Google. Os dados agregados das métricas básicas podem ser consultados em um período de até 18 meses. As métricas que suportam um detalhamento podem mostrar dados agregados sobre esse intervalo, divididos por dia da semana ou hora do dia. As solicitações de rotas de carro podem ser informadas em resumos por um determinado número de dias.
ReportLocalPostInsights | |
---|---|
Retorna insights para um conjunto de postagens locais associadas a uma única página de detalhes. Quais métricas e como elas são informadas são opções especificadas no protótipo de solicitação.
|
ReportLocationInsights | |
---|---|
Retorna um relatório com insights sobre uma ou mais métricas por local.
|
InsuranceNetworkService
Com ele, você pode receber no Google todas as redes de seguros compatíveis para locais das empresas de saúde.
ListInsuranceNetworks | |
---|---|
Retorna uma lista de todas as redes de seguros aceitas pelo Google.
|
LocalPosts
Essa API expõe a API de gerenciamento das postagens locais.
CreateLocalPost | |
---|---|
Cria uma nova postagem local associada ao local especificado e a retorna.
|
DeleteLocalPost | |
---|---|
Exclui uma postagem local. Retornará
|
GetLocalPost | |
---|---|
Recebe a postagem local especificada. Retornará
|
ListLocalPosts | |
---|---|
Retorna uma lista de postagens locais associadas a um local.
|
UpdateLocalPost | |
---|---|
Atualiza a postagem local especificada e retorna a postagem atualizada.
|
Locais
Essa API permite gerenciar locais da empresa no Google. Ela permite que você gerencie recursos de Location
. Ele define o seguinte modelo de recurso:
A API tem um conjunto de recursos
Account
, chamadosaccounts/*
Para sua conveniência, é possível usar o sinônimo "eu" em vez do ID da conta pessoal do autor da chamada autenticado. Exemplos: GET /v4/accounts/me GET /v4/accounts/me/locations
Cada
Account
tem um conjunto de recursosLocation
, chamadoaccounts/*/locations/*
AssociateLocation | |
---|---|
Associa um local a um ID de lugar. Qualquer associação anterior será substituída. Esta operação só será válida se o local não for verificado. A associação precisa ser válida, ou seja, ela aparece na lista de
|
BatchGetLocations | |
---|---|
Mostra todos os locais especificados na conta especificada.
|
ClearLocationAssociation | |
---|---|
Limpa uma associação entre um local e seu ID de lugar. Esta operação só será válida se o local não for verificado.
|
CreateLocation | |
---|---|
Cria e retorna um novo
|
DeleteLocation | |
---|---|
Exclui um local. |
FindMatchingLocations | |
---|---|
Encontra todos os locais possíveis que correspondem ao local especificado. Esta operação só será válida se o local não for verificado.
|
GetChain | |
---|---|
Recebe a cadeia especificada. Retorna
|
GetGoogleUpdatedLocation | |
---|---|
Recebe a versão atualizada pelo Google do local especificado. Retorna
|
GetLocation | |
---|---|
Recebe o local especificado. Retorna
|
ListAttributeMetadata | |
---|---|
Retorna a lista de atributos que estariam disponíveis para um local com a categoria principal e o país especificados.
|
ListLocations | |
---|---|
Lista os locais da conta especificada.
|
SearchChains | |
---|---|
Pesquisa a rede com base no nome dela.
|
TransferLocation | |
---|---|
Move um local de uma conta do usuário para outra gerenciada pelo mesmo usuário. O usuário precisa ser proprietário da conta à qual o local está associado no momento e ser pelo menos administrador da conta de destino. Retorna a localização com o novo nome de recurso.
|
UpdateLocation | |
---|---|
Atualiza o local especificado. As fotos só são permitidas em locais que tenham uma Página do Google+. Retorna
|
Mídia
Com esse serviço, é possível gerenciar mídias (fotos e vídeos) vinculadas a um local.
CreateMediaItem | |
---|---|
Cria um novo item de mídia para o local.
|
DeleteMediaItem | |
---|---|
Exclui o item de mídia especificado.
|
GetCustomerMediaItem | |
---|---|
Retorna metadados para o item de mídia do cliente solicitado.
|
GetMediaItem | |
---|---|
Retorna metadados para o item de mídia solicitado.
|
ListCustomerMediaItems | |
---|---|
Retorna uma lista de itens de mídia associados a um local que foram enviados por clientes.
|
ListMediaItems | |
---|---|
Retorna uma lista de itens de mídia associados a um local.
|
StartUploadMediaItemData | |
---|---|
Gera um
|
UpdateMediaItem | |
---|---|
Atualiza metadados do item de mídia especificado. Só pode ser usado para atualizar a categoria de um item de mídia, com a exceção de que a nova categoria não pode ser CAPA ou PERFIL.
|
QuestionsAndAnswers
Esse serviço permite o gerenciamento de perguntas e respostas de um local. As operações de perguntas e respostas são válidas somente para locais verificados.
CreateQuestion | |
---|---|
Adiciona uma pergunta para o local especificado.
|
DeleteAnswer | |
---|---|
Exclui a resposta escrita pelo usuário atual a uma pergunta.
|
DeleteQuestion | |
---|---|
Exclui uma pergunta específica escrita pelo usuário atual.
|
ListAnswers | |
---|---|
Retorna a lista paginada de respostas de uma pergunta especificada.
|
ListQuestions | |
---|---|
Retorna a lista paginada de perguntas e algumas das respostas relacionadas a um local especificado.
|
UpdateQuestion | |
---|---|
Atualiza uma pergunta específica escrita pelo usuário atual.
|
UpsertAnswer | |
---|---|
Cria uma resposta ou atualiza a resposta existente escrita pelo usuário para a pergunta especificada. Um usuário só pode criar uma resposta por pergunta.
|
Avaliações
Essa API fornece operações CRUD para avaliações. google.mybusiness.v4.Reviews
.
BatchGetReviews | |
---|---|
Retorna a lista paginada de avaliações de todos os locais especificados. Esta operação só é válida se os locais especificados forem verificados.
|
DeleteReviewReply | |
---|---|
Exclui a resposta para a avaliação especificada. Esta operação só é válida se o local especificado for verificado.
|
GetReview | |
---|---|
Retorna a avaliação especificada. Esta operação só é válida se o local especificado for verificado. Retornará
|
ListReviews | |
---|---|
Retorna a lista paginada de avaliações do local especificado. Esta operação só é válida se o local especificado for verificado.
|
UpdateReviewReply | |
---|---|
Atualiza a resposta à avaliação especificada. Uma resposta será criada se não existir uma. Esta operação só é válida se o local especificado for verificado.
|
ServiceLists
Essa API permite que as operações recebam e atualizem a lista de serviços de locais da empresa no Google. Uma lista de serviços contém os itens de serviços prestados pelos comerciantes. O serviço pode ser cortar o cabelo, instalar um aquecedor de água etc.
GetServiceList | |
---|---|
Acessa a lista de serviços especificada de um local.
|
UpdateServiceList | |
---|---|
Atualiza a lista de serviço especificada de um local.
|
Verificações
Essa API permite gerenciar verificações de local no Google. Ela permite que você gerencie recursos de Verification
.
Cada Location
tem um conjunto de recursos Verification
, chamado accounts/*/locations/*/verifications/*
.
CompleteVerification | |
---|---|
Conclua uma verificação de Ele só é necessário para métodos de verificação que não sejam
|
FetchVerificationOptions | |
---|---|
Informa todas as opções de verificação qualificadas para um local em um idioma específico.
|
ListVerifications | |
---|---|
Lista as verificações de um local, ordenadas por horário de criação.
|
VerifyLocation | |
---|---|
Inicia o processo de verificação de um local.
|
AcceptInvitationRequest
Mensagem de solicitação para AccessControl.AcceptInvitation.
Campos | |
---|---|
name |
O nome do convite que está sendo aceito. |
Conta
Uma conta é um contêiner para os locais da sua empresa. Se você é o único usuário que gerencia os locais da sua empresa, pode utilizar sua Conta do Google pessoal. Para compartilhar o gerenciamento de locais com vários usuários, crie uma conta do negócio.
Campos | |
---|---|
name |
O nome do recurso, no formato |
account_name |
Nome da conta. |
type |
Apenas saída. Especifica os |
role |
Apenas saída. Especifica o |
state |
Apenas saída. Indica o |
account_number |
Número de referência da conta, se provisionado. |
permission_level |
Apenas saída. Especifica o |
organization_info |
Informações adicionais de uma organização. Só é preenchido para uma conta da organização. |
OrganizationInfo
Informações adicionais armazenadas para uma organização.
Campos | |
---|---|
registered_domain |
O domínio registrado da conta. |
postal_address |
O endereço postal da conta. |
phone_number |
Número de contato da organização. |
AccountRole
Indica o nível de acesso que o usuário autenticado tem nessa conta. Para mais informações, consulte o artigo da Central de Ajuda
Enums | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED |
Não especificado. |
OWNER |
O usuário é o proprietário dessa conta. (Exibida como "Primary Owner" na interface do usuário). |
CO_OWNER |
O usuário é um coproprietário da conta. (exibida como "Proprietário" na interface). |
MANAGER |
O usuário pode gerenciar esta conta. |
COMMUNITY_MANAGER |
O usuário pode gerenciar páginas sociais (Google+) para a conta. É exibido como "Site Manager" na interface. |
AccountState
Indica o status da conta, por exemplo, se ela foi verificada pelo Google.
Campos | |
---|---|
status |
Se forem verificados, os locais futuros criados serão automaticamente conectados ao Google Maps e terão páginas do Google+ criadas sem a necessidade de moderação. |
AccountStatus
Indica o status de verificação da conta.
Enums | |
---|---|
ACCOUNT_STATUS_UNSPECIFIED |
Não especificado. |
VERIFIED |
Conta verificada. |
UNVERIFIED |
Conta que não foi verificada e a verificação não foi solicitada. |
VERIFICATION_REQUESTED |
Conta que não foi verificada, mas a verificação foi solicitada. |
AccountType
Indica o tipo de conta: pessoal/de usuário ou empresarial.
Enums | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED |
Não especificado. |
PERSONAL |
Uma conta de usuário final. |
LOCATION_GROUP |
Um grupo de locais. Para mais informações, consulte o artigo da Central de Ajuda |
USER_GROUP |
Um grupo de usuários para separar os funcionários da organização em grupos. Para mais informações, consulte o artigo da Central de Ajuda |
ORGANIZATION |
Uma organização que representa uma empresa. Para mais informações, consulte o artigo da Central de Ajuda |
AdWordsLocationExtensions
Informações adicionais exibidas no Google AdWords.
Campos | |
---|---|
ad_phone |
Um número de telefone alternativo que será exibido nas extensões de local do Google AdWords em vez do número de telefone principal do local. |
AddressInput
Entrada para verificação de ADDRESS.
Campos | |
---|---|
mailer_contact_name |
Nome do contato para o qual o e-mail será enviado. |
Administrador
Campos | |
---|---|
name |
O nome do recurso. Para administradores de contas, o formato é: Para administradores de locais, o formato é: |
admin_name |
O nome do administrador. Ao fazer o convite inicial, este é o endereço de e-mail do convidado. Em chamadas |
role |
Especifica o |
pending_invitation |
Apenas saída. Indica se esse administrador tem um convite pendente para o recurso especificado. |
AdminRole
Indica o nível de acesso que um administrador tem. Para mais informações, consulte o artigo da Central de Ajuda
Enums | |
---|---|
ADMIN_ROLE_UNSPECIFIED |
Não especificado. |
OWNER |
O administrador tem acesso de proprietário e é o proprietário principal. (Exibida como "Primary Owner" na interface do usuário). |
CO_OWNER |
O administrador tem acesso de proprietário. (exibida como "Proprietário" na interface). |
MANAGER |
O administrador tem acesso de gerenciamento. |
COMMUNITY_MANAGER |
O administrador pode gerenciar páginas sociais (Google+). É exibido como "Site Manager" na interface. |
AlertType
O tipo de evento para o qual a postagem de alerta foi criada.
Enums | |
---|---|
ALERT_TYPE_UNSPECIFIED |
Nenhum alerta especificado. |
COVID_19 |
Alertas relacionados à pandemia do coronavírus de 2019. As postagens sobre a COVID-19 são compatíveis apenas com campos de resumo e call-to-action. Quando esses alertas não forem mais relevantes, a criação de novas postagens de alerta para o tipo COVID-19 será desativada. No entanto, o comerciante ainda poderá gerenciar as postagens existentes sobre a COVID-19. |
Alérgenos
Informações de alergênicos sobre um alimento.
Enums | |
---|---|
ALLERGEN_UNSPECIFIED |
Alérgeno não especificado |
DAIRY |
Alérgenos relacionados a laticínios |
EGG |
Alérgeno relacionado ao ovo |
FISH |
Alérgenos relacionados a peixes |
PEANUT |
Alérgeno relacionado ao amendoim |
SHELLFISH |
Alérgenos relacionados a mariscos |
SOY |
Alérgeno relacionado à soja |
TREE_NUT |
Alérgeno relacionado a castanhas |
WHEAT |
Alérgeno relacionado ao trigo |
Resposta
Representa uma resposta a uma pergunta
Campos | |
---|---|
name |
Apenas saída. O nome exclusivo das respostas accounts/*/locations/*/questions/*/answers/* |
author |
Apenas saída. É o autor da resposta. |
upvote_count |
Apenas saída. O número de votos positivos na resposta. |
text |
O texto da resposta. Ele precisa conter pelo menos um caractere que não seja um espaço. O tamanho máximo é de 4.096 caracteres. |
create_time |
Apenas saída. A marcação de tempo de quando a resposta foi escrita. |
update_time |
Apenas saída. O carimbo de data/hora da última modificação da resposta. |
AssociateLocationRequest
Mensagem de solicitação para Locations.AssociateLocationRequest.
Campos | |
---|---|
name |
O nome do recurso do local a ser associado. |
place_id |
A associação a ser estabelecida. Se não for definido, indica que não há correspondência. |
Atributo
Um atributo de local. Os atributos fornecem informações adicionais sobre um local. Os atributos que podem ser definidos em um local podem variar de acordo com as propriedades dele (por exemplo, categoria). Os atributos disponíveis são determinados pelo Google e podem ser adicionados e removidos sem mudanças na API.
Campos | |
---|---|
attribute_id |
ID do atributo. Os IDs dos atributos são fornecidos pelo Google. |
value_type |
Apenas saída. O tipo de valor que este atributo contém. É usado para determinar como interpretar o valor. |
values[] |
Os valores para este atributo. O tipo dos valores fornecidos precisa corresponder ao esperado para esse atributo. Consulte AttributeValueType. Esse é um campo repetido em que vários valores de atributo podem ser fornecidos. Os tipos de atributo aceitam apenas um valor. |
repeated_enum_value |
Quando o tipo de valor do atributo é REPEATED_ENUM, ele contém o valor do atributo, e os outros campos de valores precisam estar vazios. |
url_values[] |
Quando o tipo de valor do atributo é URL, esse campo contém os valores desse atributo, e os outros campos de valores precisam estar vazios. |
AttributeMetadata
Metadados para um atributo. Contém informações de exibição do atributo, incluindo um nome localizado e um título para agrupar atributos relacionados.
Campos | |
---|---|
attribute_id |
ID do atributo. |
value_type |
O tipo de valor do atributo. Espera-se que os valores definidos e recuperados sejam desse tipo. |
display_name |
O nome de exibição localizado para o atributo, se disponível. Caso contrário, o nome de exibição em inglês. |
group_display_name |
O nome de exibição localizado do grupo que contém esse atributo, se disponível. Caso contrário, o nome do grupo em inglês. Os atributos relacionados são reunidos em um grupo e devem ser exibidos juntos sob o título fornecido aqui. |
is_repeatable |
Se verdadeiro, o atributo aceita vários valores. Se for falso, forneça apenas um valor. |
value_metadata[] |
Para alguns tipos de atributos, como tipos enumerados, é fornecida uma lista de valores compatíveis e os nomes de exibição correspondentes. |
is_deprecated |
Se for verdadeiro, o atributo será descontinuado e não poderá mais ser usado. Se o uso for suspenso, a atualização desse atributo não vai resultar em erro, mas as atualizações não serão salvas. Em algum momento após ser descontinuado, o atributo será totalmente removido e se tornará um erro. |
AttributeValueMetadata
Metadados para valores de atributo compatíveis.
Campos | |
---|---|
value |
O valor do atributo. |
display_name |
O nome de exibição desse valor, localizado quando disponível. Caso contrário, será em inglês. O nome de exibição do valor precisa ser usado no contexto com o nome de exibição do atributo. Por exemplo, para um atributo de tipo enumerado "Wi-Fi", poderia conter "Pago" para representar uma rede Wi-Fi paga. |
AttributeValueType
O tipo de valor do atributo.
Enums | |
---|---|
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED |
Não especificado. |
BOOL |
Os valores desse atributo são booleanos. |
ENUM |
O atributo tem uma lista predeterminada de valores disponíveis que podem ser usados. Os metadados desse atributo listam esses valores. |
URL |
Os valores desse atributo são URLs. |
REPEATED_ENUM |
O valor do atributo é uma enumeração com diversos valores possíveis que podem ser definidos ou não definidos explicitamente. |
Criação
Representa o autor de uma pergunta ou resposta
Campos | |
---|---|
display_name |
O nome de exibição do usuário |
profile_photo_url |
URL da foto de perfil do usuário. |
type |
O tipo de usuário que o autor é. |
AuthorType
Enumeração do tipo de usuário que o autor é.
Enums | |
---|---|
AUTHOR_TYPE_UNSPECIFIED |
Não deve ser usado. |
REGULAR_USER |
Um usuário comum. |
LOCAL_GUIDE |
Um Local Guide |
MERCHANT |
O proprietário/gerente do local |
BasicMetricsRequest
Uma solicitação de insights de métricas básicas.
Campos | |
---|---|
metric_requests[] |
Uma coleção de métricas para retornar valores para a inclusão das opções de como os dados devem ser retornados. |
time_range |
O intervalo para o qual coletar métricas. O período máximo é de 18 meses a partir da data da solicitação. Em alguns casos, os dados ainda podem estar ausentes por dias próximos à data da solicitação. Os dados ausentes serão especificados no |
BatchGetBusinessCategoriesRequest
Mensagem de solicitação para BusinessCategories.BatchGetBusinessCategories.
Campos | |
---|---|
language_code |
Obrigatório. O código de idioma BCP 47 em que os nomes das categorias precisam ser retornados. |
category_ids[] |
Obrigatório. É necessário definir pelo menos um nome. Os IDs do GConcept para os quais os nomes de categorias localizados precisam ser retornados. |
region_code |
Opcional. O código do país ISO 3166-1 alfa-2 usado para inferir um idioma não padrão. |
view |
Obrigatório. Especifica quais partes do recurso Categoria precisam ser retornadas na resposta. |
BatchGetBusinessCategoriesResponse
Mensagem de resposta para BusinessCategories.BatchGetBusinessCategories.
Campos | |
---|---|
categories[] |
Categorias que correspondem aos IDs do GConcept fornecidos na solicitação. Eles não virão na mesma ordem que os IDs de categoria na solicitação. |
BatchGetLocationsRequest
A mensagem de solicitação para Locations.BatchGetLocations.
Campos | |
---|---|
name |
O nome da conta em que os locais serão buscados. |
location_names[] |
Uma coleção de locais a serem buscados, especificados pelos nomes. |
BatchGetLocationsResponse
Mensagem de resposta para Locations.BatchGetLocations.
Campos | |
---|---|
locations[] |
Uma coleção de locais. |
BatchGetReviewsRequest
Mensagem de solicitação para Reviews.BatchGetReviews.
Campos | |
---|---|
name |
O nome da conta da qual recuperar uma lista de avaliações em vários locais. |
location_names[] |
Uma coleção de locais para as quais buscar avaliações, especificados pelos nomes. |
page_size |
Quantas avaliações precisam ser buscadas por página. O valor padrão é 50. |
page_token |
Se especificado, ele busca a próxima página de avaliações. |
order_by |
Opcional. Especifica o campo pelo qual as avaliações serão classificadas. Se não for especificada, a ordem das avaliações retornadas será |
ignore_rating_only_reviews |
Define se as avaliações somente com classificação serão ignoradas. |
BatchGetReviewsResponse
Mensagem de resposta para Reviews.BatchGetReviews.
Campos | |
---|---|
location_reviews[] |
Avaliações com informações de local. |
next_page_token |
Se o número de avaliações exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de avaliações em chamadas subsequentes. Se não houver mais avaliações, este campo não estará presente na resposta. |
BusinessHours
Representa os períodos em que este local está aberto para negócios. Mantém uma coleção de instâncias TimePeriod
.
Campos | |
---|---|
periods[] |
Um conjunto de horários em que o local está aberto para negócios. Cada período representa um intervalo de horas em que o local fica aberto durante a semana. |
CallToAction
Ação realizada quando o usuário clica na postagem
Campos | |
---|---|
action_type |
O tipo de ação que será realizada. |
url |
URL para o qual o usuário será direcionado após clicar. Esse campo deve ser deixado sem definição para a CTA de chamada. |
ActionType
O tipo de ação que será realizada.
Enums | |
---|---|
ACTION_TYPE_UNSPECIFIED |
Tipo não especificado. |
BOOK |
Esta postagem pede que um usuário reserve um horário/mesa/etc. |
ORDER |
Esta postagem pede que um usuário peça algo. |
SHOP |
Esta postagem pede que um usuário navegue em um catálogo de produtos. |
LEARN_MORE |
Esta postagem quer que um usuário saiba mais (no site dele). |
SIGN_UP |
Esta postagem pede que um usuário se registre, se inscreva ou participe. |
GET_OFFER |
Obsoleto. Use |
CALL |
Esta postagem pede que um usuário ligue para a empresa. |
Categoria
Uma categoria que descreve a empresa (não o que ela faz). Para ver uma lista de IDs de categoria válidos e os mapeamentos para os nomes legíveis por humanos, consulte categories.list.
Campos | |
---|---|
display_name |
. O nome legível da categoria. É definido durante a leitura do local. Ao modificar o local, Observação: este campo é usado somente em respostas. Qualquer valor especificado aqui em uma solicitação é ignorado. |
category_id |
. Um ID estável (fornecido pelo Google) para essa categoria. O Observação: este campo é usado somente em respostas. Qualquer valor especificado aqui em uma solicitação é ignorado. |
service_types[] |
. Uma lista de todos os tipos de serviço disponíveis para esta categoria de negócios. Observação: este campo é usado somente em respostas. Qualquer valor especificado aqui em uma solicitação é ignorado. |
more_hours_types[] |
Apenas saída. Mais tipos de horário de funcionamento disponíveis para esta categoria de negócios. |
CategoryView
Uma enumeração para ajudar a limitar a quantidade de dados retornados pelo servidor.
Enums | |
---|---|
CATEGORY_VIEW_UNSPECIFIED |
Não especificado, equivalente a CATEGORY_METADATA_SOMENTE. |
BASIC |
A resposta do servidor incluirá apenas os campos de categoria display_name, Category_id e language_code. Ele omite todos os campos relacionados a metadados do tipo de serviço. |
FULL |
Retorna todos os campos na resposta. |
Cadeia
Uma rede é uma marca à qual os locais da sua empresa podem estar afiliados.
Campos | |
---|---|
name |
O nome do recurso da cadeia, no formato |
chain_names[] |
São os nomes da rede. |
websites[] |
Sites da rede. |
location_count |
Número de locais que fazem parte dessa rede. |
ChainName
Nome a ser usado ao mostrar a cadeia.
Campos | |
---|---|
display_name |
O nome de exibição da cadeia. |
language_code |
O código de idioma BCP 47 do nome. |
ChainUrl
URL a ser usado ao mostrar a cadeia.
Campos | |
---|---|
url |
O URL desta cadeia. |
ClearLocationAssociationRequest
Mensagem de solicitação para Locations.ClearLocationAssociationRequest.
Campos | |
---|---|
name |
O nome do recurso do local a ser desassociado. |
CompleteVerificationRequest
Mensagem de solicitação para Verifications.CompleteVerificationAction.
Campos | |
---|---|
name |
Nome do recurso da verificação a ser concluída. |
pin |
Código PIN recebido pelo comerciante para concluir a verificação. |
CompleteVerificationResponse
Mensagem de resposta para Verifications.CompleteVerificationAction.
Campos | |
---|---|
verification |
A verificação foi concluída. |
CreateAccountAdminRequest
Mensagem de solicitação para AccessControl.CreateAccountAdmin.
Campos | |
---|---|
parent |
O nome do recurso da conta para que este administrador foi criado. |
admin |
O administrador a ser criado |
CreateAccountRequest
Mensagem de solicitação para accounts.CreateAccount.
Campos | |
---|---|
primary_owner |
O nome do recurso da conta que será a proprietária principal da conta que está sendo criada. Ele precisa estar no formato |
account |
Informações da conta que será criada. Os únicos campos permitidos são account_name e type. |
CreateLocalPostRequest
Mensagem de solicitação para CreateLocalPost.
Campos | |
---|---|
parent |
O nome do local em que a postagem local será criada. |
local_post |
Os novos metadados da postagem local. |
CreateLocationAdminRequest
Mensagem de solicitação para AccessControl.CreateLocationAdmin.
Campos | |
---|---|
parent |
O nome do recurso do local para o qual este administrador é criado. |
admin |
O administrador a ser criado |
CreateLocationRequest
A mensagem de solicitação para Locations.CreateLocation.
Campos | |
---|---|
parent |
O nome da conta em que o local será criado. |
location |
Os novos metadados de local. |
validate_only |
Se for verdadeiro, a solicitação será validada sem criar o local. |
request_id |
Um ID de solicitação exclusivo para o servidor detectar solicitações duplicadas. Recomendamos o uso de UUIDs. O comprimento máximo é de 50 caracteres. |
CreateMediaItemRequest
Mensagem de solicitação para Media.CreateMediaItem.
Campos | |
---|---|
parent |
O nome do recurso do local em que esse item de mídia será criado. |
media_item |
O item de mídia a ser criado. |
CreateQuestionRequest
Mensagem de solicitação para QuestionsAndAnswers.CreateQuestion
Campos | |
---|---|
parent |
O nome do local para o qual uma pergunta será escrita. |
question |
A nova pergunta. |
DeclineInvitationRequest
Mensagem de solicitação para AccessControl.RecusarInvitation.
Campos | |
---|---|
name |
O nome do convite da conta que está sendo recusado. |
DeleteAccountAdminRequest
Mensagem de solicitação para AccessControl.DeleteAccountAdmin.
Campos | |
---|---|
name |
O nome do recurso do administrador a ser removido da conta. |
DeleteAnswerRequest
Mensagem de solicitação para QuestionsAndAnswers.DeleteAnswer
Campos | |
---|---|
parent |
O nome da pergunta para a qual excluir uma resposta. |
DeleteLocalPostRequest
Mensagem de solicitação para DeleteLocalPost.
Campos | |
---|---|
name |
O nome da postagem local a ser excluída. |
DeleteLocationAdminRequest
Mensagem de solicitação para AccessControl.DeleteLocationAdmin.
Campos | |
---|---|
name |
O nome do recurso do administrador a ser removido do local. |
DeleteLocationRequest
A mensagem de solicitação para Locations.DeleteLocation.
Campos | |
---|---|
name |
O nome do local a ser excluído. |
DeleteMediaItemRequest
Mensagem de solicitação para Media.DeleteMediaItem.
Campos | |
---|---|
name |
Nome do item de mídia a ser excluído. |
DeleteNotificationsRequest
Mensagem de solicitação para "Accounts.DeleteNotifications".
Campos | |
---|---|
name |
O nome do recurso para as configurações de notificação que serão limpas. |
DeleteQuestionRequest
Mensagem de solicitação para QuestionsAndAnswers.DeleteQuestion
Campos | |
---|---|
name |
O nome da pergunta a ser excluída. |
DeleteReviewReplyRequest
Mensagem de solicitação para Reviews.DeleteReviewReply.
Campos | |
---|---|
name |
O nome da resposta da avaliação a ser excluída. |
DietaryRestriction
Informações alimentares de um alimento.
Enums | |
---|---|
DIETARY_RESTRICTION_UNSPECIFIED |
Tipo de dieta não especificado |
HALAL |
Denoção da comida como prato halal. |
KOSHER |
Denoção da comida como um prato kosher. |
ORGANIC |
Denoção do alimento como um prato orgânico. |
VEGAN |
Denoção da comida como um prato vegano. |
VEGETARIAN |
Denoção da comida como um prato vegetariano. |
DimensionalMetricValue
Um valor para uma única métrica com uma determinada dimensão de tempo.
Campos | |
---|---|
metric_option |
A opção que solicitou este valor dimensional. |
time_dimension |
Dimensão do valor. |
value |
O valor. Se nenhum valor for definido, faltam os dados solicitados. |
TimeDimension
Dimensão em que os dados são divididos.
Campos | |
---|---|
day_of_week |
O dia da semana ("MONDAY" a "SUNDAY") a que este valor corresponde. Definido para a opção BREAKDOWN_DAY_OF_WEEK. |
time_of_day |
A hora do dia (0 a 23) a que este valor corresponde. Definido para a opção BREAKDOWN_HOUR_OF_DAY. |
time_range |
O intervalo de tempo que esse valor abrange. Definido para as opções AGGREGATED_TOTAL e AGGREGATED_DAILY. |
DrivingDirectionMetricsRequest
Uma solicitação de insights sobre rotas de carro.
Campos | |
---|---|
num_days |
O número de dias para os quais os dados serão agregados. Os resultados retornados serão dados disponíveis sobre o último número de dias solicitados. Os valores válidos são 7, 30 e 90. |
language_code |
O código BCP 47 do idioma. Se um código de idioma não for fornecido, o padrão será o inglês. |
NumDays
Número de dias que esta solicitação pode aceitar.
Enums | |
---|---|
SEVEN |
7 dias. Esse é o valor padrão. |
THIRTY |
30 dias. |
NINETY |
90 dias. |
EmailInput
Entrada para verificação de EMAIL.
Campos | |
---|---|
email_address |
Endereço de e-mail para envio do PIN. Um endereço de e-mail só será aceito se for um dos endereços fornecidos por FetchVerificationOptions. Se o parâmetro |
ErrorDetail
Detalha um erro que resultou em uma falha interna ou de validação.
Campos | |
---|---|
code |
O código de status, que precisa ser um valor de enumeração de |
field |
Um caminho que leva a um campo no corpo da solicitação. O valor é uma sequência de identificadores separados por ponto que identificam um campo de buffer de protocolo. Por exemplo, "error_details.field" identificaria esse campo. |
message |
Uma descrição do motivo da falha do campo. A mensagem está em inglês e pode não ser adequada para exibição aos usuários. |
value |
O valor com falha na solicitação. |
field_index |
Se o campo de solicitação que gerou esse erro for repetido, ele conterá o índice baseado em zero da entrada nesse campo que causou a falha da validação. |
ErrorCode
Códigos de erro para ErrorDetail
:
- 1 a 199: códigos de erro comuns que se aplicam a todos os campos.
- 1.000 a 1.099: códigos de erro relacionados a fotos.
- 1100 a 1199: códigos de erro relacionados a endereço e latitude/longitude.
- 1200 a 1299: códigos de erro relacionados à categoria.
- 1300 a 1399: códigos de erros relacionados à operação.
Enums | |
---|---|
ERROR_CODE_UNSPECIFIED |
Código do erro "pega-tudo". |
MISSING_VALUE |
Um valor obrigatório não foi fornecido. |
INVALID_VALUE |
Foi fornecido um valor inválido. |
INVALID_CHARACTERS |
Foram encontrados caracteres inválidos. |
TOO_MANY_ITEMS |
Um campo repetido excedeu o número máximo de itens fornecido. |
READ_ONLY |
O campo somente leitura não pode ser modificado. |
OVERLAPPING_RANGES |
Os itens em um campo repetido são intervalos que se sobrepõem. |
INVERTED_RANGE |
O intervalo fornecido é invertido. Isso também inclui o caso de um intervalo vazio. |
VALUE_OUTSIDE_ALLOWED_RANGE |
O valor fornecido está fora do intervalo permitido. |
MISSING_DEPENDENT_FIELD |
O campo dependente obrigatório não existe. |
FIELD_HAS_DEPENDENCIES |
Campo obrigatório pelo campo dependente e não pode ser removido. |
UNSUPPORTED_VALUE |
O valor fornecido, embora possivelmente válido, não é aceito devido a outras restrições. |
EXPIRED_VALUE |
O valor informado expirou e não é mais válido. |
PHOTO_FETCH_FAILED |
Falha ao buscar a foto do URL especificado. |
PHOTO_UPLOAD_FAILED |
Falha ao fazer upload da foto do URL especificado. |
GEOCODE_ERROR |
Ocorreu um erro ao determinar automaticamente a latitude/longitude. |
LAT_LNG_OUTSIDE_COUNTRY |
A latitude/longitude fornecida não está no país informado. |
LAT_LNG_REQUIRED |
É preciso fornecer a latitude e a longitude. |
LAT_LNG_TOO_FAR_FROM_ADDRESS |
O par de latitude/longitude e endereço estão muito distantes. |
CATEGORY_NOT_VERIFIED |
A categoria informada não foi verificada. |
OPERATION_EXECUTION_ERROR |
Erro de execução de operação genérico. |
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION |
A operação não é suportada devido à condição da conta. |
LOCATION_DISABLED_FOR_LOCAL_POST_API |
Local desativado para a API Local Post. |
FetchVerificationOptionsRequest
Mensagem de solicitação para Verifications.FetchVerificationOptions.
Campos | |
---|---|
name |
Nome de recurso do local a ser verificado. |
language_code |
O código BCP 47 que representa o idioma a ser usado no processo de verificação. As opções disponíveis variam de acordo com o idioma. |
context |
Informações de contexto extra para a verificação de empresas de serviços. Obrigatório para os locais cujo tipo de empresa é CUSTOMER_LOCATION_SOMENTE. INVALID_ ARGUMENT será gerado se estiver definido para outros tipos de empresa de local. |
FetchVerificationOptionsResponse
Mensagem de resposta para Verifications.FetchVerificationOptions.
Campos | |
---|---|
options[] |
As opções de verificação disponíveis. |
FindMatchingLocationsRequest
Mensagem de solicitação para Locations.FindMatchingLocations.
Campos | |
---|---|
name |
O nome do recurso do local para o qual encontrar correspondências. |
language_code |
O idioma preferido do local correspondente (no formato BCP-47). |
num_results |
O número de correspondências a serem retornadas. O valor padrão é 3, com um máximo de 10. A latência pode aumentar se forem solicitadas mais. Não há paginação. |
max_cache_duration |
Obsoleto. Este campo é ignorado para todas as solicitações. |
FindMatchingLocationsResponse
Mensagem de resposta para Locations.FindMatchingLocations.
Campos | |
---|---|
matched_locations[] |
Um conjunto de locais que são possíveis correspondências com o local especificado, listados em ordem decrescente. Se houver uma correspondência exata, ela vai estar na primeira posição. |
match_time |
Quando o algoritmo correspondente foi executado pela última vez para esse local. |
FollowersMetadata
Metadados do seguidor de um local.
Campos | |
---|---|
name |
O nome do recurso para isto. accounts/{account_id}/locations/{location_id}/followers/metadata |
count |
Número total de seguidores do local. |
FoodMenu
Cardápio de uma empresa que serve pratos de comida.
Campos | |
---|---|
labels[] |
Obrigatório. Etiquetas com tags de idioma para o menu. Por exemplo, "menu", "almoço especial". Os nomes de exibição precisam ter até 140 caracteres e as descrições até mil. É necessário pelo menos um conjunto de rótulos. |
source_url |
Opcional. URL da origem do menu, se houver uma página da Web para acessar. |
sections[] |
Obrigatório. Seções do menu. |
cuisines[] |
Opcional. Informações de culinária para o cardápio. É altamente recomendável preencher esse campo. |
Culinária
Informações culinárias de um restaurante.
Enums | |
---|---|
CUISINE_UNSPECIFIED |
Culinária não especificada |
AMERICAN |
Culinária norte-americana |
ASIAN |
culinária asiática |
BRAZILIAN |
comida brasileira |
BREAK_FAST |
Café da manhã |
BRUNCH |
Brunch |
CHICKEN |
Galinha |
CHINESE |
Culinária chinesa |
FAMILY |
Culinária familiar |
FAST_FOOD |
Fast-food |
FRENCH |
Culinária francesa |
GREEK |
culinária grega |
GERMAN |
culinária alemã |
HAMBURGER |
Hambúrguer |
INDIAN |
Culinária indiana |
INDONESIAN |
culinária indonésia |
ITALIAN |
Culinária italiana |
JAPANESE |
Culinária japonesa |
KOREAN |
Culinária coreana |
LATIN_AMERICAN |
Culinária latino-americana |
MEDITERRANEAN |
culinária mediterrânea |
MEXICAN |
Culinária mexicana |
PAKISTANI |
culinária paquistanesa |
PIZZA |
Pizza |
SEAFOOD |
Frutos do mar |
SPANISH |
culinária espanhola |
SUSHI |
Sushi |
THAI |
culinária tailandesa |
TURKISH |
culinária turca |
VEGETARIAN |
Comida vegetariana |
VIETNAMESE |
culinária vietnamita |
OTHER_CUISINE |
Outros tipos de culinária |
FoodMenuItem
Item de uma seção. Pode ser o próprio prato ou pode conter vários FoodMenuItemOption.
Campos | |
---|---|
labels[] |
Obrigatório. Marcadores de idioma marcados para este item de menu. Os nomes de exibição precisam ter até 140 caracteres e as descrições até mil. É necessário pelo menos um conjunto de rótulos. |
attributes |
Obrigatório. Atributos detalhados do item. Quando as opções do item são especificadas, eles são considerados como atributos base e são preenchidos para cada opção. |
options[] |
Opcional. Isso se refere a um item oferecido em várias opções diferentes, e os usuários precisam fazer escolhas. Por exemplo, pizza "normal" x "grande". Quando as opções são especificadas, os rótulos e os atributos no nível do item se tornam automaticamente os rótulos e atributos da primeira opção. Os clientes só precisam especificar outras opções de alimentação neste campo. |
FoodMenuItemAttributes
Atributos de um prato/item de comida.
Campos | |
---|---|
price |
Obrigatório. Preço do prato. |
spiciness |
Opcional. Nível de picante do prato. |
allergen[] |
Opcional. Alérgenos associados ao prato. É altamente recomendável preencher esse campo. |
dietary_restriction[] |
Opcional. Informações alimentares do prato. É altamente recomendável preencher esse campo. |
nutrition_facts |
Opcional. Informações nutricionais da opção de prato. É altamente recomendável preencher esse campo. |
ingredients[] |
Opcional. Ingredientes da opção de prato. |
serves_num_people |
Opcional. Este prato oferece quantas pessoas podem ser servidas. |
preparation_methods[] |
Opcional. Métodos sobre como a opção de prato é preparada. |
portion_size |
Opcional. Tamanho do pedido, representado em unidades de itens. (por exemplo, quatro "espetinhos", seis "pedaços") |
media_keys[] |
Opcional. As teclas de mídia da mídia associada ao prato. Somente mídias com foto são compatíveis. Quando há várias fotos associadas, a primeira é considerada a foto preferida. |
Ingredientes
Esta mensagem indica as informações dos ingredientes de um prato.
Campos | |
---|---|
labels[] |
Obrigatório. Rótulos para descrever o ingrediente. Os nomes de exibição precisam ter até 140 caracteres e as descrições até mil. É necessário pelo menos um conjunto de rótulos. |
PortionSize
Tamanho da porção de um prato.
Campos | |
---|---|
quantity |
Obrigatório. Número da parte. |
unit[] |
Obrigatório. O campo name_info repetido é para a unidade em vários idiomas. |
FoodMenuItemOption
Opção de um item. Requer uma seleção explícita do usuário.
Campos | |
---|---|
labels[] |
Obrigatório. Rótulos com tags de idioma para essa opção de menu. E.g.: "beef pad thai", "veggie pad thai", "pizza pequena", "pizza grande". Os nomes de exibição precisam ter até 140 caracteres e as descrições até mil. É necessário pelo menos um conjunto de rótulos. |
attributes |
Obrigatório. Atributos detalhados da opção do item. Atributos individuais não especificados serão herdados dos atributos no nível do item como base. |
FoodMenuSection
Seção de um menu. Pode conter vários itens/pratos.
Campos | |
---|---|
labels[] |
Obrigatório. Marcadores de idioma com tag para esta seção de menu. Os nomes de exibição precisam ter até 140 caracteres e as descrições até mil. É necessário pelo menos um conjunto de rótulos. |
items[] |
Obrigatório. Itens da seção. Cada seção precisa ter pelo menos um item. |
FoodMenus
Menus de uma empresa que serve pratos.
Campos | |
---|---|
name |
Obrigatório. Identificador do Google para este local no formato: |
menus[] |
Opcional. Uma coleção de cardápios de comida. |
GenerateAccountNumberRequest
Mensagem de solicitação para accounts.GenerateAccountNumber.
Campos | |
---|---|
name |
O nome da conta para a qual gerar um número de conta. |
GetAccountRequest
Mensagem de solicitação para accounts.GetAccount.
Campos | |
---|---|
name |
O nome da conta a ser buscada. |
GetChainRequest
A mensagem de solicitação para Locations.GetChain.
Campos | |
---|---|
name |
O nome do recurso da cadeia, no formato |
GetCustomerMediaItemRequest
Mensagem de solicitação para Media.GetCustomerMediaItem.
Campos | |
---|---|
name |
O nome do recurso do item de mídia do cliente solicitado. |
GetFollowersMetadataRequest
Mensagem de solicitação para acessar os metadados dos seguidores de um local.
Campos | |
---|---|
name |
O nome do recurso dos metadados dos seguidores do local. accounts/{account_id}/locations/{location_id}/followers/metadata |
GetFoodMenusRequest
Solicitar mensagem para FoodMenu.GetFoodMenus
Campos | |
---|---|
name |
Obrigatório. Identificador do Google para este local no formato: |
read_mask |
Opcional. Os campos específicos a serem retornados. Se nenhuma máscara for especificada, ela retornará o FoodMenu completo (igual a "*"). Não é possível especificar individualmente os itens de campos repetidos. Por exemplo: "nome" e "menus" são máscaras válidas, enquanto "menus.sections" é inválido. |
GetHealthProviderAttributesRequest
Mensagem de solicitação para HealthProviderAttributes.GetHealthProviderAttributes.
Campos | |
---|---|
name |
Obrigatório. O identificador do Google desse local no formato: accounts/{account_id}/locations/{location_id}/healthProviderAttributes |
language_code |
Opcional. O código BCP 47 do idioma. Se um código de idioma não for fornecido, o padrão será o inglês. No momento, apenas "en" é compatível. |
GetLocalPostRequest
Mensagem de solicitação para LocalPosts.GetLocalPost.
Campos | |
---|---|
name |
O nome da postagem local a ser buscada. |
GetLocationRequest
Mensagem de solicitação para Locations.GetLocation.
Campos | |
---|---|
name |
O nome do local a ser buscado. |
GetMediaItemRequest
Mensagem de solicitação para Media.GetMediaItem.
Campos | |
---|---|
name |
O nome do item de mídia solicitado. |
GetNotificationsRequest
Mensagem de solicitação para accounts.GetNotifications.
Campos | |
---|---|
name |
Nome do recurso de configurações de notificação. |
GetReviewRequest
Mensagem de solicitação para Reviews.GetReview.
Campos | |
---|---|
name |
Nome da avaliação a ser buscada. |
GetServiceListRequest
Receber mensagem da solicitação da lista de serviços.
Campos | |
---|---|
name |
Obrigatório. Identificador do Google para este local no formato: |
GoogleLocation
Representa um Location
presente no Google. Esse local pode ser reivindicado pelo usuário, por outra pessoa ou pode não ter sido reivindicado.
Campos | |
---|---|
name |
Nome do recurso desse GoogleLocation, no formato |
location |
As informações de |
request_admin_rights_url |
Um URL que redireciona o usuário para a interface de solicitação de direitos de administrador. Esse campo só estará presente se o local já tiver sido reivindicado por algum usuário, incluindo o usuário atual. |
GoogleUpdatedLocation
Representa um local que foi modificado pelo Google.
Campos | |
---|---|
location |
A versão atualizada do Google deste local. |
diff_mask |
Os campos que o Google atualizou. |
HealthProviderAttributes
Os atributos do provedor de saúde vinculados a este local.
Campos | |
---|---|
name |
Obrigatório. Identificador do Google para este local no formato: |
insurance_networks[] |
Opcional. Uma lista de redes de seguros aceitas por este local. |
InsuranceNetwork
Uma única rede de seguros. Próximo ID: 5
Campos | |
---|---|
network_id |
Obrigatório. O ID desta rede de seguros gerada pelo Google. |
network_names |
Apenas saída. Um mapa dos nomes de exibição da rede nos idiomas solicitados em que o idioma é a chave e o nome de exibição localizado é o valor. O nome de exibição em inglês é definido por padrão. |
payer_names |
Apenas saída. Um mapa dos nomes de exibição do pagador nos idiomas solicitados em que o idioma é a chave e o nome de exibição localizado é o valor. O nome de exibição em inglês é definido por padrão. |
state |
Apenas saída. O estado desta rede de seguros. |
InternalError
Descreve falhas internas.
Campos | |
---|---|
error_details[] |
Detalha falhas individuais. |
Convite
Apenas saída. Representa um convite pendente.
Campos | ||
---|---|---|
name |
O nome do recurso para o convite. |
|
role |
A função de convidado na conta. |
|
Campo de união target . Indica o público-alvo deste convite. target pode ser apenas de um dos tipos a seguir: |
||
target_account |
A conta pouco preenchida a que este convite se destina. |
|
target_location |
O local de destino do convite. |
TargetLocation
Representa um local de destino para um convite pendente.
Campos | |
---|---|
location_name |
O nome do local para o qual o usuário é convidado. |
location_address |
O endereço do local para o qual o usuário foi convidado. |
ListAccountAdminsRequest
Mensagem de solicitação para AccessControl.ListAccountAdmins.
Campos | |
---|---|
parent |
O nome da conta da qual recuperar uma lista de administradores. |
ListAccountAdminsResponse
Mensagem de resposta para AccessControl.ListAccountAdmins.
Campos | |
---|---|
admins[] |
Um conjunto de instâncias |
ListAccountsRequest
A mensagem de solicitação para accounts.ListAccounts.
Campos | |
---|---|
page_size |
Quantas contas precisam ser buscadas por página. O padrão é 20, o mínimo é 2, e o tamanho máximo da página é 20. |
page_token |
Se especificado, a próxima página de contas é recuperada. O |
name |
O nome do recurso da conta para que a lista de contas acessíveis diretamente será recuperada. Isso é válido apenas para organizações e grupos de usuários. Se estiver vazio, retornará |
filter |
Um filtro que restringe as contas a retornar. A resposta inclui apenas entradas que correspondem ao filtro. Se Por exemplo, uma solicitação com o filtro |
ListAccountsResponse
Mensagem de resposta para accounts.ListAccounts.
Campos | |
---|---|
accounts[] |
Um conjunto de contas às quais o usuário tem acesso. A conta pessoal do usuário que fez a consulta será sempre o primeiro item do resultado, a menos que seja filtrado. |
next_page_token |
Se o número de contas exceder o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de contas em uma chamada subsequente para |
ListAnswersRequest
Mensagem de solicitação para QuestionsAndAnswers.ListAnswers
Campos | |
---|---|
parent |
O nome da pergunta para a qual as respostas serão buscadas. |
page_size |
Quantas respostas precisam ser buscadas por página. O valor padrão e máximo de |
page_token |
Se especificado, a próxima página de respostas é recuperada. |
order_by |
O pedido para retornar as respostas. As opções válidas incluem "update_time desc" e "upvote_count desc", que retornará as respostas classificadas em ordem decrescente pelo campo solicitado. A ordem de classificação padrão é 'update_time desc'. |
ListAnswersResponse
Mensagem de resposta para QuestionsAndAnswers.ListAnswers
Campos | |
---|---|
answers[] |
As respostas solicitadas. |
total_size |
O número total de respostas postadas para esta pergunta em todas as páginas. |
next_page_token |
Se o número de respostas exceder o tamanho máximo de página solicitado, esse campo será preenchido com um token para buscar a próxima página de respostas em uma chamada subsequente. Se não houver mais respostas, este campo não estará presente na resposta. |
ListAttributeMetadataRequest
Mensagem de solicitação para Location.ListAttributeMetadata. Se o nome do recurso de local for informado, ele vai ser usado para preencher o restante dos critérios. Se não estiver presente, a categoria e o país devem ser fornecidos.
Campos | |
---|---|
name |
Nome do recurso do local para procurar os atributos disponíveis. |
category_id |
O ID estável da categoria principal para encontrar os atributos disponíveis. |
country |
O código de país ISO 3166-1 alfa-2 para encontrar os atributos disponíveis. |
language_code |
O código de idioma BCP 47 para receber nomes de exibição de atributos. Se esse idioma não estiver disponível, eles serão fornecidos em inglês. |
page_size |
Quantos atributos serão incluídos por página. O padrão é 200, e o mínimo é 1. |
page_token |
Se especificado, a próxima página de metadados do atributo é recuperada. O |
ListAttributeMetadataResponse
Mensagem de resposta para Locations.ListAttributeMetadata.
Campos | |
---|---|
attributes[] |
Uma coleção de metadados de atributos para os atributos disponíveis. |
next_page_token |
Se o número de atributos exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de atributos em uma chamada subsequente para |
ListBusinessCategoriesRequest
Campos | |
---|---|
region_code |
O código de país ISO 3166-1 alfa-2. |
language_code |
O código de idioma BCP 47. Se o idioma não estiver disponível, o padrão será o inglês. |
search_term |
String de filtro opcional do usuário. |
page_size |
Quantas categorias precisam ser buscadas por página. O padrão é 100, o mínimo é 1, e o tamanho máximo da página é 100. |
page_token |
Se especificado, a próxima página de categorias será buscada. |
view |
Opcional. Especifica quais partes do recurso Categoria precisam ser retornadas na resposta. |
ListBusinessCategoriesResponse
Campos | |
---|---|
categories[] |
As categorias. As categorias são a visualização BÁSICA. Eles não contêm informações de ServiceType. |
total_category_count |
O número total de categorias dos parâmetros de solicitação. |
next_page_token |
Se o número de categorias exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de categorias em uma chamada subsequente para |
ListCustomerMediaItemsRequest
Mensagem de solicitação para Media.ListCustomerMediaItems.
Campos | |
---|---|
parent |
O nome do local cujos itens de mídia do cliente serão listados. |
page_size |
Quantos itens de mídia retornar por página. O valor padrão é 100, e o tamanho máximo de página permitido é 200. |
page_token |
Se especificado, retorna a próxima página de itens de mídia. |
ListCustomerMediaItemsResponse
Mensagem de resposta para Media.ListCustomerMediaItems.
Campos | |
---|---|
media_items[] |
A lista retornada de itens de mídia. |
total_media_item_count |
O número total de itens de mídia para este local, independentemente da paginação. Esse número é aproximado, especialmente quando há várias páginas de resultados. |
next_page_token |
Se houver mais itens de mídia do que o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de itens de mídia em uma chamada subsequente para ListCustomerMediaItems. |
ListInsuranceNetworksRequest
Mensagem de solicitação para InsuranceNetworkService.ListInsuranceNetworks
Campos | |
---|---|
parent |
Obrigatório. O nome do local cujas redes de seguros serão listadas. O nome está no formato: accounts/{account_id}/locations/{location_id} |
language_code |
Opcional. O código BCP 47 do idioma. Se um código de idioma não for fornecido, o padrão será o inglês. No momento, apenas "en" é compatível. |
page_size |
Quantas redes de seguros devem ser retornadas por página. O valor padrão é 5000. O tamanho máximo da página é 10.000. |
page_token |
Se especificado, retorna a próxima página de redes de seguros. |
ListInsuranceNetworksResponse
Mensagem de resposta para InsuranceNetworkService.ListInsuranceNetworks
Campos | |
---|---|
networks[] |
Uma lista de redes de seguros aceitas pelo Google. |
next_page_token |
Se houver mais redes de seguros do que o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de redes de seguros em uma chamada subsequente para ListInsuranceNetworks. |
ListInvitationsRequest
Mensagem de solicitação para AccessControl.ListInvitations.
Campos | |
---|---|
parent |
O nome da conta da qual a lista de convites está sendo recuperada. |
target_type |
Especifica os tipos de segmentação que precisam aparecer na resposta. |
TargetType
É o tipo de público-alvo do convite.
Enums | |
---|---|
ALL |
Listar convites para todos os tipos de segmentação. Esse é o padrão. |
ACCOUNTS_ONLY |
Liste convites somente para segmentações do tipo "Conta". |
LOCATIONS_ONLY |
Lista convites apenas para segmentações do tipo "Local". |
ListInvitationsResponse
Mensagem de resposta para AccessControl.ListInvitations.
Campos | |
---|---|
invitations[] |
Uma coleção de convites de locais pendentes para a conta. O número de convites listados aqui não pode exceder 1.000. |
ListLocalPostsRequest
Mensagem de solicitação para ListLocalPosts.
Campos | |
---|---|
parent |
O nome do local cujas postagens locais serão listadas. |
page_size |
Quantas postagens locais serão retornadas por página. O padrão é 20. O mínimo é 1, e o tamanho máximo da página é 100. |
page_token |
Se especificado, retorna a próxima página de postagens locais. |
ListLocalPostsResponse
Mensagem de resposta para ListLocalPosts.
Campos | |
---|---|
local_posts[] |
A lista retornada de postagens locais. |
next_page_token |
Se houver mais postagens locais do que o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de postagens locais em uma chamada subsequente para |
ListLocationAdminsRequest
Mensagem de solicitação para AccessControl.ListLocationAdmins.
Campos | |
---|---|
parent |
O nome do local do qual listar os administradores. |
ListLocationAdminsResponse
Mensagem de resposta para AccessControl.ListLocationAdmins.
Campos | |
---|---|
admins[] |
Um conjunto de instâncias |
ListLocationsRequest
A mensagem de solicitação para Locations.ListLocations.
Campos | |
---|---|
parent |
O nome da conta em que os locais serão buscados. Se a |
page_size |
Quantos locais devem ser buscados por página. O padrão é 100, o mínimo é 1, e o tamanho máximo da página é 100. |
page_token |
Se especificado, ele busca o próximo |
filter |
Um filtro que restringe os locais a serem retornados. A resposta inclui apenas entradas que correspondem ao filtro. Se Para mais informações sobre campos válidos e exemplos de uso, consulte o Guia "Trabalhar com dados de local". |
language_code |
O código de idioma BCP 47 em que as propriedades de local de exibição serão mostradas. Se esse idioma não estiver disponível, ele será fornecido no idioma do local. Se nenhuma dessas opções estiver disponível, elas serão fornecidas em inglês. Obsoleto. Após 15 de agosto de 2020, esse campo não será mais aplicado. Em vez disso, o idioma do local sempre será usado. |
order_by |
Ordem de classificação da solicitação. Vários campos devem ser separados por vírgula, seguindo a sintaxe SQL. A ordem de classificação padrão é crescente. Para especificar a ordem decrescente, um sufixo " desc" precisa ser adicionado. Os campos válidos para order_by são location_name e store_code. Por exemplo: "location_name, store_code desc" ou "location_name" ou "store_code desc" |
ListLocationsResponse
Mensagem de resposta para Locations.ListLocations.
Campos | |
---|---|
locations[] |
Os locais. |
next_page_token |
Se o número de locais exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de locais em uma chamada subsequente para |
total_size |
O número aproximado de locais na lista, independentemente da paginação. |
ListMediaItemsRequest
Mensagem de solicitação para Media.ListMediaItems.
Campos | |
---|---|
parent |
O nome do local cujos itens de mídia serão listados. |
page_size |
Quantos itens de mídia retornar por página. O valor padrão é 100, que também é o número máximo permitido de itens de mídia que podem ser adicionados a um local usando a API Google My Business. O tamanho máximo da página é 2.500. |
page_token |
Se especificado, retorna a próxima página de itens de mídia. |
ListMediaItemsResponse
Mensagem de resposta para Media.ListMediaItems.
Campos | |
---|---|
media_items[] |
A lista retornada de itens de mídia. |
total_media_item_count |
O número total de itens de mídia para este local, independentemente da paginação. |
next_page_token |
Se houver mais itens de mídia do que o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de itens de mídia em uma chamada subsequente para ListMediaItems. |
ListQuestionsRequest
Mensagem de solicitação para QuestionsAndAnswers.ListQuestions
Campos | |
---|---|
parent |
O nome do local para o qual as perguntas serão buscadas. |
page_size |
Quantas perguntas são buscadas por página. O valor padrão e máximo de |
page_token |
Se especificado, a próxima página de perguntas é recuperada. |
answers_per_question |
O número de respostas a serem buscadas por pergunta. O valor padrão e máximo de |
filter |
Um filtro que restringe as perguntas a serem retornadas. O único filtro compatível no momento é "ignore_answered=true" |
order_by |
O pedido para devolver as perguntas. As opções válidas incluem "update_time desc" e "upvote_count desc", que retornará as perguntas classificadas em ordem decrescente pelo campo solicitado. A ordem de classificação padrão é 'update_time desc'. |
ListQuestionsResponse
Mensagem de resposta para QuestionsAndAnswers.ListQuestions
Campos | |
---|---|
questions[] |
As perguntas solicitadas, |
total_size |
O número total de perguntas postadas sobre este local em todas as páginas. |
next_page_token |
Se o número de perguntas exceder o tamanho máximo de página solicitado, esse campo será preenchido com um token para buscar a próxima página de perguntas em uma chamada subsequente. Se não houver mais perguntas, este campo não estará presente na resposta. |
ListRecommendedGoogleLocationsRequest
Peça uma mensagem para listar os locais recomendados para uma conta do Perfil da Empresa.
Campos | |
---|---|
name |
Nome do recurso da conta para o qual buscar os locais recomendados do Google. |
page_size |
Quantos locais devem ser buscados por página. O padrão é 25, o mínimo é 1, e o tamanho máximo da página é 100. |
page_token |
Se especificado, a próxima página de locais é recuperada. |
ListRecommendedGoogleLocationsResponse
Mensagem de resposta para GoogleLocations.ListRecommendedGoogleLocations.
Ele também contém alguns locais que foram reivindicados por outros usuários do Perfil da Empresa desde a última vez em que foram recomendados para esta conta do Perfil da Empresa.
Campos | |
---|---|
google_locations[] |
Os locais recomendados para uma conta do Perfil da Empresa. Cada um deles representa um |
total_size |
O número total de locais recomendados para esta conta do Perfil da Empresa, independentemente da paginação. |
next_page_token |
Durante a paginação, se houver mais locais disponíveis para busca na próxima página, esse campo será preenchido com um token para buscar a próxima página de locais em uma chamada subsequente. Se não houver mais locais a serem buscados, este campo não estará presente na resposta. |
ListReviewsRequest
Mensagem de solicitação para Reviews.ListReviews.
Campos | |
---|---|
parent |
O nome do local para o qual as avaliações serão buscadas. |
page_size |
Quantas avaliações precisam ser buscadas por página. O |
page_token |
Se especificado, ele busca a próxima página de avaliações. |
order_by |
Especifica o campo pelo qual as avaliações serão classificadas. Se não for especificada, a ordem das avaliações retornadas será |
ListReviewsResponse
Mensagem de resposta para Reviews.ListReviews.
Campos | |
---|---|
reviews[] |
As avaliações. |
average_rating |
Nota média de todas as avaliações desse local em uma escala de 1 a 5, em que 5 é a nota mais alta. |
total_review_count |
O número total de avaliações para esse local. |
next_page_token |
Se o número de avaliações exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de avaliações em uma chamada subsequente para ListReviews. Se não houver mais avaliações, este campo não estará presente na resposta. |
ListVerificationsRequest
Mensagem de solicitação para Verifications.ListVerifications.
Campos | |
---|---|
parent |
Nome do recurso do local a que as solicitações de verificação pertencem. |
page_size |
Quantas verificações devem ser incluídas por página. Se não for definido, retornará todos. |
page_token |
Se especificado, retorna a próxima página de verificações. |
ListVerificationsResponse
Mensagem de resposta para Verifications.ListVerifications.
Campos | |
---|---|
verifications[] |
Lista de verificações. |
next_page_token |
Se o número de verificações exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de verificação em uma chamada subsequente. Se não houver mais atributos, este campo não estará presente na resposta. |
LocalPost
Representa uma postagem local para um local.
Campos | |
---|---|
name |
Apenas saída. O identificador do Google para esta postagem local está no formato: |
language_code |
O idioma da postagem local. |
summary |
Descrição/corpo da postagem local. |
call_to_action |
O URL para onde os usuários são direcionados ao clicar na promoção. Ignorado para o tipo de tópico |
create_time |
Apenas saída. Hora da criação da postagem. |
update_time |
Apenas saída. Hora da última modificação da postagem feita pelo usuário. |
event |
Informações do evento. Obrigatório para os tipos de tópico |
state |
Apenas saída. O estado da postagem, indicando em que parte do ciclo de vida ela se encontra. |
media[] |
A mídia associada à postagem. source_url é o único campo de dados compatível com um LocalPost MediaItem. |
search_url |
Apenas saída. O link para a postagem local na Pesquisa Google. Esse link pode ser usado para compartilhar a postagem nas mídias sociais, e-mail, mensagem de texto etc. |
topic_type |
Obrigatório. O tipo de tema da postagem: padrão, evento, oferta ou alerta. |
alert_type |
O tipo de alerta para o qual a postagem foi criada. Este campo só é aplicável a postagens de alerta topic_type e se comporta como um subtipo de alertas. |
offer |
Dados adicionais para postagens de oferta. Só deve ser definido quando topic_type é OFFER. |
LocalPostState
Indica o estado da postagem.
Enums | |
---|---|
LOCAL_POST_STATE_UNSPECIFIED |
Estado não especificado. |
REJECTED |
Esta postagem foi rejeitada devido a uma violação da política de conteúdo. |
LIVE |
Esta postagem foi publicada e aparece nos resultados da pesquisa. |
PROCESSING |
Esta postagem está sendo processada e não aparece nos resultados da pesquisa. |
LocalPostEvent
Todas as informações relacionadas a um evento são apresentadas em uma postagem local.
Campos | |
---|---|
title |
Nome do evento. |
schedule |
Data/hora de início e término do evento. |
LocalPostMetrics
Todas as métricas solicitadas para uma postagem local.
Campos | |
---|---|
local_post_name |
|
metric_values[] |
Uma lista de valores para as métricas solicitadas. |
LocalPostOffer
Campos específicos para postagens de oferta.
Campos | |
---|---|
coupon_code |
Opcional. Código da oferta que pode ser usado na loja ou on-line. |
redeem_online_url |
Opcional. Link on-line para resgatar a oferta. |
terms_conditions |
Opcional. Termos e Condições da oferta. |
LocalPostTopicType
O tipo de tema da postagem local, que é usado para selecionar modelos diferentes e criar e renderizar uma postagem.
Enums | |
---|---|
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED |
Nenhum tipo de postagem foi especificado. |
STANDARD |
A postagem contém informações básicas, como resumo e imagens. |
EVENT |
A postagem contém informações básicas e um evento. |
OFFER |
A postagem contém informações básicas, um evento e um conteúdo relacionado a ofertas (por exemplo, código do cupom) |
ALERT |
Anúncios de alta prioridade e oportunos relacionados a um evento em andamento. Esses tipos de postagem nem sempre estão disponíveis para criação. |
Local
Um local. Consulte o artigo da Central de Ajuda para ver uma descrição detalhada desses campos ou o endpoint da categoria para consultar uma lista de categorias de negócios válidas.
Campos | |
---|---|
name |
Identificador do Google para este local no formato: No contexto de correspondências, este campo não será preenchido. |
language_code |
O idioma do local. Definido durante a criação e não pode ser atualizado. |
store_code |
Identificador externo desse local, que precisa ser exclusivo em uma determinada conta. Esse é um meio de associar o local aos seus próprios registros. |
location_name |
O nome do local deve refletir o nome real da sua empresa, conforme usado de forma consistente na loja, no site e em artigos de papelaria, e como é conhecido pelos clientes. Outras informações, quando relevantes, podem ser incluídas em outros campos do recurso (por exemplo, |
primary_phone |
Um número de telefone que tenha a conexão mais direta possível com o local individual da sua empresa. Sempre que possível, use um número de telefone local em vez do número de uma central de atendimento. |
additional_phones[] |
É possível ligar para até dois números de telefone (celular ou fixo, não fax) da sua empresa, além do número de telefone principal. |
address |
Um endereço exato e preciso para descrever o local da sua empresa. Caixas postais ou de correspondência localizadas em locais remotos não são aceitas. No momento, você pode especificar no máximo cinco valores |
primary_category |
A categoria que melhor descreve a área de atuação principal do local. |
additional_categories[] |
Categorias adicionais para descrever sua empresa. As categorias ajudam seus clientes a encontrar resultados precisos e específicos para os serviços em que têm interesse. Para manter suas informações comerciais precisas e atualizadas, use o menor número possível de categorias para descrever seu negócio principal. Escolher categorias o mais específicas possíveis, mas que representem seu negócio principal. |
website_url |
Um URL para esta empresa. Se possível, use um URL que represente o local específico da empresa em vez de um site/URL genérico que representa todos os locais ou a marca. |
regular_hours |
Horário de funcionamento da empresa. |
special_hours |
Horário de funcionamento especial da empresa. Isso normalmente inclui o horário de funcionamento em feriados e outros horários fora do normal. Eles substituem o horário de funcionamento normal. |
service_area |
Empresas com área de cobertura oferecem o atendimento no local do cliente. Se a empresa for de serviço local, este campo vai descrever as áreas atendidas pela empresa. |
location_key |
Um conjunto de chaves que vinculam esta empresa a outros Serviços do Google, como uma página do Google+ e lugares do Google Maps. |
labels[] |
É uma coleção de strings de formato livre para incluir tags na sua empresa. Esses marcadores NÃO são voltados para o usuário, somente você pode vê-los. Limitado a 255 caracteres (por rótulo). |
ad_words_location_extensions |
Informações adicionais exibidas no Google AdWords. |
latlng |
Latitude e longitude fornecidas pelo usuário. Ao criar um local, este campo será ignorado se o endereço fornecido for geocodificado corretamente. Esse campo só vai ser retornado em solicitações get se o valor |
open_info |
Uma sinalização que indica se o local está aberto no momento. |
location_state |
Apenas saída. Um conjunto de booleanos que reflete o estado de um local. |
attributes[] |
Atributos desse local. |
metadata |
Somente saída. Outras informações não editáveis pelo usuário. |
price_lists[] |
Obsoleto: informações da lista de preços para este local. |
profile |
Descreve sua empresa com sua voz e compartilha com os usuários a história da sua empresa e das suas ofertas. |
relationship_data |
Todos os locais e redes relacionados a este. |
more_hours[] |
Mais horários de funcionamento para diferentes departamentos ou clientes específicos de uma empresa. |
Metadados
Outras informações não editáveis pelo usuário sobre o local.
Campos | |
---|---|
duplicate |
Informações sobre o local duplicado. Presente apenas quando |
maps_url |
Um link para o local no Maps. |
new_review_url |
Um link para a página na Pesquisa Google em que o cliente pode avaliar o local. |
Duplicar
Informações sobre o local duplicado.
Campos | |
---|---|
location_name |
O nome do recurso do local duplicado. Preenchido apenas se o usuário autenticado tiver direitos de acesso ao local e ele não tiver sido excluído. |
place_id |
O ID do local duplicado. |
access |
Indica se o usuário tem acesso ao local duplicado. |
Acesso
Nível de acesso do usuário ao local duplicado. Isso substitui a propriedade "Propriedade" e deve ser usado.
Enums | |
---|---|
ACCESS_UNSPECIFIED |
Não especificado. |
ACCESS_UNKNOWN |
Não foi possível determinar se o usuário tem acesso ao local duplicado. |
ALLOWED |
O usuário tem acesso ao local duplicado. |
INSUFFICIENT |
O usuário não tem acesso ao local duplicado. |
RelationshipData
Informações de todos os locais principais e secundários relacionados a este.
Campos | |
---|---|
parent_chain |
O nome do recurso da rede de que esse local faz parte. |
LocationDrivingDirectionMetrics
Um local indexado com as regiões de onde as pessoas costumam vir. Esse valor é capturado com a contagem de quantas solicitações de rotas de carro para esse local vêm de cada região.
Campos | |
---|---|
location_name |
O nome do recurso de local a que o valor da métrica pertence. |
top_direction_sources[] |
Solicitações de direção por região de origem. Por convenção, eles são classificados por contagem com no máximo 10 resultados. |
time_zone |
Fuso horário (IDs de fuso horário IANA, por exemplo, "Europa/Londres") do local. |
TopDirectionSources
Principais regiões de origem das solicitações de rotas de carro.
Campos | |
---|---|
day_count |
É o número de dias em que os dados são agregados. |
region_counts[] |
Regiões classificadas em ordem decrescente por contagem. |
RegionCount
Uma região com a contagem de solicitações associada.
Campos | |
---|---|
latlng |
Centro da região. |
label |
Rótulo legível por humanos para a região. |
count |
Número de solicitações de rotas de carro desta região. |
LocationKey
Referências de chave alternativas para um local.
Campos | |
---|---|
plus_page_id |
Apenas saída. Se esse local estiver associado a uma página do Google+, ele será preenchido com o ID da página do Google+ desse local. |
place_id |
Se o local tiver sido verificado e estiver conectado ao Google Maps ou aparecer nele, esse campo será preenchido com o ID do local. Esse ID pode ser usado em várias APIs Places. Se esse local não tiver sido verificado, esse campo poderá ser preenchido se o local tiver sido associado a um lugar que aparece no Google Maps. Este campo pode ser definido durante a criação de chamadas, mas não para Update. O booleano |
explicit_no_place_id |
Apenas saída. O valor "true" indica que um ID de lugar não definido é deliberado, o que é diferente de nenhuma associação ter sido feita ainda. |
request_id |
Apenas saída. O |
LocationMetrics
Uma série de métricas e detalhamentos associadas a um local em determinado período.
Campos | |
---|---|
location_name |
O nome do recurso de local a que esses valores pertencem. |
time_zone |
Fuso horário da IANA do local. |
metric_values[] |
Uma lista de valores para as métricas solicitadas. |
LocationReview
Representa uma avaliação com informações de local.
Campos | |
---|---|
name |
Nome do recurso de local. |
review |
Uma avaliação do local. |
LocationState
Contém um conjunto de booleanos que refletem o estado de um local.
Campos | |
---|---|
is_google_updated |
Apenas saída. Indica se o ID associado a esse local tem atualizações. |
is_duplicate |
Apenas saída. Indica se o local é uma cópia de outro. |
is_suspended |
Apenas saída. Indica se o local está suspenso. Os locais suspensos não ficam visíveis para os usuários finais nos produtos do Google. Se você acredita que isso foi um erro, consulte o artigo da Central de Ajuda. |
can_update |
Apenas saída. Indica se o local pode ser atualizado. |
can_delete |
Apenas saída. Indica se o local pode ser excluído usando a API Google My Business. |
is_verified |
Apenas saída. Indica se o local foi verificado. |
needs_reverification |
Apenas saída. Indica se o local requer uma nova verificação. |
is_pending_review |
Apenas saída. Indica se a revisão do local está pendente. |
is_disabled |
Apenas saída. Indica se o local está desativado. |
is_published |
Apenas saída. Indica se o local foi publicado. |
is_disconnected |
Apenas saída. Indica se o local está desconectado de um lugar no Google Maps. |
is_local_post_api_disabled |
Apenas saída. Indica se accounts.locations.localPosts está desativado para esse local. |
can_modify_service_list |
Apenas saída. Indica se a listagem pode modificar uma ServiceList. |
can_have_food_menus |
Apenas saída. Indica se o anúncio está qualificado para um cardápio de refeições. |
has_pending_edits |
Apenas saída. Indica se alguma das propriedades desse local está no estado de edição pendente. |
has_pending_verification |
Apenas saída. Indica se o local tem solicitações de verificação pendentes. |
can_operate_health_data |
Apenas saída. Indica se o local pode operar em dados de Saúde. |
can_operate_lodging_data |
Apenas saída. Indica se o local pode operar em dados de hospedagem. |
MatchedLocation
Representa uma possível correspondência com um local.
Campos | |
---|---|
location |
O local pouco preenchido que é uma possível correspondência. Os campos não preenchidos incluem, entre outros: nome (o local correspondente não pode ser recuperado por |
is_exact_match |
É uma correspondência exata? |
MediaItem
Um único item de mídia.
Campos | ||
---|---|---|
name |
O nome do recurso para este item de mídia. |
|
media_format |
O formato desse item de mídia. Precisa ser definido quando o item de mídia é criado e é somente leitura em todas as outras solicitações. Não foi possível atualizar. |
|
location_association |
Obrigatório ao chamar Isso é necessário ao adicionar novas mídias a um local com |
|
google_url |
Apenas saída. É o URL hospedado pelo Google para este item de mídia. Esse URL não é estático porque pode mudar com o tempo. Para vídeos, esta será uma imagem de visualização com um ícone de reprodução sobreposto. |
|
thumbnail_url |
Apenas saída. Quando fornecido, o URL de uma imagem em miniatura para esse item de mídia. |
|
create_time |
Apenas saída. Hora da criação desse item de mídia. |
|
dimensions |
Apenas saída. As dimensões (largura e altura) em pixels. |
|
insights |
Apenas saída. Estatísticas para este item de mídia. |
|
attribution |
Apenas saída. Informações de atribuição para itens de mídia do cliente. Você precisa exibir essa atribuição conforme fornecida aos usuários e não pode excluí-la ou alterá-la. |
|
description |
Descrição para esse item de mídia. As descrições não podem ser modificadas na API Google My Business, mas podem ser definidas ao criar um novo item de mídia que não seja uma foto de capa. |
|
Campo de união Com exceção das categorias Todas as fotos enviadas precisam seguir as diretrizes do Perfil da Empresa para fotos. |
||
source_url |
Um URL acessível publicamente de onde o item de mídia pode ser recuperado. Ao criar um, data_ref deve ser definido para especificar a origem do item de mídia. Se Não é possível atualizar este campo. |
|
data_ref |
Apenas entrada. Uma referência aos dados binários do item de mídia, conforme obtido pelo método Ao criar um item de mídia,
ou
precisa ser definido. |
Atribuição
Informações de atribuição para itens de mídia do cliente, como o nome e a foto do perfil do colaborador.
Campos | |
---|---|
profile_name |
O nome de usuário ao qual atribuir o item de mídia. |
profile_photo_url |
URL da miniatura da foto do perfil do usuário atribuído. |
takedown_url |
O URL da página de remoção, em que o item de mídia pode ser denunciado, se for inadequado. |
profile_url |
É o URL da página de perfil do Google Maps do usuário atribuído. |
Dimensões
Dimensões do item de mídia.
Campos | |
---|---|
width_pixels |
Largura do item de mídia, em pixels. |
height_pixels |
Altura do item de mídia, em pixels. |
LocationAssociation
Como o item de mídia está associado ao local.
Campos | ||
---|---|---|
Campo de união location_attachment_type . A mídia do local precisa ter uma categoria ou o ID de um item da lista de preços a que está associada. Mídias que não sejam de local (por exemplo, fotos de postagens locais) não podem ter nenhum dos dois. location_attachment_type pode ser apenas de um dos tipos a seguir: |
||
category |
A categoria à qual a foto do local pertence. |
|
price_list_item_id |
O ID de um item da lista de preços a que esta foto de local está associada. |
Categoria
Enumeração da categoria de item de mídia.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Categoria não especificada. |
COVER |
Foto da capa. Um local tem apenas uma foto de capa. |
PROFILE |
Foto do perfil. Um local tem apenas uma foto do perfil. |
LOGO |
Foto do logotipo. |
EXTERIOR |
Mídia externa. |
INTERIOR |
Mídia interna. |
PRODUCT |
Mídia de produto. |
AT_WORK |
Mídia no trabalho. |
FOOD_AND_DRINK |
Mídia de alimentos e bebidas. |
MENU |
Mídia do menu. |
COMMON_AREA |
Mídia de área comum. |
ROOMS |
Mídia das salas. |
TEAMS |
Mídia de equipes. |
ADDITIONAL |
Mídia adicional sem classificação. |
MediaFormat
Enumeração do formato de mídia.
Enums | |
---|---|
MEDIA_FORMAT_UNSPECIFIED |
Formato não especificado. |
PHOTO |
O item de mídia é uma foto. Nesta versão, apenas fotos são compatíveis. |
VIDEO |
O item de mídia é um vídeo. |
MediaInsights
Insights e estatísticas para o item de mídia.
Campos | |
---|---|
view_count |
Apenas saída. O número de vezes que o item de mídia foi visualizado. |
MediaItemDataRef
Referência aos dados binários de fotos de um MediaItem
enviado pela API Google My Business.
Crie uma referência de dados usando StartUploadMediaItemData
e use-a ao fazer upload de bytes para [UpdateMedia] e, depois, chamar CreateMediaItem
.
Campos | |
---|---|
resource_name |
O ID exclusivo dos dados binários deste item de mídia. Usado para fazer upload dos dados da foto com [UpdateMedia] e ao criar um novo item de mídia usando esses bytes com Exemplo de upload de bytes: Para chamadas |
MenuLabel
Rótulo a ser usado ao exibir o menu e os vários subcomponentes dele.
Campos | |
---|---|
display_name |
Obrigatório. Nome de exibição do componente. |
description |
Opcional. Informações complementares do componente. |
language_code |
Opcional. O código de idioma BCP 47. Se o idioma não estiver disponível, o padrão será o inglês. |
Métrica
Uma métrica de dados sobre um recurso.
Enums | |
---|---|
METRIC_UNSPECIFIED |
Nenhuma métrica especificada. |
ALL |
Abreviação para solicitar todas as métricas disponíveis. As métricas que estão incluídas em TODOS variam e dependem do recurso para o qual os insights estão sendo solicitados. |
QUERIES_DIRECT |
O número de vezes que o recurso foi mostrado ao pesquisar o local diretamente. |
QUERIES_INDIRECT |
O número de vezes que o recurso apareceu como resultado de uma pesquisa categórica (por exemplo, restaurante). |
QUERIES_CHAIN |
O número de vezes que um recurso foi exibido como resultado de uma pesquisa pela rede a que ele pertence ou por uma marca que ele vende. Por exemplo, Starbucks, Adidas. Esse é um subconjunto de QUERIES_INDIRECT. |
VIEWS_MAPS |
Quantas vezes o recurso foi visualizado no Google Maps. |
VIEWS_SEARCH |
O número de vezes que o recurso foi visualizado na Pesquisa Google. |
ACTIONS_WEBSITE |
Número de vezes que o site foi clicado. |
ACTIONS_PHONE |
Número de vezes que o número de telefone foi clicado. |
ACTIONS_DRIVING_DIRECTIONS |
O número de vezes que rotas de carro foram solicitadas. |
PHOTOS_VIEWS_MERCHANT |
O número de visualizações dos itens de mídia enviados pelo comerciante. |
PHOTOS_VIEWS_CUSTOMERS |
O número de visualizações dos itens de mídia enviados por clientes. |
PHOTOS_COUNT_MERCHANT |
O número total de itens de mídia ativos que foram enviados pelo comerciante. |
PHOTOS_COUNT_CUSTOMERS |
O número total de itens de mídia ativos que foram enviados pelos clientes. |
LOCAL_POST_VIEWS_SEARCH |
O número de vezes que a postagem local foi visualizada na Pesquisa Google. |
LOCAL_POST_ACTIONS_CALL_TO_ACTION |
Número de vezes que o botão de call-to-action foi clicado no Google. |
MetricOption
Opção para especificar como os dados devem ser mostrados na resposta.
Enums | |
---|---|
METRIC_OPTION_UNSPECIFIED |
Nenhuma opção de métrica foi especificada. O padrão será AGGREGATED_TOTAL em uma solicitação. |
AGGREGATED_TOTAL |
Retorna valores agregados em todo o período. Esse é o valor padrão. |
AGGREGATED_DAILY |
Retorna valores diários com carimbo de data/hora em um período. |
BREAKDOWN_DAY_OF_WEEK |
Os valores serão retornados como um detalhamento por dia da semana. Válida apenas para ACTIONS_PHONE. |
BREAKDOWN_HOUR_OF_DAY |
Os valores serão retornados como um detalhamento por hora do dia. Válida apenas para ACTIONS_PHONE. |
MetricRequest
Uma solicitação para retornar valores para uma métrica e as opções de como esses valores devem ser retornados.
Campos | |
---|---|
metric |
A métrica solicitada. |
options[] |
Como os valores devem aparecer quando retornados. |
MetricValue
Um valor para uma única métrica a partir de um horário inicial.
Campos | |
---|---|
metric |
A métrica à qual o valor se aplica. |
total_value |
O valor agregado total desta métrica. Definido para a opção AGGREGATED_TOTAL. |
dimensional_values[] |
São os valores dimensionais para esta métrica. |
MoreHours
Os períodos em que um local fica aberto para determinados tipos de empresa.
Campos | |
---|---|
hours_type_id |
Obrigatório. Tipo de horário de funcionamento. Os clientes devem chamar {#link businessCategories:BatchGet} para saberem os tipos de horário aceitos para as categorias de seus locais. |
periods[] |
Obrigatório. Um conjunto de horários em que o local está aberto. Cada período representa um intervalo de horas em que o local fica aberto durante a semana. |
MoreHoursType
Outros tipos de horário que uma empresa pode oferecer, além do horário de funcionamento normal.
Campos | |
---|---|
hours_type_id |
Apenas saída. Um ID estável fornecido pelo Google para esse tipo de horário de funcionamento. |
display_name |
Apenas saída. O nome de exibição legível em inglês para o tipo de hora. |
localized_display_name |
Apenas saída. O nome de exibição legível localizado para o tipo de hora. |
NetworkState
O estado de uma rede de seguros relacionada a este local.
Enums | |
---|---|
NETWORK_STATE_UNSPECIFIED |
Valor padrão. |
ACCEPTED |
Esta rede é aceita por esse local. |
PENDING_ADD |
Há uma solicitação pendente para adicionar esta rede à lista de opções aceitas. |
PENDING_DELETE |
Há uma solicitação pendente para remover esta rede da lista de opções aceitas. |
NOT_ACCEPTED |
Esta rede não é aceita por este local. |
NotificationType
Tipo de notificação enviada para o tópico do Cloud Pub/Sub.
Enums | |
---|---|
NOTIFICATION_TYPE_UNSPECIFIED |
Nenhum tipo de notificação. Não corresponde a nenhuma notificação. |
GOOGLE_UPDATE |
O local tem atualizações do Google para análise. O campo location_name na notificação mostra o nome de recurso do local com atualizações do Google. |
NEW_REVIEW |
Uma nova avaliação foi adicionada ao local. O campo "review_name" na notificação mostra o nome do recurso da avaliação adicionada, e location_name mostra o nome do recurso do local. |
UPDATED_REVIEW |
Uma avaliação no local foi atualizada. O campo "review_name" na notificação mostra o nome do recurso da avaliação adicionada, e location_name mostra o nome do recurso do local. |
NEW_CUSTOMER_MEDIA |
Um novo item de mídia foi adicionado ao local por um usuário do Google Maps. A notificação fornecerá o nome do recurso do novo item de mídia. |
NEW_QUESTION |
Uma nova pergunta é adicionada ao local. A notificação vai informar o nome do recurso da pergunta. |
UPDATED_QUESTION |
Uma pergunta do local é atualizada. A notificação vai informar o nome do recurso da pergunta. |
NEW_ANSWER |
Uma nova resposta é adicionada ao local. A notificação vai informar o nome do recurso da pergunta e da resposta. |
UPDATED_ANSWER |
Uma resposta do local será atualizada. A notificação vai informar o nome do recurso da pergunta e da resposta. |
UPDATED_LOCATION_STATE |
O LocationState do local foi atualizado. A notificação contém a máscara de campo dos campos LocationState atualizados. |
Notificações
Um tópico do Google Cloud Pub/Sub em que é possível publicar notificações quando um local é atualizado ou tem uma nova avaliação. Haverá apenas um recurso de configurações de notificação por conta.
Campos | |
---|---|
name |
Apenas saída. O nome do recurso de notificações. |
topic_name |
O tópico do Google Cloud Pub/Sub que vai receber notificações quando os locais gerenciados por esta conta forem atualizados. Se ela for deixada sem definição, nenhuma notificação será postada. A conta mybusiness-api-pubsub@system.gserviceaccount.com precisa ter pelo menos permissões de publicação no tópico do Cloud Pub/Sub. |
notification_types[] |
Os tipos de notificações que serão enviados ao tópico do Cloud Pub/Sub. É necessário especificar pelo menos um. Para parar de receber notificações, use |
NutritionFacts
Esta mensagem representa os dados nutricionais de um prato.
Campos | |
---|---|
calories |
Opcional. Calorias do prato. |
total_fat |
Opcional. Informações de gordura de um prato. |
cholesterol |
Opcional. Informações de colesterol de um determinado prato. |
sodium |
Opcional. Informações de sódio para um determinado prato. |
total_carbohydrate |
Opcional. Informações de carboidratos de um prato. |
protein |
Opcional. Informações de proteínas de um prato. |
CaloriesFact
Esta mensagem indica informações de calorias com limites máximos e mínimos. O valor mais baixo precisa ser especificado. Tanto os valores inferiores quanto os máximos são números não negativos.
Campos | |
---|---|
lower_amount |
Obrigatório. Menor quantidade de calorias |
upper_amount |
Opcional. Quantidade superior de calorias |
unit |
Obrigatório. Unidade das informações de calorias fornecidas. |
EnergyUnit
Possíveis unidades de energia alimentar (calorias).
Enums | |
---|---|
ENERGY_UNIT_UNSPECIFIED |
Unidade de energia não especificada |
CALORIE |
Calorias |
JOULE |
Joule |
MassUnit
Possíveis unidades de massa.
Enums | |
---|---|
MASS_UNIT_UNSPECIFIED |
Unidade de massa não especificada |
GRAM |
Gram |
MILLIGRAM |
Miligrama |
NutritionFact
Esta mensagem indica informações nutricionais com limites máximos e mínimos e pode ser representada por uma unidade de massa. O valor mais baixo precisa ser especificado. Tanto os valores inferiores quanto os máximos são números não negativos.
Campos | |
---|---|
lower_amount |
Obrigatório. Menor quantidade de nutrição |
upper_amount |
Opcional. maior quantidade de nutrição |
unit |
Obrigatório. Unidade das informações nutricionais fornecidas. |
OpenInfo
Informações relacionadas ao estado de abertura da empresa.
Campos | |
---|---|
status |
Indica se o local está aberto. Todos os locais ficam abertos por padrão, a menos que sejam atualizados para fechados. |
can_reopen |
Apenas saída. Indica se a empresa está qualificada para reabertura. |
opening_date |
A data em que o local foi aberto pela primeira vez. Se o dia exato não for conhecido, apenas o mês e o ano poderão ser fornecidos. A data precisa estar no passado ou no máximo um ano no futuro. |
OpenForBusiness
Indica o status de um local.
Enums | |
---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
Não especificado. |
OPEN |
Indica que o local está aberto. |
CLOSED_PERMANENTLY |
Indica que o local foi permanentemente fechado. |
CLOSED_TEMPORARILY |
Indica que o local foi temporariamente fechado. Esse valor só pode ser aplicado a locais publicados (ou seja, location_state.is_publication = true). Ao atualizar o campo de status para esse valor, os clientes precisam definir update_mask explicitamente como open_info.status . Nenhuma outra máscara de atualização pode ser definida durante esta chamada de atualização. Essa é uma restrição temporária que será flexibilizada em breve. |
PermissionLevel
Indica o nível de acesso que o usuário autenticado tem nessa conta.
Enums | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
Não especificado. |
OWNER_LEVEL |
O usuário tem permissão no nível do proprietário. |
MEMBER_LEVEL |
O usuário tem permissão no nível de membro. |
PhoneInput
Entrada para verificação por PHONE_CALL/SMS.
Campos | |
---|---|
phone_number |
O número de telefone que deve receber a ligação ou receber um SMS. Precisa ser um dos números de telefone nas opções qualificadas. |
PlaceInfo
Define uma área representada por um ID de lugar.
Campos | |
---|---|
name |
O nome localizado do lugar. Por exemplo, |
place_id |
O ID do local. Precisa corresponder a uma region. |
Places
Define a união de áreas representadas por um conjunto de lugares.
Campos | |
---|---|
place_infos[] |
As áreas representadas por IDs de lugar. É limitado a 20 lugares. |
PointRadius
Um raio em torno de um ponto específico (latitude/longitude).
Campos | |
---|---|
latlng |
A latitude/longitude que especifica o centro de uma área definida pelo raio. |
radius_km |
A distância em quilômetros da área ao redor do ponto. |
PreparationMethod
Método de preparação de um prato.
Enums | |
---|---|
PREPARATION_METHOD_UNSPECIFIED |
Método de preparação não especificado |
BAKED |
Método bake |
BARBECUED |
Método de churrasco |
BASTED |
Método Basted |
BLANCHED |
Método de Blanched |
BOILED |
Método cozido |
BRAISED |
Método trançada |
CODDLED |
Método codificado |
FERMENTED |
Método fermentado |
FRIED |
Método frito |
GRILLED |
Método grelhado |
KNEADED |
Método unido |
MARINATED |
Método marinado |
PAN_FRIED |
Método de fritura |
PICKLED |
Método em conserva |
PRESSURE_COOKED |
Método de cozimento por pressão |
ROASTED |
Método roasted |
SAUTEED |
Método Sauteed |
SEARED |
Método selado |
SIMMERED |
Método simulado |
SMOKED |
Método defumado |
STEAMED |
Método Steamed |
STEEPED |
Método inclinada |
STIR_FRIED |
Método refogado |
OTHER_METHOD |
Outro método |
PriceList
Obsoleto: uma lista de informações sobre preços de itens. As listas de preços são estruturadas como uma ou mais listas de preços, cada uma contendo uma ou mais seções com um ou mais itens. Por exemplo, as listas de preços podem representar menus de café da manhã/almoço/jantar, com seções de hambúrgueres/filés/frutos do mar.
Campos | |
---|---|
price_list_id |
Obrigatório. ID da lista de preços. A lista de preços, a seção e os códigos do item não podem ser duplicados neste local. |
labels[] |
Obrigatório. Rótulos com tags de idioma para a lista de preços. |
source_url |
URL de origem opcional de onde a lista de preços foi extraída. Por exemplo, pode ser o URL da página que foi copiada automaticamente para preencher as informações do menu. |
sections[] |
Obrigatório. Seções desta lista de preços. Cada lista de preços precisa conter pelo menos uma seção. |
Rótulo
Rótulo usado ao exibir a lista de preços, a seção ou o item.
Campos | |
---|---|
display_name |
Obrigatório. Nome de exibição da lista de preços, seção ou item. |
description |
Opcional. Descrição da lista de preços, seção ou item. |
language_code |
Opcional. O código de idioma BCP-47 a que essas strings se aplicam. Somente um conjunto de marcadores pode ser definido por idioma. |
Seção
Uma seção da lista de preços com um ou mais itens.
Campos | |
---|---|
section_id |
Obrigatório. ID da seção. A lista de preços, a seção e os códigos do item não podem ser duplicados neste local. |
labels[] |
Obrigatório. Rótulos com tags de idioma para a seção. Recomendamos que os nomes e descrições das seções tenham 140 caracteres ou menos. É necessário pelo menos um conjunto de rótulos. |
section_type |
Opcional. Tipo da seção atual da lista de preços. O valor padrão é FOOD. |
items[] |
Itens que estão contidos nesta seção da lista de preços. |
Item
Um único item de lista. Cada variação de um item na lista de preços precisa ter um item próprio com dados de preços próprios.
Campos | |
---|---|
item_id |
Obrigatório. ID do item. A lista de preços, a seção e os códigos do item não podem ser duplicados neste local. |
labels[] |
Obrigatório. Rótulos com tags de idioma para o item. Recomendamos que os nomes dos itens tenham até 140 caracteres e as descrições até 250 caracteres. É necessário pelo menos um conjunto de rótulos. |
price |
Opcional. Preço do item. |
SectionType
Tipo da seção.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED |
Não especificado. |
FOOD |
A seção contém itens que representam alimentos. |
SERVICES |
A seção contém itens que representam serviços. |
Perfil
Todas as informações relacionadas ao perfil do local.
Campos | |
---|---|
description |
Descrição do local com sua própria voz, não editável por outras pessoas. |
Pergunta
Representa uma única pergunta e algumas das respostas dela.
Campos | |
---|---|
name |
Apenas saída. O nome exclusivo da pergunta. accounts/*/locations/*/questions/* |
author |
Apenas saída. É o autor da pergunta. |
upvote_count |
Apenas saída. O número de votos positivos para a pergunta. |
text |
O texto da pergunta. Ele deve conter pelo menos três palavras, e o tamanho total deve ser maior ou igual a 10 caracteres. O tamanho máximo é de 4.096 caracteres. |
create_time |
Apenas saída. A marcação de tempo de quando a pergunta foi escrita. |
update_time |
Apenas saída. A marcação de tempo da última modificação da pergunta. |
top_answers[] |
Apenas saída. Uma lista de respostas para a pergunta, classificadas por votos. Esta pode não ser uma lista completa de respostas, dependendo dos parâmetros de solicitação (answers_per_question) |
total_answer_count |
Apenas saída. O número total de respostas postadas para esta pergunta. |
RepeatedEnumAttributeValue
Valores de um atributo com um value_type
de REPEATED_ENUM. Isso consiste em duas listas de IDs de valor: aquelas definidas (true) e aquelas que não estão definidas (false). Os valores ausentes são considerados desconhecidos. É necessário especificar pelo menos um valor.
Campos | |
---|---|
set_values[] |
Valores de enumeração que são definidos. |
unset_values[] |
Valores de enumeração que não são definidos. |
ReportGoogleLocationRequest
Mensagem de solicitação para denunciar um GoogleLocation
.
Campos | ||
---|---|---|
name |
Nome do recurso de um [GoogleLocation], no formato |
|
location_group_name |
Opcional. O nome do recurso do grupo de locais para o qual esse local do Google está sendo informado, no formato |
|
report_reason_elaboration |
Opcional. Uma entrada de texto para explicar o motivo pelo qual o usuário está denunciando esse local. O tamanho máximo é de 512 caracteres. |
|
report_reason_language_code |
Opcional. O código de idioma BCP 47 usado em |
|
Campo de união report_reason . Motivo pelo qual esse local está sendo informado. É necessário informar um motivo. report_reason pode ser apenas de um dos tipos a seguir: |
||
report_reason_bad_location |
O motivo pelo qual o usuário está denunciando esse local quando o problema está relacionado ao próprio local. |
|
report_reason_bad_recommendation |
É o motivo pelo qual o usuário está informando esse local quando o problema está na recomendação. Esse relatório é útil se o local foi recomendado para a conta do Perfil da Empresa. |
BadLocationReason
Um conjunto de possíveis motivos para informar um local quando há um problema com a qualidade dos dados dele.
Enums | |
---|---|
BAD_LOCATION_REASON_UNSPECIFIED |
Não especificado. |
NOT_A_LOCATION |
O local recomendado não é um local real. |
PERMANENTLY_CLOSED |
O local recomendado está permanentemente fechado. |
DOES_NOT_EXIST |
O local recomendado não existe. |
SPAM |
O local recomendado é spam, falso ou ofensivo. |
NOT_A_BUSINESS |
O local recomendado é uma casa ou um lugar particular. |
MOVED |
O local recomendado foi movido para um novo local. Precisa ser acompanhado por um |
DUPLICATE |
O local recomendado é uma cópia de outro local. |
BadRecommendationReason
Um conjunto de possíveis motivos para informar um local quando há um problema com a qualidade da recomendação (quando esse local é recomendado ao usuário).
Enums | |
---|---|
BAD_RECOMMENDATION_REASON_UNSPECIFIED |
Não especificado. |
NOT_A_STORE_FRONT |
O local recomendado não é uma vitrine. |
NOT_PART_OF_SUGGESTED_CHAIN |
O local recomendado não pertence à rede sugerida no Precisa ser acompanhado por um |
IRRELEVANT |
O local recomendado não é relevante para o usuário. Precisa ser acompanhado por um |
ReportLocalPostInsightsRequest
Mensagem de solicitação para Insights.ReportLocalPostInsights
Campos | |
---|---|
name |
Obrigatório. O nome do local em que os insights serão buscados. |
local_post_names[] |
Obrigatório. A lista de postagens para buscar dados de insights. Todas as postagens precisam pertencer ao local cujo nome é especificado no campo |
basic_request |
Uma solicitação para incluir insights de métricas básicas no relatório. Essa solicitação se aplica a todas as postagens solicitadas. |
ReportLocalPostInsightsResponse
Mensagem de resposta para Insights.ReportLocalPostInsights
Campos | |
---|---|
name |
|
local_post_metrics[] |
Uma entrada por postagem solicitada correspondente a este local. |
time_zone |
Fuso horário (IDs de fuso horário IANA, por exemplo, "Europa/Londres") do local. |
ReportLocationInsightsRequest
Mensagem de solicitação para Insights.ReportLocationInsights.
Campos | |
---|---|
name |
O nome do recurso da conta. |
location_names[] |
Um conjunto de locais para os quais buscar insights, especificados pelos nomes. |
basic_request |
Uma solicitação para incluir insights de métricas básicas no relatório. |
driving_directions_request |
Uma solicitação para incluir insights sobre solicitações de rotas no relatório. |
ReportLocationInsightsResponse
Mensagem de resposta para Insights.ReportLocationInsights
.
Campos | |
---|---|
location_metrics[] |
Uma coleção de valores de métricas por local. |
location_driving_direction_metrics[] |
Uma coleção de valores para métricas relacionadas a rotas de carro. |
Revisão
Apenas saída. Representa uma avaliação de um local.
Campos | |
---|---|
name |
O nome do recurso. Para análise, o formato é |
review_id |
O identificador exclusivo criptografado. |
reviewer |
É o autor da avaliação. |
star_rating |
A nota da avaliação. |
comment |
O corpo da avaliação como texto simples com marcações. |
create_time |
O carimbo de data/hora de quando a avaliação foi escrita. |
update_time |
O carimbo de data/hora da última modificação da avaliação. |
review_reply |
O proprietário/gerente da resposta desse local a esta avaliação. |
Revisor
Representa o autor da avaliação.
Campos | |
---|---|
profile_photo_url |
Link da foto do perfil do avaliador. Preenchido apenas se |
display_name |
O nome do avaliador. Preenchido apenas com o nome real do avaliador se |
is_anonymous |
Indica se o avaliador optou por permanecer anônimo. |
StarRating
A nota de até cinco, em que cinco é a mais alta.
Enums | |
---|---|
STAR_RATING_UNSPECIFIED |
Não especificado. |
ONE |
Uma estrela de, no máximo, cinco. |
TWO |
Duas estrelas de, no máximo, cinco. |
THREE |
Três estrelas de, no máximo, cinco. |
FOUR |
Quatro estrelas de, no máximo, cinco. |
FIVE |
A nota máxima. |
ReviewReply
Representa a resposta do proprietário/gerente do local a uma avaliação.
Campos | |
---|---|
comment |
O corpo da resposta como texto simples com marcações. O tamanho máximo é de 4.096 bytes. |
update_time |
Apenas saída. O carimbo de data/hora da última modificação da resposta. |
SearchChainsRequest
Mensagem de solicitação para Locations.SearchChains.
Campos | |
---|---|
chain_display_name |
Pesquise uma rede pelo nome. Consultas exatas/parciais/difusas/relacionadas são aceitas. Exemplos: "walmart", "wal-mart", "walmmmart", "沃尔玛" |
result_count |
O número máximo de redes correspondentes a serem retornadas dessa consulta. O padrão é 10. O valor máximo possível é 500. |
SearchChainsResponse
Mensagem de resposta para Locations.SearchChains.
Campos | |
---|---|
chains[] |
Redes que correspondem ao network_display_name consultado em SearchChainsRequest. Se não houver correspondências, este campo estará vazio. Os resultados são listados em ordem de relevância. |
SearchGoogleLocationsRequest
Mensagem de solicitação para GoogleLocations.SearchGoogleLocations.
Campos | ||
---|---|---|
result_count |
O número de correspondências a serem retornadas. O valor padrão é 3, com um máximo de 10. A latência pode aumentar se forem solicitadas mais. Não há paginação. |
|
Campo de união search_query . Consulta de pesquisa. Isso pode ser fornecido como um objeto de localização ou como uma consulta de string. search_query pode ser apenas de um dos tipos a seguir: |
||
location |
Local a ser pesquisado. Se fornecido, encontrará locais que correspondem aos detalhes fornecidos. |
|
query |
Consulta de texto a ser pesquisada. Os resultados da pesquisa de uma string de consulta serão menos precisos do que se fornecerem um local exato, mas podem fornecer correspondências mais imprecisas. |
SearchGoogleLocationsResponse
Mensagem de resposta para GoogleLocations.SearchGoogleLocations.
Campos | |
---|---|
google_locations[] |
Uma coleção de GoogleLocations que são possíveis correspondências com a solicitação especificada, listadas em ordem decrescente de precisão. |
ServiceAreaBusiness
Empresas de serviço local prestam serviços no local do cliente (por exemplo, chaveiro ou encanador).
Campos | ||
---|---|---|
business_type |
Indica o |
|
Campo de união coverageArea . Indica a área de cobertura em que a empresa oferece serviços. coverageArea pode ser apenas de um dos tipos a seguir: |
||
radius |
Apenas saída. A área que essa empresa atende centrada em torno de um ponto. |
|
places |
A área que essa empresa atende, definida por um conjunto de lugares. |
BusinessType
Indica se a empresa só oferece serviços no local no local do cliente (por exemplo, um caminhão) ou no local e no local (por exemplo, uma pizzaria com área de refeições que também faz entregas).
Enums | |
---|---|
BUSINESS_TYPE_UNSPECIFIED |
Apenas saída. Não especificado. |
CUSTOMER_LOCATION_ONLY |
Oferece serviço apenas nas proximidades (não no endereço comercial). |
CUSTOMER_AND_BUSINESS_LOCATION |
Oferece serviço no endereço comercial e nos arredores. |
ServiceBusinessContext
Dados adicionais para a verificação de empresas de serviços.
Campos | |
---|---|
address |
O endereço de verificação do local. Ele é usado para ativar mais opções de verificação ou para enviar um cartão-postal. |
ServiceList
Uma lista de serviços com um ou mais itens.
Campos | |
---|---|
name |
Obrigatório. Identificador do Google para este local no formato: |
service_items[] |
Itens de serviço contidos nesta lista de serviços. Os itens de serviço duplicados serão removidos automaticamente. |
ServiceItem
Uma mensagem que descreve um único item de serviço. Ele é usado para descrever o tipo de serviço que o comerciante oferece. Por exemplo, corte de cabelo pode ser um serviço.
Campos | ||
---|---|---|
is_offered |
Opcional. Este campo decide se o serviço de entrada é oferecido ou não pelo comerciante. |
|
price |
Opcional. Representa o preço monetário do item de serviço. Recomendamos que ocurrency_code e as unidades sejam definidos ao incluir um preço. |
|
Campo de união service_item_info . Um dos campos a seguir sempre deve ser definido. service_item_info pode ser apenas de um dos tipos a seguir: |
||
structured_service_item |
Este campo será definido com o caso de dados de serviços estruturados. |
|
free_form_service_item |
Este campo será definido para o caso de dados de serviços em formato livre. |
FreeFormServiceItem
Representa um serviço de formato livre oferecido pelo comerciante. Esses são serviços que não são expostos como parte dos nossos dados de serviço de estrutura. O comerciante insere manualmente os nomes desses serviços na plataforma do comerciante geográfico.
Campos | |
---|---|
category_id |
Obrigatório. |
label |
Obrigatório. Rótulos com tags de idioma para o item. Recomendamos que os nomes dos itens tenham até 140 caracteres e as descrições até 250 caracteres. Este campo só deverá ser definido se a entrada for um item de serviço personalizado. Os tipos de serviço padronizados precisam ser atualizados com service_type_id. |
StructuredServiceItem
Representa um serviço estruturado oferecido pelo comerciante. Por exemplo: instalação_de_sanitário.
Campos | |
---|---|
service_type_id |
Obrigatório. O campo |
description |
Opcional. Descrição do item de serviço estruturado. O limite de caracteres é de 300. |
ServiceType
Uma mensagem descrevendo um tipo de serviço que a empresa oferece.
Campos | |
---|---|
service_type_id |
Apenas saída. Um ID estável (fornecido pelo Google) para esse tipo de serviço. |
display_name |
Apenas saída. O nome de exibição legível para o tipo de serviço. |
SpecialHourPeriod
Representa um único período em que o horário de funcionamento de um local é diferente do horário comercial normal. Um período de horário de funcionamento especial precisa representar um intervalo de menos de 24 horas. A open_time
e a start_date
precisam anteceder a close_time
e a end_date
. close_time
e end_date
podem ser estendidos para 23h59 do dia seguinte ao start_date
especificado. Por exemplo, as entradas a seguir são válidas:
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
As entradas a seguir não são válidas:
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
Campos | |
---|---|
start_date |
A data do calendário em que esse período de horário de funcionamento especial começa. |
open_time |
O tempo decorrido em |
end_date |
A data do calendário em que esse período de horário de funcionamento especial termina. Se o campo |
close_time |
O tempo decorrido em |
is_closed |
Se verdadeiro, |
SpecialHours
Representa um conjunto de períodos em que o horário de funcionamento de um local é diferente do horário comercial normal.
Campos | |
---|---|
special_hour_periods[] |
Uma lista de exceções para o horário de funcionamento da empresa. |
Pimenta
O nível de pimenta de um prato.
Enums | |
---|---|
SPICINESS_UNSPECIFIED |
Nível não especificado |
MILD |
Denoção de tempero moderado. |
MEDIUM |
Denoção de temperado médio. |
HOT |
Denoção de picante quente. O nível mais picante. |
StartUploadMediaItemDataRequest
Mensagem de solicitação para Media.StartUploadMediaItemData.
Campos | |
---|---|
parent |
O nome do recurso do local ao qual este item de mídia será adicionado. |
TimeInterval
Um intervalo de tempo, inclusivo. Ele precisa conter todos os campos para ser válido.
Campos | |
---|---|
start_date |
A data de início deste período. |
start_time |
É o horário de início deste período. |
end_date |
A data de término deste período. |
end_time |
O horário de término deste período. |
TimePeriod
Representa um período em que a empresa está aberta, começando no dia/horário de abertura especificado e fechando no dia/horário de fechamento especificado. O horário de fechamento precisa ser posterior ao horário de abertura, por exemplo, mais tarde no mesmo dia ou em um dia subsequente.
Campos | |
---|---|
open_day |
Indica o |
open_time |
Hora no formato estendido de 24h ISO 8601 (hh:mm). Os valores válidos são 00h00-24h00, em que 24h00 representa a meia-noite no fim do campo do dia especificado. |
close_day |
Indica o |
close_time |
Hora no formato estendido de 24h ISO 8601 (hh:mm). Os valores válidos são 00h00-24h00, em que 24h00 representa a meia-noite no fim do campo do dia especificado. |
TimeRange
Um intervalo de tempo. Os dados serão obtidos no intervalo como um inverval semiaberto (ou seja, [start_time, end_time)).
Campos | |
---|---|
start_time |
Carimbo de data/hora da época para o início do intervalo (inclusivo). |
end_time |
Carimbo de data/hora da época para o fim do intervalo (exclusivo). |
TransferLocationRequest
Mensagem de solicitação para Locations.TransferLocation.
Campos | |
---|---|
name |
O nome do local a ser transferido. |
to_account |
Nome do recurso da conta para onde o local será transferido (por exemplo, "accounts/8675309"). |
UpdateAccountAdminRequest
Mensagem de solicitação para AccessControl.UpdateAccountAdmin.
Campos | |
---|---|
name |
O nome do recurso do administrador a ser atualizado. |
admin |
O administrador atualizado. Observação: o único campo editável é |
UpdateAccountRequest
Mensagem de solicitação para accounts.UpdateAccount.
Campos | |
---|---|
name |
Nome da conta a ser atualizada. |
account |
As informações da conta atualizadas. Observação: o único campo editável é |
validate_only |
Se for verdadeiro, a solicitação será validada sem realmente atualizar a conta. |
UpdateFoodMenusRequest
Solicitar mensagem para FoodMenu.UpdateFoodMenus
Campos | |
---|---|
food_menus |
Obrigatório. As informações atualizadas do cardápio. O menu pode ser desfeito ao atualizar sem nenhuma seção do menu. |
update_mask |
Opcional. Os campos específicos que serão atualizados. Se nenhuma máscara for especificada, isso será tratado como uma atualização completa, e todos os campos serão definidos com os valores transmitidos, o que pode incluir a remoção da configuração de campos vazios na solicitação. Itens de campo repetidos não podem ser atualizados individualmente. Observação: o "name" de FoodMenus é o identificador de recurso que não é atualizável. |
UpdateHealthProviderAttributesRequest
Mensagem de solicitação para HealthProviderAttributes.UpdateHealthProviderAttributes.
Campos | |
---|---|
health_provider_attributes |
Obrigatório. Os atributos do provedor de saúde atualizados. |
update_mask |
Opcional. Os campos específicos que serão atualizados. Se nenhuma máscara for especificada, isso será tratado como uma atualização completa, e todos os campos serão definidos com os valores transmitidos, o que pode incluir a remoção da configuração de campos vazios na solicitação. Na V1, há apenas o campo seguro_networks a ser atualizado. Mais atributos serão compatíveis posteriormente. |
UpdateLocalPostRequest
Mensagem de solicitação para UpdateLocalPost.
Campos | |
---|---|
name |
O nome da postagem local a ser atualizada. |
local_post |
As informações atualizadas da postagem local. |
update_mask |
Os campos específicos que serão atualizados. É necessário especificar cada campo que está sendo atualizado na máscara. |
UpdateLocationAdminRequest
Mensagem de solicitação para AccessControl.UpdateLocationAdmin.
Campos | |
---|---|
name |
O nome do recurso do administrador a ser atualizado. |
admin |
O administrador atualizado. Observação: o único campo editável é |
UpdateLocationRequest
Mensagem de solicitação para locations.UpdateLocation.
Campos | |
---|---|
name |
O nome do local a ser atualizado. |
location |
As informações de local atualizadas. |
update_mask |
Os campos específicos que serão atualizados. Se nenhuma máscara for especificada, isso será tratado como uma atualização completa, e todos os campos serão definidos com os valores transmitidos, o que pode incluir a remoção da configuração de campos vazios na solicitação. |
validate_only |
Se verdadeiro, a solicitação é validada sem realmente atualizar o local. |
attribute_mask |
Os IDs dos atributos a serem atualizados. Somente os atributos indicados na máscara serão atualizados. Se um atributo estiver presente na máscara e não no local, ele será removido. Uma máscara vazia vai atualizar todos os atributos. Sempre que esse campo for definido, update_mask deve incluir atributos como um dos campos a serem atualizados. |
UpdateMediaItemRequest
Mensagem de solicitação para Media.UpdateMediaItem.
Campos | |
---|---|
name |
O nome do item de mídia a ser atualizado. |
media_item |
O item de mídia a ser atualizado. Somente a categoria ou o código do item da lista de preços pode ser atualizado. |
update_mask |
Os campos específicos que serão atualizados. Se nenhuma máscara for especificada, isso será tratado como uma atualização completa, e todos os campos editáveis serão definidos para os valores transmitidos. |
UpdateNotificationsRequest
Mensagem de solicitação para "Accounts.UpdateNotifications".
Campos | |
---|---|
name |
Nome do recurso de configurações de notificação. |
notifications |
As configurações de notificação atualizadas. |
UpdateQuestionRequest
Mensagem de solicitação para QuestionsAndAnswers.UpdateQuestion
Campos | |
---|---|
name |
O nome da pergunta a ser atualizada. |
question |
A pergunta atualizada. |
UpdateReviewReplyRequest
Mensagem de solicitação para Reviews.UpdateReviewReply.
Campos | |
---|---|
name |
O nome da avaliação a ser respondida. |
review_reply |
A resposta à avaliação. Se já houver uma resposta, a antiga será substituída. |
UpdateServiceListRequest
Mensagem de solicitação de atualização da lista de serviços.
Campos | |
---|---|
service_list |
Opcional. As informações atualizadas da lista de serviços. Se esse campo ficar vazio, a API vai excluir a ServiceList. Se uma ServiceList estiver definida, a API substituirá a ServiceList original pela definida. |
update_mask |
Opcional. Os campos específicos que serão atualizados. Se nenhuma máscara for especificada, isso será tratado como uma atualização completa, e todos os campos serão definidos com os valores transmitidos, o que pode incluir a remoção da configuração de campos vazios na solicitação. Itens de campo repetidos não podem ser atualizados individualmente. |
UpsertAnswerRequest
Mensagem de solicitação para QuestionsAndAnswers.UpsertAnswer
Campos | |
---|---|
parent |
O nome da pergunta para a qual escrever uma resposta. |
answer |
A nova resposta. |
UrlAttributeValue
Valores de um atributo com um value_type
de URL.
Campos | |
---|---|
url |
O URL. |
ValidationError
Descreve falhas de validação em uma solicitação do cliente.
Campos | |
---|---|
error_details[] |
Detalha falhas de validação individuais com códigos de erro de números inteiros. |
Verificação
Uma verificação representa uma tentativa de verificação de um local.
Campos | |
---|---|
name |
Nome do recurso da verificação. |
method |
Método da verificação. |
state |
O estado da verificação. |
create_time |
A data e hora em que a verificação é solicitada. |
VerificationState
Todos os estados de verificação possíveis.
Enums | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
O valor padrão resultará em erros. |
PENDING |
A verificação está pendente. |
COMPLETED |
A verificação foi concluída. |
FAILED |
Falha na verificação. |
VerificationMethod
Especifica os processos usados pelo Google para verificar um local.
Enums | |
---|---|
VERIFICATION_METHOD_UNSPECIFIED |
O valor padrão resultará em erros. |
ADDRESS |
Envie um cartão postal com um PIN de verificação para um endereço de correspondência específico. O PIN é usado para concluir a verificação com o Google. |
EMAIL |
Enviar um e-mail com um PIN de verificação para um endereço de e-mail específico. O PIN é usado para concluir a verificação com o Google. |
PHONE_CALL |
Fazer uma chamada telefônica com um PIN de verificação para um número de telefone específico. O PIN é usado para concluir a verificação com o Google. |
SMS |
Enviar um SMS com um PIN de verificação para um número de telefone específico. O PIN é usado para concluir a verificação com o Google. |
AUTO |
Verifique o local sem qualquer outra ação do usuário. Essa opção não está disponível para todos os locais. |
VerificationOption
Essa opção indica como verificar o local (indicado pelo método de verificação) e para onde a verificação será enviada (indicada pelos dados de exibição).
Campos | ||
---|---|---|
verification_method |
Método para verificar o local. |
|
Campo de união DisplayData . Um dos dados de exibição. Os dados precisam corresponder ao método. Vai ser vazio se o método correspondente não tiver dados de exibição. DisplayData pode ser apenas de um dos tipos a seguir: |
||
phone_data |
Definir apenas se o método for PHONE_CALL ou SMS. |
|
address_data |
Defina apenas se o método for MAIL. |
|
email_data |
Defina apenas se o método for EMAIL. |
AddressVerificationData
Exiba dados para verificações por cartão-postal.
Campos | |
---|---|
business_name |
Nome da empresa do comerciante. |
address |
Endereço para o qual um cartão-postal pode ser enviado. |
EmailVerificationData
Mostrar dados para verificações por e-mail.
Campos | |
---|---|
domain_name |
Nome de domínio no endereço de e-mail, por exemplo, "gmail.com" em foo@gmail.com |
user_name |
Nome de usuário no endereço de e-mail, por exemplo, "foo" em foo@gmail.com |
is_user_name_editable |
Se o cliente tem permissão para fornecer um nome de usuário diferente. |
PhoneVerificationData
Dados de exibição para verificações por telefone, por exemplo, ligação, SMS.
Campos | |
---|---|
phone_number |
Número de telefone para o qual o PIN será enviado. |
VerifyLocationRequest
Mensagem de solicitação para Verifications.VerifyLocation.
Campos | ||
---|---|---|
name |
Nome de recurso do local a ser verificado. |
|
method |
Método de verificação. |
|
language_code |
O código BCP 47 que representa o idioma a ser usado no processo de verificação. |
|
context |
Informações de contexto extra para a verificação de empresas de serviços. Obrigatório para os locais cujo tipo de empresa é CUSTOMER_LOCATION_SOMENTE. Para a verificação de ADDRESS, o endereço será usado para enviar o cartão-postal. Para outros métodos, ele precisa ser igual ao transmitido para FetchVerifyOptions. INVALID_ ARGUMENT será gerado se estiver definido para outros tipos de locais da empresa. |
|
Campo de união RequestData . Dados de entrada do usuário para um método específico, além dos dados de exibição. Os dados precisam corresponder ao método solicitado. Deixe em branco se nenhum dado for necessário. RequestData pode ser apenas de um dos tipos a seguir: |
||
email_input |
A entrada para o método EMAIL. |
|
address_input |
A entrada para o método ADDRESS. |
|
phone_input |
A entrada para o método PHONE_CALL/SMS |
VerifyLocationResponse
Mensagem de resposta para Verifications.VerifyLocation.
Campos | |
---|---|
verification |
A solicitação de verificação criada. |