Method: accounts.locations.list

Elenca le località dell'account specificato.

Richiesta HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Il nome dell'account da cui recuperare le posizioni. Se l'Account è di AccountType PERSONALE, vengono restituite solo le Sedi che sono di proprietà diretta dell'Account, altrimenti verranno restituite tutte le sedi accessibili dall'Account, direttamente o indirettamente.

Parametri di query

Parametri
pageSize

integer

Il numero di sedi da recuperare per pagina. Il valore predefinito è 100, il minimo è 1 e la dimensione massima della pagina è 100.
pageToken

string

Se specificato, consente di recuperare le page posizioni successive. Il token di pagina viene restituito dalle chiamate precedenti a locations.list quando sono presenti più sedi di quelle che potrebbero rientrare nelle dimensioni di pagina richieste.
filter

string

Un filtro vincola le località da restituire. La risposta include solo le voci che corrispondono al filtro. Se il campo filter è vuoto, vengono applicati i vincoli e vengono recuperate tutte le località (suddivise in pagine) per l'account richiesto.

Per ulteriori informazioni sui campi validi e sull'utilizzo di esempio, consulta la Guida all'utilizzo dei dati sulla posizione.
languageCode
(deprecated)

string

Il codice della lingua BCP 47 in cui visualizzare le proprietà della località. Se questa lingua non è disponibile, verranno forniti nella lingua della località. Se nessuno dei due è disponibile, verrà fornito in inglese.

Deprecato. Dopo il 15 agosto 2020, questo campo non verrà più applicato. Verrà invece sempre utilizzata la lingua della località.
orderBy

string

Ordinamento della richiesta. Più campi devono essere separati da virgole, secondo la sintassi SQL. L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente, un suffisso " disc" aggiungere. I campi validi per orderBy sono locationName e storeCode. Ad esempio: "locationName, storeCode desc" o "locationName" o "storeCode desc"

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Messaggio di risposta per locations.ListLocations.

Rappresentazione JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campi
locations[]

object (Location)

Le località.
nextPageToken

string

Se il numero di sedi supera le dimensioni di pagina richieste, questo campo viene compilato con un token per recuperare la pagina successiva di sedi in una chiamata successiva a locations.list. Se non sono presenti altre località, questo campo non è presente nella risposta.
totalSize

integer

Il numero approssimativo di località nell'elenco, indipendentemente dall'impaginazione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.