REST Resource: accounts.locations.localPosts

Источник: LocalPost

Обозначает местное отделение для определенного населенного пункта.

JSON-представление 
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object (CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "recurringInstanceTime": string,
  "event": {
    object (LocalPostEvent)
  },
  "state": enum (LocalPostState),
  "media": [
    {
      object (MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum (LocalPostTopicType),
  "alertType": enum (AlertType),

  // Union field topic_type_specific_fields can be only one of the following:
  "offer": {
    object (LocalPostOffer)
  }
  // End of list of possible types for union field topic_type_specific_fields.
}
Поля
name

string

Только вывод. Идентификатор Google для этой локальной публикации в формате: accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}

languageCode

string

Язык местной почты.

summary

string

Description/body of the local post.

callToAction

object ( CallToAction )

URL-адрес, на который пользователи перенаправляются при переходе по ссылке в рекламной акции. Игнорируется для типа темы OFFER .

createTime

string ( Timestamp format)

Output only. Time of the creation of the post.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

updateTime

string ( Timestamp format)

Только вывод. Время последнего изменения записи пользователем.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

scheduledTime

string ( Timestamp format)

Если задано, определяет, когда будет опубликована запись. Пользователь может установить это значение, чтобы планировать публикации заранее.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

recurringInstanceTime
(deprecated)

string ( Timestamp format)

Только для вывода. Устарело: используйте event.recurring_instance_time вместо него. Это поле будет удалено в будущей версии. Только для вывода. Время обновления последнего повторяющегося экземпляра записи.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

event

object ( LocalPostEvent )

Информация о мероприятии. Обязательно для тем типа EVENT и OFFER .

state

enum ( LocalPostState )

Только вывод. Состояние публикации, указывающее, на каком этапе жизненного цикла она находится.

media[]

object ( MediaItem )

Медиафайлы, связанные с публикацией. sourceUrl — единственное поддерживаемое поле данных для элемента LocalPost MediaItem.

searchUrl

string

Только для вывода. Ссылка на местную публикацию в поиске Google. Эту ссылку можно использовать для распространения публикации в социальных сетях, по электронной почте, в SMS и т. д.

topicType

enum ( LocalPostTopicType )

Обязательно. Тип темы сообщения: стандартное, событие, предложение или оповещение.

alertType

enum ( AlertType )

Тип оповещения, для которого создается сообщение. Это поле применимо только к сообщениям с типом темы «Оповещение» и является подтипом «Оповещения».

Поле объединения topic_type_specific_fields . Конкретные поля для типа темы. topic_type_specific_fields может принимать только одно из следующих значений:
offer

object ( LocalPostOffer )

Дополнительные данные для сообщений с предложениями. Этот параметр следует устанавливать только в том случае, если topicType имеет значение OFFER.

Призыв к действию

Действие, которое выполняется, когда пользователь переходит по ссылке в публикации.

JSON-представление 
{
  "actionType": enum (ActionType),
  "url": string
}
Поля
actionType

enum ( ActionType )

Тип действия, которое будет выполнено.

url

string

URL-адрес, на который пользователь будет перенаправлен после нажатия кнопки. Для кнопки «Позвонить» это поле следует оставить незаполненным.

Тип действия

Тип действия, которое будет выполнено.

Перечисления
ACTION_TYPE_UNSPECIFIED Тип не указан.
BOOK В этом посте пользователю предлагается записаться на прием/забронировать столик и т.д.
ORDER В этом посте пользователю предлагается сделать заказ.
SHOP В этом посте пользователю предлагается просмотреть каталог товаров.
LEARN_MORE Цель этой публикации — побудить пользователя узнать больше (на их веб-сайте).
SIGN_UP В этом посте пользователю предлагается зарегистрироваться/вступить в какую-либо организацию.
GET_OFFER

Устарело. Используйте OFFER в LocalPostTopicType для создания публикации с содержимым, содержащим предложение.

CALL В этом сообщении пользователю предлагается позвонить в компанию.

LocalPostEvent

Вся информация, касающаяся мероприятия, опубликованного в местном издании.

JSON-представление 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
Поля
title

string

Название мероприятия.

schedule

object ( TimeInterval )

Дата и время начала и окончания мероприятия.

recurrenceInfo

object ( RecurrenceInfo )

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

recurringInstanceTime

string ( Timestamp format)

Только вывод. Время последнего обновления повторяющегося экземпляра записи.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

Временной интервал

Интервал времени включительно. Для корректной работы он должен содержать все поля.

JSON-представление 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
Поля
startDate

object ( Date )

Дата начала этого периода.

startTime

object ( TimeOfDay )

Время начала этого периода.

endDate

object ( Date )

Дата окончания этого периода.

endTime

object ( TimeOfDay )

The end time of this period.

Дата

Представляет собой целую или частичную календарную дату, например, день рождения. Время суток и часовой пояс либо указаны отдельно, либо не имеют значения. Дата указывается относительно григорианского календаря. Это может представлять одно из следующих значений:

  • Полная дата, включающая ненулевые значения года, месяца и дня.
  • Месяц и день, с нулевым годом (например, годовщина).
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц, с нулевым днем ​​(например, срок действия кредитной карты).

Связанные типы:

JSON-представление 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должен быть от 1 до 9999, или 0, чтобы указать дату без года.

month

integer

Месяц года. Должен быть от 1 до 12, или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должен быть от 1 до 31 и соответствовать году и месяцу, или 0, чтобы указать только год или год и месяц, где день не имеет значения.

Время суток

Представляет собой время суток. Дата и часовой пояс либо не имеют значения, либо указаны в другом месте. API может разрешить использование високосных секунд. Связанные типы: google.type.Date и google.protobuf.Timestamp .

JSON-представление 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Поля
hours

integer

Часы суток в 24-часовом формате. Значение должно быть больше или равно 0 и, как правило, меньше или равно 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия предприятия.

minutes

integer

Минуты часа. Должно быть больше или равно 0 и меньше или равно 59.

seconds

integer

Секунды минуты. Должно быть больше или равно 0 и, как правило, меньше или равно 59. API может допускать значение 60, если он поддерживает високосные секунды.

nanos

integer

Доли секунд, в наносекундах. Должно быть больше или равно 0 и меньше или равно 999 999 999.

RecurrenceInfo

Представляет информацию о повторяемости локальной публикации.

JSON-представление 
{
  "seriesEndTime": string,

  // Union field occurrence_pattern can be only one of the following:
  "dailyPattern": {
    object (DailyOccurrencePattern)
  },
  "weeklyPattern": {
    object (WeeklyOccurrencePattern)
  },
  "monthlyPattern": {
    object (MonthlyOccurrencePattern)
  }
  // End of list of possible types for union field occurrence_pattern.
}
Поля
seriesEndTime

string ( Timestamp format)

Необязательно. Время окончания ряда повторений.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

Поле объединения occurrence_pattern . Шаблон повторения для повторяющейся записи. occurrence_pattern может принимать только одно из следующих значений:
dailyPattern

object ( DailyOccurrencePattern )

Ежедневная закономерность возникновения.

weeklyPattern

object ( WeeklyOccurrencePattern )

Еженедельная закономерность возникновения.

monthlyPattern

object ( MonthlyOccurrencePattern )

Ежемесячная закономерность возникновения.

Ежедневная закономерность событий

Этот тип не содержит полей.

Отражает закономерность ежедневных событий.

Еженедельная закономерность возникновения

Представляет собой закономерность еженедельных событий.

JSON-представление 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Поля
daysOfWeek[]

enum ( DayOfWeek )

Необязательно. Список дней недели для предложения/мероприятия. Если поле пустое, публикация будет повторяться в тот же день недели, что и время начала мероприятия.

День недели

Обозначает день недели.

Перечисления
DAY_OF_WEEK_UNSPECIFIED День недели не указан.
MONDAY Понедельник
TUESDAY Вторник
WEDNESDAY Среда
THURSDAY Четверг
FRIDAY Пятница
SATURDAY Суббота
SUNDAY Воскресенье

Ежемесячная закономерность возникновения

Представляет собой закономерность возникновения событий в течение месяца.

JSON-представление 
{

  // Union field monthly_option can be only one of the following:
  "dayOfMonth": integer,
  "dayOfWeekOccurrence": enum (DayOfWeekOccurrence)
  // End of list of possible types for union field monthly_option.
}
Поля
Поле объединения monthly_option . Параметр повторения для шаблона ежемесячного выполнения. monthly_option может принимать только одно из следующих значений:
dayOfMonth

integer

День месяца.

dayOfWeekOccurrence

enum ( DayOfWeekOccurrence )

День недели, совпадающий с датой события в месяце. День недели определяется днем ​​недели, с которого началось событие. Например, если событие начинается в пятницу, а dayOfWeekOccurrence равно SECOND, то событие будет повторяться во вторую пятницу каждого месяца.

День недели

День недели, соответствующий определенному событию в месяце.

Перечисления
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED Событие, произошедшее в неуказанный день недели.
FIRST Первый день недели в месяце.
SECOND Второй день недели в месяце.
THIRD Третий день недели в месяце.
FOURTH Четвертый день недели в месяце.
LAST Последний день недели в месяце.

LocalPostState

Указывает, в каком состоянии находится сообщение.

Перечисления
LOCAL_POST_STATE_UNSPECIFIED Штат не указан.
REJECTED Данная публикация была отклонена из-за нарушения правил размещения контента.
LIVE Данная публикация размещена и в настоящее время отображается в результатах поиска.
PROCESSING Данная публикация находится в процессе обработки и не отображается в результатах поиска.
SCHEDULED Эта публикация запланирована на будущее и не отображается в результатах поиска.
RECURRING Эта публикация является повторяющейся и в настоящее время отображается в результатах поиска.

LocalPostTopicType

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

Перечисления
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED Тип записи не указан.
STANDARD В публикации содержится основная информация, такая как краткое описание и изображения.
EVENT В сообщении содержится основная информация и описание события.
OFFER В публикации содержится основная информация, сведения о мероприятии и предложениях (например, промокод).
ALERT Важные и своевременные объявления, касающиеся текущих событий. Не всегда есть возможность писать подобные посты.

AlertType

Тип события, для которого было создано оповещение.

Перечисления
ALERT_TYPE_UNSPECIFIED Информация об оповещении отсутствует.
COVID_19 Оповещения, связанные с пандемией коронавирусной болезни 2019 года. Для публикаций, посвященных COVID-19, поддерживаются только поля с кратким описанием и призывом к действию. Когда эти оповещения перестанут быть актуальными, создание новых публикаций типа «COVID-19» будет отключено. Однако продавец по-прежнему сможет управлять существующими публикациями, посвященными COVID-19.

LocalPostOffer

Конкретные поля для размещения предложений.

JSON-представление 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
Поля
couponCode

string

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

redeemOnlineUrl

string

Необязательно. Ссылка для активации предложения доступна онлайн.

termsConditions

string

Необязательно. Условия предложения.

Методы

create

 Создает новый локальный пост, связанный с указанным местоположением, и возвращает его.

delete

 Удаляет локальную запись.

get

 Получает указанный локальный пост.

list

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

patch

 Обновляет указанный локальный пост и возвращает обновленный локальный пост.