Method: accounts.locations.list

Elenca le località per l'account specificato.

Richiesta HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
parent

string

Obbligatorio. Il nome dell'account da cui recuperare le sedi.

  • ID account specifico: se l'account è di tipo AccountType.PERSONAL, la risposta restituisce solo le sedi di proprietà diretta di quell'account. Per tutti gli altri tipi (ad es. AccountType.LOCATION_GROUP), restituisce tutte le località accessibili.

  • Carattere jolly (-): l'utilizzo di accounts/- identifica l'utente autenticato. Questo ambito è impostato su AccountType.PERSONAL per impostazione predefinita, ma include sia le sedi di proprietà diretta sia quelle di proprietà indiretta (ad es. quelle accessibili tramite gruppi di membri).

Parametri di query

Parametri
pageSize

integer

Facoltativo. Numero di località da recuperare per pagina. Se non è impostato, il valore predefinito è 10. Il valore minimo è 1 e la dimensione massima della pagina è 100.
pageToken

string

Facoltativo. Se specificato, recupera il page di località successivo. Il token di pagina viene restituito dalle chiamate precedenti a locations.list quando il numero di località era superiore a quello che poteva essere inserito nella dimensione della pagina richiesta.
filter

string

Facoltativo. Un filtro che limita le località da restituire. La risposta include solo le voci che corrispondono al filtro. Se filter è vuoto, vengono applicati i vincoli e vengono recuperate tutte le sedi (impaginate) per l'account richiesto.

Per saperne di più sui campi validi e sull'utilizzo di esempio, consulta la guida all'utilizzo dei dati sulla posizione.
orderBy

string

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 il suffisso "desc". I campi validi per orderBy sono title e storeCode. Ad esempio: "title, storeCode desc" o "title" o "storeCode desc"
readMask

string (FieldMask format)

Obbligatorio. Maschera di lettura per specificare i campi che verranno restituiti nella risposta.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

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 (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campi
locations[]

object (Location)

Le località.
nextPageToken

string

Se il numero di località supera le dimensioni della pagina richiesta, questo campo viene compilato con un token per recuperare la pagina successiva di località 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 dalla paginazione. Questo campo verrà restituito solo se filter viene utilizzato come parametro di query.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.