ステップ 4: ダッシュボードを検索、表示、更新する
ユーザの多くは、通常ダッシュボードを使用してレポートを操作します。Salesforce1 レポート API を使用すると、レポートと同じくらい簡単に、ダッシュボードにアクセスしたりダッシュボードを更新したりできます。
たとえば、ユーザが必要なダッシュボードを見つけるためにいくつもの画面に目を通さなければならず、うんざりしているとします。Salesforce1 レポート API を使用すれば、最近表示したダッシュボードの中から選ぶことができます。
-
Dashboard List リソースに対して GET 要求を実行すれば、最近使用したダッシュボードのリストを取得できるため、ユーザがダッシュボードを簡単に見つけられるようになります。
1/services/data/v31.0/analytics/dashboards各ダッシュボードについて、Dashboard List リソースから次のような情報が返されます。URL ハンドルには、ダッシュボードの状況または結果が保存されます。リストは、ダッシュボードの最終更新日順に並び替えられます。1[ { 2 3 "id" : "01ZD00000007QeuMAE", 4 5 "name" : "Adoption Dashboard", 6 7 "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007QeuMAE/status", 8 9 "url" : "/services/data/v31.0/analytics/dashboards/01ZD00000007QeuMAE" 10 11}] -
ユーザがアプリケーションを使用しているプラットフォームやデバイスに応じて、ダッシュボードのデータを異なる方法で表示することも可能です。Dashboard Results リソースに GET 要求を実行すれば、ダッシュボードからデータをプルできます。
1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE返される情報は、ダッシュボードの実際のデータとそのメタデータ (ダッシュボード ID、名前、コンポーネントメタデータ、検索条件) およびその更新状況です。結果は次のように表示されます。1{ 2 3{ 4 5 "componentData" : [ { 6 7 "componentId" : "01aD0000000a36LIAQ", 8 9 "reportResult" : { 10 11 // Report result data omitted for brevity. 12 13 }, 14 15 "status" : { 16 17 "dataStatus" : "DATA", 18 19 "errorCode" : null, 20 21 "errorMessage" : null, 22 23 "errorSeverity" : null, 24 25 "refreshDate" : "2014-04-10T20:37:43.000+0000", 26 27 "refreshStatus" : "IDLE" 28 29 } 30 31 } ], 32 33 "dashboardMetadata" : { 34 35 "attributes" : { 36 37 "dashboardId" : "01ZD00000007S89MAE", 38 39 "dashboardName" : "Simple Dashboard", 40 41 "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status", 42 43 "type" : "Dashboard" 44 45 }, 46 47 "canChangeRunningUser" : false, 48 49 "components" : [ { 50 51 "componentData" : 0, 52 53 "footer" : null, 54 55 "header" : null, 56 57 "id" : "01aD0000000a36LIAQ", 58 59 "properties" : { 60 61 "aggregateName" : "s!AMOUNT", 62 63 "maxRows" : null, 64 65 "sort" : { 66 67 "column" : "TYPE", 68 69 "sortOrder" : "asc" 70 71 }, 72 73 "visualizationProperties" : { }, 74 75 "visualizationType" : "Bar" 76 77 }, 78 79 "reportId" : "00OD0000001g2nWMAQ", 80 81 "title" : null, 82 83 "type" : "Report" 84 85 } ], 86 87 "description" : null, 88 89 "developerName" : "Simple_Dashboard", 90 91 "filters" : [ { 92 93 "name" : "Amount", 94 95 "options" : [ { 96 97 "alias" : null, 98 99 "endValue" : null, 100 101 "id" : "0ICD00000004CBiOAM", 102 103 "operation" : "greaterThan", 104 105 "startValue" : null, 106 107 "value" : "USD 2000000" 108 109 } ], 110 111 "selectedOption" : null 112 113 } ], 114 115 "id" : "01ZD00000007S89MAE", 116 117 "layout" : { 118 119 "columns" : [ { 120 121 "components" : [ 0 ] 122 123 } ] 124 125 }, 126 127 "name" : "Simple Dashboard", 128 129 "runningUser" : { 130 131 "displayName" : "Allison Wheeler", 132 133 "id" : "005D00000016V2qIAE" 134 135 } 136 137 } 138 139} -
ユーザに最新データが表示されないのではないかと懸念する場合は、更新するダッシュボードの ID を指定して、PUT Dashboard Results 要求を送信すれば、ダッシュボードをリモートで更新できます。
1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE応答には、更新済みのダッシュボードの状況 URL が含まれます。1{ 2 3 "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status" 4 5}