For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/ja/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/ja/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/ja/tutorials-billing-analysis.md.
  • 🇯🇵 日本語

    • OVHcloud API: 請求データ分析の設定

    このガイドでは、OVHcloud請求APIの複数のエンドポイントを設定する手順を提供します

    目的

    このガイドでは、OVHcloud請求APIの複数のエンドポイントを設定する手順を提供します。請求データを取得し、アプリケーションに統合して正確で効率的な財務追跡を行う方法を学びます。

    請求ガイド

    概要

    OVHcloud APIは、複数のエンドポイント設定をサポートしており、相互に接続されたリソースからデータを取得して統合できます。このガイドでは、OVHcloud請求APIエンドポイントの設定と利用方法について包括的な手順を提供します。これらの手順に従うことで、請求情報をプログラム的に取得、処理、分析することができます。

    必要条件

    開始する前に、以下を確認してください：

    • 請求アクセス権限のあるアクティブなOVHcloudアカウント
    • API認証情報、具体的には：
      • アプリケーションキー（App Key）
      • アプリケーションシークレット（App Secret）
      • コンシューマーキー
    • OVHcloud API Developer Portalへのアクセス
    • APIエンドポイント相互作用の基本的な理解

    請求エンドポイント設定の手順

    1. API接続の初期化

    OVHcloud API Connectorドキュメントに詳述されている認証設定プロセスに従って、OVHcloud API接続を設定します。これは、コネクタのユーザーインターフェースを通じてアプリケーションキー、アプリケーションシークレット、およびコンシューマーキーを取得して安全に入力することを含みます。これらの認証情報の取得と設定についての包括的な手順については、コネクタドキュメントのAPI接続詳細セクションを参照してください。

    1. API接続の初期化 — 請求ガイド 1. API接続の初期化 — 請求ガイド (2)

    2. 請求エンドポイントの定義

    2.1. アカウント請求IDの取得

    • エンドポイント: /me/bill
    • 目的: アカウントのすべての請求IDのリストを取得

    手順:

    1. コネクタで「新しいエンドポイントを追加」を選択
    2. エンドポイントパスとして/me/billを入力
    3. クエリパラメータを設定（例：年でフィルタリング） - この例では、キー:date.fromと値:2023を使用し、2023年のレコードを取得します。
    4. エンドポイントに一意の名前bills_ids_from_2023があることを確認
    5. 「確認」と「保存」をクリック
    2.1. アカウント請求IDの取得 — 請求ガイドエンドポイント 2.1. アカウント請求IDの取得 — 請求ガイドエンドポイント (2)
    Info

    接続されたエンドポイントが正しいかどうかを確認する追加の手順を含めることができます。この手順は必須ではありませんが、最初の場合は、探しているデータの概要を得るのに役立ちます。

    エンドポイントデータの検証

    1. アナライザータブに移動
    2. 新しいエンドポイントのメタデータを抽出
    3. 請求レコードが正しく取得されていることを確認

    2.2. アカウント請求詳細IDの取得

    • エンドポイント: /me/bill/{billId}/details
    • 目的: 各請求行の詳細IDのリストを取得

    手順:

    1. 「エンドポイントを追加」をクリック
    2. エンドポイントパスとして/me/bill/{billId}/detailsを入力
    3. 複数エンドポイント選択を設定
    4. 前の請求エンドポイントにリンク
    5. パスパラメータとして{billId}を選択
    6. エンドポイントに一意の名前bills_details_ids_from_2023があることを確認
    7. 設定を保存
    2.2. アカウント請求詳細IDの取得 — 請求ガイドエンドポイント 2.2. アカウント請求詳細IDの取得 — 請求ガイドエンドポイント (2) 2.2. アカウント請求詳細IDの取得 — 請求ガイドエンドポイント (3)
    Info

    ソース管理を簡素化するために、一意のエンドポイント名を使用します。これは、ステップ4. レイクハウスにデータをインポートする際に役立ちます。

    Warning

    注意: 現在、1つのパスパラメータのみが動的に選択できます。複数のパスパラメータを持つ複雑なエンドポイントの場合は、手動入力が必要になる場合があります。

    設定タブをクリックしてメインモーダルに戻ると、パスパラメータとエンドポイントフィールドが編集不可になっていることに気づくでしょう。これは、これらの値が別のエンドポイントから派生しているためです。変更が必要な場合は、単に複数エンドポイントセクションに戻り、エンドポイント選択ドロップダウンから「複数エンドポイントなし」を選択します。

    2.3. アカウント請求詳細の取得

    • エンドポイント: /me/bill/{billId}/details/{detailsID}
    • 目的: 各請求行の詳細を取得

    手順:

    1. 「エンドポイントを追加」をクリック
    2. エンドポイントパスとして/me/bill/{billId}/details/{detailsID}を入力
    3. 複数エンドポイント選択を設定
    4. 前の請求詳細IDエンドポイントにリンク
    5. パスパラメータとして{billId}と{detailsID}を選択
    6. エンドポイントに一意の名前bills_details_from_2023があることを確認
    7. 設定を保存
    2.3. アカウント請求詳細の取得 — 請求ガイドエンドポイント 2.3. アカウント請求詳細の取得 — 請求ガイドエンドポイント (2)

    2.4. サービスIDの取得

    • エンドポイント: /services
    • 目的: アカウントのすべてのサービスのIDを取得

    手順:

    1. 「エンドポイントを追加」をクリック
    2. エンドポイントパスとして/servicesを入力
    3. エンドポイントに一意の名前services_idsがあることを確認
    4. 設定を保存
    2.4. サービスIDの取得 — 請求ガイドエンドポイント

    2.5. サービス情報の取得

    • エンドポイント: /services/{serviceId}
    • 目的: パイプラインのデータを豊かにするためにサービスについての情報を取得

    手順:

    1. 「エンドポイントを追加」をクリック
    2. エンドポイントパスとして/services/{serviceId}を入力
    3. 複数エンドポイント選択を設定
    4. 前のサービスIDエンドポイントにリンク
    5. パスパラメータとして{serviceId}を選択
    6. エンドポイントに一意の名前servicesがあることを確認
    7. 設定を保存
    2.5. サービス情報の取得 — 請求ガイドエンドポイント 2.5. サービス情報の取得 — 請求ガイドエンドポイント (2)

    エンドポイントの設定はこれで完了です。以下のように表示されるはずです：

    2.5. サービス情報の取得 — 請求ガイドエンドポイント (3)

    3. メタデータの抽出

    エンドポイントが設定されたので、Connectors内のアナライザーツールに移動します。そこで、最近設定したエンドポイントを選択してください。システムがこれらのエンドポイントに関連する処理ジョブを開始し、完了するのに時間がかかる場合があります。

    Warning

    このプロセスの所要時間は、タスクの複雑さと処理されるデータ量によって異なります。

    3. メタデータの抽出 — 請求ガイド分析 3. メタデータの抽出 — 請求ガイド分析 (2) 3. メタデータの抽出 — 請求ガイド分析 (3) 3. メタデータの抽出 — 請求ガイド分析 (4) 3. メタデータの抽出 — 請求ガイド分析 (5) 3. メタデータの抽出 — 請求ガイド分析 (6)

    3.1. データの書式変更

    ソースから抽出したデータは、ブループリントを通じてバケット化するか、または私たちが望む正確な形式に合わせて変更できます。これは、2つのエンドポイントについて行う予定です。

    • bills_details_from_2023
    • services

    3.1.1. 請求明細の書式変更

    APIからのフィールドperiodstartは、YYYY-MM-DD形式の値です。DDは、サービスを購入した日によって月内の任意の日となります。この日を各月の1日に設定するためにブループリントを使用します。

    3.1.1. 請求明細の書式変更 — 請求ガイド分析

    データ分析の右上にあるNew Ruleをクリックし、Date formatを選択してください。

    3.1.1. 請求明細の書式変更 — 請求ガイドブループリント

    ブループリントの設定画面に移動しました。以下のように入力してください。

    • 属性: periodstart
    • 現在の日付形式: %Y-%m-%d
    • 置き換え: %Y-%m-01
    • 条件: Is not null
    3.1.1. 請求明細の書式変更 — 請求ガイドブループリント (2)

    確認をクリックすると、periodstartに1つのブループリントがあることがわかります。

    3.1.1. 請求明細の書式変更 — 請求ガイドブループリント (3)

    3.1.2. サービスの書式変更

    servicesエンドポイントの多くの日付時刻フィールドには、タイムゾーン情報が含まれています。このタイムゾーン情報を日付時刻から削除するために、Date Formatブループリントですべての日付を書式変更します。これは、以前に見た通りです。

    servicesエンドポイントに移動し、New ruleをクリックし、Date formatを選択してください。

    3.1.2. サービスの書式変更 — 請求ガイド分析 3.1.2. サービスの書式変更 — 請求ガイドブループリント

    ブループリントの設定画面に移動しました。以下のように入力してください。

    • 属性: billing_next_billingdate
    • 現在の日付形式: %Y-%m-%dT%H:%M:%S%z
    • 置き換え: %Y-%m-%dT%H:%M:%S
    • 条件: All
    3.1.2. サービスの書式変更 — 請求ガイドブループリント (2)

    次の属性についても同じ操作を繰り返すことができます。

    • billing_expirationdate
    • billing_lifecycle_current_terminationdate
    • billing_lifecycle_current_creationdate
    • billing_renew_current_nextdate

    4. データをレイクハウスにインポート

    データソースが設定されたので、テーブルを構築することができます。Lakehouse ManagerとTablesセクションに移動し、+とCreate from a Connectors sourceをクリックしてください。

    最初のテーブルは、bill_details_from_2023データソースを使用してポップレートされます。raw_bills_detailsの次をクリックしてテーブルをリネームし、その後作成をクリックしてください。

    4. データをレイクハウスにインポート — 請求ガイドレイクハウス 4. データをレイクハウスにインポート — 請求ガイドレイクハウス (2)

    専用のテーブルにサービスをインポートすることもできます。

    4. データをレイクハウスにインポート — 請求ガイドレイクハウス (3) 4. データをレイクハウスにインポート — 請求ガイドレイクハウス (4)

    5. サービスにタグを追加

    費用を分類するために、タグでサービスを分類したいと思います。タグは、技術環境（例：プロダクション、開発）や会社の部門、またはお客様を表すことができます。

    最初に分類するサービスのリストを抽出するには、Lakehouse Manager内のExplorerセクションに移動してください。

    データで、domainを選択し、selectをクリックし、select_distinctに置き換え、その後RUNをクリックしてください。

    次のような結果が得られるはずです。

    5. サービスにタグを追加 — 請求ガイドタグ

    DownloadとAs a CSVをクリックすると、タグ付けするすべてのリソースが含まれた最初のCSVファイルが得られます。開き、列select_distinct_domainをdomainにリネームし、その後2番目の列tagを追加し、タグ付けしたい各ドメインについて、希望する値を追加してください。次のようなCSVファイルが得られるはずです。

    5. サービスにタグを追加 — 請求ガイドタグ (2)

    このCSVファイルをConnectorsに新しいデータソースとして追加し、レイクハウスからテーブルを作成する時が来ました。Connectors -> sources -> New Source -> File Uploadに移動できます。新しいソースにDomains Taggedと名前を付け、CSVファイルを追加し、createボタンをクリックしてください。

    5. サービスにタグを追加 — 請求ガイドタグ (3) 5. サービスにタグを追加 — 請求ガイドタグ (4)

    データが正しく評価されているかどうかを確認するためにアナライザーに戻り、タグにブループリントを追加し、空の値をunknownに置き換えることができます。new rule、Replace Byをクリックしてください。フォームを以下のように入力してください。

    • 属性: tag
    • 置き換え: unknown
    • 条件: Equal
    • 等しい: 空白のままにしてください

    ブループリントを確認してください。

    5. サービスにタグを追加 — 請求ガイドタグ (5) 5. サービスにタグを追加 — 請求ガイドタグ (6) 5. サービスにタグを追加 — 請求ガイドタグ (7)

    Lakehouse ManagerとTablesセクションに戻り、この新しいソースからテーブルを作成できます。テーブルにdomains_tagsと名前を付けることを忘れないでください。

    5. サービスにタグを追加 — 請求ガイドタグ (8) 5. サービスにタグを追加 — 請求ガイドタグ (9)

    6. 集約テーブルの作成

    現在、サービス、請求書、タグに関する多くの情報を持っています。これらの情報をすべて結びつけるために、集約テーブルを構築します。

    Lakehouse ManagerおよびTablesセクション内で、+およびCreate a new empty tableをクリックします。名前を付けます: enriched_bills_details。

    6. 集約テーブルの作成 — 請求ガイドの集約

    これで、Lakehouseに次のテーブルを持つことになります:

    • services
    • domains_tags
    • raw_bills_details
    • enriched_bills_details
    6. 集約テーブルの作成 — 請求ガイドの集約 (2)

    ソースから作成したテーブルからいくつかのフィールドをドラッグし、enriched_bills_detailsにドロップします。ドラッグ＆ドロップするフィールドは次の通りです:

    • raws_bills_detailsから:
      • domain
      • periodstart
      • totalprice_value
    • domains_tagsから:
      • tag
    • servicesから:
      • resource_displayname
      • resource_product_name
      • resource_product_description

    enriched_bills_detailsテーブルは、次のようになります:

    6. 集約テーブルの作成 — 請求ガイドの集約 (3)

    これで、Buildをクリックして、この新しいテーブルを構築できます。 この新しいテーブルの構造ができたので、前の3つのテーブルからデータを抽出し、この新しいテーブルにロードするジョブを作成します。Data Processing EngineおよびActionsセクションに移動する必要があります。New Actionをクリックし、Aggregateを選択します。

    6. 集約テーブルの作成 — 請求ガイドの集約 (4)

    次に、異なるテーブルからのフィールドをenriched_bills_detailsにマッピングします。そのためには、まずソースと宛先を選択する必要があります:

    • ソース:
      • raws_bills_details
      • services
      • domains_tags
    • 宛先: enriched_bills_details

    ソースについては、3つのテーブルのデータがSQL JOIN構文を通じてどのようにリンクされているかを説明する必要があります。次に、次のジョインを追加します:

    • raws_bills_detailsとservicesの間:
    raws_bills_details.domain = services.resource_name
    • raws_bills_detailsとdomains_tagsの間:
    raws_bills_details.domain = domains_tags.domain
    6. 集約テーブルの作成 — 請求ガイドの集約 (5)

    集約を完了するには、テーブルの属性をenriched_bills_detailsに選択してグループ化する方法を設定する必要があります。以下のスクリーンショットに示すように属性をマッピングします。

    6. 集約テーブルの作成 — 請求ガイドの集約 (6)

    これで、集約を作成し、アクションを実行できます。

    7. クエリの準備とダッシュボードの構築

    現在、すべてのデータが活用できる状態になっているので、Analytics ManagerおよびQueriesに移動できます。 いくつかのクエリを作成しましょう。

    前月比のコスト推移

    クエリについては:

    • データ: totalprice_value sum FROM enriched_bills_details
    • スケール: periodstart
    • Order by: periodstart desc

    ビジュアライゼーションについては:

    • メトリックとして
    • カスタマイズ: すべてのトグルボタンを有効にします
    前月比のコスト推移 — 請求ガイドのチャート

    タグ別のコスト分布

    クエリについては:

    • データ: totalprice_value sum FROM enriched_bills_details
    • スケール: tag

    ビジュアライゼーションについては:

    • 円グラフとして
    • カスタマイズ:
      • カテゴリを表示
      • 合計の%を表示
      • 位置: 外側
      • 凡例を非表示
    タグ別のコスト分布 — 請求ガイドのチャート

    製品別のコスト分布

    クエリについては:

    • データ: totalprice_value sum FROM enriched_bills_details
    • スケール: resource_displayname

    ビジュアライゼーションについては:

    • 円グラフとして
    • カスタマイズ:
      • カテゴリを表示
      • 合計の%を表示
      • 位置: 外側
      • 凡例を非表示
    製品別のコスト分布 — 請求ガイドのチャート

    製品タイプ別のコスト分布

    クエリについては:

    • データ: totalprice_value sum FROM enriched_bills_details
    • スケール: resource_productdescription

    ビジュアライゼーションについては:

    • 円グラフとして
    • カスタマイズ:
      • カテゴリを表示
      • 合計の%を表示
      • 位置: 外側
      • 凡例を非表示
    製品タイプ別のコスト分布 — 請求ガイドのチャート

    月別およびタグ別のコスト

    クエリについては:

    • データ: totalprice_value sum FROM enriched_bills_details
    • スケール: periodstart resource_product_description tag
    • フィルタリング: periodstart Not null
    • Order by: periodstart asc

    ビジュアライゼーションについては:

    • 棒グラフとして
    • カスタマイズ:
      • 積み上げ表示
      • 凡例を非表示
      • X軸: 期間開始でグループ化
    月別およびタグ別のコスト — 請求ガイドのチャート

    ダッシュボードの作成

    ダッシュボードセクションに移動し、新しいダッシュボードを作成し、すべてのチャートをこのダッシュボードに追加できます。+ボタンをクリックします。

    ダッシュボードの上部には、データのナビゲーションを容易にするためにフィルタを追加できます。次のフィルタを追加することを検討してください:

    • periodstart
    • tag
    • resource_product_description
    ダッシュボードの作成 — 請求ガイドのチャート

    結論

    これらの手順に従うことで、OVHcloud Billing APIエンドポイントを効果的に構成し、請求情報をプログラムで取得、処理、分析することができます。

    さらに学ぶ

    トレーニングや技術的なサポートが必要な場合は、営業担当者にお問い合わせください、またはこのリンクをクリックして見積もりを依頼し、プロフェッショナルサービスの専門家にプロジェクトのカスタム分析を依頼してください。

    質問をする、フィードバックを送信する、およびData Platformを構築しているチームと直接交流するには、専用のDiscordチャネルにアクセスしてください。

    OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。

    ユーザーコミュニティに参加してください。