CRM Analytics REST API 開発者ガイド
jCRM Analytics REST API リソースの概要
CRM Analytics REST API は、CRM Analytics データにアクセスするためのリソースを提供します。
すべての CRM Analytics REST API リソースには、以下を使用してアクセスします。
- 会社のベース URL (https://yourInstance.salesforce.com など)
- バージョン情報 (/services/data/v53.0 など)
- 名前付きリソース (/wave など)
1https://yourInstance.salesforce.com/services/data/v53.0/wave組織とオブジェクトの識別子
Salesforce および CRM Analytics UI の ID 項目は、一般的に base-62 の 15 文字であり、大文字と小文字を区別します。JSON XMD にもこれは当てはまります。ただし、Dataset リソース /wave/datasets/<dataset ID> の Id プロパティのように、多くの Salesforce API は、CRM Analytics REST API も含めて、18 文字を使用して、大文字と小文字を区別しません。最後の 3 桁は、前の 15 文字のチェックサムです。大文字と小文字を区別しない ID を使用すると、大文字と小文字を区別しない参照を使用する外部アプリケーションや開発環境とのやり取りが簡単になります。18 文字の ID を 15 文字の ID に変換するには、最後の 3 文字を削除します。
一般的なリソース
CRM Analytics の一般的なリリースはここで取り上げますが、ダッシュボードやレシピなど特定の機能はそれぞれのセクションで説明します。
| リソース | 説明 | サポートされている HTTP メソッド | リソース URL |
|---|---|---|---|
| Actions リソース | Analytics のユーザが使用できる Salesforce アクションを返します。 | GET | /wave |
| Dependencies リソース | アセットの連動関係を返します。 | GET | /wave/dependencies/<folderId> |
| Feature Configuration リソース | ユーザが使用できる CRM Analytics 機能を返します。 | GET | /wave/config/features |
| JsonXform Transformation リソース | JSON 変換を実行します。 | POST | /jsonxform/transformation |
| Limits リソース | Salesforce 組織の Analytics の制限を取得します。 | GET | /wave/limits |
| Query リソース | Salesforce Analytics Query Language (SAQL) で記述されたクエリを実行します。 | POST | /wave/query |
| Security のリソース | オブジェクトおよび特定のデータセットバージョンが継承共有をサポートしているかどうかを確認する。 | GET |
|
| Wave リソース | CRM Analytics で使用できる最上位のリソースをリストします。 | GET | /wave |
REST 応答の絞り込み
CRM Analytics アプリケーションまたはフォルダの表現を返す (GET) か、アプリケーションまたはフォルダを置換 (PUT) するか、更新 (PATCH) するか、削除 (DELETE) します。
CRM Analytics REST API 入力パラメータに加え、filterGroup、external、および internal の Connect REST API 入力パラメータを使用して、要求から返された結果を絞り込むことができます。詳���は、『Connect REST API 開発者ガイド』の「応答サイズの指定」を参照してください。