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

このチュートリアルでは、csv形式で組織の使用量を取得する方法を説明します。クエリパラメーターを使用してフィルターを追加し、アプリID、プロジェクトHRN、請求タグでクエリを実行できます。フィルターを追加すると、レスポンスにフィルター条件に一致する要素が含まれます。

groupBy機能では、位置情報サービス、コンテンツ、SDK、パイプライン、データなどのcategoryを選択して、レスポンス内の使用量データをグループ化できます。デフォルトでは、groupBy appId、name、billingTagに設定されています。つまり、これらすべてのプロパティがレスポンスに含まれます。

請求可能な使用量は時間単位で算出されます。APIは概要、時間、日、月の詳細レベルに対応しており、デフォルトのレベルは概要に設定されています。プリンシパルは使用量をリクエストしている組織に属している必要があります。csvで返されるレコードの最大数は20,000件で、クエリできる最大時間範囲は95日間です。

APIのレスポンスレコードは、サブスクリプションID、カテゴリー、請求項目 (同じサービス内のフィーチャーを区別し、対応する請求にリンクする) ごとにアルファベットの昇順で表示されます。

このサンプルリクエストでは、realmIdに_org123456789_、startDateに_2021-07-01T10:39:51_、endDateに_2021-08-30T10:39:51_、appIdに_j1dasda012edasfgne_を使用しています。

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789/csv?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&appId=j1dasda012edasfgne

パラメーター

ここに示されているパラメーターは、このサンプルリクエストに必要なパラメーターのみです。パラメーターの全リストは、コスト管理の使用量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 >検索する期間の終了日。
featureId	256文字以下の文字列。例：featureId=hrn:here:service::org123456789:search-geocoding-1 フィーチャーHRN。
appId	128文字以下の文字列。例：appId=j1dasda012edasfgne クライアントアプリID。これはプラットフォームが作成したアプリIDです。
channelId	string 列挙型 (enum)："hot"、"cold" 例：channelId=cold このパラメーターが設定されている場合は、結果は使用量レポートに使用されるチャネルを識別するIDでフィルターされます。
projectHrn	256文字以下の文字列例：projectHrn=hrn:here:authorization::myrealm:project/my-project-0000 プロジェクトを識別するHRN。
billingTag	500文字以下の文字列例：billingTag=testtag 請求タグを使用して、請求書のコストを合算します。
category	128文字以下の文字列例：category=Pipelines カテゴリーとは選択した請求可能なサービスの名前で、位置情報サービス、コンテンツ、SDK、データ、パイプラインなどです。
limit	整数[1 ..100 ] デフォルト：100 返されるレコードの数。デフォルトは最大レコード数である100件に設定されています。
offset	0以上の整数。デフォルト：0 オフセットで検索結果ビューの現在のページ番号を指定します。
detailLevel	string 列挙型 (enum)："summarized"、"hour"、"day"、"month" 例：detailLevel=hour このクエリパラメーターを使用して、使用量レコードで表示する詳細レベルを1つ選択できます。詳細レベルには、概要、時間、日、月があります。概要詳細レベルでは使用量の概要が表示され、こちらがデフォルトとなります。概要がdetailLevel値の場合、usageDateTimeフィールドの値は表示されません。
groupBy	256文字以下の文字列例：groupBy=appId, billingTag, project, resource groupByパラメーターはグループとして結合されるパラメーターのカンマ区切りのリストです。サポートされている値は、project、billingTag、appId、featureId、subscription IDです。デフォルトのgroupByパラメーターはfeatureIdとsubscription IDです。クエリにgroupByパラメーターを追加すると、featureIdとsubscription IDに追加されます。
usageFields	文字列の配列。列挙型 (enum)： realmId：組織ID。 featureId：フィーチャーHRN。 billingSubscriptionId：組織のサブスクリプションID。 billingChargeNumber：対応するサービス使用コストにマッピングする一意の請求ID。この数値を対応する使用量と組み合わせて、請求可能なコストを計算します。 category：パイプライン、データ、コンテンツ、SDK、位置情報サービスなどの製品カテゴリー。 name：組織の名前。 valueDriver：使用量の単位。GBやトランザクションなど。 usageValue：特定のサービスでのお客様の使用量を測定する数値メトリクス。 billableValue：発生した請求可能な使用量。 resource：取得されユーザーに提示されたすべての使用量のデータ統計。例：usageFields=realmId,featureId,category 一意または固有の使用量フィールド名のセットを使用して、レスポンスをフィルターします。例：usageFields=realmId,featureId,category 一意または固有の使用量フィールド名のセットを使用して、レスポンスをフィルターします。

ヘッダーパラメーター


X-Request-ID	string サービスに送信された単一のリクエストまたは一連のリクエストを追跡するユーザー提供のトークン。
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) です。