インサイト関数

インサイト関数は、Data Studioツール・スイートのインサイト・ツールに対するアプリケーション・プログラミング・インタフェースのクラス、メソッド、属性およびパラメータの構文と説明を提供します。インサイトの生成はバックグラウンドで実行され、完了を確認する必要があります。

リクエスト・リストの取得プロシージャ

リクエスト名とそのパラメータのリストを返します

構文

Insight.get_request_list(owner)

パラメータ:

owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、インサイトのジョブをリストできます:

adp.Insight.get_request_list()
 
// Output
 
 [
  ... 
  {
    "owner": "ADMIN",
    "request_name": "REQUEST_INSIGHT_1",
    "request_type": "TABLE_INSIGHT",
    "source_object": "SALES",
    "source_owner": "ADMIN",
    "request_metadata": "{\"targets\":[\"ACTUAL\"],\"appName\":\"INSIGHTS\"}",
    "created": "2022-10-31T08:03:26.634Z",
    "updated": "2022-10-31T08:03:26.634Z",
    "request_job_setting": "{\"EXTRACTION\":{\"selectionRule\":{\"value\":\"MAX_DIFFERENCE\"},\"fittedShareConvergence\":{\"value\":\"LAX\"},\"maxNumExtractionDims\":{\"value\":10000},\"insightValueType\":{\"value\":\"MEMBER\"},\"excludeZero\":{\"value\":\"YES\"},\"minXAxisCount\":{\"value\":2}},\"sessionId\":null,\"applicationName\":\"INSIGHTS\",\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
    "max_num_insights": 20
  },
  ...
]

インサイト・リストの取得プロシージャ

インサイトのリストを返します。各インサイトには、insight_name、visualization_id、insight_column、insight_value、insight_dimension、dimensionの各フィールドがあります

構文

Insight.get_insights_list(request_name)

パラメータ:

request_name: リクエストの名前。

例

この例では、インサイトをリストできます:

adp.Insight.get_insights_list('REQUEST_INSIGHT_1')
 
// Output:
[
  {
    "insight_name": "INSIGHT_62",
    "visualization_id": 199,
    "insight_column": "ACTUAL",
    "insight_value": "COUNTRY.2",
    "insight_dimension": "COUNTRY",
    "dimension": "FORECST"
  },..
]

インサイトの削除プロシージャ

インサイト・リクエストを削除します

構文

Insight.drop(request_name)

パラメータ:

request_name: リクエストの名前。

例

この例では、リクエストを削除できます:

adp.Insight.drop('REQUEST_INSIGHT_1')

インサイトの生成プロシージャ

分析ビューのメジャーのインサイトを生成します。

構文

Insight.generate(av_name, measure, job_owner,
                      source_owner)

パラメータ:

av_name: 分析ビューの名前。
measure: メジャー。
job_owner: このフィールドは、ジョブの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。
source_owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、分析ビューのインサイトを生成できます:

adp.Insight.generate('COSTS_AV', 'UNIT_COST')
 
// Output
 {
  "object_owner": "ADMIN",
  "request_name": "REQUEST_INSIGHT_1",
  "max_insight_count": 20,
  "source_object": "COSTS_AV",
  "source_owner": "COSTS_AV",
  "request_metadata": "{\"targets\":[\"UNIT_COST\"],\"appName\":\"INSIGHTS\"}",
  "default_job_settings": "{\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
  "new_request": "true"
}

ジョブ・ステータスの取得

リクエスト名に指定されたジョブのステータスを取得します。フィールドinsight_job_statusがCOMPLETEDになると、インサイトの生成が終了します。

構文

Insight.get_job_status(request_name, owner)

パラメータ:

request_name: リクエストの名前。
owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、ジョブ・ステータスを表示できます:

adp.Insight.get_job_status('REQUEST_INSIGHT_1')
 
// Output
{
  "insight_job_status": "COMPLETED",
  "progress_msg": " ",
  "error_msg": null
}

グラフ詳細の取得プロシージャ

プロット可能なデータのJSONディクショナリを返します。

結果は、次の2つのフィールドで構成されます:

itemには、インサイトの全体的な情報(description、XAXIS、measure、insight_type_label、visualization_condition、source_object)が含まれます

queryには、プロットに関する情報が含まれ、labels、actualsおよびestimatesの3つのリストがあります

構文

Insight.get_graph_details(name, id, count, query_manipulation,
                          owner)

パラメータ:

name: インサイトの名前。
id: ビジュアライゼーションID。
count: 示された値の数
query_manipulation: Noneでない場合、カーソル・タイプおよび総計フィールドを問合せに追加します。
owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、グラフをプロットするためのデータを取得できます:

adp.Insight.get_graph_details("INSIGHT_62", 199, 5, True)
 
 Output:
{
  "items": {
    "description": "COUNTRY.2",
    "XAXIS": "FORECST",
    "measure": "ACTUAL",
    "insight_type_label": "Expected",
    "visualization_condition": "COUNTRY.2",
    "source_object": "C0"
  },
  "query": {
    "labels": [
      "01:[66.7-1590]",
      "02:[829-2350]",
      "04:[2350-3870]",
      "06:[3870-5390]",
      "07:[4630-6150]"
    ],
    "actuals": [
      2200,
      6200,
      24600,
      26600,
      14200
    ],
    "estimates": [
      2671.105013588167,
      4830.820533674098,
      7135.506976989193,
      24772.963909661587,
      22121.48462234561
    ]
  }
}