Method: accounts.locations.list

Listet die Standorte für das angegebene Konto auf.

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. Wenn das übergeordnete Konto [Account] [google.mybusiness.accountmanagement.v1.Account] den Wert [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL hat, werden nur Standorte zurückgegeben, die direkt zum Konto gehören. Andernfalls werden alle über das Konto zugänglichen Standorte zurückgegeben, entweder direkt oder indirekt.

Abfrageparameter

Parameter
pageSize

integer

Optional. Die Anzahl der Standorte, die pro Seite abgerufen werden sollen. Wird kein Wert festgelegt, ist der Standardwert 10. Der Mindestwert ist 1 und die maximale Seitengröße 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 Positionen vorhanden waren, als in die angeforderte Seitengröße passen konnten.
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 (paginiert) für das angeforderte Konto abgerufen.

Weitere Informationen zu gültigen Feldern und Verwendungsbeispiele finden Sie im Leitfaden zur Verwendung von Standortdaten.
orderBy

string

Optional. Sortierreihenfolge für die Anfrage. Mehrere Felder sollten gemäß der SQL-Syntax durch Kommas getrennt werden. Die Standardsortierreihenfolge ist aufsteigend. Zur Angabe der absteigenden Reihenfolge muss das Suffix " desc" hinzugefügt werden. Gültige Felder für „orderBy“ sind „title“ und „storeCode“. Beispiel: „title, storeCode desc“, „title“ oder „storeCode desc“
readMask

string (FieldMask format)

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

Dies ist eine durch Kommas getrennte Liste voll 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 bei einem nachfolgenden Aufruf von locations.list die nächste Seite mit Standorten abzurufen. Wenn es keine weiteren Standorte gibt, ist dieses Feld nicht in der Antwort vorhanden.
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 Abfrageparameter verwendet wird.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.