- Recurso: local
- Representação JSON
- BusinessHours
- TimePeriod
- DayOfWeek
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- BusinessType
- PointRadius
- LatLng
- Lugares
- PlaceInfo
- LocationKey
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- LocationState
- Atributo
- RepeatedEnumAttributeValue
- UrlAttributeValue
- Metadados
- Duplicado
- Acesso
- PriceList
- Rótulo
- Seção
- SectionType
- Item
- Dinheiro
- Perfil
- RelationshipData (em inglês)
- MoreHours
- Métodos
Recurso: 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.
Representação JSON | |
---|---|
{ "name": string, "languageCode": string, "storeCode": string, "locationName": string, "primaryPhone": string, "additionalPhones": [ string ], "address": { object ( |
Campos | |
---|---|
name |
Identificador do Google para este local no formato: No contexto de correspondências, este campo não será preenchido. |
languageCode |
O idioma do local. Definido durante a criação e não pode ser atualizado. |
storeCode |
Identificador externo desse local, que precisa ser exclusivo em uma determinada conta. Esse é um meio de associar o local aos seus próprios registros. |
locationName |
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, |
primaryPhone |
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. |
additionalPhones[] |
É 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 |
primaryCategory |
A categoria que melhor descreve a área de atuação principal do local. |
additionalCategories[] |
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. |
websiteUrl |
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. |
regularHours |
Horário de funcionamento da empresa. |
specialHours |
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. |
serviceArea |
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. |
locationKey |
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). |
adWordsLocationExtensions |
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 |
openInfo |
Uma sinalização que indica se o local está aberto no momento. |
locationState |
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. |
priceLists[] |
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. |
relationshipData |
Todos os locais e redes relacionados a este. |
moreHours[] |
Mais horários de funcionamento para diferentes departamentos ou clientes específicos de uma empresa. |
BusinessHours
Representa os períodos em que este local está aberto para negócios. Mantém uma coleção de instâncias TimePeriod
.
Representação JSON | |
---|---|
{
"periods": [
{
object ( |
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. |
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.
Representação JSON | |
---|---|
{ "openDay": enum ( |
Campos | |
---|---|
openDay |
Indica o |
openTime |
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. |
closeDay |
Indica o |
closeTime |
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. |
DayOfWeek
Representa um dia da semana.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
O dia da semana não é especificado. |
MONDAY |
Segunda-feira |
TUESDAY |
Terça-feira |
WEDNESDAY |
Quarta-feira |
THURSDAY |
quinta-feira |
FRIDAY |
Sexta-feira |
SATURDAY |
Sábado |
SUNDAY |
Domingo |
SpecialHours
Representa um conjunto de períodos em que o horário de funcionamento de um local é diferente do horário comercial normal.
Representação JSON | |
---|---|
{
"specialHourPeriods": [
{
object ( |
Campos | |
---|---|
specialHourPeriods[] |
Uma lista de exceções para o horário de funcionamento da empresa. |
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 openTime
e a startDate
precisam anteceder a closeTime
e a endDate
. closeTime
e endDate
podem ser estendidos para 23h59 do dia seguinte ao startDate
especificado. Por exemplo, as entradas a seguir são válidas:
startDate=2015-11-23, openTime=08:00, closeTime=18:00
startDate=2015-11-23, endDate=2015-11-23, openTime=08:00,
closeTime=18:00 startDate=2015-11-23, endDate=2015-11-24,
openTime=13:00, closeTime=11:59
As entradas a seguir não são válidas:
startDate=2015-11-23, openTime=13:00, closeTime=11:59
startDate=2015-11-23, endDate=2015-11-24, openTime=13:00,
closeTime=12:00 startDate=2015-11-23, endDate=2015-11-25,
openTime=08:00, closeTime=18:00
Representação JSON | |
---|---|
{ "startDate": { object ( |
Campos | |
---|---|
startDate |
A data do calendário em que esse período de horário de funcionamento especial começa. |
openTime |
O tempo decorrido em |
endDate |
A data do calendário em que esse período de horário de funcionamento especial termina. Se o campo |
closeTime |
O tempo decorrido em |
isClosed |
Se verdadeiro, |
ServiceAreaBusiness
Empresas de serviço local prestam serviços no local do cliente (por exemplo, chaveiro ou encanador).
Representação JSON | |
---|---|
{ "businessType": enum ( |
Campos | ||
---|---|---|
businessType |
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. |
PointRadius
Um raio em torno de um ponto específico (latitude/longitude).
Representação JSON | |
---|---|
{
"latlng": {
object ( |
Campos | |
---|---|
latlng |
A latitude/longitude que especifica o centro de uma área definida pelo raio. |
radiusKm |
A distância em quilômetros da área ao redor do ponto. |
LatLng
Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. A menos que especificado de outra forma, esse objeto precisa estar em conformidade com o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.
Representação JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Campos | |
---|---|
latitude |
A latitude em graus. Precisa estar no intervalo [-90,0, +90,0]. |
longitude |
A longitude em graus. Precisa estar no intervalo [-180,0, +180,0]. |
Places
Define a união de áreas representadas por um conjunto de lugares.
Representação JSON | |
---|---|
{
"placeInfos": [
{
object ( |
Campos | |
---|---|
placeInfos[] |
As áreas representadas por IDs de lugar. É limitado a 20 lugares. |
PlaceInfo
Define uma área representada por um ID de lugar.
Representação JSON | |
---|---|
{ "name": string, "placeId": string } |
Campos | |
---|---|
name |
O nome localizado do lugar. Por exemplo, |
placeId |
O ID do local. Precisa corresponder a uma region. |
LocationKey
Referências de chave alternativas para um local.
Representação JSON | |
---|---|
{ "plusPageId": string, "placeId": string, "explicitNoPlaceId": boolean, "requestId": string } |
Campos | |
---|---|
plusPageId |
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. |
placeId |
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 |
explicitNoPlaceId |
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. |
requestId |
Apenas saída. O |
AdWordsLocationExtensions
Informações adicionais exibidas no Google AdWords.
Representação JSON | |
---|---|
{ "adPhone": string } |
Campos | |
---|---|
adPhone |
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. |
OpenInfo
Informações relacionadas ao estado de abertura da empresa.
Representação JSON | |
---|---|
{ "status": enum ( |
Campos | |
---|---|
status |
Indica se o local está aberto. Todos os locais ficam abertos por padrão, a menos que sejam atualizados para fechados. |
canReopen |
Apenas saída. Indica se a empresa está qualificada para reabertura. |
openingDate |
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, locationState.is_publication = true). Ao atualizar o campo de status para esse valor, os clientes precisam definir updateMask explicitamente como openInfo.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. |
LocationState
Contém um conjunto de booleanos que refletem o estado de um local.
Representação JSON | |
---|---|
{ "isGoogleUpdated": boolean, "isDuplicate": boolean, "isSuspended": boolean, "canUpdate": boolean, "canDelete": boolean, "isVerified": boolean, "needsReverification": boolean, "isPendingReview": boolean, "isDisabled": boolean, "isPublished": boolean, "isDisconnected": boolean, "isLocalPostApiDisabled": boolean, "canModifyServiceList": boolean, "canHaveFoodMenus": boolean, "hasPendingEdits": boolean, "hasPendingVerification": boolean, "canOperateHealthData": boolean, "canOperateLodgingData": boolean } |
Campos | |
---|---|
isGoogleUpdated |
Apenas saída. Indica se o ID associado a esse local tem atualizações. |
isDuplicate |
Apenas saída. Indica se o local é uma cópia de outro. |
isSuspended |
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. |
canUpdate |
Apenas saída. Indica se o local pode ser atualizado. |
canDelete |
Apenas saída. Indica se o local pode ser excluído usando a API Google My Business. |
isVerified |
Apenas saída. Indica se o local foi verificado. |
needsReverification |
Apenas saída. Indica se o local requer uma nova verificação. |
isPendingReview |
Apenas saída. Indica se a revisão do local está pendente. |
isDisabled |
Apenas saída. Indica se o local está desativado. |
isPublished |
Apenas saída. Indica se o local foi publicado. |
isDisconnected |
Apenas saída. Indica se o local está desconectado de um lugar no Google Maps. |
isLocalPostApiDisabled |
Apenas saída. Indica se accounts.locations.localPosts está desativado para esse local. |
canModifyServiceList |
Apenas saída. Indica se a listagem pode modificar uma ServiceList. |
canHaveFoodMenus |
Apenas saída. Indica se o anúncio está qualificado para um cardápio de refeições. |
hasPendingEdits |
Apenas saída. Indica se alguma das propriedades desse local está no estado de edição pendente. |
hasPendingVerification |
Apenas saída. Indica se o local tem solicitações de verificação pendentes. |
canOperateHealthData |
Apenas saída. Indica se o local pode operar em dados de Saúde. |
canOperateLodgingData |
Apenas saída. Indica se o local pode operar em dados de hospedagem. |
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.
Representação JSON | |
---|---|
{ "attributeId": string, "valueType": enum ( |
Campos | |
---|---|
attributeId |
ID do atributo. Os IDs dos atributos são fornecidos pelo Google. |
valueType |
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. |
repeatedEnumValue |
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. |
urlValues[] |
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. |
RepeatedEnumAttributeValue
Valores de um atributo com um valueType
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.
Representação JSON | |
---|---|
{ "setValues": [ string ], "unsetValues": [ string ] } |
Campos | |
---|---|
setValues[] |
Valores de enumeração que são definidos. |
unsetValues[] |
Valores de enumeração que não são definidos. |
UrlAttributeValue
Valores de um atributo com um valueType
de URL.
Representação JSON | |
---|---|
{ "url": string } |
Campos | |
---|---|
url |
O URL. |
Metadados
Outras informações não editáveis pelo usuário sobre o local.
Representação JSON | |
---|---|
{
"duplicate": {
object ( |
Campos | |
---|---|
duplicate |
Informações sobre o local duplicado. Presente apenas quando |
mapsUrl |
Um link para o local no Maps. |
newReviewUrl |
Um link para a página na Pesquisa Google em que o cliente pode avaliar o local. |
Duplicar
Informações sobre o local duplicado.
Representação JSON | |
---|---|
{
"locationName": string,
"placeId": string,
"access": enum ( |
Campos | |
---|---|
locationName |
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. |
placeId |
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. |
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.
Representação JSON | |
---|---|
{ "priceListId": string, "labels": [ { object ( |
Campos | |
---|---|
priceListId |
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. |
sourceUrl |
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.
Representação JSON | |
---|---|
{ "displayName": string, "description": string, "languageCode": string } |
Campos | |
---|---|
displayName |
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. |
languageCode |
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.
Representação JSON | |
---|---|
{ "sectionId": string, "labels": [ { object ( |
Campos | |
---|---|
sectionId |
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. |
sectionType |
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. |
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. |
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.
Representação JSON | |
---|---|
{ "itemId": string, "labels": [ { object ( |
Campos | |
---|---|
itemId |
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. |
Dinheiro
Representa um montante em dinheiro com o respectivo tipo de moeda.
Representação JSON | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
Campos | |
---|---|
currencyCode |
Código de moeda de três letras definido no ISO 4217. |
units |
As unidades inteiras do montante. Por exemplo, se |
nanos |
Número de unidades nano (10^-9) do montante. É necessário que o valor fique entre -999.999.999 e +999.999.999 (inclusive os dois limites). Se |
Perfil
Todas as informações relacionadas ao perfil do local.
Representação JSON | |
---|---|
{ "description": string } |
Campos | |
---|---|
description |
Descrição do local com sua própria voz, não editável por outras pessoas. |
RelationshipData
Informações de todos os locais principais e secundários relacionados a este.
Representação JSON | |
---|---|
{ "parentChain": string } |
Campos | |
---|---|
parentChain |
O nome do recurso da rede de que esse local faz parte. |
MoreHours
Os períodos em que um local fica aberto para determinados tipos de empresa.
Representação JSON | |
---|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
Campos | |
---|---|
hoursTypeId |
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. |
Métodos |
|
---|---|
|
Associa um local a um ID de lugar. |
|
Mostra todos os locais especificados na conta especificada. |
|
Retorna a lista paginada de avaliações de todos os locais especificados. |
|
Limpa uma associação entre um local e seu ID de lugar. |
|
Cria e retorna um novo location da conta especificada. |
|
Exclui um local. |
|
Informa todas as opções de verificação qualificadas para um local em um idioma específico. |
|
Encontra todos os locais possíveis que correspondem ao local especificado. |
|
Recebe o local especificado. |
|
Retorna os cardápios de alimentos de um local específico. |
|
Recebe a versão atualizada pelo Google do local especificado. |
|
Retorna os atributos do provedor de saúde de um local específico. |
|
Acessa a lista de serviços especificada de um local. |
|
Lista os locais da conta especificada. |
|
Atualiza o local especificado. |
|
Retorna um relatório com insights sobre uma ou mais métricas por local. |
(deprecated) |
Move um local de uma conta do usuário para outra gerenciada pelo mesmo usuário. |
|
Atualiza os cardápios de um local específico. |
|
Atualiza os atributos do provedor de saúde de um local específico. |
|
Atualiza a lista de serviço especificada de um local. |
|
Inicia o processo de verificação de um local. |