エラーと対処

よく返るエラーと、そのときにすること。

エラーの応答は、次の形の JSON です。error に短いコードが入るので、対処を分けるときはこの値を見てください。

{ "error": "quote_not_found", "status": 422 }

操作ごとのエラーは、API リファレンスの各ページの応答の欄に書いてあります。ここでは、多くの操作で出るものをまとめます。

送り直す前に読み直すもの

応答	意味	対処
409 `comments revision conflict`	読んだ後に、ほかの人かエージェントがコメントを書き換えた	文書を読み直し、応答の `currentRevision`（または読み直した `review.commentsRevision`）で送り直す
409 `stale_expected_version`	送った版の ID が最新でない	応答の `latestVersionId` で読み直して送り直す
409 `source_changed`・`version_changed`	run を開始した後に、文書の本文か版が変わった	文書を読み直し、新しい run で書き直す
409 `human_touched`	人が返信や解決などでそのコメントに触った	コメントは直さず、返信で伝える

応答	意味	対処
400	必須の項目が無い、形が違う	応答の `error` を見て、該当の項目を直す
401	トークンが違う、または送っていない	トークンと `Authorization` ヘッダーを確かめる
403	このトークンでは使えない操作、または対象に対する権限が無い	使えるトークンを API リファレンスで確かめる
404	文書・run・コメントが無い	ID を確かめる
413 `html too large`	HTML が大きすぎる（25 MiB まで）	画像を外に出すなどして小さくする
422 `quote_not_found`・`quote_not_unique`	コメントの位置の引用が、本文に無い・2 か所以上に当たる	本文をそのまま写す。2 か所以上に当たるときは、引用を長くするか見出しの区切りで絞る
422 `run_limit_exceeded`	1 つの run の上限を超えた	run を終えて、新しい run で続ける

応答	意味	対処
400 `invalid_member`	組織メンバーのメールアドレス、種別、状態が不正です。	メールアドレスと `external`・`client`、`active`・`disabled` の指定を確かめます。
403 `invite_not_member`	招待先、案件の役割の相手、またはオーナーの移譲先が組織の台帳に登録されていません。	組織管理者に台帳への登録を依頼します。
403 `project_required`	社外・クライアントの配信に案件が指定されていません。	`project` に案件コードを指定します。
403 `project_role_required`	配信または案件への結び付けを行う人が、その案件で編集以上の役割を持っていません。	案件の `editor` または `manager` の役割を確認します。
409 `owner_not_logged_in`	オーナーの移譲先が一度もログインしていません。	移譲先で先にログインしてから、もう一度実行します。
409 `owner_ambiguous`	移譲先のメールアドレスに複数の Google の身分があります。	対象の身分を整理してから、もう一度実行します。

応答	意味	対処
500	サーバー側の不備	時間をおいて送り直す。続くときは FSM へ連絡する
503	一時的に処理できない	少し待って送り直す