Method: accounts.locations.list

Wyświetla listę lokalizacji dla 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 mają zostać pobrane lokalizacje. Jeśli Account to AccountType PERSONAL, zwracane są tylko Lokalizacje, które należą bezpośrednio do Konta. W przeciwnym razie zwracane są 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, minimum to 1, a maksymalny rozmiar strony to 100.
pageToken

string

Jeśli jest określona, pobiera następne page lokalizacji. Token strony jest zwracany przez poprzednie wywołania funkcji locations.list, gdy nie ma większej liczby lokalizacji niż mieści się w żądanym rozmiarze strony.
filter

string

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

Więcej informacji na temat prawidłowych pól i przykładowych zastosowań znajdziesz w artykule Praca z danymi o lokalizacji.
languageCode
(deprecated)

string

Kod języka BCP 47, w którym mają być pobierane właściwości lokalizacji wyświetlania. Jeśli ten język nie jest dostępny, będą udostępniane w języku lokalizacji. Jeśli żadna z nich nie jest dostępna, będą podane w języku angielskim.

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

string

Kolejność sortowania dla żądania. Kilka pól należy rozdzielić przecinkami, zgodnie ze składnią SQL. Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą, dodaj sufiks „ malejąco" . Prawidłowe pola wartości orderBy to locationName i storeCode. Na przykład: „locationName, storeCode desc”. lub „locationName” lub „storeCode desc”

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Komunikat z odpowiedzią na temat Locations.ListLocations.

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, w tym polu pojawia się token umożliwiający pobranie następnej strony lokalizacji przy kolejnym wywołaniu funkcji locations.list. Jeśli nie ma więcej lokalizacji, tego pola nie ma w odpowiedzi.
totalSize

integer

Przybliżona liczba lokalizacji na liście niezależnie od podziału na strony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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.