- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
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 |
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 |
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 |
Opcjonalnie. Jeśli podasz te wartości, zostanie pobrana liczba kolejnych lokalizacji ( |
filter |
Opcjonalnie. Filtr ograniczający lokalizacje do zwrócenia. Odpowiedź zawiera tylko wpisy pasujące do filtra. Jeśli pole 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 |
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 |
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: |
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 ( |
Pola | |
---|---|
locations[] |
Lokalizacje. |
nextPageToken |
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 |
totalSize |
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 |
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.