この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

CRM Analytics REST API 開発者ガイド

CRM Analytics REST API の概要
例
クエリ API による CRM Analytics データの照会
履歴 API を使用した CRM Analytics アセットの以前のバージョンのバックアップおよび復元
CRM Analytics データの実行、スケジュール、および REST API との同期
リソース
要求
応答
付録
PDF

履歴 API を使用した CRM Analytics アセットの以前のバージョンのバックアップおよび復元

CRM Analytics ダッシュボード、レンズ、レシピ、およびデータフローを編集すると、CRM Analytics によってそれらが自動的にバックアップされます。アセットの新しいバージョンを保存するたびに、CRM Analytics によってそのスナップショットが保存されます。後から、スナップショットをプレビューし、REST 履歴 API を使用して以前のバージョンに戻すことができます。

ダッシュボード、レンズ、レシピ、およびデータフローの新しいバージョンを保存するたびに、CRM Analytics によって古いバージョンが保存されます。また、ダッシュボードとレンズの条件付き書式も保存されます。

CRM Analytics では、タグ付けされたアセット 10 個とタグ付けされていないアセット 10 個の合計 20 個のアセットのバージョンが保存されます。保存するアセットの新しいバージョンが 20 個を超える場合は、CRM Analytics によって新しいバージョンが保存され、古いバージョンは消去されます。この制限に達した場合、タグ付けされたバージョンを保存すると、最も古いタグ付けされたバージョンが消去されます。タグ付けされていないバージョンを保存すると、最も古いタグ付けされていないバージョンが消去されます。この制限数を増やすには、Salesforce に連絡して、組織の「Maximum analytics asset histories to track in the database (データベースで追跡する最大の Analytics アセット履歴)」 (AnalyticsMaxHistories とも呼びます) の値を増やすよう担当者に依頼してください。

アセットのバージョンを説明するタグを追加することで、自分や他のチームメンバーに変更内容とその理由を示すことができます。手動または自動タグ設定のいずれかを使用できます。

CRM Analytics には、アセットのバージョンを手動でタグ設定する方法が 2 つあります。

  • ダッシュボードまたはレンズを保存するとき、[保存] ダイアログに [バージョン履歴] ボックスが表示されます。そのボックスに変更についての簡単な説明を入力します。(現在データフローには、以前のバージョンにタグを追加するためのユーザインターフェースがありません)。ダッシュボードの [保存] ダイアログの [バージョン履歴] 項目
  • また、公開 REST API を使用して変更にタグを設定することもできます。API を使用して、説明を含んだ履歴レコードにタグ付けします。これは、アセットを保存した後でも実行できます。既存の説明は編集できます。
    1*PATCH: /services/data/v46.0/wave/dashboards/0FKxx0000004CAeGAM/histories/0Rmxx0000004Cx2CAE*
2*REQUEST BODY: {"label" : "new description"}*
CRM Analytics によって、2 つの方法のいずれかで自動的にタグが履歴レコードに追加されます。
  • アセットの初期バージョンを作成して保存すると、履歴レコードにタグ Initial Create が追加されます。
  • テンプレートからアプリケーションを作成するかアップグレードすると、新しく作成したアプリケーションの履歴レコードにタグが追加されます。このタグは、テンプレートのアクション、テンプレート名、およびテンプレートのバージョンを含んでいます。この情報は、新しいテンプレートバージョンでアプリケーションをアップグレードした後に、アセットの以前の正しいバージョンを復元するために役立ちます。

以前のアセットバージョンをプレビューし、そのバージョンに戻す

アセットの履歴レコードのリストを取得するには、ワークベンチにログインするか API コールを実行します。または、CRM Analytics プラグインを使用して、Salesforce コマンドラインインターフェース (CLI) に適切なコマンドを入力します。

以前のバージョンのダッシュボードが依存しているアセットが CRM Analytics から削除されている場合、そのバージョンは機能しない可能性があります。これには、他のダッシュボード、データセット、レンズ、画像などのアセットが該当する可能性があります。

警告

  • ダッシュボードの履歴レコード。
    • ワークベンチコール:
      1GET: /services/data/v526.0/wave/dashboards/<dashboardId>/histories
    • CLI コマンド:
      1sfdx analytics:dashboard:history:list
  • レンズの履歴レコード。
    • ワークベンチコール:
      1GET: /services/data/v52.0/wave/dashboards/<lensId>/histories
    • CLI コマンド:sfdx analytics:lens:history:list:
  • レシピの履歴レコード。
    • ワークベンチコール:
      1GET: /services/data/v52.0/wave/recipes/<recipeId>/histories
  • データフローの履歴レコード。
    • ワークベンチコール:
      1GET: /services/data/v52.0/wave/dataflows/<dataflowId>/histories
    • CLI コマンド:sfdx analytics:dataflow:history:list:

必要に応じて、アセット応答 (HATEOAS) の URL から履歴 API のエンドポイントに移動できます。次に示すダッシュボードの詳細な応答では、リンクが強調表示されています。ダッシュボードの復元用の Analytics アセット履歴 API エンドポイント

または、ワークベンチから次の REST コールを手動で実行します。

  • すべてのダッシュボードのリストを取得します。
    1GET: /services/data/v52.0/wave/dashboards
  • 特定のダッシュボードを検索します。レスポンスボディでその詳細の URL をクリックします。
    1GET: /services/data/v52.0/wave/dashboards/<dashboardId>
  • 履歴のリストを取得し、ダッシュボードの詳細な応答で historiesUrl をクリックします。
    1GET: /services/data/v52.0/wave/dashboards/*<dashboardId>/histories*

以前のバージョンのプレビュー

アセットのバージョン履歴をリスト表示した後に、バージョンの JSON をプレビューします。プレビューの際には、保存されたときの JSON が表示されます。

以前のアセットバージョンの JSON をプレビューするには、ワークベンチを使用します。レスポンスボディの previewUrl をクリックします。

以前のバージョンをプレビューするための Analytics アセット履歴 API コール

データフローには、previewUrl と privatePreviewUrl の 2 つのプレビュー URL があります。非公開プレビュー URL では、CRM Analytics データフローエディターを使用して JSON ファイルを宣言的にダウンロードした場合と同じ JSON 形式が使用されます。プレビュー URL では、公開バージョンの JSON が提供されます。

メモ

以前のバージョンの復元

正しいアセットのバージョンをプレビューしていることを確認したら、REST API コールまたは CLI を使用して復元します。

REST プロセスを使用して、復元するバージョンに移動し、revertUrl. を見つけます。

この REST URL には PUT コールが必要です。

メモ

以前のバージョンを復元するための Analytics アセット履歴 API コール
以前のバージョンのアセットを復元するには、revertUrl に対して PUT を実行します。
1*PUT: /services/data/v52.0/wave/dashboards/*<dashboardId>/bundle**
2*REQUEST BODY: {"historyId": "<historyId>, historyLabel" : "optional description of new change"}*

復元するバージョンの historyId をコピーします。これを次のようにリクエストボディに入力します。

以前のバージョンを復元するための Analytics アセット履歴 API コール

アセットを復元する CLI コマンドは次のとおりです。

  • ダッシュボード。sfdx analytics:dashboard:history:revert -i <dashboardid> -h <historyid>
  • レンズ。sfdx analytics:lens:history:revert -i <lensid> -h <historyid>
  • データフロー。sfdx analytics:dataflow:history:revert -i <dataflowid> -h <historyid>

historyid は、復元するアセットのバージョンの ID です。

制限事項

アセットの以前のバージョンを復元すると、そのアセットが期待どおりに実行されない場合があります。アセットが他のアセット (データセットなど) に依存しており、他のアセットが削除または変更されている場合、エラーが発生する可能性があります。ただし、以前のバージョンを復元するたびに、履歴レコードが作成されます。このため、いつでも最後の作業コピーを復元できます。

アセットを削除すると、それとともにすべての履歴が削除されるため、元に戻せなくなります。

現在、CRM Analytics では、以前のバージョンのデータセット XMD ファイルがバックアップされません。