Package google.mybusiness.businessinformation.v1

Categorias que correspondem aos IDs do GConcept fornecidos na solicitação. Eles não virão na mesma ordem que os IDs de categoria na solicitação.

BusinessHours

Representa os períodos em que este local está aberto para negócios. Contém uma coleção de instâncias de [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod].

Campos

Campos
`periods[]`	`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.

periods[]

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.

Categorias

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

Campos

Campos
`primary_category`	`Category` Obrigatório. A categoria que melhor descreve a área de atuação principal do local.
`additional_categories[]`	`Category` Opcional. 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.

primary_category

Obrigatório. A categoria que melhor descreve a área de atuação principal do local.

additional_categories[]

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

Categoria

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

Campos
`name`	`string` Obrigatório. Um ID estável (fornecido pelo Google) para essa categoria. O valor deve ser especificado ao modificar a categoria (ao criar ou atualizar um local).
`display_name`	`string` Apenas saída. O nome legível da categoria. É definido durante a leitura do local. Ao modificar o local, `category_id` precisa ser definido.
`service_types[]`	`ServiceType` Apenas saída. Uma lista de todos os tipos de serviço disponíveis para essa categoria de negócios.
`more_hours_types[]`	`MoreHoursType` Apenas saída. Mais tipos de horário de funcionamento disponíveis para esta categoria de negócios.

CategoryView

Uma enumeração para ajudar a limitar a quantidade de dados retornados pelo servidor.

Enums
`CATEGORY_VIEW_UNSPECIFIED`	Não especificado, equivalente a CATEGORY_METADATA_SOMENTE.
`BASIC`	A resposta do servidor incluirá apenas os campos de categoria display_name, Category_id e language_code. Ele omite todos os campos relacionados a metadados do tipo de serviço.
`FULL`	Retorna todos os campos na resposta.

Cadeia

Uma rede é uma marca à qual os locais da sua empresa podem estar afiliados.

Campos
`name`	`string` Obrigatório. O nome do recurso da cadeia, no formato `chains/{chain_id}`.
`chain_names[]`	`ChainName` São os nomes da rede.
`websites[]`	`ChainUri` Sites da rede.
`location_count`	`int32` Número de locais que fazem parte dessa rede.

ChainName

Nome a ser usado ao mostrar a cadeia.

Campos

Campos
`display_name`	`string` O nome de exibição da cadeia.
`language_code`	`string` O código de idioma BCP 47 do nome.

display_name

string

O nome de exibição da cadeia.

language_code

string

O código de idioma BCP 47 do nome.

ChainUri

URL a ser usado ao mostrar a cadeia.

Campos

Campos
`uri`	`string` O URI desta cadeia.

uri

string

O URI desta cadeia.

CreateLocationRequest

A mensagem de solicitação para Locations.CreateLocation.

Campos
`parent`	`string` Obrigatório. O nome da conta em que o local será criado.
`location`	`Location` Obrigatório. Os novos metadados de local.
`validate_only`	`bool` Opcional. Se for verdadeiro, a solicitação será validada sem criar o local.
`request_id`	`string` Opcional. Um ID de solicitação exclusivo para o servidor detectar solicitações duplicadas. Recomendamos o uso de UUIDs. O comprimento máximo é de 50 caracteres.

DeleteLocationRequest

A mensagem de solicitação para Locations.DeleteLocation.

Campos

Campos
`name`	`string` Obrigatório. O nome do local a ser excluído.

name

string

Obrigatório. O nome do local a ser excluído.

ErrorCode

Todos os códigos de erro retornados pela API.

Enums
`ERROR_CODE_UNSPECIFIED`	Código do erro ausente.
`INVALID_ATTRIBUTE_NAME`	Um dos atributos fornecidos não pode ser aplicado a este local. Somente os atributos retornados na resposta `ListAttributeMetadata` podem ser aplicados a esse local. Todos os nomes de atributos problemáticos serão retornados na chave `attribute_names` em metadados.
`ASSOCIATE_OPERATION_ON_VERIFIED_LOCATION`	Esse erro é retornado quando um cliente tenta associar um local ou limpar uma associação de local em um local que está em estado verificado.
`ASSOCIATE_LOCATION_INVALID_PLACE_ID`	O `place_id` informado na solicitação `associateLocation` não corresponde ao local ou é inválido. Verifique se o `place_id` que está sendo definido corresponde a um dos IDs retornados na resposta `SearchGoogleLocations`.
`LAT_LNG_UPDATES_NOT_PERMITTED`	Este projeto não tem permissão para atualizar o campo "lat/lng" no local. Você pode atualizar a latitude/longitude usando a funcionalidade de fixar o alfinete na interface ou fornecer um endereço.
`PO_BOX_IN_ADDRESS_NOT_ALLOWED`	Não é possível usar a caixa postal no endereço. As chaves de metadados incluem "field_mask".
`BLOCKED_REGION`	Devido a sanções internacionais que devemos obedecer, não podemos aceitar empresas dessa região. As chaves de metadados incluem "field_maks".
`MISSING_BOTH_PHONE_AND_WEBSITE`	É necessário um telefone ou site para empresas de CUSTOMER_LOCATION_ apenas. As chaves de metadados incluem "field_mask".
`MISSING_STOREFRONT_ADDRESS_OR_SAB`	Todos os locais precisam ter pelo menos um endereço de loja ou uma área de cobertura. As chaves de metadados incluem "field_mask".
`LAT_LNG_TOO_FAR_FROM_ADDRESS`	O par de latitude/longitude e endereço estão muito distantes. As chaves de metadados incluem "field_mask".
`LAT_LNG_REQUIRED`	OBSOLETO. Substituído por PIN_DROP_REQUIRED. Não foi possível localizar o endereço especificado. Forneça uma latitude/longitude. As chaves de metadados incluem "field_mask".
`INVALID_CHARACTERS`	Foram encontrados caracteres inválidos. As chaves de metadados incluem "field_mask" e "invalid_characters".
`FORBIDDEN_WORDS`	Foram encontradas palavras proibidas. As chaves de metadados incluem "field_mask" e "forbidden_words".
`INVALID_INTERCHANGE_CHARACTERS`	Foram encontrados caracteres inválidos. As chaves de metadados incluem "field_mask".
`FIELDS_REQUIRED_FOR_CATEGORY`	Campos adicionais são obrigatórios para esta categoria de local. As chaves de metadados incluem "field_mask", "value" e "fields_required".
`STOREFRONT_REQUIRED_FOR_CATEGORY`	Sua categoria de negócios requer uma loja física que os clientes possam visitar. As chaves de metadados incluem "field_mask".
`ADDRESS_MISSING_REGION_CODE`	O endereço não tem o region_code obrigatório. As chaves de metadados incluem "field_mask".
`ADDRESS_EDIT_CHANGES_COUNTRY`	O endereço não pode ser movido para outro país. As chaves de metadados incluem "field_mask".
`SPECIAL_HOURS_SET_WITHOUT_REGULAR_HOURS`	O horário de funcionamento especial só pode ser especificado se o local tiver horário de funcionamento normal. Os metadados estão vazios.
`INVALID_TIME_SCHEDULE`	A programação de horário inválida, a hora sobreposta ou de término é anterior à hora de início. As chaves de metadados incluem "field_mask".
`INVALID_HOURS_VALUE`	Formato ou valor de horário inválido. As chaves de metadados incluem "field_mask".
`OVERLAPPED_SPECIAL_HOURS`	As horas especiais não podem se sobrepor. As chaves de metadados incluem "field_mask".
`INCOMPATIBLE_MORE_HOURS_TYPE_FOR_CATEGORY`	A categoria principal da sua empresa não é compatível com esse tipo de horário de funcionamento. As chaves de metadados incluem "field_mask" e "incompatible_hours_type".
`DUPLICATE_CHILDREN_LOCATIONS`	"child_locations" duplicado em inteiro_data. As chaves de metadados incluem "field_mask".
`INCOMPATIBLE_SERVICE_AREA_AND_CATEGORY`	Uma empresa de serviço local não pode ter a categoria principal selecionada. As chaves de metadados incluem "field_mask".
`INVALID_SERVICE_AREA_PLACE_ID`	Place_id inválido em service_area. As chaves de metadados incluem "field_mask" e "place_id".
`INVALID_AREA_TYPE_FOR_SERVICE_AREA`	Tipo de área inválido para service_area. As chaves de metadados incluem "field_mask" e "place_id".
`OPENING_DATE_TOO_FAR_IN_THE_FUTURE`	Insira uma data de abertura que não ultrapasse um ano a partir da data atual. As chaves de metadados incluem "field_mask".
`OPENING_DATE_MISSING_YEAR_OR_MONTH`	A data de abertura deve ter um ano ou um mês especificado. As chaves de metadados incluem "field_mask".
`OPENING_DATE_BEFORE_1AD`	A data de abertura não pode ser anterior a 1 d.C. As chaves de metadados incluem "field_mask".
`TOO_MANY_ENTRIES`	Há muitas entradas para o campo. As chaves de metadados incluem "field_mask" e "max_count".
`INVALID_PHONE_NUMBER`	A entrada do número de telefone não é reconhecida. As chaves de metadados incluem "field_mask" e "value".
`INVALID_PHONE_NUMBER_FOR_REGION`	Número de telefone inválido para a região. As chaves de metadados incluem "field_mask" e "value".
`MISSING_PRIMARY_PHONE_NUMBER`	Número de telefone principal ausente. As chaves de metadados incluem "field_mask".
`THROTTLED`	Não é possível atualizar o campo no momento. As chaves de metadados incluem "field_mask" e "value".
`UNSUPPORTED_POINT_RADIUS_SERVICE_AREA`	As áreas de cobertura com raio de ponto não são mais compatíveis. As chaves de metadados incluem "field_mask".
`INVALID_CATEGORY`	ID de categoria inválido. As chaves de metadados incluem "field_mask" e "value".
`CANNOT_REOPEN`	A empresa não pode ser reaberta. As chaves de metadados incluem "field_mask".
`INVALID_BUSINESS_OPENING_DATE`	A data de abertura da empresa é inválida. As chaves de metadados incluem "field_mask".
`INVALID_LATLNG`	A latitude/longitude é inválida. As chaves de metadados incluem "field_mask".
`PROFILE_DESCRIPTION_CONTAINS_URL`	A descrição da empresa não pode conter URL. As chaves de metadados incluem "field_mask".
`LODGING_CANNOT_EDIT_PROFILE_DESCRIPTION`	Não é possível editar a descrição do perfil do local da hospedagem. As chaves de metadados incluem "field_mask".
`INVALID_URL`	Link inválido. As chaves de metadados incluem "field_mask".
`INVALID_ADDRESS`	Endereço inválido. As chaves de metadados incluem "field_mask".
`PARENT_CHAIN_CANNOT_BE_THE_LOCATION_ITSELF`	ParentChain não pode ser o local em si. As chaves de metadados incluem "field_mask" e "value".
`RELATION_CANNOT_BE_THE_LOCATION_ITSELF`	A relação não pode ser o próprio local. As chaves de metadados incluem "field_mask" e "value".
`MISSING_ADDRESS_COMPONENTS`	Está faltando um valor para os componentes de endereço. As chaves de metadados incluem "field_mask".
`READ_ONLY_ADDRESS_COMPONENTS`	Não é possível editar componentes de endereço somente leitura. As chaves de metadados incluem "field_mask".
`STRING_TOO_LONG`	A string é muito longa. As chaves de metadados incluem "field_mask" e "max_length".
`STRING_TOO_SHORT`	A string é muito curta. As chaves de metadados incluem "field_mask" e "min_length".
`REQUIRED_FIELD_MISSING_VALUE`	Valor ausente para o campo obrigatório. As chaves de metadados incluem "field_mask".
`ATTRIBUTE_PROVIDER_URL_NOT_ALLOWED`	O URL de um provedor não pode ser adicionado ou editado. As chaves de metadados incluem "attribute_name".
`ATTRIBUTE_INVALID_ENUM_VALUE`	Valor desconhecido para o atributo enum. As chaves de metadados incluem "attribute_name".
`ATTRIBUTE_NOT_AVAILABLE`	Um atributo escalonável não é válido para este local. As chaves de metadados incluem ""attribute_name".
`ATTRIBUTE_CANNOT_BE_REPEATED`	O atributo escalonável só pode ser especificado uma vez. As chaves de metadados incluem "attribute_name".
`ATTRIBUTE_TYPE_NOT_COMPATIBLE_FOR_CATEGORY`	O atributo escalonável não é compatível com as categorias definidas no local. As chaves de metadados incluem "attribute_name".
`ADDRESS_REMOVAL_NOT_ALLOWED`	Sua empresa não pode remover o endereço. As chaves de metadados incluem "field_mask".
`AMBIGUOUS_TITLE`	O melhor nome é ambíguo para um idioma. As chaves de metadados incluem "field_mask".
`INVALID_CATEGORY_FOR_SAB`	Uma empresa que só atende no local do cliente não pode ter gcids que sejam subtipos de gcid:estabelecimentos_poi. As chaves de metadados incluem "field_mask" e "value".
`RELATION_ENDPOINTS_TOO_FAR`	Os endpoints de relação estão muito distantes uns dos outros. As chaves de metadados incluem "field_mask" e "value".
`INVALID_SERVICE_ITEM`	Nem estruturado_service_item nem free_form_service_item estão definidos. As chaves de metadados incluem "field_mask".
`SERVICE_ITEM_LABEL_NO_DISPLAY_NAME`	O rótulo não tem um nome de exibição. As chaves de metadados incluem "field_mask".
`SERVICE_ITEM_LABEL_DUPLICATE_DISPLAY_NAME`	O nome de exibição não é exclusivo para todos os rótulos nas listas de preços. As chaves de metadados incluem "field_mask".
`SERVICE_ITEM_LABEL_INVALID_UTF8`	O rótulo contém símbolos UTF-8 inválidos. As chaves de metadados incluem "field_mask".
`FREE_FORM_SERVICE_ITEM_WITH_NO_CATEGORY_ID`	Campo "category_id" ausente no free_form_service_item. As chaves de metadados incluem "field_mask".
`FREE_FORM_SERVICE_ITEM_WITH_NO_LABEL`	Rótulo ausente em free_form_service_item. As chaves de metadados incluem "field_mask".
`SERVICE_ITEM_WITH_NO_SERVICE_TYPE_ID`	Falta o campo service_type_id nostructured_service_item. As chaves de metadados incluem "field_mask".
`INVALID_LANGUAGE`	O código do idioma é inválido. As chaves de metadados incluem "field_mask".
`PRICE_CURRENCY_MISSING`	Código de moeda ISO 4217 ausente. As chaves de metadados incluem "field_mask".
`PRICE_CURRENCY_INVALID`	O código de moeda fornecido não é válido conforme o ISO 4217. As chaves de metadados incluem "field_mask".
`SERVICE_TYPE_ID_DUPLICATE`	Os IDs de tipo de serviço não são exclusivos no local. As chaves de metadados incluem "field_mask".
`PIN_DROP_REQUIRED`	Não foi possível localizar o endereço especificado. Use a interface para fixar um alfinete. As chaves de metadados incluem "field_mask".
`STALE_DATA`	Um ou mais itens foram atualizados recentemente pelo Google. No momento, somente o proprietário desta empresa pode fazer alterações nos dados localizados em "campo" acessando business.google.com. As chaves de metadados incluem "field_mask".
`PHONE_NUMBER_EDITS_NOT_ALLOWED`	O campo de número de telefone foi desativado para este local, e as edições não são permitidas. As chaves de metadados incluem "field_mask".
`MULTIPLE_ORGANIZATIONALLY_PART_OF_RELATION`	Há mais de uma relação que modela a relação lógica entre dois locais (por exemplo, despertamento, funciona em). As chaves de metadados incluem "field_mask" e "value".

GetAttributesRequest

Solicitação para AttributesService.GetAttributes.

Campos

Campos
`name`	`string` Obrigatório. O identificador do Google desse local no formato `locations/{location_id}/attributes`.

name

string

Obrigatório. O identificador do Google desse local no formato locations/{location_id}/attributes.

GetChainRequest

A mensagem de solicitação para Locations.GetChain.

Campos

Campos
`name`	`string` Obrigatório. O nome do recurso da cadeia, no formato `chains/{chain_place_id}`.

name

string

Obrigatório. O nome do recurso da cadeia, no formato chains/{chain_place_id}.

GetGoogleUpdatedAttributesRequest

Solicitação para AttributesService.GetGoogleUpdatedAttributes.

Campos

Campos
`name`	`string` Obrigatório. O identificador do Google desse local no formato `locations/{location_id}/attributes`.

name

string

Obrigatório. O identificador do Google desse local no formato locations/{location_id}/attributes.

GetGoogleUpdatedLocationRequest

A mensagem de solicitação para Locations.GetGoogleUpdatedLocation.

Campos

Campos
`name`	`string` Obrigatório. O nome do local a ser buscado.
`read_mask`	`FieldMask` Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta.

name

string

Obrigatório. O nome do local a ser buscado.

read_mask

Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta.

GetLocationRequest

Mensagem de solicitação para Locations.GetLocation.

Campos

Campos
`name`	`string` Obrigatório. O nome do local a ser buscado.
`read_mask`	`FieldMask` Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta.

name

string

Obrigatório. O nome do local a ser buscado.

read_mask

Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta.

GoogleLocation

Representa um Location presente no Google. Esse local pode ser reivindicado pelo usuário, por outra pessoa ou pode não ter sido reivindicado.

Campos

Campos
`name`	`string` Nome do recurso desse GoogleLocation, no formato `googleLocations/{googleLocationId}`.
`location`	`Location` As informações de `Location` preenchidas de forma esparsa. Este campo pode ser reutilizado no `CreateLocation` se não for reivindicado por um usuário.
`request_admin_rights_uri`	`string` Um URL que redireciona o usuário para a interface de solicitação de direitos de administrador. Esse campo só estará presente se o local já tiver sido reivindicado por algum usuário, incluindo o usuário atual.

name

string

Nome do recurso desse GoogleLocation, no formato googleLocations/{googleLocationId}.

location

As informações de Location preenchidas de forma esparsa. Este campo pode ser reutilizado no CreateLocation se não for reivindicado por um usuário.

request_admin_rights_uri

string

Um URL que redireciona o usuário para a interface de solicitação de direitos de administrador. Esse campo só estará presente se o local já tiver sido reivindicado por algum usuário, incluindo o usuário atual.

GoogleUpdatedLocation

Representa um local que foi modificado pelo Google.

Campos

Campos
`location`	`Location` A versão atualizada do Google deste local.
`diff_mask`	`FieldMask` Os campos que o Google atualizou.
`pending_mask`	`FieldMask` Os campos com edições pendentes que ainda não foram enviadas ao Maps e à Pesquisa.

location

A versão atualizada do Google deste local.

diff_mask

Os campos que o Google atualizou.

pending_mask

Os campos com edições pendentes que ainda não foram enviadas ao Maps e à Pesquisa.

Rótulo

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

Campos

Campos
`display_name`	`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.
`language_code`	`string` Opcional. O código de idioma BCP-47 a que essas strings se aplicam. Somente um conjunto de marcadores pode ser definido por idioma.

display_name

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.

language_code

string

Opcional. O código de idioma BCP-47 a que essas strings se aplicam. Somente um conjunto de marcadores pode ser definido por idioma.

ListAttributeMetadataRequest

Solicitação para AttributesService.ListAttributeMetadata.

Campos
`parent`	`string` Nome do recurso do local para procurar os atributos disponíveis. Se ele for definido, os atributos "category_name", "region_code", "language_code" e "show_all" não são obrigatórios e não podem ser definidos.
`category_name`	`string` O ID estável da categoria principal para encontrar os atributos disponíveis. Precisa estar no formato categorias/{category_id}.
`region_code`	`string` O código de país ISO 3166-1 alfa-2 para encontrar os atributos disponíveis.
`language_code`	`string` O código de idioma BCP 47 para receber nomes de exibição de atributos. Se esse idioma não estiver disponível, eles serão fornecidos em inglês.
`show_all`	`bool` Os metadados de todos os atributos disponíveis são retornados quando esse campo é definido como verdadeiro, desconsiderando os campos "pai" e "category_name". Os campos language_code e region_code são obrigatórios quando show_all está definido como verdadeiro.
`page_size`	`int32` Quantos atributos serão incluídos por página. O padrão é 200, e o mínimo é 1.
`page_token`	`string` Se especificado, a próxima página de metadados do atributo é recuperada.

ListAttributeMetadataResponse

Resposta para AttributesService.ListAttributeMetadata.

Campos

attribute_metadata[]

AttributeMetadata

Uma coleção de metadados de atributos para os atributos disponíveis.

next_page_token

string

Se o número de atributos exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de atributos em uma chamada subsequente para attributes.list. Se não houver mais atributos, este campo não estará presente na resposta.

ListCategoriesRequest

Mensagem de solicitação para BusinessCategories.ListCategories.

Campos
`region_code`	`string` Obrigatório. O código de país ISO 3166-1 alfa-2.
`language_code`	`string` Obrigatório. O código de idioma BCP 47.
`filter`	`string` Opcional. String de filtro do usuário. O único campo aceito é `displayName`. Por exemplo: `filter=displayName=foo`.
`page_size`	`int32` Opcional. Quantas categorias precisam ser buscadas por página. O padrão é 100, o mínimo é 1, e o tamanho máximo da página é 100.
`page_token`	`string` Opcional. Se especificado, a próxima página de categorias será buscada.
`view`	`CategoryView` Obrigatório. Especifica quais partes do recurso Categoria precisam ser retornadas na resposta.

ListCategoriesResponse

Mensagem de resposta para BusinessCategories.ListCategories.

Campos

Campos
`categories[]`	`Category` As categorias correspondentes com base nos parâmetros solicitados.
`next_page_token`	`string` Se o número de categorias exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de categorias em uma chamada subsequente para `ListCategories`.

categories[]

As categorias correspondentes com base nos parâmetros solicitados.

next_page_token

string

Se o número de categorias exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de categorias em uma chamada subsequente para ListCategories.

ListLocationsRequest

A mensagem de solicitação para Locations.ListLocations.

Campos
`parent`	`string` Obrigatório. O nome da conta em que os locais serão buscados. Se a conta principal [Account] [google.mybusiness.accountmanagement.v1.Account] for de [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, somente os Locais de propriedade direta da conta serão retornados. Caso contrário, todos os locais acessíveis da conta serão retornados, direta ou indiretamente.
`page_size`	`int32` Opcional. Quantos locais devem ser buscados por página. Se não for definido, o valor padrão será 10. O mínimo é 1, e o tamanho máximo da página é 100.
`page_token`	`string` Opcional. Se especificado, ele busca o próximo `page` de locais. O token de página é retornado por chamadas anteriores para `ListLocations` quando há mais locais do que o tamanho de página solicitado.
`filter`	`string` Opcional. Um filtro que restringe os locais a serem retornados. A resposta inclui apenas entradas que correspondem ao filtro. Se `filter` estiver vazio, as restrições serão aplicadas e todos os locais (paginados) serão recuperados para a conta solicitada. Para mais informações sobre campos válidos e exemplos de uso, consulte o Guia "Trabalhar com dados de local".
`order_by`	`string` Opcional. Ordem de classificação da solicitação. Vários campos devem ser separados por vírgula, seguindo a sintaxe SQL. A ordem de classificação padrão é crescente. Para especificar a ordem decrescente, um sufixo " desc" precisa ser adicionado. Os campos válidos para "order_by" são "title" e "store_code". Por exemplo: "title, store_code desc" ou "title" ou "store_code desc"
`read_mask`	`FieldMask` Obrigatório. Leia a máscara para especificar quais campos serão retornados na resposta.

ListLocationsResponse

Mensagem de resposta para Locations.ListLocations.

Campos

Campos
`locations[]`	`Location` Os locais.
`next_page_token`	`string` Se o número de locais exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de locais em uma chamada subsequente para `ListLocations`. Se não houver mais locais, este campo não estará presente na resposta.
`total_size`	`int32` O número aproximado de locais na lista, independentemente da paginação. Esse campo só será retornado se `filter` for usado como um parâmetro de consulta.

locations[]

Os locais.

next_page_token

string

Se o número de locais exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de locais em uma chamada subsequente para ListLocations. Se não houver mais locais, este campo não estará presente na resposta.

total_size

int32

O número aproximado de locais na lista, independentemente da paginação. Esse campo só será retornado se filter for usado como um parâmetro de consulta.

Local

Um local. Consulte o artigo da Central de Ajuda para ver uma descrição detalhada desses campos ou o endpoint da categoria para consultar uma lista de categorias de negócios válidas.

Campos
`name`	`string` Identificador do Google para esse local no formato: `locations/{location_id}`.
`language_code`	`string` Imutável. O idioma do local. Definido durante a criação e não pode ser atualizado.
`store_code`	`string` Opcional. 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 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, `Address`, `Categories`). Não adicione informações desnecessárias ao nome (por exemplo, prefira "Google" em vez de "Google Inc. — Sede corporativa de Mountain View"). Não inclua slogans de marketing, códigos da loja, caracteres especiais, horário de funcionamento ou status "fechado/aberto", números de telefone, URLs de sites, informações de serviço/produto, local/endereço ou rotas ou informações de contenção (por exemplo, "caixa eletrônico 24 horas no Rio de Janeiro").
`phone_numbers`	`PhoneNumbers` Opcional. Os diferentes números de telefone que os clientes podem usar para entrar em contato com a empresa.
`categories`	`Categories` Opcional. As diferentes categorias que descrevem a empresa.
`storefront_address`	`PostalAddress` Opcional. 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 `address_lines` no endereço. Defina esse campo apenas para empresas que têm uma vitrine. Esse campo não deve ser definido para locais do tipo `CUSTOMER_LOCATION_ONLY`. Se definido, qualquer valor fornecido será descartado.
`website_uri`	`string` Opcional. Um URL para esta empresa. Se possível, use um URL que represente o local específico da empresa em vez de um site/URL genérico que representa todos os locais ou a marca.
`regular_hours`	`BusinessHours` Opcional. Horário de funcionamento da empresa.
`special_hours`	`SpecialHours` Opcional. 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. Este campo não pode ser definido sem o horário de funcionamento normal.
`service_area`	`ServiceAreaBusiness` Opcional. 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.
`labels[]`	`string` Opcional. É 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. Precisa ter entre 1 e 255 caracteres por rótulo.
`ad_words_location_extensions`	`AdWordsLocationExtensions` Opcional. Informações adicionais exibidas no Google AdWords.
`latlng`	`LatLng` Opcional. 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 `latlng` fornecido pelo usuário tiver sido aceito durante a criação ou se o valor `latlng` tiver sido atualizado no site do Perfil da Empresa no Google. Esse campo só pode ser atualizado por clientes aprovados.
`open_info`	`OpenInfo` Opcional. Uma sinalização que indica se o local está aberto no momento.
`metadata`	`Metadata` Apenas saída. Outras informações não editáveis pelo usuário.
`profile`	`Profile` Opcional. Descreve sua empresa com sua voz e compartilha com os usuários a história da sua empresa e das suas ofertas. Este campo é obrigatório para todas as categorias, exceto as categorias de hospedagem (por exemplo, hotéis, hotéis de estrada, pousadas).
`relationship_data`	`RelationshipData` Opcional. Todos os locais e redes relacionados a este.
`more_hours[]`	`MoreHours` Opcional. Mais horários de funcionamento para diferentes departamentos ou clientes específicos de uma empresa.
`service_items[]`	`ServiceItem` Opcional. Lista de serviços aceitos pelos comerciantes. Os serviços podem ser cortar o cabelo, instalar um aquecedor de água etc. Os itens duplicados são removidos automaticamente.

Metadados

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

Campos
`has_google_updated`	`bool` 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 informações que precisam ser verificadas.
`has_pending_edits`	`bool` Apenas saída. Indica se alguma das propriedades desse local está no estado de edição pendente.
`can_delete`	`bool` Apenas saída. Indica se o local pode ser excluído usando a API.
`can_operate_local_post`	`bool` Apenas saída. Indica se a ficha da empresa pode gerenciar postagens locais.
`can_modify_service_list`	`bool` Apenas saída. Indica se a listagem pode modificar a lista de serviços.
`can_have_food_menus`	`bool` Apenas saída. Indica se o anúncio está qualificado para um cardápio de refeições.
`can_operate_health_data`	`bool` Apenas saída. Indica se o local pode operar em dados de Saúde.
`can_operate_lodging_data`	`bool` Apenas saída. Indica se o local pode operar em dados de hospedagem.
`place_id`	`string` Apenas saída. Se o local aparecer no Google Maps, o 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 Update.
`duplicate_location`	`string` Apenas saída. O recurso de local duplicado por este local.
`maps_uri`	`string` Apenas saída. Um link para o local no Maps.
`new_review_uri`	`string` Apenas saída. Um link para a página na Pesquisa Google em que o cliente pode avaliar o local.
`can_have_business_calls`	`bool` Apenas saída. Indica se a ficha da empresa está qualificada para chamadas.
`has_voice_of_merchant`	`bool` Apenas saída. Indica se a ficha da empresa tem a voz do comerciante. Se esse booleano for falso, chame a API locations.getVoiceOfMerchantState para saber por que a empresa não tem a voz do comerciante.

MoreHours

Os períodos em que um local fica aberto para determinados tipos de empresa.

Campos

Campos
`hours_type_id`	`string` 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[]`	`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.

hours_type_id

string

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[]

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.

MoreHoursType

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

Campos

hours_type_id

string

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

display_name

string

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

localized_display_name

string

Apenas saída. O nome de exibição legível localizado para o tipo de hora.

OpenInfo

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

Campos

status

OpenForBusiness

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

can_reopen

bool

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

opening_date

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

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 os números de telefone principais ou adicionais usando a máscara de atualização. Recomendamos um formato de telefone internacional, como "+1 415 555 0132". Saiba mais em (https://developers.google.com/style/phone-numbers#international-phone-numbers).

Campos

primary_phone

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.

additional_phones[]

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.

PlaceInfo

Define uma área representada por um ID de lugar.

Campos

place_name

string

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

place_id

string

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

Places

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

Campos

place_infos[]

PlaceInfo

As áreas representadas por IDs de lugar. É limitado a 20 lugares.

Perfil

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

Campos

description

string

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

Campos

parent_location

RelevantLocation

O local pai com o qual esse local está relacionado.

children_locations[]

RelevantLocation

A lista de locais filhos com que esse local tem relações.

parent_chain

string

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

RelevantLocation

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

Campos

place_id

string

Obrigatório. Especifique o local que está do outro lado da relação pelo placeID.

relation_type

RelationType

Obrigatório. O tipo de relacionamento.

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, a mesma marca/gerenciamento superior/organização, mas com atributos principais diferentes, como horário de funcionamento ou números de telefone. Por exemplo, Farmácia Costco é um departamento no atacado da Costco.
`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 Shopping, lojas em um shopping).

RepeatedEnumAttributeValue

Valores de um atributo com um value_type de REPEATED_ENUM. Isso consiste em duas listas de IDs de valor: aquelas definidas (true) e aquelas que não estão definidas (false). Os valores ausentes são considerados desconhecidos. É necessário especificar pelo menos um valor.

Campos

set_values[]

string

Valores de enumeração que são definidos.

unset_values[]

string

Valores de enumeração que não são definidos.

SearchChainsRequest

Mensagem de solicitação para Locations.SearchChains.

Campos

chain_name

string

Obrigatório. Pesquise uma rede pelo nome. Consultas exatas/parciais/difusas/relacionadas são aceitas. Exemplos: "walmart", "wal-mart", "walmmmart", "沃尔玛"

page_size

int32

O número máximo de redes correspondentes a serem retornadas dessa consulta. O padrão é 10. O valor máximo possível é 500.

SearchChainsResponse

Mensagem de resposta para Locations.SearchChains.

Campos

chains[]

Chain

Redes que correspondem ao network_display_name consultado em SearchChainsRequest. Se não houver correspondências, este campo estará vazio. Os resultados são listados em ordem de relevância.

SearchGoogleLocationsRequest

Mensagem de solicitação para GoogleLocations.SearchGoogleLocations.

Campos
`page_size`	`int32` O número de correspondências a serem retornadas. O valor padrão é 3, com um máximo de 10. A latência pode aumentar se forem solicitadas mais. Não há paginação.
Campo de união `search_query`. Consulta de pesquisa. Isso pode ser fornecido como um objeto de localização ou como uma consulta de string. `search_query` pode ser apenas de um dos tipos a seguir:
`location`	`Location` Local a ser pesquisado. Se fornecido, encontrará locais que correspondem aos detalhes fornecidos.
`query`	`string` Consulta de texto a ser pesquisada. Os resultados da pesquisa de uma string de consulta serão menos precisos do que se fornecerem um local exato, mas podem fornecer correspondências mais imprecisas.

SearchGoogleLocationsResponse

Mensagem de resposta para GoogleLocations.SearchGoogleLocations.

Campos

google_locations[]

GoogleLocation

Uma coleção de GoogleLocations que são possíveis correspondências com a solicitação especificada, listadas em ordem decrescente de precisão.

ServiceAreaBusiness

Empresas de serviço local prestam serviços no local do cliente (por exemplo, chaveiro ou encanador).

Campos

business_type

BusinessType

Obrigatório. Indica o [type] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType] da empresa com área de cobertura.

places

Places

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

region_code

string

Imutável. Código regional do CLDR do país/região em que a empresa que atende no local do cliente está localizada. Para mais detalhes, acesse 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 com CUSTOMER_LOCATION_SOMENTE. Caso contrário, ele é ignorado.

A região especificada aqui pode ser diferente das regiões onde essa empresa atende (por exemplo, empresas que prestam serviços em outras regiões).

Se o local exigir verificação após a criação, o endereço informado para fins de verificação precisa estar nessa região, e o proprietário da empresa ou o representante autorizado precisa estar disponível para receber correspondências no endereço de verificação fornecido.

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). Se uma empresa estiver sendo atualizada de CUSTOMER_AND_BUSINESS_LOCATION para CUSTOMER_LOCATION_only, a atualização de local precisará incluir a máscara de campo `storefront_address` e definir o campo como vazio.
`CUSTOMER_AND_BUSINESS_LOCATION`	Oferece serviço no endereço comercial e nos arredores.

ServiceItem

Uma mensagem que descreve um único item de serviço. Ele é usado para descrever o tipo de serviço que o comerciante oferece. Por exemplo, corte de cabelo pode ser um serviço.

Campos
`price`	`Money` Opcional. Representa o preço monetário do item de serviço. Recomendamos que ocurrency_code e as unidades sejam definidos ao incluir um preço. Esse valor será tratado como um preço fixo para o item de serviço.
Campo de união `service_item_info`. Um dos campos a seguir sempre deve ser definido. `service_item_info` pode ser apenas de um dos tipos a seguir:
`structured_service_item`	`StructuredServiceItem` Opcional. Este campo será definido com o caso de dados de serviços estruturados.
`free_form_service_item`	`FreeFormServiceItem` Opcional. Este campo será definido para o caso de dados de serviços em formato livre.

FreeFormServiceItem

Representa um serviço de formato livre oferecido pelo comerciante. Esses são serviços que não são expostos como parte dos nossos dados de serviço de estrutura. O comerciante insere manualmente os nomes desses serviços na plataforma do comerciante geográfico.

Campos

category

string

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

label

Label

Obrigatório. Rótulos com tags de idioma para o item. Recomendamos que os nomes dos itens tenham até 140 caracteres e as descrições até 250 caracteres. Este campo só deverá ser definido se a entrada for um item de serviço personalizado. Os tipos de serviço padronizados precisam ser atualizados com service_type_id.

StructuredServiceItem

Representa um serviço estruturado oferecido pelo comerciante. Por exemplo: instalação_de_sanitário.

Campos

service_type_id

string

Obrigatório. O campo service_type_id é um ID exclusivo fornecido pelo Google que pode ser encontrado em ServiceType. Esta informação é fornecida pelo serviço RPC BatchGetCategories.

description

string

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

ServiceType

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

Campos

service_type_id

string

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

display_name

string

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

SpecialHourPeriod

Representa um único período em que o horário de funcionamento de um local é diferente do horário comercial normal. Um período de horário de funcionamento especial precisa representar um intervalo de menos de 24 horas. A open_time e a start_date precisam anteceder a close_time e a end_date. close_time e end_date podem ser estendidos para 23h59 do dia seguinte ao start_date especificado. Por exemplo, as entradas a seguir são válidas:

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

As entradas a seguir não são válidas:

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00

Campos
`start_date`	`Date` Obrigatório. A data do calendário em que esse período de horário de funcionamento especial começa.
`open_time`	`TimeOfDay` Opcional. Os valores válidos são 00:00-24:00, em que 24:00 representa a meia-noite no final do campo do dia especificado. Precisa ser especificado se `closed` for falso.
`end_date`	`Date` Opcional. A data do calendário em que esse período de horário de funcionamento especial termina. Se o campo `end_date` não for definido, o padrão será a data especificada em `start_date`. Se definido, esse campo precisa ser igual a ou no máximo 1 dia após `start_date`.
`close_time`	`TimeOfDay` Opcional. Os valores válidos são 00h00-24h00, em que 24h00 representa a meia-noite no fim do campo do dia especificado. Precisa ser especificado se `closed` for falso.
`closed`	`bool` Opcional. Se verdadeiro, `end_date`, `open_time` e `close_time` são ignorados, e a data especificada em `start_date` é tratada como o local fechado o dia inteiro.

SpecialHours

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

Campos

special_hour_periods[]

SpecialHourPeriod

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

TimePeriod

Representa um período em que a empresa está aberta, começando no dia/horário de abertura especificado e fechando no dia/horário de fechamento especificado. O horário de fechamento precisa ser posterior ao horário de abertura, por exemplo, mais tarde no mesmo dia ou em um dia subsequente.

Campos
`open_day`	`DayOfWeek` Obrigatório. Indica o `day of the week` em que o período começa.
`open_time`	`TimeOfDay` Obrigatório. Os valores válidos são 00h00-24h00, em que 24h00 representa a meia-noite no fim do campo do dia especificado.
`close_day`	`DayOfWeek` Obrigatório. Indica o `day of the week` em que o período termina.
`close_time`	`TimeOfDay` Obrigatório. Os valores válidos são 00h00-24h00, em que 24h00 representa a meia-noite no fim do campo do dia especificado.

UpdateAttributesRequest

Solicitação para AttributesService.UpdateAttributes.

Campos

attributes

Attributes

Uma coleção de atributos que precisam ser atualizados.

attribute_mask

Obrigatório. Nome dos atributos que você quer atualizar. Representado por attributes/{attribute}.

Atualizações: todos os atributos fornecidos no campo de atributos que você quer atualizar precisam ser definidos no attribute_mask. Os atributos definidos na lista acima, mas não no attribute_mask, serão ignorados.

Exclusões: se você quiser excluir determinados atributos, eles precisarão ser especificados no attribute_mask sem nenhuma entrada correspondente na lista de atributos. Se você quiser excluir todos os atributos definidos em um local, procure todos os atributos aplicáveis a ele e os adicione a attribute_mask com um campo de atributos vazio.

UpdateLocationRequest

Mensagem de solicitação para locations.UpdateLocation.

Campos

location

Obrigatório. As informações de local atualizadas.

update_mask