Method: accounts.locations.list

Wyświetla listę lokalizacji dla określonego konta.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Nazwa konta, z którego mają zostać pobrane lokalizacje.

  • Identyfikator konkretnego konta: jeśli konto jest typu AccountType.PERSONAL, odpowiedź zwraca tylko lokalizacje, które należą bezpośrednio do tego konta. W przypadku wszystkich innych typów (np. AccountType.LOCATION_GROUP) zwraca wszystkie dostępne lokalizacje.

  • Symbol wieloznaczny (-): użycie accounts/- identyfikuje uwierzytelnionego użytkownika. Domyślny zakres to AccountType.PERSONAL, ale obejmuje on zarówno lokalizacje należące bezpośrednio, jak i pośrednio (np. te dostępne przez grupy członków).

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie: Liczba lokalizacji do pobrania na stronę. Jeśli nie zostanie ustawiona, domyślna wartość to 10. Minimalny rozmiar strony to 1, a maksymalny – 100.
pageToken

string

Opcjonalnie: Jeśli jest określony, pobiera następną liczbę (page) lokalizacji. Token strony jest zwracany przez poprzednie wywołania metody locations.list, gdy było więcej lokalizacji, niż mogło się zmieścić w żądanym rozmiarze strony.
filter

string

Opcjonalnie: Filtr ograniczający zwracane lokalizacje. Odpowiedź zawiera tylko wpisy pasujące do filtra. Jeśli parametr filter jest pusty, stosowane są ograniczenia i pobierane są wszystkie lokalizacje (z podziałem na strony) dla żądanego konta.

Więcej informacji o prawidłowych polach i przykładowych zastosowaniach znajdziesz w przewodniku po pracy z danymi o lokalizacji.
orderBy

string

Opcjonalnie: Kolejność sortowania żądania. Wiele pól należy rozdzielić przecinkami zgodnie ze składnią SQL. Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą, należy dodać sufiks „ desc”. Prawidłowe pola dla orderBy to title i storeCode. Na przykład: „title, storeCode desc” lub „title” albo „storeCode desc”
readMask

string (FieldMask format)

Wymagane. Maska odczytu określająca, które pola zostaną zwrócone w odpowiedzi.

Jest to rozdzielona przecinkami lista pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat odpowiedzi dla Locations.ListLocations.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Pola
locations[]

object (Location)

Lokalizacje.
nextPageToken

string

Jeśli liczba lokalizacji przekroczyła żądany rozmiar strony, to pole jest wypełniane tokenem, który umożliwia pobranie następnej strony lokalizacji przy kolejnym wywołaniu metody locations.list. Jeśli nie ma więcej lokalizacji, to pole nie jest obecne w odpowiedzi.
totalSize

integer

Przybliżona liczba lokalizacji na liście niezależnie od podziału na strony. To pole zostanie zwrócone tylko wtedy, gdy filter zostanie użyty jako parametr zapytania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.