Package google.mybusiness.placeactions.v1

Índice

PlaceActions

Esta API permite administrar los vínculos de PlaceAction de las ubicaciones de la empresa.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

Muestra la lista de los tipos de acciones de lugar disponibles para una ubicación o un país.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

CreatePlaceActionLinkRequest

Mensaje de solicitud para PlaceActions.CreatePlaceActionLink.

Campos
parent

string

Obligatorio. El nombre del recurso de la ubicación en la que se creará este vínculo de acción de lugar. locations/{location_id}.

DeletePlaceActionLinkRequest

Mensaje de solicitud para PlaceActions.DeletePlaceActionLink.

Campos
name

string

Obligatorio. El nombre del recurso del vínculo de acción de lugar que se quitará de la ubicación.

ErrorCode

Códigos de error para fallas internas

Enumeradores
ERROR_CODE_UNSPECIFIED Código de error no especificado.
UNVERIFIED_LOCATION La ubicación no está verificada.
INVALID_LOCATION_CATEGORY La categoría de ubicación no es apta para el tipo de acción de lugar. El tipo de acción de lugar que causa el error se mostrará en los metadatos, con la string "place_action_type" como clave y la cadena de valor enum PlaceActionType como el valor.
INVALID_URL La URL presenta errores de formato o no es válida. La URL de la acción de lugar que no es válida se mostrará en los metadatos, con la cadena "url" como la clave y la url como el valor.
URL_PROVIDER_NOT_ALLOWED La URL tiene un proveedor que no está permitido. La URL de la acción de lugar que no está permitida se mostrará en los metadatos, con la cadena "url" como clave y la url como valor.
TOO_MANY_VALUES Se establecieron demasiados valores para el tipo de acción de lugar. El tipo para el que se alcanza el límite se mostrará en los metadatos, con la string "place_action_type" como clave y la string de valor de enumeración PlaceActionType como el valor.

GetPlaceActionLinkRequest

Mensaje de solicitud para PlaceActions.GetPlaceActionLink.

Campos
name

string

Obligatorio. El nombre del vínculo de acción de lugar que se debe recuperar.

ListPlaceActionLinksRequest

Mensaje de solicitud para PlaceActions.ListPlaceActionLinks. Esto mostrará los vínculos de acción de lugar de una ubicación, sin un orden específico. Es posible que esta acción no muestre los vínculos creados recientemente (en las últimas 24 horas) a través de otras plataformas, p.ej., el sitio web de Google Mi Negocio. Los vínculos que se hayan creado hace más de 24 horas se mostrarán a través de esta API.

Campos
parent

string

Obligatorio. Es el nombre de la ubicación cuyos vínculos de acción de lugar se incluirán en la lista. locations/{location_id}.
filter

string

Opcional. Un filtro que restringe los vínculos de acción de lugar que se mostrarán. La respuesta incluye entradas que coinciden con el filtro. Solo admitimos el siguiente filtro: 1. place_action_type=XYZ, donde XYZ es un PlaceActionType válido.
page_size

int32

Opcional. Cantidad de vínculos de acción de lugar que se deben mostrar por página. Predeterminado de 10. El mínimo es 1.
page_token

string

Opcional. Si se especifica, muestra la siguiente página de vínculos de acción de lugar.

ListPlaceActionLinksResponse

Mensaje de respuesta para PlaceActions.ListPlaceActionLinks.

Campos
next_page_token

string

Si la cantidad de vínculos de acción de lugar es mayor que el tamaño de la página solicitada, este campo se propaga con un token para recuperar la siguiente página de resultados.

ListPlaceActionTypeMetadataRequest

Mensaje de solicitud para PlaceActions.ListPlaceActionTypeMetadata. Los resultados no se devolverán en ningún orden específico.

Campos
language_code

string

Opcional. Es el código de idioma IETF BCP-47 para mostrar los nombres visibles. Si este idioma no está disponible, se ofrecerán en inglés.
page_size

int32

Opcional. Cantidad de tipos de acciones que se deben incluir por página. El valor predeterminado es 10 y el mínimo es 1.
page_token

string

Opcional. Si se especifica, se recupera la siguiente página de los metadatos del tipo de acción de lugar. Se muestra pageToken cuando una llamada a placeActionTypeMetadata.list muestra más resultados de los que pueden caber en el tamaño de la página solicitado.
filter

string

Opcional. Un filtro que restringe los tipos de acciones de lugar de los que se mostrarán los metadatos. La respuesta incluye entradas que coinciden con el filtro. Solo admitimos los siguientes filtros: 1. ubicación=XYZ, donde XYZ es una cadena que indica el nombre del recurso de una ubicación, en el formato locations/{location_id}. 2. region_code=XYZ, donde XYZ es un código regional CLDR de Unicode para encontrar los tipos de acción disponibles

Si no se proporciona un filtro, se devuelven todos los tipos de acciones de lugar.

ListPlaceActionTypeMetadataResponse

Mensaje de respuesta para PlaceActions.ListPlaceActionTypeMetadata.

Campos
place_action_type_metadata[]

PlaceActionTypeMetadata

Una colección de metadatos para los tipos de acciones de lugar disponibles.
next_page_token

string

Si la cantidad de tipos de acciones supera el tamaño de página solicitado, este campo se propagará con un token para recuperar la página siguiente en una llamada posterior a placeActionTypeMetadata.list. Si no hay más resultados, este campo no aparecerá en la respuesta.

ProviderType

El tipo de proveedor de vínculos, solo se puede leer.

Enumeradores
PROVIDER_TYPE_UNSPECIFIED No se especifica.
MERCHANT Un proveedor propio, como un comercio o una agencia en nombre de un comercio
AGGREGATOR_3P Un agregador externo, como un socio de Reserve with Google

PlaceActionType

Es el tipo de acción de lugar que se puede realizar mediante el vínculo.

Enumeradores
PLACE_ACTION_TYPE_UNSPECIFIED No se especifica.
APPOINTMENT El tipo de acción es reservar una cita.
ONLINE_APPOINTMENT El tipo de acción es reservar una cita en línea.
DINING_RESERVATION El tipo de acción consiste en hacer una reserva en un restaurante.
FOOD_ORDERING El tipo de acción consiste en pedir comida para llevar o entrega a domicilio.
FOOD_DELIVERY El tipo de acción es pedir comida para la entrega.
FOOD_TAKEOUT El tipo de acción es pedir comida para llevar.
SHOP_ONLINE El tipo de acción es comprar, que puede ser entrega a domicilio o retiro.

PlaceActionTypeMetadata

Metadatos de los tipos de acciones de lugar admitidos.

Campos
place_action_type

PlaceActionType

Es el tipo de acción de lugar.
display_name

string

El nombre visible localizado del atributo, si está disponible; de lo contrario, es el nombre visible en inglés.

UpdatePlaceActionLinkRequest

Mensaje de solicitud para PlaceActions.UpdatePlaceActionLink.

Campos
update_mask

FieldMask

Obligatorio. Los campos específicos que se actualizarán. Los únicos campos que se pueden editar son uri, place_action_type y is_preferred. Si el vínculo actualizado ya existe en la misma ubicación con los mismos place_action_type y uri, falla y muestra un error ALREADY_EXISTS.