Salesforce CDP API 開発者ガイド
jSalesforce CDP Profile API ライブラリ
Salesforce CDP Profile API コールは、顧客のプロファイル情報の参照と検索に使用します。これらの API コールを外部の Web/モバイルアプリケーションに含めることで、顧客のプロファイル情報を参照できます。
Salesforce CDP Profile API コールを使用すると、計算済みエンゲージメントインサイトと共にプロファイル情報を取得して、完全な Salesforce CDP ページを構築できます。
これらのコールでは、プロファイルカテゴリ内のデータモデルオブジェクトのみがサポートされます。これには、個人、連絡先メール、統合個人、連絡先住所などがあります。また、[個人] 項目に関連した計算済み属性も取得できます。たとえば、顧客プロファイルから過去 6 か月間の売上合計を計算して取得できます。
これらのコールでは、エンゲージメントカテゴリのデータモデルオブジェクト (販売注文など) はサポートされません。
Salesforce CDP Profile API コールは、REST 標準仕様に準拠します。
主なプロパティ
- 取得する項目を明示的に指定しないと、エンティティの項目や属性がアルファベット順に並び替えられて先頭の 10 件のデータのみが応答に含まれます。この 10 件という制限は、項目名を明示的に指定する場合には適用されません。
- 最大で 50 件の項目を取得できます。
- 論理演算子の AND と比較演算子の等号のみがサポートされます。
- クエリで使用できる検索条件の数に制限はありません。
- 返される行の上限はデフォルトで 4999 行に設定されています。最大で 4999 行を返すことができます。
- 日付と時刻の項目では次の形式を使用してください。
1Date/DateTime BirthDate__c=1990-07-12 00:00:00
コールリファレンス
GET /api/v1/profile/metadata/{dataModelName}
GET /api/v1/profile/{dataModelName}
GET /api/v1/profile/{dataModelName}/{Id}
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
接続アプリケーションの設定
顧客に関する新しいインサイトを見つけるように接続アプリケーションを設定します。
Salesforce CDP のアクセストークンの取得と交換
アクセストークンを取得して交換します。
トラブルシューティング
「User hasn't approved this consumer yet (ユーザがまだコンシューマを承認していません)」のエラーメッセージが返された場合は、次の設定パラメータを確認してください。
- 接続アプリケーションの設定で [ユーザは自己承認可能] が有効化されていることを確認します。
- refresh_token 範囲のほかに、1 つ以上の (カスタム範囲以外の) 範囲が選択されていることを確認します。
- 自己承認 URL で、scope パラメータ値が api refresh_token cdpquery cdpprofile に設定されていることを確認します。
- 自己承認 URL に対して最初にコールを実行したときには、URL で要求されている各範囲への権限を求める同意ページに応答する必要があります。