REST Resource: accounts.locations

Recurso: local

Um local. Consulte o artigo da Central de Ajuda para uma descrição detalhada desses campos ou o endpoint de categoria para 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

Identificador. O identificador do Google para este 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. Identificador externo desse local, que precisa ser exclusivo em uma determinada conta. Esse é um meio de associar o local aos seus registros.
title

string

Obrigatório. O nome do local precisa refletir o nome real da empresa usado de forma consistente na vitrine, no site e em itens de papelaria, e que os clientes conhecem. Qualquer informação adicional, quando relevante, pode ser incluída em outros campos do recurso (por exemplo, Address, Categories). Não adicione informações desnecessárias ao nome (por exemplo, prefira "Google" em vez de "Google Inc. - Mountain View Corporate Headquarters"). Não inclua slogans de marketing, códigos de loja, caracteres especiais, horário de funcionamento ou status de fechado/aberto, números de telefone, URLs de sites, informações de serviços/produtos, local/endereço ou rotas, nem informações de contenção (por exemplo, "Caixa eletrônico do Chase no Duane Reade").
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. Use um endereço exato e preciso para descrever o local da sua empresa. Caixas postais ou de correspondência localizadas em lugares remotos não são aceitáveis. No momento, você pode especificar no máximo cinco valores de 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. Se for definido, qualquer valor fornecido será descartado.
websiteUri

string

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

object (BusinessHours)

Opcional. Horário de funcionamento da empresa.
specialHours

object (SpecialHours)

Opcional. Horário de funcionamento especial da empresa. Normalmente inclui o horário de funcionamento em feriados e outros horários fora do horário de funcionamento normal. Eles substituem o horário de funcionamento regular. Este campo não pode ser definido sem o horário normal.
serviceArea

object (ServiceAreaBusiness)

Opcional. As empresas de serviço local atuam no local do cliente. Se a empresa for de serviço local, este campo descreverá as áreas atendidas por ela.
labels[]

string

Opcional. Uma coleção de strings de formato livre para que você adicione tags à sua empresa. Essas etiquetas NÃO são voltadas para o usuário e só podem ser vistas por você. Precisa ter entre 1 e 255 caracteres por rótulo.
adWordsLocationExtensions

object (AdWordsLocationExtensions)

Opcional. Informações adicionais exibidas no Google AdWords.
latlng

object (LatLng)

Opcional. Latitude e longitude fornecidas pelo usuário. Ao criar um local, este campo será ignorado se o endereço informado for geocodificado com sucesso. Este campo só será retornado em solicitações GET se o valor latlng informado pelo usuário for aceito durante a criação ou se o valor latlng tiver sido atualizado pelo 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 e compartilha com os usuários o diferencial do seu negócio e das suas ofertas.

Esse campo é obrigatório para todas as categorias, exceto as de hospedagem (por exemplo, hotéis, motéis, 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 corte de cabelo, instalação de 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, os dois campos precisam ser definidos. Os clientes não podem atualizar apenas os números de telefone principal 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. Use um número de telefone local em vez do número de uma central de atendimento sempre que possível.
additionalPhones[]

string

Opcional. Além do número principal, sua empresa pode receber chamadas em mais duas linhas (de telefone celular ou fixo, exceto fax).

Categorias

Uma coleção de categorias que descreve a empresa. Durante as atualizações, os dois campos precisam ser definidos. Os clientes não podem 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 os negócios principais do local.
additionalCategories[]

object (Category)

Opcional. As categorias adicionais para descrever sua empresa. As categorias ajudam seus clientes a encontrar resultados exatos e específicos para os serviços em que têm interesse. Para manter as informações da sua empresa corretas e atualizadas, use o menor número possível de categorias para descrever seu negócio principal. Escolha categorias o mais específicas possíveis, mas que representem seu negócio principal.

Categoria

Uma categoria que descreve essa 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.

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 essa categoria. O valor precisa ser especificado ao modificar a categoria (ao criar ou atualizar um local).
displayName

string

Apenas saída. Nome legível por humanos da categoria. É 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. Tipos de horários de funcionamento adicionais disponíveis para essa categoria de negócios.

ServiceType

Uma mensagem que descreve um tipo de serviço oferecido pela empresa.

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 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.
displayName

string

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

string

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

PostalAddress

Representa um endereço postal, como para entrega postal ou endereços de pagamento. Com um endereço postal, um serviço postal pode entregar itens em um local, caixa postal ou similar. Um endereço postal não se destina a modelar localizações geográficas, como estradas, cidades ou montanhas.

No uso típico, um endereço é criado pela entrada do usuário ou pela importação de dados, dependendo do tipo de processo.

Conselhos sobre como inserir ou editar endereços:

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

Para mais orientações sobre como usar esse 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 do esquema de 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. Consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para mais detalhes. 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, quando usados, eles podem acionar uma validação adicional com outras partes do endereço (por exemplo, validação de estado ou CEP nos Estados Unidos).
sortingCode

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Quando usado, o valor é uma string como "CEDEX", opcionalmente seguida por um número (por exemplo, "CEDEX 7"), ou apenas um número, que representa o "código do setor" (Jamaica), o "indicador de área de entrega" (Malawi) ou o "indicador de agência postal" (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. Para a Espanha, é a província, e não a comunidade autônoma (por exemplo, "Barcelona", e não "Catalunha"). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, esse campo deve ser deixado em branco.
locality

string

Opcional. Geralmente se refere à cidade do endereço. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões do mundo com localizações que não são bem definidas ou que não se encaixam nessa estrutura, deixe locality vazio e use addressLines.
sublocality

string

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

string

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

Como os valores em addressLines não têm informações de tipo e, às vezes, podem conter vários valores em um único campo (por exemplo, "Austin, TX"), é importante que a ordem das linhas seja clara. A ordem das linhas de endereço precisa ser a "ordem do envelope" para o país ou região do endereço. Em lugares onde isso pode variar (por exemplo, no Japão), address_language é usado para deixar isso explícito (por exemplo, "ja" para ordenação do maior para o menor e "ja-Latn" ou "en" para ordenação do menor para o maior). Dessa 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 no 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 contenha apenas 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 político-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. Contém uma coleção de instâncias [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 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 terminando 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 seguinte.

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 esse 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 final do campo de dia especificado. Observação: no mapeamento JSON do Proto3, os valores zero padrão (00:00) são omitidos, produzindo {} para openTime.
closeDay

enum (DayOfWeek)

Obrigatório. Indica o day of the week em que esse 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 final do campo de dia especificado. Observação: no mapeamento JSON do Proto3, os valores zero padrão (00:00) são omitidos, produzindo {} para closeTime.

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 de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e, normalmente, menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

integer

Segundos de um minuto. Precisa ser maior ou igual a 0 e, normalmente, menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos, em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

SpecialHours

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

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

object (SpecialHourPeriod)

Obrigatório. Uma lista de exceções ao horário de funcionamento normal da empresa.

SpecialHourPeriod

Representa um único período em que o horário de funcionamento de um local é diferente do normal. Um período de horário de funcionamento especial precisa representar um intervalo de menos de 24 horas. openTime e startDate precisam ser anteriores a closeTime e endDate. O closeTime e o endDate podem se estender até as 11h59 do dia seguinte ao startDate especificado. 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 seguintes entradas 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 de 00:00 a 24:00, em que 24:00 representa a meia-noite no final do campo de 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, use como padrão 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, em que 24:00 representa a meia-noite no final do campo de dia especificado. Precisa ser especificado se closed for falso.
closed

boolean

Opcional. Se for verdadeiro, endDate, openTime e closeTime serão ignorados, e a data especificada em startDate será tratada como o local fechado o dia todo.

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 que atendem no local do cliente (por exemplo, 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 de serviço local.
places

object (Places)

Opcional. A área que essa empresa atende, definida por um conjunto de lugares.
regionCode

string

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

Este campo é obrigatório para empresas do tipo CUSTOMER_LOCATION_ONLY e é ignorado em outros casos.

A região especificada aqui pode ser diferente das regiões das áreas que essa empresa atende (por exemplo, empresas de serviço local que prestam serviços em regiões diferentes daquela em que estão localizadas).

Se esse local exigir verificação 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 precisa poder receber correspondência postal no endereço de verificação fornecido.

BusinessType

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

Tipos enumerados
BUSINESS_TYPE_UNSPECIFIED Apenas saída. Não especificado.
CUSTOMER_LOCATION_ONLY Oferece serviço apenas nas proximidades e 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 precisará incluir a máscara de campo storefrontAddress e definir o campo como vazio.
CUSTOMER_AND_BUSINESS_LOCATION Oferece serviço no endereço comercial e nos arredores.

Lugares

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

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

object (PlaceInfo)

Opcional. As áreas representadas por IDs de lugar. Limite 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. O ID do lugar. Precisa corresponder a uma região. (https://developers.google.com/places/web-service/supported_types#table3)

AdWordsLocationExtensions

Informações adicionais exibidas no Google AdWords.

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

string

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

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 seguir 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 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 ser de até um ano no futuro.

OpenForBusiness

Indica o status de um local.

Tipos enumerados
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,
  "isParticularlyPersonalPlace": 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 procurar as informações que precisam ser verificadas.
hasPendingEdits

boolean

Apenas saída. Indica se alguma das propriedades deste 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
(deprecated)

boolean

Apenas saída. Descontinuado: este campo não é mais preenchido e será removido em uma versão futura.
canModifyServiceList

boolean

Apenas saída. Indica se a ficha 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 este local aparecer no Google Maps, este campo será preenchido com o ID de lugar. Esse ID pode ser usado em diversas 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 que este local duplica.
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 do 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 o Voice of Merchant. Se esse booleano for falso, chame a API locations.getVoiceOfMerchantState para saber por que o comerciante não tem a Voice of Merchant.
isParticularlyPersonalPlace

boolean

Apenas saída. Indica se o local é classificado como um lugar excepcionalmente pessoal. Isso significa que há restrições nos recursos do Histórico de Localização. Se você acredita que houve um engano, consulte o artigo da Central de Ajuda.

Perfil

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

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

string

Obrigatório. Descrição do local com suas próprias palavras, não editável por mais 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)

Opcional. O local pai com que este local tem relações.
childrenLocations[]

object (RelevantLocation)

Opcional. A lista de locais filhos com que este local tem relações.
parentChain

string

Opcional. O nome do recurso da rede de que este local faz parte. [Como encontrar o ID da franquia] [Locations.SearchChains]

RelevantLocation

Informações sobre outro local relacionado ao local atual. A relação pode ser 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 pelo placeID.
relationType

enum (RelationType)

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

RelationType

As relações de tipo a serem especificadas.

Tipos enumerados
RELATION_TYPE_UNSPECIFIED Tipo não especificado.
DEPARTMENT_OF Isso representa uma relação entre dois locais que compartilham uma área física, a mesma marca/gerência/organização, mas com atributos principais diferentes, como horário de funcionamento ou números de telefone. Por exemplo, a Costco Pharmacy é um departamento da Costco Wholesale.
INDEPENDENT_ESTABLISHMENT_IN Isso representa os casos em que dois locais estão no mesmo espaço físico, mas pertencem a empresas diferentes (por exemplo, Starbucks em um Safeway, lojas em um shopping).

MoreHours

Os períodos em que um local está aberto para determinados tipos de negócios.

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

string

Obrigatório. Tipo de horário. Os clientes precisam chamar {#link businessCategories:BatchGet} para receber os tipos de horário disponíveis para as categorias dos locais.
periods[]

object (TimePeriod)

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.

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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "structuredServiceItem": {
    object (StructuredServiceItem)
  },
  "freeFormServiceItem": {
    object (FreeFormServiceItem)
  }
  // End of mutually exclusive fields.
}
Campos
price

object (Money)

Opcional. Representa o preço monetário do item de serviço. Recomendamos que currencyCode e units sejam definidos ao incluir um preço. Isso será tratado como um preço fixo para o item de serviço.
Um dos campos a seguir precisa estar sempre definido. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
structuredServiceItem

object (StructuredServiceItem)

Opcional. Esse campo será definido como caso de dados de serviços estruturados.
freeFormServiceItem

object (FreeFormServiceItem)

Opcional. Esse campo será definido no caso de dados de serviços de formato livre.
Fim dos campos mutuamente exclusivos.

StructuredServiceItem

Representa um serviço estruturado oferecido pelo comerciante. Por exemplo: toilet_installation.

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

string

Obrigatório. O campo serviceTypeId é um ID exclusivo fornecido pelo Google que pode ser encontrado em ServiceType. Essas informações são fornecidas pelo serviço 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 serviços não são expostos como parte dos nossos dados de serviço estruturados. O comerciante insere manualmente os nomes desses serviços usando uma superfície do geomerchant.

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 dela). category e serviceTypeId precisam corresponder às combinações possíveis 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 até 250 caracteres. Esse campo só deve ser definido se a entrada for um item de serviço personalizado. Os tipos de serviço padronizados precisam ser atualizados usando serviceTypeId.

Marcador

Rótulo a ser usado ao exibir a lista de preços, seção ou item.

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

string

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

string

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

string

Opcional. O código de idioma BCP-47 a que essas strings se aplicam. Somente um conjunto de rótulos pode ser definido 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", então 1 unidade vai 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 será positivo ou zero. Se units for zero, nanos poderá ser positivo, zero ou negativo. Se units for negativo, nanos 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.