API ベストプラクティス

以下のチェックリストは、正常なインテグレーションにとって重要なプラクティスの一覧です。インテグレーションにおいて、以下の全てのプラクティスが実施されているか確認してください。

Gengo API のワークフロー

適切なワークフローは以下の通りです。

  • 原文テキストの提出
  • 注文ステータスの取得
  • 完成した翻訳文の取得

詳しくは、ビジュアルガイド をご確認ください。

三重角括弧の活用

三重角括弧は、ブランド名といった特定のテキストを、変更せずそのまま残したい場合に便利です。詳細

注: HTML タグは例外です。これらはもともと翻訳・編集されることがないため、三重角括弧は使用しないでください。

position パラメーターの活用

提出する文字列の語順を維持する必要がある場合(字幕など)、リクエスト時に案件ごとに position パラメータ(1から始まる)を設定してください。これにより、トランスレーターは想定される語順を確認できます。

可能な限り案件をグループ化

as_group パラメータを 1 に設定することで、複数の案件を同じ言語ペアとレベルで提出できます。これにより、グループ化された案件に対して単一のトランスレーターが翻訳にあたるため、品質の一貫性が向上します。

トランスレーターに文脈を提供

文脈に関する追加の情報を提供いただくことで、翻訳の品質と精度が向上するだけでなく、納期が早まります。

注文レベルのコメントには指示やスタイルガイドのほか、追加の分脈情報となる外部ドキュメントへのリンクを記載してください。

案件レベルのコメントにて、特定の案件への文脈情報をご提供ください。attachments パラメータを使えば、分脈情報として画像をご提供いただけます。ペイロードに関する詳細は、こちら でご確認ください。

custom_data に内部情報を保存

“custom_data” パラメータは、Gengo API ユーザーが自身のシステムに関する参照情報を接続するために設計されたものです。callback_urlslug には参照情報を保存しないでください。

コールバック機能と更新情報のポーリングの両方を使用、どちらか一つでは不十分

コールバック/Webフックの機能により、プロジェクトの通知を受け取ることができます。これにより、ご注文のステータスの変更を簡単に把握できます。コールバックが送信された場合に関する詳細は、コールバックに関するページ でご確認いただけます。

ただし、ネットワークの問題が生じた際など、コールバックが正しく送信されない場合もあります。ご注文の翻訳状況を把握するため、定期的に案件のステータスをご確認ください。ビジュアルガイドにあるように、GET /translate/jobs/{ids}/ エンドポイント を使用することで、受注可能な案件をご確認いただけます。

必要に応じて、承認、拒否、案件の修正依頼の機能を追加

必ず、PUT /translate/jobs/ エンドポイント を使用し、承認、拒否、案件の修正依頼のオプションを追加してください。

詳しくは、レビューのワークフロー のセクションをご確認ください。

信頼できるトランスレーター、または お気に入りトランスレーター が翻訳にあたっている場合を除き、auto_approve = 0 の使用をお勧めします。案件が承認された場合、お客様は翻訳に満足されたことを確認したことになり、返金や再翻訳を要求する権利は失われます。