Method: accounts.locations.list

Zawiera listę lokalizacji określonego konta.

Żądanie HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Nazwa konta, z którego chcesz pobrać lokalizacje. Jeśli Account należy do AccountType OSOBISTEGO, zwracane są tylko Lokalizacje, które bezpośrednio należą do Konta. W przeciwnym razie zwraca wszystkie dostępne lokalizacje z Konta (bezpośrednio lub pośrednio).

Parametry zapytania

Parametry
pageSize

integer

Liczba lokalizacji do pobrania na stronę. Wartość domyślna to 100, minimalna wartość to 1, a maksymalny rozmiar strony to 100.
pageToken

string

Jeśli podasz te wartości, zostanie pobrana liczba kolejnych lokalizacji (page). Token strony jest zwracany przez poprzednie wywołania funkcji locations.list, gdy liczba lokalizacji przekracza limit żądanego rozmiaru strony.
filter

string

Filtr ograniczający lokalizacje do zwrócenia. Odpowiedź zawiera tylko wpisy pasujące do filtra. Jeśli pole filter jest puste, obowiązują ograniczenia, a wszystkie lokalizacje (z podziałem na strony) są pobierane z żądanego konta.

Więcej informacji o prawidłowych polach i przykładowym użyciu danych znajdziesz w artykule Praca z danymi o lokalizacji (w języku angielskim).
languageCode
(deprecated)

string

Kod języka BCP 47, w którym obowiązują właściwości wyświetlanych lokalizacji. Jeśli ten język jest niedostępny, zostaną podane w języku lokalizacji. Jeśli żadna z tych opcji nie jest dostępna, wyświetlane są po angielsku.

Rola wycofana. Po 15 sierpnia 2020 roku to pole nie będzie już stosowane. Zamiast tego zawsze będzie używany język lokalizacji.
orderBy

string

Kolejność sortowania żądania. Poszczególne pola powinny być rozdzielone 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 elementu orderBy to locationName i storeCode. Na przykład: „nazwaLokalizacji, opis parametru sklepu”, „NazwaLokalizacji” lub „Opis kodu sklepu”.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Odpowiedź na żądanie Locations.ListLocations.

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

object (Location)

Lokalizacje.
nextPageToken

string

Jeśli liczba lokalizacji przekracza żądany rozmiar strony, w tym polu pojawia się token służący do pobierania następnej strony z lokalizacjami przy kolejnym wywołaniu funkcji 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 bez względu na podział na strony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.