Method: placeActionTypeMetadata.list

Zwraca listę dostępnych typów działań związanych z miejscem w przypadku lokalizacji lub kraju.

Żądanie HTTP

GET https://mybusinessplaceactions.googleapis.com/v1/placeActionTypeMetadata

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
languageCode

string

Opcjonalnie: Kod języka IETF BCP-47, w którym pojawiają się wyświetlane nazwy. Jeśli ten język nie jest dostępny, będą wyświetlane w języku angielskim.

pageSize

integer

Opcjonalnie: Liczba typów działań, które należy uwzględnić na stronie. Wartość domyślna to 10, a minimum to 1.

pageToken

string

Opcjonalnie: Jeśli jest określony, pobierana jest następna strona metadanych działania związanego z miejscem. Parametr pageToken jest zwracany, gdy wywołanie funkcji placeActionTypeMetadata.list zwróci więcej wyników, niż mieści się w żądanym rozmiarze strony.

filter

string

Opcjonalnie: Filtr ograniczający typy działań związanych z miejscem, których metadane mają dotyczyć. Odpowiedź zawiera wpisy pasujące do filtra. Obsługujemy tylko te filtry: 1. lokalizacja=XYZ, gdzie XYZ to ciąg znaków wskazujący nazwę zasobu lokalizacji w formacie locations/{locationId}. 2. kod_regionu=XYZ, gdzie XYZ to kod regionu Unicode CLDR umożliwiający znalezienie dostępnych typów działań.

Jeśli nie zostanie podany żaden filtr, zwracane są wszystkie typy działań związanych z miejscem.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat odpowiedzi na temat PlaceActions.ListPlaceActionTypeMetadata.

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

Zapis JSON
{
  "placeActionTypeMetadata": [
    {
      object (PlaceActionTypeMetadata)
    }
  ],
  "nextPageToken": string
}
Pola
placeActionTypeMetadata[]

object (PlaceActionTypeMetadata)

Zbiór metadanych dla dostępnych typów działań związanych z miejscem.

nextPageToken

string

Jeśli liczba typów działań przekracza żądany rozmiar strony, w tym polu pojawi się token pobierania następnej strony przy kolejnym wywołaniu funkcji placeActionTypeMetadata.list. Jeśli nie ma więcej wyników, to pole nie będzie obecne w odpowiedzi.

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.

PlaceActionTypeMetadata

Metadane dotyczące obsługiwanych typów działań związanych z miejscem.

Zapis JSON
{
  "placeActionType": enum (PlaceActionType),
  "displayName": string
}
Pola
placeActionType

enum (PlaceActionType)

Typ działania związanego z miejscem.

displayName

string

zlokalizowana wyświetlana nazwa atrybutu, jeśli jest dostępna; w przeciwnym razie wyświetla się nazwa w języku angielskim.