Method: accounts.locations.list

Elenca le località 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

string

Obbligatorio. Il nome dell'account da cui recuperare le posizioni. Se l'account principale [google.mybusiness.accountmanagement.v1.Account] è di [TipoAccount] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONALE. Vengono restituite solo le sedi di proprietà diretta dell'account, altrimenti verranno restituite tutte le sedi accessibili direttamente o indirettamente dall'account.

Parametri di query

Parametri
pageSize

integer

(Facoltativo) Il numero di sedi da recuperare per pagina. Se non è impostato, il valore predefinito è 10. Il valore minimo è 1, mentre la dimensione massima della pagina è 100.
pageToken

string

(Facoltativo) 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

(Facoltativo) 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.
orderBy

string

(Facoltativo) 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 title e storeCode. Ad esempio: "title, storeCode desc". o "title" o "storeCode desc"
readMask

string (FieldMask format)

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

Si tratta di un elenco di nomi completi dei campi separati da virgole. 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 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. Questo campo verrà restituito solo se viene utilizzato filter come parametro di ricerca.

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.