ガイドAPIリファレンス
ガイド

projectHrnによる使用量のcsv取得方法

このチュートリアルでは、projectHrnを使用してcsv形式で使用量を取得する方法を説明します。プロジェクトHRNを見つけるには、プラットフォームランチャーで[プロジェクトマネージャー]オプションを選択します。プロジェクトHRNの表が表示され、そのリストからリクエストに対応する正しいプロジェクトHRNを見つけられます。

このサンプルリクエストでは、realmIdに_org123456789_、startDateに_2021-07-01T10:39:51_、endDateに_2021-08-30T10:39:51_、projectHrnに_hrn:here:authorization::myorganization:project/my-project-0000_を使用しています。

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789/csv?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&projectHrn=hrn%3Ahere%3Aauthorization%3A%3Amyrealm%3Aproject%2Fmy-project-0000

パラメーター

ここに示されているパラメーターは、このサンプルリクエストに必要なパラメーターのみです。パラメーターの全リストは、コスト管理の使用量API v2 APIリファレンスを参照してください。

realmId required文字列[5 ..30 ]文字。
_例:_org123456789
組織ID。
startDate
必須
文字列"date-time"。
*例:*startDate=yyyy-MM-dd'T'HH:mm:ss
検索する期間の開始日。
endDate
必須
文字列"date-time"。
*例:*endDate=yyyy-MM-dd'T'HH:mm:ss
検索する期間の終了日。
projectHrn256文字以下の文字列。
*例:*projectHrn=hrn:here:authorization::myrealm:project/my-project-0000
プロジェクトを識別するHRN。

ヘッダーパラメーター

X-Request-IDstring
サービスに送信された単一のリクエストまたは一連のリクエストを追跡するユーザー提供のトークン。
X-Correlation-ID
必須
string
自動生成されるID。リクエストを一意に識別し、レスポンスで利用可能。サポートチームに特定のリクエストの問い合わせを行う場合は、このヘッダーの値を共有します。こちらは問題のトラブルシューティングで役に立ちます。

レスポンス:HTTP 200 OK

csv形式のレスポンスには、次の列が一覧表示されます。

  • カテゴリー (category):カテゴリーとは選択した請求可能なサービスの名前で、位置情報サービス、コンテンツ、SDK、データ、パイプラインなどです。
  • サービス名またはリソース名:Navigate SDK、Network Positioning、3D Buildingsなどのサービス。
  • 請求タグ (billingTag):コストの結合に使用されるユーザー定義の一意の文字列。
  • プロジェクトID (projectHrn):(任意) 作業とリソースを管理するための一意の識別子。これはプロジェクトHRNとも呼ばれます。
  • 開始日 (startDate):使用の開始日。
  • 終了日 (endDate):使用の終了日。
  • 使用量 (billableValue):発生した請求可能な使用量。
  • 単位 (valueDriver):請求可能な単位 (GBなど)。
  • 単位あたりの料金:単位あたりの請求可能料金。
  • 合計価格:算出された使用量コスト。

パートナーの場合はcsv出力にもう1列追加されます。追加される列は組織の名前で、orgNameパラメーターです。