DeepLの「課金対象文字数を表示」パラメータで、詳細なAPI利用レポートを取得する

主なポイント
- DeepL APIユーザーは、成功したそれぞれのAPIリクエストについて課金対象となる文字数を確認できます。
- show_billed_charactersパラメータを使用すると、ユーザーはAPIレスポンスから直接、即座にAPI利用データにアクセスできます。
- このリクエストごとの利用データは、APIから直接、独自のレポート作成やコスト追跡のワークフローに活用できます。
- このツールは、翻訳可能な文字の特定が難しいHTMLやXMLなどの構造化コンテンツにおいて特に便利です。
- この機能により、DeepL APIのレポート機能が/usageエンドポイントの範囲を超えて拡張され、翻訳アクティビティをより正確に把握できるようになります。
- 新しいshow_billed_charactersパラメータは、追加の設定を必要とせず、すべてのDeepL APIをお使いのお客様に今すぐご利用いただけます。
DeepL APIは、常に開発者や企業様に向けたレポートと分析の提供を最優先事項としてきました。これは、API内の/usageエンドポイントから直接生成する場合でも、複数のAPIキー向けのレポート機能で生成する場合でも同じことです。
当社チームは、拡大を続けるレポートツールのラインナップに便利な新機能を追加しました。これにより、今後すべてのAPIユーザー様に「show_billed_characters」をご利用いただけるようになりました。
今回の措置で、DeepL APIのレポート機能はさらに充実しました。今後は、各APIリクエストのレスポンスデータについて、課金対象となる文字数を詳細に確認できるようになりました。
DeepL APIは、当社の強力な言語AIを活用してさらに精力的に業務をこなせるようお手伝いをします。
show_billed_charactersパラメータとは?
これまでは、APIユーザーがDeepL APIから直接正確な使用状況データを取得したい場合には、/usageエンドポイントを呼び出すしかありませんでした。これは、進行中の請求期間における最新のご利用文字数を取得するための、非常に効果的な方法です。しかし、各リクエストで翻訳された文字数の正確な内訳は取得できません。
オプションのパラメータを使用すると、成功したそれぞれのAPIリクエストレスポンスについて翻訳され課金対象となった文字数が取得できるため、この問題が解決します。
DeepL APIユーザー様向けの、キー単位の柔軟なレポート機能をご紹介します。
show_billed_charactersパラメータの仕組みとは?
cURLコマンドなどを通じてAPIに直接リクエストを送信するAPIユーザーは、リクエストに新しい「show_billed_characters」パラメータを追加できます。これにより、レスポンスデータの一部として、課金対象となる文字数が返されます。
文字数に応じた課金が発生するAPIレスポンスでは、すべてのレスポンスで「billed_characters:50」という形式の新しい整数値が返されます。
APIユーザーはこの値を追跡し、レポート作成ワークフローや個々のAPIリクエストのコスト追跡に利用できます。
これはHTMLやXMLなどの構造化コンテンツを含むリクエストにおいて、翻訳可能な文字を特定することが困難な場合、特に有用です。
DeepLでは将来的に、デフォルトでAPIレスポンスにbilled_charactersを含める予定です。そうなった場合、APIレスポンスに「billed_characters」を含めないようにするには、show_billed_charactersを「false」に設定する必要が出てきます。
複数のAPIキーを使用してセキュリティを強化するDeepLによる取り組みの詳細はこちら。
show_billed_charactersを有効にした場合のAPIレスポンスの表示例
現在、APIにリクエストを送信すると、次のようなレスポンスが返されます:

新しい 「show_billed_characters」パラメータを使用してリクエストを送信すると、レスポンスは次のようになります:

グローバル企業が今すぐ取り組むべき6つの翻訳改革についてはこちら。
DeepLがリクエストごとの課金対象文字数レポート機能を追加した理由
多くのお客様からこの機能についてのご要望をいただいておりました。今回のアップデートにより、API翻訳リクエストが成功するたびに、課金対象となる文字数の詳細なレポートを取得し、そのデータを貴社のレポートツールに直接統合できるようになります。
show_billed_charactersパラメータはDeepL APIユーザー向けにすでに一般提供されているため、追加設定なしでご利用いただけます。
さらに、この変更を反映するためにAPI技術資料を更新しました。技術資料を参考にしながら、show_billed_charactersパラメータ機能をワークフローに統合し、翻訳の精度向上にお役立てください。
詳細については、リクエストボディの説明およびリリースノートをご覧ください。
DeepLのツールが、真の越境ビジネスの実現に向けてAI翻訳を変革していくプロセスをご覧ください。
DeepL APIでよりスマートなレポート作成を実現