Method: accounts.locations.list

Zawiera listę lokalizacji 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

To pole jest wymagane. Nazwa konta, z którego chcesz pobrać lokalizacje. Jeśli konto nadrzędne [Account] [google.mybusiness.accountmanagement.v1.Account] ma typ [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, zwracane są tylko Lokalizacje, które należą bezpośrednio do konta. W przeciwnym razie zwraca wszystkie lokalizacje dostępne na koncie – bezpośrednio lub pośrednio.

Parametry zapytania

Parametry
pageSize

integer

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

string

Opcjonalnie. 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

Opcjonalnie. 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).
orderBy

string

Opcjonalnie. 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 wartości orderBy to title i storeCode. Na przykład: „title, opis kodu sklepu” lub „tytuł” lub „opis kodu sklepu”.
readMask

string (FieldMask format)

To pole jest wymagane. Maska odczytu, aby określić, które pola będą zwracane w odpowiedzi.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie 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 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. To pole zostanie zwrócone tylko wtedy, gdy jako parametr zapytania używany jest filter.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

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