Method: stats.getIndex

すべてのデータソースにわたって集約されたインデックス登録されたアイテムの統計情報を取得します。この API は、過去の日付の統計情報のみを返します。当日のデータは返されません。

注: この API を実行するには、標準のエンドユーザー アカウントが必要です。

HTTP リクエスト

GET https://cloudsearch.googleapis.com/v1/stats/index

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
fromDate

object (Date)

統計情報を取得する期間の開始日。この値は、現在の日付から 1 年以内である必要があります。

toDate

object (Date)

統計情報を取得する期間の終了日。この値は、現在の日付から 1 年以内であり、fromDate より大きい必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "stats": [
    {
      object (CustomerIndexStats)
    }
  ],
  "averageIndexedItemCount": string
}
フィールド
stats[]

object (CustomerIndexStats)

インデックスに登録されたアイテム数の概要(リクエストされた期間の日数分)。

averageIndexedItemCount

string (int64 format)

請求が行われる特定の期間のアイテムの平均数。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud_search.stats.indexing
  • https://www.googleapis.com/auth/cloud_search.stats
  • https://www.googleapis.com/auth/cloud_search

詳しくは、認可ガイドをご覧ください。

CustomerIndexStats

指定した日付のステータス コード別のアイテムの集計。

JSON 表現
{
  "date": {
    object (Date)
  },
  "itemCountByStatus": [
    {
      object (ItemCountByStatus)
    }
  ]
}
フィールド
date

object (Date)

統計が計算された日付。

itemCountByStatus[]

object (ItemCountByStatus)

ステータス コード別に集計されたアイテムの数。