- Richiesta HTTP
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
Elenca le sedi dell'account specificato.
Richiesta HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
parent |
Obbligatorio. Il nome dell'account da cui recuperare le posizioni. Se l'account principale [Account] [google.mybusiness.accountmanagement.v1.Account] è di [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, vengono restituite solo le sedi di proprietà dell'account, altrimenti verranno restituite tutte le sedi accessibili dall'account, direttamente o indirettamente. |
Parametri di ricerca
Parametri | |
---|---|
pageSize |
Campo facoltativo. Quante posizioni recuperare per pagina. Se non è impostato, il valore predefinito è 10. Il valore minimo è 1, mentre la dimensione massima della pagina è 100. |
pageToken |
Campo facoltativo. Se specificato, recupera le località successive ( |
filter |
Campo facoltativo. Un filtro che vincola le località da restituire. La risposta include solo le voci che corrispondono al filtro. Se Per ulteriori informazioni sui campi validi e sull'utilizzo di esempio, consulta la Guida all'utilizzo dei dati sulla posizione. |
orderBy |
Campo facoltativo. Ordinamento della richiesta. Più campi devono essere separati da virgole, seguendo la sintassi SQL. L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente, è necessario aggiungere un suffisso " desc". I campi validi per orderBy sono title e storeCode. Ad esempio: "title, storeCode desc" o "title" o "storeCode desc". |
readMask |
Obbligatorio. Maschera di lettura per specificare quali campi verranno restituiti nella risposta. Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: |
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Messaggio di risposta per locations.ListLocations.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"locations": [
{
object ( |
Campi | |
---|---|
locations[] |
Le località. |
nextPageToken |
Se il numero di località supera le dimensioni di pagina richieste, questo campo viene compilato con un token per recuperare la pagina successiva delle località in una chiamata successiva a |
totalSize |
Il numero approssimativo di località nell'elenco indipendentemente dall'impaginazione. Questo campo verrà restituito solo se |
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.