REST Resource: accounts.locations

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 conferir uma lista de categorias de negócios válidas.

Representação JSON 
{
  "name": string,
  "languageCode": string,
  "storeCode": string,
  "title": string,
  "phoneNumbers": {
    object (PhoneNumbers)
  },
  "categories": {
    object (Categories)
  },
  "storefrontAddress": {
    object (PostalAddress)
  },
  "websiteUri": string,
  "regularHours": {
    object (BusinessHours)
  },
  "specialHours": {
    object (SpecialHours)
  },
  "serviceArea": {
    object (ServiceAreaBusiness)
  },
  "labels": [
    string
  ],
  "adWordsLocationExtensions": {
    object (AdWordsLocationExtensions)
  },
  "latlng": {
    object (LatLng)
  },
  "openInfo": {
    object (OpenInfo)
  },
  "metadata": {
    object (Metadata)
  },
  "profile": {
    object (Profile)
  },
  "relationshipData": {
    object (RelationshipData)
  },
  "moreHours": [
    {
      object (MoreHours)
    }
  ],
  "serviceItems": [
    {
      object (ServiceItem)
    }
  ]
}
Campos
name

string

O identificador do Google para esse local no formato: locations/{locationId}.
languageCode

string

Imutável. O idioma do local. Definido durante a criação e não atualizável.
storeCode

string

Opcional. O identificador externo desse local, que precisa ser exclusivo em uma determinada conta. Esse é um meio de associar o local aos seus próprios registros.
title

string

Obrigatório. O nome do local precisa refletir o nome real da sua empresa, conforme utilizado de maneira 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, Address, Categories). Não adicione informações desnecessárias ao seu nome (por exemplo, dê preferência a "Google" em vez de "Google LLC – Sede corporativa em Mountain View"). Não inclua slogans de marketing, códigos das lojas, caracteres especiais, horário de funcionamento ou status de fechamento/aberto, números de telefone, URLs de sites, informações sobre serviços/produtos, local/endereço ou rotas ou informações sobre contenção (por exemplo, "Caixa eletrônico Itaú da Ria de Vigo").
phoneNumbers

object (PhoneNumbers)

Opcional. Os diferentes números de telefone que os clientes podem usar para entrar em contato com a empresa.
categories

object (Categories)

Opcional. As diferentes categorias que descrevem a empresa.
storefrontAddress

object (PostalAddress)

Opcional. Um endereço preciso e correto para descrever o local da sua empresa. Caixas postais ou de correspondência localizadas em locais remotos não são aceitas. No momento, é possível especificar no máximo cinco valores addressLines no endereço. Esse campo só deve ser definido para empresas que têm uma loja física. Esse campo não deve ser definido para locais do tipo CUSTOMER_LOCATION_ONLY, mas se definido, qualquer valor fornecido será descartado.
websiteUri

string

Opcional. Um URL para esta empresa. Se possível, use um URL que represente esse local da empresa específico, em vez de um site/URL genérico que represente todos os locais ou a marca.
regularHours

object (BusinessHours)

Opcional. Horário de funcionamento da empresa.
specialHours

object (SpecialHours)

Opcional. Horário de funcionamento especial da empresa. Isso geralmente inclui o horário de funcionamento em feriados e outros horários fora do normal. Eles substituem o horário de funcionamento normal. Não é possível definir este campo sem o horário de funcionamento normal.
serviceArea

object (ServiceAreaBusiness)

Opcional. Empresas com área de cobertura fornecem seus serviços no local do cliente. Se a empresa for de serviço local, esse campo descreverá as áreas atendidas por ela.
labels[]

string

Opcional. Uma coleção de strings de formato livre para que você inclua tags na sua empresa. Esses marcadores NÃO são voltados para o usuário. que só você pode ver. Precisa ter entre 1 e 255 caracteres por rótulo.
adWordsLocationExtensions

object (AdWordsLocationExtensions)

Opcional. Informações adicionais que são exibidas no Google AdWords.
latlng

object (LatLng)

Opcional. Latitude e longitude fornecidas pelo usuário. Durante a criação de um local, este campo será ignorado se o endereço fornecido for geocodificado corretamente. Esse campo só será retornado em solicitações "get" se o valor de latlng fornecido pelo usuário tiver sido aceito durante a criação ou se o valor de latlng tiver sido atualizado no site do Perfil da Empresa no Google. Este campo só pode ser atualizado por clientes aprovados.
openInfo

object (OpenInfo)

Opcional. Uma sinalização que indica se o local está aberto para funcionamento.
metadata

object (Metadata)

Apenas saída. Outras informações não editáveis pelo usuário.
profile

object (Profile)

Opcional. Descreve sua empresa com sua própria voz e compartilha com os usuários a história exclusiva dela e de suas ofertas.

Este campo é obrigatório para todas as categorias, exceto as de hospedagem (por exemplo, hotéis, hotéis de estrada, pousadas).
relationshipData

object (RelationshipData)

Opcional. Todos os locais e redes relacionados a este.
moreHours[]

object (MoreHours)

Opcional. Mais horários de funcionamento para diferentes departamentos ou clientes específicos de uma empresa.
serviceItems[]

object (ServiceItem)

Opcional. Lista de serviços aceitos pelos comerciantes. Um serviço pode ser cortar cabelo, instalar aquecedor de água etc. Os itens de serviço duplicados serão removidos automaticamente.

PhoneNumbers

Uma coleção de números de telefone da empresa. Durante as atualizações, ambos os campos precisam ser definidos. Os clientes não podem atualizar apenas números de telefone principais ou adicionais usando a máscara de atualização. O formato de telefone internacional é preferível, como "+1 415 555 0132". Saiba mais em (https://developers.google.com/style/phone-numbers#international-phone-numbers).

Representação JSON 
{
  "primaryPhone": string,
  "additionalPhones": [
    string
  ]
}
Campos
primaryPhone

string

Obrigatório. 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[]

string

Opcional. É 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.

Categorias

Uma coleção de categorias que descreve a empresa. Durante as atualizações, ambos os campos precisam ser definidos. Os clientes estão proibidos de atualizar individualmente as categorias principais ou adicionais usando a máscara de atualização.

Representação JSON 
{
  "primaryCategory": {
    object (Category)
  },
  "additionalCategories": [
    {
      object (Category)
    }
  ]
}
Campos
primaryCategory

object (Category)

Obrigatório. A categoria que melhor descreve o negócio principal do local.
additionalCategories[]

object (Category)

Opcional. Categorias adicionais para descrever sua empresa. As categorias ajudam os clientes a encontrar resultados precisos e específicos para os serviços em que têm interesse. Para manter suas informações comerciais corretas 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.

Categoria

Uma categoria que descreve o que a empresa é (não o que ela faz). Para conferir uma lista de IDs de categoria válidos e os mapeamentos para os nomes legíveis por humanos, consulte categories.list.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "serviceTypes": [
    {
      object (ServiceType)
    }
  ],
  "moreHoursTypes": [
    {
      object (MoreHoursType)
    }
  ]
}
Campos
name

string

Obrigatório. Um ID estável (fornecido pelo Google) para esta categoria. O valor precisa ser especificado ao modificar a categoria (ao criar ou atualizar um local).
displayName

string

Apenas saída. O nome legível da categoria. Ele é definido na leitura do local. Ao modificar o local, category_id precisa ser definido.
serviceTypes[]

object (ServiceType)

Apenas saída. Uma lista de todos os tipos de serviço disponíveis para essa categoria de negócios.
moreHoursTypes[]

object (MoreHoursType)

Apenas saída. Mais tipos de horário de funcionamento disponíveis para essa categoria de negócios.

ServiceType

Uma mensagem que descreve um tipo de serviço que a empresa oferece.

Representação JSON 
{
  "serviceTypeId": string,
  "displayName": string
}
Campos
serviceTypeId

string

Apenas saída. Um ID estável (fornecido pelo Google) para esse tipo de serviço.
displayName

string

Apenas saída. O nome de exibição legível por humanos para o tipo de serviço.

MoreHoursType

Mais tipos de horário de funcionamento que uma empresa pode oferecer, além do horário de funcionamento normal.

Representação JSON 
{
  "hoursTypeId": string,
  "displayName": string,
  "localizedDisplayName": string
}
Campos
hoursTypeId

string

Apenas saída. Um ID estável fornecido pelo Google para esse tipo de horário de funcionamento.
displayName

string

Apenas saída. O nome de exibição legível em inglês para o tipo de horário.
localizedDisplayName

string

Apenas saída. O nome de exibição localizado legível para o tipo de horário de funcionamento.

PostalAddress

Representa um endereço postal, por exemplo, para endereços para pagamento ou distribuição postal. Com um endereço postal, o serviço de correios pode entregar itens em um local, uma caixa postal ou outro local semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).

No uso normal, um endereço seria criado por digitação do usuário ou pela importação de dados existentes, dependendo do tipo de processo.

Dicas sobre inserção / edição de endereços: - Use um widget de endereço pronto para internacionalização, como https://github.com/google/libaddressinput. - Os usuários não devem receber elementos da interface para entrada ou edição de campos fora dos países em que o campo é usado.

Para mais orientações sobre como usar este esquema, consulte: https://support.google.com/business/answer/6397478.

Representação JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

integer

A revisão de esquema do PostalAddress. Precisa ser definido como 0, que é a revisão mais recente.

Todas as novas revisões precisam ser compatíveis com versões anteriores.
regionCode

string

Obrigatório. Código de região CLDR do país/região do endereço. Nunca é inferido e cabe ao usuário garantir que o valor esteja correto. Para mais detalhes, consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça.
languageCode

string

Opcional. Código de idioma BCP-47 do conteúdo deste endereço (se conhecido). Costuma ser o idioma da IU do formulário de entrada ou espera-se que corresponda a um dos idiomas usados no país/região do endereço ou nos equivalentes transliterados dele. Pode afetar a formatação em determinados países, mas não é fundamental para a exatidão dos dados e nunca afetará a validação ou outras operações relacionadas à não formatação.

Se você não conhece o valor, omita-o (em vez de especificar um padrão possivelmente incorreto).

Exemplos: "zh-Hant", "ja", "ja-latn", "pt".
postalCode

string

Opcional. Código postal do endereço. Nem todos os países usam ou exigem códigos postais, mas nos locais onde são usados, eles podem desencadear uma validação adicional com outras partes do endereço (por exemplo, validação de estado/CEP nos EUA).
sortingCode

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Nos locais em que é usado, o valor é uma string como “CEDEX”, que pode ser seguida por um número (por exemplo, “CEDEX 7”), ou apenas um número sozinho, representando o “código do setor” (Jamaica), o “indicador de área de entrega” (Malawi) ou o “indicador de agência de correio” (por exemplo, Costa do Marfim).
administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Por exemplo, pode ser um estado, uma província, uma zona ou uma prefeitura. Especificamente na Espanha, é a província, e não a comunidade autônoma (por exemplo, “Barcelona”, não “Catalunha”). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, isso deve ser deixado em branco.
locality

string

Opcional. Geralmente se refere à parte do endereço relativa a cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões onde as localidades não são claramente definidas ou não se encaixam bem nessa estrutura, deixe a localidade em branco e use addressLines.
sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito.
addressLines[]

string

Linhas de endereço não estruturadas que descrevem os níveis mais detalhados de um endereço.

Como os valores em addressLines não têm informações de tipo e podem conter diversos valores em um único campo (por exemplo, “Austin, TX”), é importante que a ordem da linha seja clara. Ela precisa estar em “ordem de envelope” em país ou região do endereço. Em locais em que isso pode variar (por exemplo, Japão), address_language é usado para explicitar (por exemplo, "ja" para ordem do maior para o menor e "ja-Latn" ou "pt" para ordem do menor para o maior). Desta forma, a linha mais específica de um endereço pode ser selecionada com base no idioma.

A representação estrutural mínima permitida de um endereço consiste em um regionCode com todas as informações restantes colocadas em addressLines. Seria possível formatar esse endereço sem geocodificação, mas nenhum raciocínio semântico poderia ser feito sobre qualquer um dos componentes do endereço até que ele fosse pelo menos parcialmente resolvido.

Criar um endereço que apresente apenas um regionCode e addressLines e depois geocodificar é a maneira recomendada de lidar com endereços completamente não estruturados (em vez de adivinhar quais partes do endereço devem ser localidades ou áreas administrativas).
recipients[]

string

Opcional. O destinatário no endereço. Sob certas circunstâncias, este campo pode conter informações em várias linhas. Por exemplo, informações sobre cuidados.
organization

string

Opcional. O nome da organização no endereço.

BusinessHours

Representa os períodos em que esse local está aberto para negócios. Mantém um conjunto de instâncias de [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod].

Representação JSON 
{
  "periods": [
    {
      object (TimePeriod)
    }
  ]
}
Campos
periods[]

object (TimePeriod)

Obrigatório. Um conjunto de horários em que o local está aberto para negócios. Cada período representa um intervalo de horários em que o local fica aberto durante a semana.

TimePeriod

Representa um período em que a empresa fica 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 de abertura, por exemplo, mais tarde no mesmo dia ou em um dia subsequente.

Representação JSON 
{
  "openDay": enum (DayOfWeek),
  "openTime": {
    object (TimeOfDay)
  },
  "closeDay": enum (DayOfWeek),
  "closeTime": {
    object (TimeOfDay)
  }
}
Campos
openDay

enum (DayOfWeek)

Obrigatório. Indica o day of the week em que o período começa.
openTime

object (TimeOfDay)

Obrigatório. Os valores válidos são 00:00-24:00, em que 24:00 representa a meia-noite no fim do campo do dia especificado.
closeDay

enum (DayOfWeek)

Obrigatório. Indica o day of the week em que o período termina.
closeTime

object (TimeOfDay)

Obrigatório. Os valores válidos são 00:00-24:00, em que 24:00 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

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas do dia no formato de 24 horas. Precisa ser de 0 a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos da hora do dia. Precisa ser de 0 a 59.
seconds

integer

Segundos do minutos do horário. Normalmente precisa ser de 0 a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser de 0 a 999.999.999.

SpecialHours

Representa um conjunto de períodos em que o horário de funcionamento de um local difere do horário de funcionamento normal.

Representação JSON 
{
  "specialHourPeriods": [
    {
      object (SpecialHourPeriod)
    }
  ]
}
Campos
specialHourPeriods[]

object (SpecialHourPeriod)

Obrigatório. Uma lista de exceções ao 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 de funcionamento normal. Um período de horário de funcionamento especial precisa representar um intervalo inferior a 24 horas. openTime e startDate precisam ser anteriores a closeTime e endDate. closeTime e endDate podem se estender até 23h59 do dia seguinte à startDate especificada. Por exemplo, as seguintes entradas 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 (Date)
  },
  "openTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "closeTime": {
    object (TimeOfDay)
  },
  "closed": boolean
}
Campos
startDate

object (Date)

Obrigatório. A data do calendário em que esse período de horário de funcionamento especial começa.
openTime

object (TimeOfDay)

Opcional. Os valores válidos são 00:00-24:00, em que 24:00 representa a meia-noite no fim do campo do dia especificado. Precisa ser especificado se closed for falso.
endDate

object (Date)

Opcional. A data do calendário em que esse período de horário de funcionamento especial termina. Se o campo endDate não estiver definido, o padrão será a data especificada em startDate. Se definido, esse campo precisa ser igual ou no máximo um dia após startDate.
closeTime

object (TimeOfDay)

Opcional. Os valores válidos são 00:00-24:00, onde 24:00 representa a meia-noite no fim do campo do dia especificado. Precisa ser especificado se closed for falso.
closed

boolean

Opcional. Se verdadeiro, endDate, openTime e closeTime serão ignorados, e a data especificada na startDate será tratada como o local que ficará fechado o dia inteiro.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

ServiceAreaBusiness

Empresas com área de cobertura oferecem seus serviços no local do cliente (por exemplo, um chaveiro ou encanador).

Representação JSON 
{
  "businessType": enum (BusinessType),
  "places": {
    object (Places)
  },
  "regionCode": string
}
Campos
businessType

enum (BusinessType)

Obrigatório. Indica o [tipo] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType] da empresa que atende no local do cliente.
places

object (Places)

A área atendida pela empresa definida por um conjunto de lugares.
regionCode

string

Imutável. Código regional CLDR do país ou da região em que essa empresa de área de cobertura está localizada. Para mais detalhes, consulte http://cldr.unicode.org/ e http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça.

Este campo é obrigatório para empresas CUSTOMER_LOCATION_ONLY. Caso contrário, é ignorado.

A região especificada aqui pode ser diferente das regiões das áreas em que a empresa atua (por exemplo, empresas que prestam serviços em regiões diferentes daquela em que estão sediadas).

Se for necessário confirmar o local após a criação, o endereço fornecido para fins de verificação precisa estar localizado nessa região, e o proprietário da empresa ou o representante autorizado dele precisa receber correspondências no endereço de verificação fornecido.

BusinessType

Indica se a empresa oferece serviços apenas no local do cliente (por exemplo, um caminhão de reboque) ou no endereço e no local (por exemplo, uma pizzaria com área de refeições, que também faz entregas aos clientes).

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). Se uma empresa estiver sendo atualizada de CUSTOMER_AND_BUSINESS_LOCATION para CUSTOMER_LOCATION_ONLY, a atualização do local terá que incluir a máscara de campo storefrontAddress e deixar o campo vazio.
CUSTOMER_AND_BUSINESS_LOCATION Oferece serviço no endereço comercial e nos arredores.

Places

Define a união de áreas representadas por um conjunto de lugares.

Representação JSON 
{
  "placeInfos": [
    {
      object (PlaceInfo)
    }
  ]
}
Campos
placeInfos[]

object (PlaceInfo)

As áreas representadas por IDs de lugar. Limitado a um máximo de 20 lugares.

PlaceInfo

Define uma área representada por um ID de lugar.

Representação JSON 
{
  "placeName": string,
  "placeId": string
}
Campos
placeName

string

Obrigatório. O nome localizado do lugar. Por exemplo, Scottsdale, AZ.
placeId

string

Obrigatório. ID do local. Precisa corresponder a uma região. (https://developers.google.com/places/web-service/supported_types#table3)

AdWordsLocationExtensions

Informações adicionais que são exibidas no Google AdWords.

Representação JSON 
{
  "adPhone": string
}
Campos
adPhone

string

Obrigatório. Um número de telefone alternativo a ser exibido nas extensões de local do Google AdWords em vez do número de telefone principal do local.

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. Salvo indicação em contrário, 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

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

OpenInfo

Informações relacionadas ao estado de abertura da empresa.

Representação JSON 
{
  "status": enum (OpenForBusiness),
  "canReopen": boolean,
  "openingDate": {
    object (Date)
  }
}
Campos
status

enum (OpenForBusiness)

Obrigatório. Indica se o local está aberto. Todos os locais ficam abertos por padrão, a menos que sejam atualizados para estarem fechados.
canReopen

boolean

Apenas saída. Indica se a empresa está qualificada para reabertura.
openingDate

object (Date)

Opcional. 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 informados. A data precisa estar no passado ou não pode ser superior a 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.

Metadados

Outras informações não editáveis pelo usuário sobre o local.

Representação JSON 
{
  "hasGoogleUpdated": boolean,
  "hasPendingEdits": boolean,
  "canDelete": boolean,
  "canOperateLocalPost": boolean,
  "canModifyServiceList": boolean,
  "canHaveFoodMenus": boolean,
  "canOperateHealthData": boolean,
  "canOperateLodgingData": boolean,
  "placeId": string,
  "duplicateLocation": string,
  "mapsUri": string,
  "newReviewUri": string,
  "canHaveBusinessCalls": boolean,
  "hasVoiceOfMerchant": boolean
}
Campos
hasGoogleUpdated

boolean

Apenas saída. Indica se o ID de lugar associado a esse local tem atualizações que precisam ser atualizadas ou rejeitadas pelo cliente. Se esse booleano estiver definido, chame o método getGoogleUpdated para buscar as informações que precisam ser verificadas.
hasPendingEdits

boolean

Apenas saída. Indica se alguma das propriedades desse local está no estado de edição pendente.
canDelete

boolean

Apenas saída. Indica se o local pode ser excluído usando a API.
canOperateLocalPost

boolean

Apenas saída. Indica se a ficha da empresa pode gerenciar postagens locais.
canModifyServiceList

boolean

Apenas saída. Indica se a ficha da empresa pode modificar a lista de serviços.
canHaveFoodMenus

boolean

Apenas saída. Indica se a ficha da empresa está qualificada para o cardápio.
canOperateHealthData

boolean

Apenas saída. Indica se o local pode operar com dados de Saúde.
canOperateLodgingData

boolean

Apenas saída. Indica se o local pode operar com dados de hospedagem.
placeId

string

Apenas saída. Se esse local aparecer no Google Maps, esse campo será preenchido com o ID do local. Esse ID pode ser usado em várias APIs Places.

Este campo pode ser definido durante a criação de chamadas, mas não para a atualização.
duplicateLocation

string

Apenas saída. O recurso de local duplicado por esse local.
mapsUri

string

Apenas saída. Um link para o local no Maps.
newReviewUri

string

Apenas saída. Um link para a página na Pesquisa Google em que um cliente pode deixar uma avaliação sobre o local.
canHaveBusinessCalls

boolean

Apenas saída. Indica se a ficha da empresa está qualificada para ligações comerciais.
hasVoiceOfMerchant

boolean

Apenas saída. Indica se a ficha da empresa tem a voz do comerciante. Se o booleano for "false", chame a API locations.getVoiceOfMerchantState para saber detalhes sobre o motivo da ausência do Voice of Merchant.

Perfil

Todas as informações relacionadas ao perfil do local.

Representação JSON 
{
  "description": string
}
Campos
description

string

Obrigatório. A descrição do local em sua própria voz, não editável por ninguém.

RelationshipData

Informações de todos os locais principais e secundários relacionados a este.

Representação JSON 
{
  "parentLocation": {
    object (RelevantLocation)
  },
  "childrenLocations": [
    {
      object (RelevantLocation)
    }
  ],
  "parentChain": string
}
Campos
parentLocation

object (RelevantLocation)

O local pai com o qual esse local tem relações.
childrenLocations[]

object (RelevantLocation)

A lista de locais filhos relacionados ao local.
parentChain

string

O nome do recurso da rede a que este local pertence. [Como encontrar o ID da rede] [Locations.SearchChains]

RelevantLocation

Informações sobre outro local relacionado ao local atual. A relação pode ser qualquer um de DEPARTMENT_OF ou INDEPENDENT_ESTABLISHMENT_OF, e o local especificado aqui pode estar em qualquer lado (pai/filho) do local.

Representação JSON 
{
  "placeId": string,
  "relationType": enum (RelationType)
}
Campos
placeId

string

Obrigatório. Especifique o local que está do outro lado da relação com o ID de lugar.
relationType

enum (RelationType)

Obrigatório. O tipo da relação.

RelationType

As relações de tipo a serem especificadas.

Enums
RELATION_TYPE_UNSPECIFIED Tipo não especificado.
DEPARTMENT_OF Isso representa uma relação entre dois locais que compartilham uma área física, mesma marca/gestão superior/organização, mas com atributos-chave diferentes, como horário de funcionamento da loja ou números de telefone. Por exemplo, Farmácia Extra é um departamento da Franquia Nação Verde.
INDEPENDENT_ESTABLISHMENT_IN Isso representa os casos em que dois locais estão localizados no mesmo local físico, mas são de empresas diferentes (por exemplo, Starbucks em um Safeway, lojas em um shopping).

MoreHours

Período em que um local fica aberto para determinados tipos de empresa.

Representação JSON 
{
  "hoursTypeId": string,
  "periods": [
    {
      object (TimePeriod)
    }
  ]
}
Campos
hoursTypeId

string

Obrigatório. Tipo de horário de funcionamento. Os clientes devem chamar {#link businessCategories:BatchGet} para receber os tipos de horário de funcionamento aceitos nas categorias dos locais.
periods[]

object (TimePeriod)

Obrigatório. Um conjunto de horários em que este local está aberto. Cada período representa um intervalo de horários em que o local fica aberto durante a semana.

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.

Representação JSON 
{
  "price": {
    object (Money)
  },

  // Union field service_item_info can be only one of the following:
  "structuredServiceItem": {
    object (StructuredServiceItem)
  },
  "freeFormServiceItem": {
    object (FreeFormServiceItem)
  }
  // End of list of possible types for union field service_item_info.
}
Campos
price

object (Money)

Opcional. Representa o preço monetário do item de serviço. Recomendamos que o currencyCode e as unidades sejam definidos ao incluir um preço. Esse valor será tratado como um preço fixo do item de serviço.
Campo de união service_item_info. Um dos campos a seguir deve sempre ser definido. service_item_info pode ser apenas de um dos tipos a seguir:
structuredServiceItem

object (StructuredServiceItem)

Opcional. Este campo será definido como o caso dos dados de serviços estruturados.
freeFormServiceItem

object (FreeFormServiceItem)

Opcional. Este campo será definido como o caso dos dados de serviços de formato livre.

StructuredServiceItem

Representa um serviço estruturado oferecido pelo comerciante. Por exemplo: instalação_de_toilet.

Representação JSON 
{
  "serviceTypeId": string,
  "description": string
}
Campos
serviceTypeId

string

Obrigatório. O campo serviceTypeId é um ID exclusivo fornecido pelo Google e que pode ser encontrado em ServiceType. Essa informação é fornecida pelo serviço de RPC categories.batchGet.
description

string

Opcional. Descrição do item de serviço estruturado. O limite de caracteres é de 300.

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ços de estrutura. O comerciante insere manualmente os nomes desses serviços por meio de uma plataforma de geocomerciante.

Representação JSON 
{
  "category": string,
  "label": {
    object (Label)
  }
}
Campos
category

string

Obrigatório. Esse campo representa o nome da categoria (ou seja, o ID estável da categoria). category e serviceTypeId precisam corresponder às possíveis combinações fornecidas na mensagem Category.
label

object (Label)

Obrigatório. Rótulos com tag de idioma para o item. Recomendamos que os nomes dos itens tenham até 140 caracteres e as descrições, no máximo 250. Esse 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 serviceTypeId.

Rótulo

Rótulo a ser 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

string

Obrigatório. Nome de exibição da lista, seção ou item de preços.
description

string

Opcional. Descrição da lista de preços, seção ou item.
languageCode

string

Opcional. O código de idioma BCP-47 ao qual essas strings se aplicam. Só é possível definir um conjunto de rótulos por idioma.

Dinheiro

Representa um montante em dinheiro com o respectivo tipo de moeda.

Representação JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Campos
currencyCode

string

É o código de moeda de três letras definido no ISO 4217.
units

string (int64 format)

As unidades inteiras do montante. Por exemplo, se currencyCode for "USD", 1 unidade equivalerá a um dólar americano.
nanos

integer

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 units for positivo, nanos precisará ser positivo ou zero. Se units for zero, nanos poderá ser positivo, zero ou negativo. Se units for negativo, nanos precisará ser negativo ou zero. Por exemplo,US $-1,75 é representado como units=-1 e nanos=-750.000.000.

Métodos

create

 Cria um novo local que será de propriedade do usuário conectado.

list

 Lista os locais da conta especificada.