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. Jeśli nadrzędne [konto] [google.mybusiness.accountmanagement.v1.Account] ma [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] OSOBISTE, zwracane są tylko Lokalizacje należące 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

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

string

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

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

string

Opcjonalnie: 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 tytuł i kod sklepu. Na przykład: „title, storeCode desc”. lub „tytuł” lub „storeCode desc”
readMask

string (FieldMask format)

Wymagane. Maska odczytu określająca, które pola będą zwracane w odpowiedzi.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat z odpowiedzią na temat 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, 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. To pole jest zwracane tylko wtedy, gdy jako parametr zapytania jest używane 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.