- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
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 |
Nazwa konta, z którego chcesz pobrać lokalizacje. Jeśli |
Parametry zapytania
Parametry | |
---|---|
pageSize |
Liczba lokalizacji do pobrania na stronę. Wartość domyślna to 100, minimalna wartość to 1, a maksymalny rozmiar strony to 100. |
pageToken |
Jeśli podasz te wartości, zostanie pobrana liczba kolejnych lokalizacji ( |
filter |
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). |
languageCode |
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 |
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 ( |
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. |
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.