用語集
ANKK APP と API で使用する主要なドメイン用語と、その定義をまとめています。各用語から関連ガイドも参照できます。
🏢 ブランド (Brand)
Section titled “🏢 ブランド (Brand)”SNS 接続、公開ジョブ、チームメンバー、API キーをまとめて管理する主要なワークスペースです。各 API キーは 1 つのブランドにのみ紐付きます。
🔗 SNS 接続 (SNS Connection)
Section titled “🔗 SNS 接続 (SNS Connection)”ブランドと外部のソーシャルメディアアカウントを、OAuth または資格情報で認証して結び付けたものです。connection_id で識別されます。
- 関連ガイド: SNS アカウントの接続、Connections API、SNS の機能
📝 コンテンツ (Content)
Section titled “📝 コンテンツ (Content)”特定の SNS 接続に公開する単位です。本文、メディア、ハッシュタグ、予約日時、プラットフォーム固有のパラメータを含みます。
- 関連ガイド: コンテンツの作成、Contents API
⚙️ 公開ジョブ (Publish Job)
Section titled “⚙️ 公開ジョブ (Publish Job)”コンテンツを送信先の SNS に配信する非同期処理を追跡する実行記録です。
- 関連ガイド: キューと公開ステータス、失敗と再試行
📥 作成されたコンテンツ vs 収集されたコンテンツ (Created Content vs Collected Content)
Section titled “📥 作成されたコンテンツ vs 収集されたコンテンツ (Created Content vs Collected Content)”- 作成されたコンテンツ: ANKK APP 内で作成または予約された投稿です。失敗時に再試行でき、キューで待機中は編集できます。
- 収集されたコンテンツ: 外部の SNS アカウントから同期された既存の投稿です。読み取り専用で、ANKK 内では編集も再試行もできません。
- 関連ガイド: 公開済みコンテンツ
⏳ 受理済み (Accepted / HTTP 202)
Section titled “⏳ 受理済み (Accepted / HTTP 202)”リクエストが認証、割り当て、およびペイロードの検証に合格し、安全にキューに入れられたことを示します。実際の配信完了(published)とは異なります。
- 関連ガイド: キューと公開ステータス、Webhooks
🔑 べき等キー (Idempotency Key)
Section titled “🔑 べき等キー (Idempotency Key)”クライアントから提供される一意のトークンで、外部ソーシャルネットワークでの二重投稿のリスクなしに安全な再試行を保証します。
- 関連ガイド: エラー処理、Contents API
⚠️ 再接続が必要 vs ユーザーの操作が必要 (Reconnect Required vs Requires User Action)
Section titled “⚠️ 再接続が必要 vs ユーザーの操作が必要 (Reconnect Required vs Requires User Action)”- 再接続が必要: トークンの期限切れまたは権限の取り消しが発生しており、OAuthの再認証が必要です。
- ユーザーの操作が必要: 外部プラットフォームのアプリ内で直接アクション(例:新しい規約への同意)を行う必要があります。
- 関連ガイド: 失敗と再試行、SNSアカウントの接続
🔔 Webhook
Section titled “🔔 Webhook”ジョブの完了時にエンドポイントに配信される、HMAC SHA256署名済みのリアルタイムHTTP POSTイベントです。
- 関連ガイド: Webhooksリファレンス