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

本地帖子的说明/正文。
callToAction

object (CallToAction)

用户点击推广活动后会转到的网址。对于主题类型 OFFER，系统会忽略此参数。
createTime

string (Timestamp format)

仅限输出。帖子的创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

与帖子关联的媒体。对于 LocalPost MediaItem，唯一受支持的数据字段是 sourceUrl。
searchUrl

string

仅限输出。指向 Google 搜索中本地帖子的链接。您可以使用此链接通过社交媒体、电子邮件、短信等方式分享帖子。
topicType

enum (LocalPostTopicType)

必需。帖子的主题类型：标准、活动、优惠或提醒。
alertType

enum (AlertType)

为帖子创建的提醒类型。此字段仅适用于 topicType 为“提醒”的帖子，并充当提醒的子类型。
联合字段 topic_type_specific_fields。主题类型的特定字段。topic_type_specific_fields 只能是下列其中一项：
offer

object (LocalPostOffer)

优惠帖子的其他数据。仅当 topicType 为 OFFER 时，才应设置此字段。

CallToAction

用户点击帖子时执行的操作

JSON 表示法 
{
  "actionType": enum (ActionType),
  "url": string
}
字段
actionType

enum (ActionType)

将要执行的操作的类型。
url

string

用户点击后将会转到的网址。对于来电 CTA，应将此字段保持为未设置状态。

ActionType

将要执行的操作的类型。

枚举
ACTION_TYPE_UNSPECIFIED 未指定类型。
BOOK 此帖子提示用户预约服务/桌位等。
ORDER 此帖子提示用户订购商品。
SHOP 此帖子提示用户浏览商品清单。
LEARN_MORE 此帖子提示用户前往他们的网站了解详情。
SIGN_UP 此帖子提示用户注册/报名/参加某项活动。
GET_OFFER

已弃用。在 LocalPostTopicType 中使用 OFFER 创建包含优惠内容的帖子。
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 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

TimeInterval

时间间隔（含）。必须包含所有字段才能生效。

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)

相应时间段的结束时间。

日期

表示整个或部分日历日期（例如生日）。一天中的时间和时区要么在别处指定，要么不重要。日期相对于公历。可以表示以下任一情况：

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天，年份值为零（例如周年纪念日）。
  • 单独的年份，月份和天值为零。
  • 年份和月份，天值为零（例如，信用卡到期日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间，或为 0（即指定不含年份的日期）。
month

integer

一年中的第几个月。必须介于 1 到 12 之间，或为 0（即只指定年份，不指定月份和天值）。
day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效，或为 0（即天不重要，指定单独的年份或者年份和月份）。

TimeOfDay

表示一天中的某个时间。日期和时区不重要，或在别处指定。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 允许闰秒，则 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

每月出现一次的模式。

DailyOccurrencePattern

此类型没有字段。

表示每日发生模式。

WeeklyOccurrencePattern

表示每周出现一次的模式。

JSON 表示法 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
字段
daysOfWeek[]

enum (DayOfWeek)

可选。优惠/活动的周内日期列表。如果为空，则帖子将在与活动 schedule.start_time 相同的星期几重复发布。

DayOfWeek

表示星期几。

枚举
DAY_OF_WEEK_UNSPECIFIED 未指定星期几。
MONDAY 星期一
TUESDAY 星期二
WEDNESDAY 星期三
THURSDAY 星期四
FRIDAY 星期五
SATURDAY 星期六
SUNDAY 星期日

MonthlyOccurrencePattern

表示每月一次的发生模式。

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，则该活动将在每个月的第二个星期五重复。

DayOfWeekOccurrence

相应星期几在该月中的出现次数。

枚举
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED 未指定星期几的发生情况。
FIRST 相应月份中一周的第一天。
SECOND 一个月中的第二个星期几。
THIRD 相应月份的第三个星期几。
FOURTH 相应月份的第 4 个星期几。
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 与新型冠状病毒 (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

 更新指定的本地帖子，并返回更新后的本地帖子。