REST Resource: accounts.locations.localPosts

资源:LocalPost

表示营业地点的本地帖子

JSON 表示法
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object (CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "event": {
    object (LocalPostEvent)
  },
  "state": enum (LocalPostState),
  "media": [
    {
      object (MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum (LocalPostTopicType),
  "alertType": enum (AlertType),
  "offer": {
    object (LocalPostOffer)
  }
}
字段
name

string

仅供输出。此本地帖子的 Google 标识符,格式为:accounts/{accountId}/locations/{locationId}/localPosts/{localPostId}

languageCode

string

本地帖子的语言。

summary

string

本地帖子的说明/正文。

callToAction

object (CallToAction)

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

createTime

string (Timestamp format)

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅供输出。用户最后修改帖子的时间。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

event

object (LocalPostEvent)

活动信息。对主题类型 EVENTOFFER 是必需的。

state

enum (LocalPostState)

仅供输出。帖子的状态,指示帖子处于生命周期的哪个部分。

media[]

object (MediaItem)

与帖子相关联的媒体。sourceUrl 是 LocalPost MediaItem 唯一支持的数据字段。

searchUrl

string

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

topicType

enum (LocalPostTopicType)

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

alertType

enum (AlertType)

为帖子创建的提醒类型。此字段仅适用于 topicType 提醒 的帖子,其作用为提醒的子类型。

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)
  }
}
字段
title

string

事件名称。

schedule

object (TimeInterval)

活动的开始和结束日期/时间。

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)

此时间段的结束时间。

TimeOfDay

表示一天中的某个时间。日期和时区不重要,或在别处指定。API 可以选择允许闰秒。相关类型为 google.type.Dategoogle.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 和 999999999 之间的数字。

LocalPostState

指明帖子所处的状态

枚举
LOCAL_POST_STATE_UNSPECIFIED 未指定状态。
REJECTED 此帖子因违反内容政策而被拒绝。
LIVE 此帖子已发布,目前正显示在搜索结果中。
PROCESSING 此帖子正在处理中,不会显示在搜索结果中。

LocalPostTopicType

本地帖子的主题类型,用于选择不同的模板来创建和呈现帖子。

枚举
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED 未指定帖子类型。
STANDARD 帖子包含基本信息,例如摘要和图片。
EVENT 帖子包含基本信息和活动。
OFFER 帖子包含基本信息、活动和优惠相关内容(例如优惠券代码)
ALERT 与正在进行的活动相关的高优先级及时通知。这些类型的帖子并非始终可用于创作。

AlertType

为其创建提醒帖子的事件类型。

枚举
ALERT_TYPE_UNSPECIFIED 未指定提醒。
COVID_19 与 2019 年新型冠状病毒 (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

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

reportInsights

返回与单个商家信息相关联的一组本地帖子的数据分析。