Google My Business API

A API Google My Business oferece uma interface para gerenciar informações do local da empresa no Google.

Serviço: mybusiness.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações de API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://mybusiness.googleapis.com

Recurso REST: v4.accounts

Métodos
create
(deprecated)
POST /v4/accounts
Cria uma conta com o nome e o tipo especificados no pai informado.
deleteNotifications
(deprecated)
DELETE /v4/{name=accounts/*/notifications}
Limpa as configurações de notificação do Pub/Sub da conta.
generateAccountNumber
(deprecated)
POST /v4/{name=accounts/*}:generateAccountNumber
Gera um número de conta para essa conta.
get
(deprecated)
GET /v4/{name=accounts/*}
Extrai a conta especificada.
getNotifications
(deprecated)
GET /v4/{name=accounts/*/notifications}
Retorna as configurações de notificação do Pub/Sub da conta.
list
(deprecated)
GET /v4/accounts
Lista todas as contas do usuário autenticado.
listRecommendGoogleLocations GET /v4/{name=accounts/*}:recommendGoogleLocations
Lista todos os GoogleLocations que foram recomendados para a conta especificada do Perfil da Empresa.
update
(deprecated)
PUT /v4/{name=accounts/*}
Atualiza a conta do negócio especificada.
updateNotifications
(deprecated)
PUT /v4/{name=accounts/*/notifications}

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:

  • Novas avaliações para locais administrados pela conta.

Recurso REST: v4.accounts.admins

Métodos
create
(deprecated)
POST /v4/{parent=accounts/*}/admins
Convida o usuário especificado para se tornar um administrador da conta especificada.
delete
(deprecated)
DELETE /v4/{name=accounts/*/admins/*}
Remove o administrador especificado da conta especificada.
list
(deprecated)
GET /v4/{parent=accounts/*}/admins
Lista os administradores da conta especificada.
patch
(deprecated)
PATCH /v4/{name=accounts/*/admins/*}
Atualiza o administrador do administrador da conta especificado.

Recurso REST: v4.accounts.invitations

Métodos
accept
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:accept
Aceita o convite especificado.
decline
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:decline
Recusa o convite especificado.
list
(deprecated)
GET /v4/{parent=accounts/*}/invitations
Lista os convites pendentes da conta especificada.

Recurso REST: v4.accounts.locations

Métodos
associate POST /v4/{name=accounts/*/locations/*}:associate
Associa um local a um ID de lugar.
batchGet POST /v4/{name=accounts/*}/locations:batchGet
Extrai todos os locais especificados na conta especificada.
batchGetReviews POST /v4/{name=accounts/*}/locations:batchGetReviews
Retorna a lista paginada de avaliações de todos os locais especificados.
clearAssociation POST /v4/{name=accounts/*/locations/*}:clearAssociation
Limpa uma associação entre um local e o ID de lugar.
create POST /v4/{parent=accounts/*}/locations
Cria e retorna um novo location de propriedade da conta especificada.
delete DELETE /v4/{name=accounts/*/locations/*}
Exclui um local.
fetchVerificationOptions POST /v4/{name=accounts/*/locations/*}:fetchVerificationOptions
Informa todas as opções de verificação qualificadas para um local em um idioma específico.
findMatches POST /v4/{name=accounts/*/locations/*}:findMatches
Encontra todos os locais possíveis que correspondem ao local especificado.
get GET /v4/{name=accounts/*/locations/*}
Extrai o local especificado.
getFoodMenus GET /v4/{name=accounts/*/locations/*/foodMenus}
Retorna os cardápios de um local específico.
getGoogleUpdated GET /v4/{name=accounts/*/locations/*}:googleUpdated
Recebe a versão atualizada pelo Google do local especificado.
getHealthProviderAttributes GET /v4/{name=accounts/*/locations/*/healthProviderAttributes}
Retorna os atributos do provedor de saúde de um local específico.
getServiceList GET /v4/{name=accounts/*/locations/*/serviceList}
Acessa a lista de serviços especificada de um local.
list GET /v4/{parent=accounts/*}/locations
Lista os locais da conta especificada.
patch PATCH /v4/{name=accounts/*/locations/*}
Atualiza o local especificado.
reportInsights POST /v4/{name=accounts/*}/locations:reportInsights
Retorna um relatório que contém insights sobre uma ou mais métricas por local.
transfer
(deprecated)
POST /v4/{name=accounts/*/locations/*}:transfer
Move um local de uma conta do usuário para outra administrada pelo mesmo usuário.
updateFoodMenus PATCH /v4/{foodMenus.name=accounts/*/locations/*/foodMenus}
Atualiza os cardápios de um local específico.
updateHealthProviderAttributes PATCH /v4/{healthProviderAttributes.name=accounts/*/locations/*/healthProviderAttributes}
Atualiza os atributos do provedor de saúde de um local específico.
updateServiceList PATCH /v4/{serviceList.name=accounts/*/locations/*/serviceList}
Atualiza a lista de serviço especificada de um local.
verify POST /v4/{name=accounts/*/locations/*}:verify
Inicia o processo de verificação de um local.

Recurso REST: v4.accounts.locations.admins

Métodos
create
(deprecated)
POST /v4/{parent=accounts/*/locations/*}/admins
Convida o usuário especificado para se tornar um administrador do local especificado.
delete
(deprecated)
DELETE /v4/{name=accounts/*/locations/*/admins/*}
Remove o administrador especificado como administrador do local especificado.
list
(deprecated)
GET /v4/{parent=accounts/*/locations/*}/admins
Lista todos os administradores do local especificado.
patch
(deprecated)
PATCH /v4/{name=accounts/*/locations/*/admins/*}
Atualiza o administrador do administrador de local especificado.

Recurso REST: v4.accounts.locations.followers

Métodos
getMetadata GET /v4/{name=accounts/*/locations/*/followers/metadata}
Acessar as configurações de seguidores de um local.

Recurso da REST: v4.accounts.locations.insuranceNetworks

Métodos
list GET /v4/{parent=accounts/*/locations/*}/insuranceNetworks
Retorna uma lista de todas as redes de seguros aceitas pelo Google.

Recurso da REST: v4.accounts.locations.localPosts

Métodos
create POST /v4/{parent=accounts/*/locations/*}/localPosts
Cria uma nova postagem local associada ao local especificado e a retorna.
delete DELETE /v4/{name=accounts/*/locations/*/localPosts/*}
Exclui uma postagem local.
get GET /v4/{name=accounts/*/locations/*/localPosts/*}
Extrai a postagem local especificada.
list GET /v4/{parent=accounts/*/locations/*}/localPosts
Retorna uma lista de postagens locais associadas a um local.
patch PATCH /v4/{name=accounts/*/locations/*/localPosts/*}
Atualiza a postagem local especificada e retorna a postagem local atualizada.
reportInsights POST /v4/{name=accounts/*/locations/*}/localPosts:reportInsights
Retorna insights para um conjunto de postagens locais associadas a uma única página de detalhes.

Recurso REST: v4.accounts.locations.media

Métodos
create POST /v4/{parent=accounts/*/locations/*}/media
Cria um novo item de mídia para o local.
delete DELETE /v4/{name=accounts/*/locations/*/media/*}
Exclui o item de mídia especificado.
get GET /v4/{name=accounts/*/locations/*/media/*}
Retorna metadados para o item de mídia solicitado.
list GET /v4/{parent=accounts/*/locations/*}/media
Retorna uma lista de itens de mídia associados a um local.
patch PATCH /v4/{name=accounts/*/locations/*/media/*}
Atualiza os metadados do item de mídia especificado.
startUpload POST /v4/{parent=accounts/*/locations/*}/media:startUpload
Gera um MediaItemDataRef para upload de itens de mídia.

Recurso REST: v4.accounts.locations.media.customers

Métodos
get GET /v4/{name=accounts/*/locations/*/media/customers/*}
Retorna os metadados do item de mídia do cliente solicitado.
list GET /v4/{parent=accounts/*/locations/*}/media/customers
Retorna uma lista de itens de mídia associados a um local que foram enviados por clientes.

Recurso REST: v4.accounts.locations.questions

Métodos
create POST /v4/{parent=accounts/*/locations/*}/questions
Adiciona uma pergunta para o local especificado.
delete DELETE /v4/{name=accounts/*/locations/*/questions/*}
Exclui uma pergunta específica escrita pelo usuário atual.
list GET /v4/{parent=accounts/*/locations/*}/questions
Retorna a lista paginada de perguntas e algumas das respostas relacionadas a um local especificado.
patch PATCH /v4/{name=accounts/*/locations/*/questions/*}
Atualiza uma pergunta específica escrita pelo usuário atual.

Recurso REST: v4.accounts.locations.questions.answers

Métodos
delete DELETE /v4/{parent=accounts/*/locations/*/questions/*}/answers:delete
Exclui a resposta escrita pelo usuário atual a uma pergunta.
list GET /v4/{parent=accounts/*/locations/*/questions/*}/answers
Retorna a lista paginada de respostas de uma pergunta especificada.
upsert POST /v4/{parent=accounts/*/locations/*/questions/*}/answers:upsert
Cria uma resposta ou atualiza a resposta escrita pelo usuário para a pergunta especificada.

Recurso REST: v4.accounts.locations.reviews

Métodos
deleteReply DELETE /v4/{name=accounts/*/locations/*/reviews/*}/reply
Exclui a resposta à avaliação especificada.
get GET /v4/{name=accounts/*/locations/*/reviews/*}
Retorna a avaliação especificada.
list GET /v4/{parent=accounts/*/locations/*}/reviews
Retorna a lista paginada de avaliações do local especificado.
updateReply PUT /v4/{name=accounts/*/locations/*/reviews/*}/reply
Atualiza a resposta à avaliação especificada.

Recurso REST: v4.accounts.locations.verifications

Métodos
complete POST /v4/{name=accounts/*/locations/*/verifications/*}:complete
Conclua uma verificação de PENDING.
list GET /v4/{parent=accounts/*/locations/*}/verifications
Lista as verificações de um local, organizadas pelo horário de criação.

Recurso REST: v4.attributes

Métodos
list GET /v4/attributes
Retorna a lista de atributos que estariam disponíveis para um local com a categoria principal e o país especificados.

Recurso da REST: v4.categories

Métodos
batchGet GET /v4/categories:batchGet
Retorna uma lista de categorias de negócios para o idioma e os IDs de GConceitos fornecidos.
list GET /v4/categories
Retorna uma lista de categorias de negócios.

Recurso REST: v4.chains

Métodos
get GET /v4/{name=chains/*}
Recupera a cadeia especificada.
search GET /v4/chains:search
Pesquisa a rede com base no nome dela.

Recurso REST: v4.googleLocations

Métodos
report POST /v4/{name=googleLocations/*}:report
Denuncie uma GoogleLocation.
search POST /v4/googleLocations:search
Pesquisa todos os locais possíveis que correspondem à solicitação especificada.

Serviço: mybusiness.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações de API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://mybusiness.googleapis.com

Recurso REST: v1.media

Métodos
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Faz upload da mídia.