インタラクション属性リファレンス

インタラクションオブジェクトは、拠点のインタラクション一覧を取得、集約されたインタラクションを取得、ID を指定してインタラクションを取得で返されます。ページネーションに対応する 2 つのエンドポイントは、これらのオブジェクトを Relay 形式のコネクションでラップします。data.interactions（拠点単位）と data.rollupInteractions（アカウント内の集約）には、それぞれ edges[].node、pageInfo、totalCountが含まれます。ID を指定した取得ではページネーションは行われず、data.interactionDetailsは edges、pageInfo、totalCountを持たない単純な { "interactions": [ ... ] }オブジェクトです。

インタラクションのフィールド

フィールド	型	説明
id	String	インタラクションの UUID です。返信時に `interactionId`として渡します
interactionId	String	`id`と同じ UUID です
source	String	レビューサイトまたはソーシャルサイトのホスト名です（例: `maps.google.com`、`yelp.com`）
title	String	取得元が提供している場合のインタラクションのタイトルです
content	String	レビューまたは投稿の本文です
authorName	String	投稿者の表示名です
rating	Integer	1～5 の星評価です（レビューのみ）
date	String	インタラクションの ISO 8601 形式のタイムスタンプです
permalink	String	取得元サイト上のインタラクションへの直接リンクです
category	String	大分類です（例: `Review`、`Social`）
type	String	具体的なインタラクションの種類です。`Review`、`Question`、`Comment`、`Recommendation`、`Post`、`Photo`、`Message`、`Response`です
responded	Boolean	オーナーからの返信が存在するかどうかを示します
notes	String	アカウントオーナーの非公開メモです
responses	Array	このインタラクションに紐づくオーナーからの返信です（下記参照）
responseCount	Integer	紐づく返信の数です
canRespond	Boolean	この取得元に対して Listings API から返信を投稿できるかどうかを示します
locationId	Integer	このインタラクションが属する拠点のデータベース上の数値 ID です
flaggedReason	String	インタラクションにフラグが付けられた理由です（該当する場合）

返信オブジェクトのフィールド

インタラクションの responses配列の各要素（およびインタラクションに返信で返されるオブジェクト）のフィールドは次のとおりです。

フィールド	型	説明
id	String	一意の返信 ID です（編集時またはアーカイブ時に `responseId`として渡します）
interactionId	String	この返信が属するインタラクションの ID です
content	String	返信の本文です
authorName	String	返信者として表示される名前です
date	String	返信が作成された時点のタイムスタンプです
respondedWith	String	使用された返信テンプレートの ID です（使用されている場合）
respondedBy	Integer	返信を送信した Listings API ユーザーの ID です
interactionStatus	String	ライフサイクルの状態です。`CREATED`、`FAILED`、`COMPLETED`、または `CONFIRMED`です
editedResponse	Boolean	この返信が初回投稿後に編集されたかどうかを示します
remarks	String	システムの備考です（例: 失敗の詳細）

返信ステータスの遷移

interactionStatusフィールドは、取得元サイトへの返信の投稿状況を追跡します。

CREATED → COMPLETED: 掲載先に投稿済みです。そのプラットフォームでは二重確認を利用できません
CREATED → COMPLETED → CONFIRMED: 投稿後、掲載先によって確認済みです
CREATED → FAILED: 掲載先への送信に失敗しました。remarksを参照してください

フィルターの列挙値

ページネーションに対応するエンドポイントでは、次の列挙値をフィルターとして指定できます。

responseStatus: RESPONDED, PENDING
sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
category: REVIEW（およびアカウントごとに公開されるその他の大分類）