洞察分析函數

洞察分析函數將應用程式設計介面的類別、方法、屬性和參數的語法和描述提供給 Data Studio 工具套件中的 Insight 工具。產生洞察分析是在背景執行，且需要檢查是否完成。

取得要求清單程序

傳回要求名稱清單及其參數

語法

Insight.get_request_list(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 ：分析視觀表的名稱。
  • 計量：計量。
  • 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 完成時，洞察分析的產生作業已完成。

語法

Insight.get_job_status(request_name, owner)

參數：

  • request_name ：要求名稱。
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以顯示工作狀態：

adp.Insight.get_job_status('REQUEST_INSIGHT_1')
 
// Output
{
  "insight_job_status": "COMPLETED",
  "progress_msg": " ",
  "error_msg": null
}
取得圖表明細程序

傳回可能繪製資料的 json 說明。

結果包含兩個欄位：

項目包含洞察分析的整體資訊： description 、 XAXIS 、 measure 、 insight_type_label 、 visualization_condition 、 source_object

查詢包含繪圖的資訊，並有三個清單：標籤、實際值及估價單

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

參數：

  • name ：洞察分析的名稱。
  • id ：視覺化 ID。
  • count ：顯示的值數目
  • query_manipulation ：如果不是「無」，請將游標類型和總計欄位新增至查詢。
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以取得繪製圖表的資料：

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
    ]
  }
}

父項主題：使用 Python Data Studio API for Autonomous Database