組織ごとに使用量を取得します

Usage API を使用すると、組織の使用状況を照会し、各組織のレルム ID を使用できます。 クエリパラメータを使用して、アプリ ID 、プロジェクト HERE リソースネーム 、または請求タグでクエリを実行することで、追加のフィルタを追加できます。 フィルタが追加されると、応答にはフィルタ条件に一致するエレメントが含まれます。

位置情報サービス、コンテンツ、 SDK 、パイプライン、データなどのcategoryを選択することで、応答内で使用状況データをグループ化できるgroupBy機能があります。 既定 ではgroupBy、appId、name、およびbillingTagがあります。つまり、これらのすべてのプロパティが応答に含まれます。

請求可能な使用量は時間レベルで計算されます。 API では、要約、時間、日、および月の各レベルで詳細情報がサポートされます。デフォルトのレベルは summary に設定されています。 原則は、使用を要求する組織の一部である必要があります。 クエリーできる最大時間範囲は 95 日です。

API の応答レコードは、サブスクリプション ID 、カテゴリ、および課金アイテムの昇順でアルファベット順に並べ替えられます ( 同じサービス内の機能を区別し、対応する課金にリンクされます ) 。

リクエスト

この例では 、に org123456789 を使用realmIdしています。

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789

パラメーター

このリクエストには、表示されている HERE パラメータが必要です。 すべてのパラメータの一覧について は、チュートリアルの概要を参照してください。

realmId が必要です 文字列 [5..] 30] 文字
の例 : org123456789
自分の組織 ID 。
開始日
が必要です 		文字列
の例 : startDate=yyyy-mm-dd'T'HH:mm:ss
検索の開始日。
終了日
が必要です 		文字列
の例 : endDate=yyyy-mm-dd 'T'H:mm:ss>
検索の終了日。
featureID 256 文字以下の文字列
。例
: featureId=hrn: here::service::org123456789: search-geocoding-1 Feature HERE リソースネーム 。
AppID 128 文字以下の文字列
。例
: appId = j1dasda012edasfgne クライアント アプリケーション ID 。これは、プラットフォーム で作成されたアプリケーション ID です。
チャネル ID 文字列
列挙型 (enum) : "hot" "cold"
の例 : channelId = cold
このパラメータを指定すると、結果は、使用状況のレポートに使用されたチャネルを識別する ID でフィルタリングされます。 コールドチャネルは新しい請求データ処理パイプラインですが、ホットチャネルは古い請求データ処理パイプラインです。 ChannelId はテスト目的で使用されます。
projectHrn 256 文字以下の文字列
例 : projectHrn=hrn: here::authorization::myrealm: project/my-project-0000
プロジェクトを識別する HERE リソースネーム 。
billingTag 500 文字以下の文字列
。例
: billingTag=testtag 請求タグは、請求書のコストを結合するために使用されます。
カテゴリ 128 文字以下の文字列
例 : category= パイプライン
カテゴリは、選択したサービスの名前 ( 位置情報サービス、コンテンツ、 SDK 、データ、パイプラインなど ) です。 請求対象。
制限 整数 [1] 。 100]
デフォルト : 100
返されたレコード数。 デフォルトの最大レコード数は 100 です。
オフセット 0 以上の整数
デフォルト : 0
オフセットは、検索結果ビューの現在のページ番号を決定します。
詳細レベル 文字列
列挙型 (enum) : "summarized" "hour" " "day" "month"
の例 : detailLevel= 時間
このクエリ パラメーターを使用して、使用状況レコードに表示する詳細レベルのいずれかを選択できます。 詳細レベルには、要約、時間、日、または月が含まれます。 要約された詳細レベルには、使用状況の概要が表示されます。これがデフォルトです。 detailLevel が SUMMARTED に設定されている場合、 usageDateTime フィールドの値は表示されません。
グループ化 256 文字以下の文字列
。例 : groupBy=appId, billingTag, project, resource
groupBy パラメータは、グループとして結合されるパラメータのコンマ区切りのリストです。 サポートされている値は、 project 、 billingTag 、 appId 、 featureId 、および subscription ID です。デフォルトの groupBy パラメータは、 featureId およびサブスクリプション ID です。groupBy パラメータがクエリに追加されると、 featureId およびサブスクリプション ID に追加されます。
usageFields 文字列の配列
列挙型 (enum) ：
realmId ： 組織 ID 。
機能 ID : Feature HERE リソースネーム 。
請求サブスクリプション ID: 組織のサブスクリプション ID 。
請求経費番号 : 対応するサービスの使用コストにマッピングされる一意の課金 ID 。 この数値は、対応する使用量の値と組み合わされ、請求可能なコストが計算されます。
カテゴリ : パイプライン、データ、コンテンツ、 SDK などの製品カテゴリ 位置情報サービスを利用できます。
名前 : 組織の名前。
値ドライバー : 使用量の値の単位。 たとえば、 GB または Transactions などです。
usageValue ： 特定のサービスの顧客の使用状況を測定する数値のメトリック。
請求可能な値 : 請求可能な使用量。
リソース : 取得され、ユーザーに提示されたすべての使用状況データの統計情報。
例 : usageFields=realmId, featureId, category
応答のフィルタリングに使用される一意 / 個別の使用フィールド名のセット。
例 : usageFields=realmId, featureId, category
応答のフィルタリングに使用される一意 / 個別の使用フィールド名のセット。

ヘッダーパラメーター

X-Request-ID ユーザー
が指定した文字列のトークン 。サービスに送信されたリクエストまたはリクエストのグループを追跡するために使用できます。
X-Correlation-ID
が必要です 		自動
生成された文字列の ID 。応答で使用可能なリクエストを一意に識別します。 特定のリクエストについて問い合わせがある場合にサポートに連絡するときは、このヘッダの値を入力してください。この値は、問題のトラブルシューティングに役立ちます。

応答 : HTTP 200 は正常です

{
    "total": 10,
    "limit": 2,
    "items":[
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-00011212",
      "category": "service",
      "name": "Geocoder Autosuggest",
      "valueDriver": "Transactions",
      "usageValue": "10",
      "billableValue": "10"
    },
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-0001124",
      "category": "service",
      "name": "Lane attributes",
      "valueDriver": "GB",
      "usageValue": "10",
      "billableValue": "10"
    }
  ], 
    "nextOffset": 1,
    "lastOffset": 4
}

詳細については 、 Usage API リファレンスを参照してください。

「」に一致する結果は 件です

    「」に一致する結果はありません