KPI ダッシュボードで日付フィルターをカスタマイズする

日付フィルターをカスタマイズするには、API を使用して日付フィルターメタデータ（MD）オブジェクトの JSON 構造を更新します。 次の操作が可能です。

  • 関連時間の細分性を追加、編集、および削除します
  • 事前定義された期間でのフィルターの追加、編集、および削除
  • フィルターの名前を変更
  • 新規 KPI ダッシュボードのデフォルトフィルターを設定

デフォルト JSON 構成の詳細については、この記事の最後にあるデフォルト日付フィルター JSON 構成セクションを参照してください。

日付フィルターメタデータオブジェクト

日付フィルターメタデータオブジェクトの場所：

  • ワークスペース全体： https://secure.gooddata.com/gdc/md/workspace_ID/objects/query?category=dateFilterConfig&limit=1

  • 既存のダッシュボード： https://secure.gooddata.com/gdc/md/workspace_ID/obj/KPI_dashboard_ID

各フィルター、またはフィルターの一部の識別：

  • localIdentifier - JSON 構成内のフィルターに対する固有の識別子
  • 名前 - KPI ダッシュボードに表示されるフィルター名 名前を空欄にしておくと、ダッシュボードが名前を作成します。 自分の名前を追加する場合、ローカライズバージョンもアップデートします。 詳細については、メタデータのローカライズを参照してください。

以下の JSON 名と関連付けられるフィルターの種類：

KPI ダッシュボード名JSON 名
全期間allTime
固定期間relativePresets *
関連時間relativeForm
事前定義された期間relativePresets
* 設定するスタティック期間は、JSON 構成の relativePresests セクションに追加されます。

関連時間の細分性を編集します

関連時間には、日、週、月、四半期、および年の各形式の細分性が含まれます：

"GDC.time.week_us",  “GDC.time.month”,  “GDC.time.year”,  “GDC.time.quarter”,  “GDC.time.date”

細分性を除去するには、relativeFormセクションからアイテムを削除します。 以下のコードは、月と年のみの関連時間を示しています。

"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true },

事前定義された期間を追加

relativePresetsセクションの JSON 構成では、日付フィルターの事前定義期間を編集します。

それぞれの事前定義期間は以下を含みます：

  • 細分性 は、日付、週、月、四半期、および年を次の形式で指定できます。

    "GDC.time.week_us",  "GDC.time.month",  "GDC.time.year",  "GDC.time.quarter",  "GDC.time.date"

  • から および へ は細分性と今日に関連することをベースに期間の長さを特定する 細分性を基に、今日からの時間差（常にゼロ）を特定する数値。  使用例：

    開始終了細分性メモ
    -20GDC.time.date過去 3 日間
    03GDC.time.week_us4 週間先
    -21GDC.time.month2 か月前から 1 か月先
    -1-1GDC.time.quarter前四半期
    00GDC.time.year今年

  • localIdentifier は、日付フィルター MD オブジェクト内の固有名

  • KPI ダッシュボードで表示されるフィルターの 名前

  • 表示 は、ダッシュボードで利用可能なフィルターを特定

次のコードは、過去 10 日間にフィルタリングされ、ダッシュボードに表示される新しいプリセットを表示します。

{ "from" : -9, "granularity" : "GDC.time.date", "localIdentifier" : "last_10_days", "name" : "Last 10 days", "to" : 0, "visible" : true },

フィルターの名前を変更

日付フィルターやその一部の名前を変更するには、フィルターに対する名前パラメーターを編集します。 名前を空欄にしておくと、自動的に作成されます。

次のコードは、「関連時間」が「関連フィルターを設定」に変更されたことを示しています。

"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "Set a relative filter", "visible" : true },

新規ダッシュボードようにデフォルトフィルターを変更

selectedOption パラメーターは、新規作成された KPI ダッシュボードに対するデフォルトとしてどの日付フィルターを表示するかを決定します。

デフォルトでは、すべての新規 KPI ダッシュボードは今月でフィルターされます。

デフォルトフィルターを変更するには、localIdentifier をselectedOption パラメーターに追加します。

"selectedOption" : "relative_last_7_days"

デフォルト日付フィルターの JSON 構成

日付フィルター用の JSON 構成は、個々のフィルターの定義で構成されます。

レファレンスにしたり、自分の日付フィルターをアップデートするために、以下のデフォルト JSON 構成を使用できます。

 { "dateFilterConfig" : { "content" : { "absoluteForm" : { "localIdentifier" : "absoluteForm", "name" : "absoluteForm", "visible" : true }, "allTime" : { "localIdentifier" : "allTime", "name" : "allTime", "visible" : true }, "relativeForm" : { "granularities" : [ "GDC.time.week_us", "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true }, "relativePresets" : [ { "from" : -6, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_7_days", "name" : "Last 7 days", "to" : 0, "visible" : true }, { "from" : -29, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_30_days", "name" : "Last 30 days", "to" : 0, "visible" : true }, { "from" : -89, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_90_days", "name" : "Last 90 days", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_this_week", "name" : "This week", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_week", "name" : "Last week", "to" : -1, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_two_weeks", "name" : "Last two weeks", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.month", "localIdentifier" : "relative_this_month", "name" : "This month", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_month", "name" : "Last month", "to" : -1, "visible" : true }, { "from" : -11, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_12_months", "name" : "Last 12 months", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_this_quarter", "name" : "This quarter", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_quarter", "name" : "Last quarter", "to" : -1, "visible" : true }, { "from" : -3, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_4_quarters", "name" : "Last 4 quarters", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.year", "localIdentifier" : "relative_this_year", "name" : "This year", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.year", "localIdentifier" : "relative_last_year", "name" : "Last year", "to" : -1, "visible" : true } ], "selectedOption" : "relative_this_month" } } }

 

 

KPI ダッシュボード上の日付フィルター