Method: accounts.locations.list

Ruft die Standorte für das angegebene Konto ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name des Kontos, aus dem Standorte abgerufen werden sollen.

  • Spezifische Konto-ID: Wenn das Konto vom Typ AccountType.PERSONAL ist, werden in der Antwort nur Standorte zurückgegeben, die direkt diesem Konto gehören. Bei allen anderen Typen (z.B. AccountType.LOCATION_GROUP) werden alle zugänglichen Orte zurückgegeben.

  • Platzhalter (-): Mit accounts/- wird der authentifizierte Nutzer identifiziert. Dieser Bereich ist standardmäßig auf AccountType.PERSONAL festgelegt, umfasst aber sowohl direkt als auch indirekt eigene Standorte (z.B. solche, auf die über Mitgliedergruppen zugegriffen werden kann).

Suchparameter

Parameter
pageSize

integer

Optional. Wie viele Standorte pro Seite abgerufen werden sollen. Wenn nicht festgelegt, ist der Standardwert 10. Der Mindestwert ist 1 und die maximale Seitengröße beträgt 100.
pageToken

string

Optional. Wenn angegeben, werden die nächsten page-Standorte abgerufen. Das Seitentoken wird von vorherigen Aufrufen von locations.list zurückgegeben, wenn mehr Standorte vorhanden waren, als in die angeforderte Seitengröße passen.
filter

string

Optional. Ein Filter, der die zurückzugebenden Standorte einschränkt. Die Antwort enthält nur Einträge, die dem Filter entsprechen. Wenn filter leer ist, werden Einschränkungen angewendet und alle Standorte (seitenweise) für das angeforderte Konto abgerufen.

Weitere Informationen zu gültigen Feldern und Anwendungsbeispielen finden Sie im Leitfaden zum Arbeiten mit Standortdaten.
orderBy

string

Optional. Sortierreihenfolge für die Anfrage. Mehrere Felder sollten gemäß der SQL-Syntax kommagetrennt sein. Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie absteigend sortieren möchten, nutzen Sie das Suffix „desc“. Gültige Felder für „orderBy“ sind „title“ und „storeCode“. Beispiel: „title, storeCode desc“ oder „title“ oder „storeCode desc“
readMask

string (FieldMask format)

Erforderlich. Lesemaske, um anzugeben, welche Felder in der Antwort zurückgegeben werden sollen.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für Locations.ListLocations.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Felder
locations[]

object (Location)

Die Standorte.
nextPageToken

string

Wenn die Anzahl der Standorte die angeforderte Seitengröße überschreitet, wird dieses Feld mit einem Token gefüllt, um die nächste Seite mit Standorten bei einem nachfolgenden Aufruf von locations.list abzurufen. Wenn keine weiteren Standorte vorhanden sind, ist dieses Feld in der Antwort nicht enthalten.
totalSize

integer

Die ungefähre Anzahl der Standorte in der Liste, unabhängig von der Paginierung. Dieses Feld wird nur zurückgegeben, wenn filter als Suchparameter verwendet wird.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.