プレイヤーを Lingara アカウントにリンク

パラメーター

Lingara-Versionheaderstring任意

このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

player_refpathstring必須

プレイヤーのトークンを発行したときの player_ref をパーセントエンコードしたもの。guild/42 は guild%2F42 になります。

レスポンス

200 プレイヤーのリンク

statusLinkStatus必須

subjectstring必須

アカウントの lgr_sub_：このプレイヤーのイベントが今後持つ値です。

previous_subjectstring必須

ゲストの lgr_sub_：プレイヤーの過去のイベントが保持する値です。両方を同じ player_ref に振り分けてください。

linked_atstring必須

リンクが作成された日時。existing の応答では最初の呼び出しの日時です。

scopesarray of string必須

このプレイヤーのトークンが現在持てる最大の範囲：プレイヤーのトークンが持てるスコープのうち、アカウントが許可したもの。

carriedobject必須

この呼び出しでアカウントに移した行数（テーブルごと）。件数のあるテーブルだけが表示されます。

keptobject必須

この呼び出しでゲストに残した行数（テーブルごと）：まだ作成中のプラン、またはアカウントがすでに持っていた行。ここの lesson_plans に完了したプランができたら、もう一度呼び出してください。

エラー

402application/json

従量課金クライアントの呼び出しは、何も消費する前に拒否されました。spend_cap_reached：クライアントまたはそのアカウントが月間の支出上限に達しています。「連携」ページで上限を引き上げてください。metered_billing_inactive：このアカウントでは従量課金が有効になっていません。「連携」ページで設定するか、支払い方法を更新してください。

410application/json

このリクエストに応答する API バージョンは提供を終了しました。Lingara-Version でサポート対象のバージョンを送るか、クライアントを別のバージョンに固定し直してください。

4XXapplication/json

リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。

503application/json · text/plain

サービスは一時的に利用できません。Retry-After に示された秒数が経過してから再試行してください。メンテナンス中は、本文はエラーエンベロープではなくプレーンテキストになります。

5XXapplication/json

リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。

codestring必須

リクエストが拒否された理由を、分岐に使える安定したコードで示します。例：insufficient_scope（403）、rate_limited（429）、従量課金クライアントの場合は spend_cap_reached（402）と metered_billing_inactive（402）。

errorstring必須

例

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。