Package google.mybusiness.placeactions.v1

Indice

PlaceActions

Questa API consente di gestire i link PlaceAction delle sedi dell'attività commerciale.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

Restituisce l'elenco dei tipi di azioni luogo disponibili per una località o un paese.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

CreatePlaceActionLinkRequest

Messaggio di richiesta per PlaceActions.CreatePlaceActionLink.

Campi
parent

string

Obbligatorio. Il nome della risorsa della località in cui creare il link all'azione diretta. locations/{location_id}.

DeletePlaceActionLinkRequest

Messaggio di richiesta per PlaceActions.DeletePlaceActionLink.

Campi
name

string

Obbligatorio. Il nome della risorsa del link dell'azione diretta da rimuovere dalla località.

ErrorCode

Codici di errore per guasti interni.

Enum
ERROR_CODE_UNSPECIFIED Codice di errore non specificato.
UNVERIFIED_LOCATION La sede non è verificata.
INVALID_LOCATION_CATEGORY La categoria della località non è idonea per il tipo di azione luogo. Il tipo di azione Place che ha causato l'errore verrà restituito nei metadati, con la stringa "place_action_type" come chiave e la stringa con valore enum PlaceActionType come valore.
INVALID_URL Il formato dell'URL non è valido/non è valido. L'URL dell'azione non valido verrà restituito nei metadati, con la stringa "url" come chiave e url come valore.
URL_PROVIDER_NOT_ALLOWED L'URL ha un provider non consentito. L'URL di azione non consentito verrà restituito nei metadati, con la stringa "url" come chiave e url come valore.
TOO_MANY_VALUES Troppi valori impostati per il tipo di azione luogo. Il tipo per cui viene raggiunto il limite viene restituito nei metadati, con la stringa "place_action_type" come chiave e la stringa del valore enum PlaceActionType come valore.

GetPlaceActionLinkRequest

Messaggio di richiesta per PlaceActions.GetPlaceActionLink.

Campi
name

string

Obbligatorio. Il nome del link dell'azione diretta da recuperare.

ListPlaceActionLinksRequest

Messaggio di richiesta per PlaceActions.ListPlaceActionLinks. Verranno elencati i link alle azioni relative al luogo relativi a una sede, in ordine non specifico. Questa operazione potrebbe non restituire i link creati di recente (nelle ultime 24 ore) tramite altre piattaforme, ad esempio il sito web di Google MyBusiness. I link creati più di 24 ore fa verranno visualizzati tramite questa API.

Campi
parent

string

Obbligatorio. Il nome della località di cui verranno elencati i link all'azione diretta. locations/{location_id}.
filter

string

Campo facoltativo. Un filtro che vincola i link di azione diretta da restituire. La risposta include voci che corrispondono al filtro. Supportiamo solo il seguente filtro: 1. place_action_type=XYZ dove XYZ è un PlaceActionType valido.
page_size

int32

Campo facoltativo. Numero di link di azioni posizionate da restituire per ogni pagina. Il valore predefinito è 10. Il numero minimo è 1.
page_token

string

Campo facoltativo. Se specificato, restituisce la pagina successiva dei link dell'azione diretta.

ListPlaceActionLinksResponse

Messaggio di risposta per PlaceActions.ListPlaceActionLinks.

Campi
next_page_token

string

Se sono presenti più link all'azione diretta rispetto alle dimensioni della pagina richieste, questo campo viene completato con un token per recuperare la pagina dei risultati successiva.

ListPlaceActionTypeMetadataRequest

Messaggio di richiesta per PlaceActions.ListPlaceActionTypeMetadata. I risultati verranno restituiti in nessun ordine specifico.

Campi
language_code

string

Campo facoltativo. Il codice di lingua IETF BCP-47 in cui ottenere i nomi visualizzati. Se questa lingua non è disponibile, le lingue verranno fornite in inglese.
page_size

int32

Campo facoltativo. Il numero di tipi di azioni da includere per pagina. Il valore predefinito è 10, il minimo 1.
page_token

string

Campo facoltativo. Se specificato, viene recuperata la pagina successiva dei metadati del tipo di azione luogo. Il valore pageToken viene restituito quando una chiamata a placeActionTypeMetadata.list restituisce più risultati di quanti possano rientrare nelle dimensioni della pagina richieste.
filter

string

Campo facoltativo. Un filtro che vincola i tipi di azione diretta per i quali restituire i metadati. La risposta include voci che corrispondono al filtro. Supportiamo solo i seguenti filtri: 1. location=XYZ, dove XYZ è una stringa che indica il nome della risorsa di una località, nel formato locations/{location_id}. 2. Region_code=XYZ dove XYZ è un codice regione Unicode CLDR per trovare i tipi di azione disponibili.

Se non viene fornito alcun filtro, vengono restituiti tutti i tipi di azione diretta.

ListPlaceActionTypeMetadataResponse

Messaggio di risposta per PlaceActions.ListPlaceActionTypeMetadata.

Campi
place_action_type_metadata[]

PlaceActionTypeMetadata

Una raccolta di metadati per i tipi di azioni luogo disponibili.
next_page_token

string

Se il numero di tipi di azioni supera le dimensioni della pagina richieste, questo campo verrà completato con un token per recuperare la pagina successiva in una chiamata successiva a placeActionTypeMetadata.list. Se non ci sono altri risultati, questo campo non sarà presente nella risposta.

ProviderType

Il tipo di provider di link, può essere solo letto.

Enum
PROVIDER_TYPE_UNSPECIFIED Non specificato.
MERCHANT Un fornitore proprietario, ad esempio un commerciante o un'agenzia per conto di un commerciante.
AGGREGATOR_3P Un aggregatore di terze parti, ad esempio un partner Reserve with Google.

PlaceActionType

Il tipo di azione diretta che può essere eseguita utilizzando il link.

Enum
PLACE_ACTION_TYPE_UNSPECIFIED Non specificato.
APPOINTMENT Il tipo di azione è la prenotazione di un appuntamento.
ONLINE_APPOINTMENT Il tipo di azione è prenotare un appuntamento online.
DINING_RESERVATION Il tipo di azione è prenotare un ristorante.
FOOD_ORDERING Il tipo di azione è ordinare cibo con consegna a domicilio e/o da asporto.
FOOD_DELIVERY Il tipo di azione è ordinare cibo per la consegna.
FOOD_TAKEOUT Il tipo di azione è ordinare cibo da asporto.
SHOP_ONLINE Il tipo di azione è Shopping, con consegna a domicilio e/o ritiro.

PlaceActionTypeMetadata

Metadati per i tipi di azione luogo supportati.

Campi
place_action_type

PlaceActionType

Il tipo di azione diretta.
display_name

string

Il nome visualizzato localizzato per l'attributo, se disponibile; in caso contrario, il nome visualizzato in inglese.

UpdatePlaceActionLinkRequest

Messaggio di richiesta per PlaceActions.UpdatePlaceActionLink.

Campi
update_mask

FieldMask

Obbligatorio. I campi specifici da aggiornare. Gli unici campi modificabili sono uri, place_action_type e is_preferred. Se il collegamento aggiornato esiste già nella stessa posizione con gli stessi place_action_type e uri, l'operazione non riesce e viene visualizzato un errore ALREADY_EXISTS.