Method: accounts.locations.list

Elenca le sedi 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 il Account è PERSONALE AccountType, vengono restituite solo le Posizioni di proprietà dell'Account, altrimenti verranno restituite tutte le località accessibili dall'Account, sia direttamente che indirettamente.

Parametri di ricerca

Parametri
pageSize

integer

Quante posizioni recuperare per pagina. Il valore predefinito è 100, il minimo è 1 e la dimensione massima della pagina è 100.
pageToken

string

Se specificato, recupera le località successive (page). Il token di pagina viene restituito dalle precedenti chiamate a locations.list quando la posizione è maggiore di quella che rientra nelle dimensioni di pagina richieste.
filter

string

Un filtro che vincola le località da restituire. La risposta include solo le voci che corrispondono al filtro. Se filter è vuoto, i vincoli vengono applicati e tutte le posizioni (suddivise in pagine) vengono recuperate 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 BCP 47 per la lingua in cui visualizzare le proprietà di località. Se questa lingua non è disponibile, verrà fornita nella lingua della località. Se nessuna delle due è disponibile, le informazioni saranno fornite in inglese.

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

string

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 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 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 locations.list. Se non ci sono 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.