Package google.mybusiness.placeactions.v1

Índice

PlaceActions

Essa API permite gerenciar links de PlaceAction de locais da empresa.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

Retorna a lista de tipos de ação de lugar disponíveis para um local ou país.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

CreatePlaceActionLinkRequest

Mensagem de solicitação para PlaceActions.CreatePlaceActionLink.

Campos
parent

string

Obrigatório. O nome do recurso do local em que esse link de ação de lugar será criado. locations/{location_id}.

DeletePlaceActionLinkRequest

Mensagem de solicitação para PlaceActions.DeletePlaceActionLink.

Campos
name

string

Obrigatório. O nome do recurso do link de ação de lugar a ser removido do local.

ErrorCode

Códigos de erro de falhas internas.

Enums
ERROR_CODE_UNSPECIFIED Código de erro não especificado.
UNVERIFIED_LOCATION O local não foi verificado.
INVALID_LOCATION_CATEGORY A categoria de local não está qualificada para o tipo de ação de lugar. O tipo de ação de lugar que causa o erro será retornado nos metadados, com a string "place_action_type" como a chave e a string de valor de enumeração PlaceActionType como o valor.
INVALID_URL O URL é inválido ou é inválido. O URL inválido de ação de lugar será retornado nos metadados, com a string "url" como a chave e o URL como o valor.
URL_PROVIDER_NOT_ALLOWED O URL tem um provedor que não é permitido. O URL de ação de lugar não permitido será retornado nos metadados, com a string "url" como a chave e o URL como o valor.
TOO_MANY_VALUES Muitos valores foram definidos para o tipo de ação de lugar. O tipo para que o limite for atingido será retornado nos metadados, com a string "place_action_type" como a chave e a string de valor de enumeração PlaceActionType como o valor.

GetPlaceActionLinkRequest

Mensagem de solicitação para PlaceActions.GetPlaceActionLink.

Campos
name

string

Obrigatório. O nome do link de ação de lugar a ser buscado.

ListPlaceActionLinksRequest

Uma mensagem de solicitação para PlaceActions.ListPlaceActionLinks. Isso listará os links de ação de lugar para um local, sem ordem específica. Isso pode não retornar links criados recentemente (nas últimas 24 horas) em outras plataformas, como o site do Google Meu Negócio. Qualquer link criado há mais de 24 horas aparecerá por meio dessa API.

Campos
parent

string

Obrigatório. O nome do local cujos links de ação de lugar serão listados. locations/{location_id}.
filter

string

Opcional. Um filtro que restringe os links de ação de lugar a serem retornados. A resposta inclui entradas que correspondem ao filtro. Só aceitamos o seguinte filtro: 1. place_action_type=XYZ, em que XYZ é um PlaceActionType válido.
page_size

int32

Opcional. Quantos links de ação de lugar retornar por página. O padrão é 10. O mínimo é 1.
page_token

string

Opcional. Se especificado, retorna a próxima página dos links de ação de lugar.

ListPlaceActionLinksResponse

Mensagem de resposta para PlaceActions.ListPlaceActionLinks.

Campos
next_page_token

string

Se houver mais links de ação de lugar do que o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de resultados.

ListPlaceActionTypeMetadataRequest

Mensagem de solicitação para PlaceActions.ListPlaceActionTypeMetadata. Os resultados serão retornados em uma ordem não específica.

Campos
language_code

string

Opcional. O código de idioma IETF BCP-47 para receber nomes de exibição. Se esse idioma não estiver disponível, eles serão fornecidos em inglês.
page_size

int32

Opcional. Quantos tipos de ação incluir por página. O padrão é 10, e o mínimo é 1.
page_token

string

Opcional. Se especificado, a próxima página dos metadados do tipo de ação do lugar é recuperada. O pageToken é retornado quando uma chamada para placeActionTypeMetadata.list retorna mais resultados do que o tamanho de página solicitado.
filter

string

Opcional. Um filtro que restringe os tipos de ação de lugar para os quais retornar metadados. A resposta inclui entradas que correspondem ao filtro. Oferecemos suporte apenas aos seguintes filtros: 1. location=XYZ, em que XYZ é uma string que indica o nome de recurso de um local, no formato locations/{location_id}. 2. region_code=XYZ, em que XYZ é um código de região Unicode CLDR para encontrar tipos de ação disponíveis.

Se nenhum filtro for fornecido, todos os tipos de ação de lugar vão ser retornados.

ListPlaceActionTypeMetadataResponse

Mensagem de resposta para PlaceActions.ListPlaceActionTypeMetadata.

Campos
place_action_type_metadata[]

PlaceActionTypeMetadata

Uma coleção de metadados para os tipos de ação de lugar disponíveis.
next_page_token

string

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

ProviderType

O tipo do provedor de link, que só pode ser lido.

Enums
PROVIDER_TYPE_UNSPECIFIED Não especificado.
MERCHANT Um provedor próprio, como um comerciante ou uma agência, em nome de um comerciante.
AGGREGATOR_3P Um agregador de terceiros, como um parceiro do Reserve with Google.

PlaceActionType

O tipo de ação de lugar que pode ser realizada usando o link.

Enums
PLACE_ACTION_TYPE_UNSPECIFIED Não especificado.
APPOINTMENT O tipo de ação é agendar um horário.
ONLINE_APPOINTMENT O tipo de ação é agendar um horário on-line.
DINING_RESERVATION O tipo de ação é fazer uma reserva de restaurante.
FOOD_ORDERING O tipo de ação é pedir comida para entrega e/ou retirada.
FOOD_DELIVERY O tipo de ação é pedir comida para entrega.
FOOD_TAKEOUT O tipo de ação é pedir comida para retirada.
SHOP_ONLINE O tipo de ação é compras, que pode ser entrega e/ou retirada.

PlaceActionTypeMetadata

Metadados dos tipos de ação de lugar compatíveis.

Campos
place_action_type

PlaceActionType

O tipo de ação de lugar.
display_name

string

O nome de exibição localizado para o atributo, se disponível. Caso contrário, o nome de exibição em inglês.

UpdatePlaceActionLinkRequest

Mensagem de solicitação para PlaceActions.UpdatePlaceActionLink.

Campos
update_mask

FieldMask

Obrigatório. Os campos específicos que serão atualizados. Os únicos campos editáveis são uri, place_action_type e is_preferred. Se o link atualizado já existir no mesmo local com os mesmos place_action_type e uri, ocorrerá uma falha com um erro ALREADY_EXISTS.