Package google.mybusiness.placeactions.v1

Индекс

PlaceActions

Этот API позволяет управлять ссылками PlaceAction для местоположений компаний.

ListPlaceActionTypeМетаданные

rpc ListPlaceActionTypeMetadata( ListPlaceActionTypeMetadataRequest ) returns ( ListPlaceActionTypeMetadataResponse )

Возвращает список доступных типов действий с местом для местоположения или страны.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/business.manage

Дополнительную информацию см. в обзоре OAuth 2.0 .

CreatePlaceActionLinkRequest

Сообщение запроса для PlaceActions.CreatePlaceActionLink.

Поля
parent

string

Необходимый. Имя ресурса местоположения, в котором можно создать ссылку на действие этого места. locations/{location_id} .

Удалитьплацеэкшнлинкреквест

Сообщение запроса для PlaceActions.DeletePlaceActionLink.

Поля
name

string

Необходимый. Имя ресурса ссылки действия места, которую нужно удалить из местоположения.

Код ошибки

Коды ошибок внутренних сбоев.

Перечисления
ERROR_CODE_UNSPECIFIED Неуказанный код ошибки.
UNVERIFIED_LOCATION Местоположение не проверено.
INVALID_LOCATION_CATEGORY Категория местоположения не соответствует типу действия места. Тип действия места, вызвавший ошибку, будет возвращен в метаданных со строкой «place_action_type» в качестве ключа и строкой значения перечисления PlaceActionType в качестве значения.
INVALID_URL URL-адрес неверен/недействителен. Недопустимый URL-адрес действия места будет возвращен в метаданных со строкой "url" в качестве ключа и URL-адресом в качестве значения.
URL_PROVIDER_NOT_ALLOWED У URL-адреса есть запрещенный поставщик. URL-адрес запрещенного действия с местом будет возвращен в метаданных со строкой «url» в качестве ключа и URL-адресом в качестве значения.
TOO_MANY_VALUES Для типа действия места задано слишком много значений. Тип, для которого достигнут предел, будет возвращен в метаданных со строкой «place_action_type» в качестве ключа и строкой значения перечисления PlaceActionType в качестве значения.

GetPlaceActionLinkRequest

Сообщение запроса для PlaceActions.GetPlaceActionLink.

Поля
name

string

Необходимый. Название ссылки действия места, которую нужно получить.

СписокМестоДействиеСсылкиЗапрос

Сообщение запроса для PlaceActions.ListPlaceActionLinks. Здесь будут перечислены ссылки на действия для определенного местоположения в произвольном порядке. Это может не вернуть ссылки, которые были созданы недавно (в течение последних 24 часов) через другие поверхности, например, веб-сайт Google MyBusiness. Любая ссылка, созданная более 24 часов назад, будет отображаться через этот API.

Поля
parent

string

Необходимый. Название места, ссылки на действия которого будут отображаться. locations/{location_id} .

filter

string

Необязательный. Фильтр, ограничивающий возврат ссылок на действия с местом. Ответ включает записи, соответствующие фильтру. Мы поддерживаем только следующий фильтр: 1. Place_action_type=XYZ, где XYZ — допустимый PlaceActionType.

page_size

int32

Необязательный. Сколько ссылок на действия будут возвращаться на страницу. По умолчанию 10. Минимальное значение — 1.

page_token

string

Необязательный. Если указано, возвращает следующую страницу со ссылками на действия места.

ListPlaceActionLinksResponse

Ответное сообщение для PlaceActions.ListPlaceActionLinks.

Поля
next_page_token

string

Если ссылок на действия с местом больше, чем запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы результатов.

ListPlaceActionTypeMetadataRequest

Сообщение запроса для PlaceActions.ListPlaceActionTypeMetadata. Результаты будут возвращены в произвольном порядке.

Поля
language_code

string

Необязательный. Код языка IETF BCP-47 для отображения отображаемых имен. Если этот язык недоступен, они будут предоставлены на английском языке.

page_size

int32

Необязательный. Сколько типов действий включать на страницу. По умолчанию — 10, минимум — 1.

page_token

string

Необязательный. Если указано, извлекается следующая страница метаданных типа действия места. pageToken возвращается, когда вызов placeActionTypeMetadata.list возвращает больше результатов, чем может поместиться в запрошенный размер страницы.

filter

string

Необязательный. Фильтр, ограничивающий типы действий с местом, для которых возвращаются метаданные. Ответ включает записи, соответствующие фильтру. Мы поддерживаем только следующие фильтры: 1. location=XYZ, где XYZ — это строка, указывающая имя ресурса местоположения в формате locations/{location_id} . 2. Region_code=XYZ, где XYZ — это код региона Unicode CLDR для поиска доступных типов действий.

Если фильтр не указан, возвращаются все типы действий с местом.

ListPlaceActionTypeMetadataResponse

Ответное сообщение для PlaceActions.ListPlaceActionTypeMetadata.

Поля
place_action_type_metadata[]

PlaceActionTypeMetadata

Коллекция метаданных для доступных типов действий с местом.

next_page_token

string

Если количество типов действий превысило запрошенный размер страницы, это поле будет заполнено токеном для получения следующей страницы при последующем вызове placeActionTypeMetadata.list . Если результатов больше нет, это поле не будет присутствовать в ответе.

ТипПровидера

Тип поставщика ссылок доступен только для чтения.

Перечисления
PROVIDER_TYPE_UNSPECIFIED Не указан.
MERCHANT Поставщик 1P, например продавец или агентство от имени продавца.
AGGREGATOR_3P 3P-агрегатор, например Reserve with Google .

ТипПлейсДейшнТип

Тип действия с местом, которое можно выполнить по ссылке.

Перечисления
PLACE_ACTION_TYPE_UNSPECIFIED Не указан.
APPOINTMENT Тип действия — запись на прием.
ONLINE_APPOINTMENT Тип действия — запись на прием онлайн.
DINING_RESERVATION Тип действия — бронирование столика в ресторане.
FOOD_ORDERING Тип действия — заказ еды на доставку и/или на вынос.
FOOD_DELIVERY Тип действия — заказ еды на доставку.
FOOD_TAKEOUT Тип действия — заказ еды на вынос.
SHOP_ONLINE Тип действия — покупка, которая может быть доставкой и/или самовывозом.

PlaceActionTypeМетаданные

Метаданные для поддерживаемых типов действий с местом.

Поля
place_action_type

PlaceActionType

Тип действия места.

display_name

string

Локализованное отображаемое имя атрибута, если оно доступно; в противном случае — отображаемое имя на английском языке.

ОбновитьМестоДействиеСсылкаЗапрос

Сообщение запроса для PlaceActions.UpdatePlaceActionLink.

Поля
update_mask

FieldMask

Необходимый. Конкретные поля для обновления. Единственные редактируемые поля — это uri , place_action_type и is_preferred . Если обновленная ссылка уже существует в том же месте с тем же place_action_type и uri , произойдет сбой с ошибкой ALREADY_EXISTS .