互动属性参考

互动端点返回的互动对象和回复对象的字段参考。

列出某个地点的互动、获取汇总互动和按 ID 获取互动均返回互动对象。2 个支持分页的端点将这些对象封装在 Relay 风格的连接中:data.interactions(按地点)和 data.rollupInteractions(账户汇总)各自包含 edges[].node、pageInfo 和 totalCount。按 ID 获取时不分页,data.interactionDetails 是一个普通的 { "interactions": [ ... ] } 对象,不包含 edges、pageInfo 或 totalCount。

互动字段

字段类型说明
idString互动的 UUID。回复时将其作为 interactionId 传入
interactionIdString与 id 相同的 UUID
sourceString评价网站或社交网站的主机名(例如 maps.google.com、yelp.com)
titleString互动标题,仅在来源提供标题时存在
contentString评价或帖子的正文
authorNameString作者的显示名称
ratingInteger星级评分,1–5(仅适用于评价)
dateString互动的 ISO 8601 时间戳
permalinkString来源网站上该互动的直接链接
categoryString顶层分类,例如 Review 或 Social
typeString具体的互动类型,Review、Question、Comment、Recommendation、Post、Photo、Message、Response
respondedBoolean是否存在商家回复
notesString账户所有者的私人备注
responsesArray此互动关联的商家回复(见下文)
responseCountInteger关联的回复数量
canRespondBoolean是否可以通过 Listings API 向此来源发布回复
locationIdInteger所属地点的数字数据库 ID
flaggedReasonString互动被标记的原因(如有)

回复对象字段

互动的 responses 数组中的每一项(以及回复互动返回的对象):

字段类型说明
idString唯一回复 ID(编辑或归档时作为 responseId 传入)
interactionIdString此回复所属互动的 ID
contentString回复文本
authorNameString显示的回复者名称
dateString回复创建时的时间戳
respondedWithString使用的回复模板 ID(如有)
respondedByInteger提交该回复的 Listings API 用户的 ID
interactionStatusString生命周期状态,CREATED、FAILED、COMPLETED 或 CONFIRMED
editedResponseBoolean此回复自首次发布后是否经过编辑
remarksString系统备注(例如失败详情)

回复状态流转

interactionStatus 字段用于跟踪回复发布到来源网站的过程:

  • CREATED → COMPLETED:已发布到发布平台;该平台不提供二次确认
  • CREATED → COMPLETED → CONFIRMED:已发布,随后已获发布平台确认
  • CREATED → FAILED:向发布平台提交失败;请参阅 remarks

筛选枚举值

支持分页的端点接受以下枚举值作为筛选条件:

  • responseStatus:RESPONDED、PENDING
  • sortOrder:NEWEST_FIRST、OLDEST_FIRST、LAST_RESPONDED
  • category:REVIEW(以及各账户提供的其他顶层分类)