Listings APIListings API
登入

互動屬性參考

互動端點傳回的互動與回覆物件欄位參考。

列出地點的互動、取得彙總互動 和 依 ID 取得互動 會傳回互動物件。兩個分頁端點會將這些物件包裝在 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（以及各帳戶提供的其他高階分類）