一回の操作で許可する作業を決める
オンボーディングの参考資料を探す機能では、利用者の一操作でアーカイブを何回呼び出してよいかを先に決めます。Reddit API Gatewayは、製品基盤を担当するエンジニア向けに独立したRedditの履歴アーカイブへのアクセスを提供します。公式の提携やリアルタイム更新はありません。SaaSの小さなサンプルを使い、公開前に機能の予算境界を整理できます。
過去の言及を数件表示する画面を想定してください。バックエンドは製品利用者の権限を確認してから、上限のある処理を受け付けます。利用者別の制限や支出枠は自分のアプリケーションで実装します。アーカイブキーが示すのはこのドメインの支払うアカウントであり、製品のロールや顧客別残高を割り当てるものではありません。
三件を要求し、ゼロ件の結果も確認する
開始例は、https://api.redditapigateway.com/v1/search?q=onboarding&subreddit=SaaS&limit=3 へのGETです。qは検索語、subredditは対象コミュニティ、limitはこの要求で取得したい上限件数を指定します。これは要求形式の例であり、実際の応答や三件の存在を示したものではありません。SaaSの記録は不足している場合も、存在しない場合もあります。取得ページを製品側で分類することはできますが、サーバーが製品分析や感情分析を自動で行うわけではありません。
説明専用の合成応答例：{"data":[],"pagination":{"page":1,"limit":3,"total":0,"relation":"eq"},"credits":{"cost":1,"balance":99}}。実際の取得結果ではなく、残高も架空です。空の結果でも成功した一回の取得には一クレジットが必要です。画面で使える記録の有無と取得の成功を分け、実際に受け取った応答を保存してから処理の進捗を更新してください。
処理単位で試行回数を数える
計画例として、一処理につき取得を最大三回まで試行できるようにします。三回とも成功すれば、表示に使える記録がなくても三クレジット、$0.003です。この試行上限は製品側のルールです。保存した行数だけでなく、ページ移動や再試行も同じ枠に含めて数えてください。
保存済みの応答をもう一度処理するだけなら、新しい取得要求は不要です。一方、新しいサンプルの要求では内容が変わる可能性があり、成功すれば追加のクレジットを消費します。更新操作が有料の作業を開始する場合は、保存済み結果を開く操作と区別し、利用者が選べるようにします。
サンプルから伝えられることを選ぶ
応答は平坦なレコードで、順番はアーカイブの文書順です。日時順、関連度順、スコア順ではありません。min_scoreは最低スコアの絞り込みだけを行います。parent_idやlink_idがあれば関係分析のために任意でまとめられますが、単に読む、数える、分類するためにツリーを作る必要はありません。グループ化しても欠けた親やコメントは復元されず、一ページを会話全体やコミュニティ全体の活動として扱うことはできません。
表示するのは受信したサンプルだと明示します。短いページだけでは、SaaSにほかのオンボーディングの議論がないとはいえません。ローカルで記録をまとめても会話全体を復元した証拠にはなりません。選んだ内容と一緒に要求引数や取得時の情報を保存すると、別の担当者も表示の根拠を確認できます。
サンプル取得を運用できる製品機能にする
フィルターはドキュメントで選び、許可する呼び出し数は料金ページで見積もります。キーのページではアカウントと残高を準備し、ガイドでは許可した処理の中で秘密情報を使い、交換する手順を確認します。サンプルを繰り返し利用する製品機能へ移す前に、各段階の担当を決めてください。
最低追加額は$50で、有料50,000クレジットに相当します。月額契約ではなく、有料クレジットに有効期限はありません。試用100クレジットはネットワーク全体の不正利用防止条件によるため、全アカウントに必ず付く予算として扱わないでください。アカウント、キー、残高はredditapigateway.com専用です。製品の利用者ごとの上限や機能別の予算は、自分のアプリケーションで別途設ける制御です。
