Package google.mybusiness.placeactions.v1

Indeks

PlaceActions

Ten interfejs API umożliwia zarządzanie linkami PlaceAction do adresów sklepów.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

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

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.

CreatePlaceActionLinkRequest

Prośba o wiadomość dotyczącą PlaceActions.CreatePlaceActionLink.

Pola
parent

string

To pole jest wymagane. Nazwa zasobu lokalizacji, w której chcesz utworzyć link do działania związanego z miejscem. locations/{location_id}.

DeletePlaceActionLinkRequest

Prośba o wiadomość dotyczącą PlaceActions.DeletePlaceActionLink.

Pola
name

string

To pole jest wymagane. Nazwa zasobu linku do działania związanego z miejscem, który chcesz usunąć z lokalizacji.

ErrorCode

Kody błędów wewnętrznych.

Wartości w polu enum
ERROR_CODE_UNSPECIFIED Nieokreślony kod błędu.
UNVERIFIED_LOCATION Lokalizacja nie jest zweryfikowana.
INVALID_LOCATION_CATEGORY Kategoria lokalizacji nie jest odpowiednia dla typu działania związanego z miejscem. Typ działania związanego z miejscem, który powoduje błąd, zostanie zwrócony w metadanych z ciągiem znaków „place_action_type” jako kluczem i ciągiem wartości wyliczeniowym PlaceActionType jako wartością.
INVALID_URL Adres URL jest uszkodzony lub nieprawidłowy. Nieprawidłowy adres URL działania związanego z miejscem zostanie zwrócony w metadanych z ciągiem znaków „url” jako kluczem i adresem URL jako wartością.
URL_PROVIDER_NOT_ALLOWED Adres URL ma niedozwolonego dostawcę. Niedozwolony adres URL działania związanego z miejscem zostanie zwrócony w metadanych wraz z ciągiem znaków „url” jako kluczem i adresem URL jako wartością.
TOO_MANY_VALUES Ustawiono zbyt wiele wartości dla typu działania związanego z miejscem. Typ, w przypadku którego osiągnięto limit, zostanie zwrócony w metadanych z ciągiem znaków „place_action_type” jako kluczem i ciągiem wartości wyliczeniowym PlaceActionType jako wartością.

GetPlaceActionLinkRequest

Prośba o wiadomość dotyczącą PlaceActions.GetPlaceActionLink.

Pola
name

string

To pole jest wymagane. Nazwa linku do działania związanego z miejscem do pobrania.

ListPlaceActionLinksRequest

Prośba o wiadomość dotyczącą PlaceActions.ListPlaceActionLinks. Spowoduje to wyświetlenie linków do działań związanych z danym miejscem w określonej kolejności. Może to spowodować problemy z wyświetleniem linków utworzonych niedawno (w ciągu ostatnich 24 godzin) na innych platformach, np. na stronie internetowej Google Moja Firma. Wszystkie linki utworzone ponad 24 godziny temu będą wyświetlane przez ten interfejs API.

Pola
parent

string

To pole jest wymagane. Nazwa lokalizacji, dla której będą wyświetlane linki do działań związanych z miejscem. locations/{location_id}.
filter

string

Opcjonalnie. Filtr ograniczający linki działań związanych z miejscem, które mają zostać zwrócone. Odpowiedź zawiera wpisy pasujące do filtra. Obsługujemy wyłącznie następujące filtry: 1. place_action_type=XYZ, gdzie XYZ to prawidłowa wartość PlaceActionType.
page_size

int32

Opcjonalnie. Liczba linków do działań związanych z miejscem do zwrócenia na stronę. Wartość domyślna to 10. Minimalna wartość to 1.
page_token

string

Opcjonalnie. Jeśli podasz wartość, zwraca następną stronę linków do działań związanych z miejscem.

ListPlaceActionLinksResponse

Odpowiedź na pytanie dotyczące PlaceActions.ListPlaceActionLinks.

Pola
next_page_token

string

Jeśli linków do działań związanych z miejscem jest więcej niż żądany rozmiar strony, to pole zostanie wypełnione tokenem służącym do pobrania następnej strony z wynikami.

ListPlaceActionTypeMetadataRequest

Prośba o wiadomość dotyczącą elementu PlaceActions.ListPlaceActionTypeMetadata. Wyniki nie będą zwracane w określonej kolejności.

Pola
language_code

string

Opcjonalnie. Kod języka IETF BCP-47, w którym są pobierane nazwy wyświetlane. Jeśli ten język nie jest dostępny, zostaną podane w języku angielskim.
page_size

int32

Opcjonalnie. Liczba typów działań uwzględnianych na stronie. Wartość domyślna to 10, minimalna 1.
page_token

string

Opcjonalnie. Jeśli zostaną określone, zostanie pobrana następna strona z metadanymi typu działania związanego z miejscem. Wartość pageToken jest zwracana, gdy wywołanie metody placeActionTypeMetadata.list zwraca więcej wyników, niż może się zmieścić w żądanym rozmiarze strony.
filter

string

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

Jeśli nie podasz filtra, zwracane będą wszystkie typy działań związanych z miejscem.

ListPlaceActionTypeMetadataResponse

Odpowiedź na pytanie typu PlaceActions.ListPlaceActionTypeMetadata.

Pola
place_action_type_metadata[]

PlaceActionTypeMetadata

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

string

Jeśli liczba typów działań przekracza żądany rozmiar strony, w tym polu pojawi się token służący do 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.

ProviderType

Można tylko odczytywać typ dostawcy linku.

Wartości w polu enum
PROVIDER_TYPE_UNSPECIFIED Nie określono.
MERCHANT Dostawca zewnętrzny, np. sprzedawca, lub agencja działająca w imieniu sprzedawcy.
AGGREGATOR_3P Agregator zewnętrzny, np. partner Reserve with Google.

PlaceActionType

Typ działania związanego z miejscem, które można wykonać za pomocą linku.

Wartości w polu enum
PLACE_ACTION_TYPE_UNSPECIFIED Nie określono.
APPOINTMENT Typ działania to zarezerwowanie spotkania.
ONLINE_APPOINTMENT Typ działania to rezerwowanie spotkania online.
DINING_RESERVATION Typ działania to rezerwowanie stolika w restauracji.
FOOD_ORDERING Typ działania to zamawianie jedzenia z dostawą lub na wynos.
FOOD_DELIVERY Typ działania to zamawianie jedzenia z dostawą.
FOOD_TAKEOUT Typ działania to zamawianie jedzenia na wynos.
SHOP_ONLINE Typ działania to zakupy, np. dostawa lub odbiór.

PlaceActionTypeMetadata

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

Pola
place_action_type

PlaceActionType

Typ działania związanego z miejscem.
display_name

string

Zlokalizowana nazwa wyświetlana atrybutu, jeśli jest dostępna. W przeciwnym razie – angielska nazwa wyświetlana.

UpdatePlaceActionLinkRequest

Prośba o wiadomość dotyczącą PlaceActions.UpdatePlaceActionLink.

Pola
update_mask

FieldMask

To pole jest wymagane. Określone pola do zaktualizowania. Jedyne pola, które można edytować, to uri, place_action_type i is_preferred. Jeśli zaktualizowany link już istnieje w tej samej lokalizacji z tymi samymi wartościami place_action_type i uri, wystąpi błąd ALREADY_EXISTS.