Method: accounts.locations.list

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

string

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

integer

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

string

Campo facoltativo. 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

Campo facoltativo. 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.
orderBy

string

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

string (FieldMask format)

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: "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 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. Questo campo verrà restituito solo se filter viene utilizzato 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.