CdpQuery クラス

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getAllMetadata()

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getAllMetadata(String entityType, String entityCategory, String entityName)

パラメーター

entityType

型: String

要求されたメタデータエンティティの種別。有効な値は、DataLakeObject、DataModelObject、CalculatedInsight です。指定されていない場合、すべての種別が返されます。

entityCategory

型: String

メタデータエンティティのカテゴリ。有効な値は、Profile、Engagement、Related です。指定されていない場合、すべてのカテゴリエンティティが返されます。

entityName

型: String

エンティティのメタデータ名 (UnifiedIndividual__dlm など)。指定されていない場合、エンティティの完全なリストが返されます。

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getInsightsMetadata()

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getInsightsMetadata(String ciName)

パラメーター

ciName

型: String

計算済みインサイトオブジェクトの名前 (IndividualChildrenCount__cio など)。

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getProfileMetadata()

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryMetadataOutput getProfileMetadata(String dataModelName)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)��

戻り値

型: ConnectApi.CdpQueryMetadataOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutputV2 nextBatchAnsiSqlV2(String nextBatchId)

パラメーター

nextBatchId

型: String

次のバッチの ID。詳細は、「使用方法」セクションを参照してください。

戻り値

型: ConnectApi.CdpQueryOutputV2

使用方法

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryANSISql(ConnectApi.CdpQueryInput input)

パラメーター

input

型: ConnectApi.CdpQueryInput

SQL クエリを含む ConnectApi.CdpQueryInput のボディ。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

53.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryANSISql(ConnectApi.CdpQueryInput input, Integer batchSize, Integer offset, String orderby)

パラメーター

input

型: ConnectApi.CdpQueryInput

SQL クエリを含む ConnectApi.CdpQueryInput のボディ。

batchSize

型: Integer

返されるレコードの数。値の範囲は 1 ～ 4,999 です。デフォルト値は、4999 です。

offset

型: Integer

結果を返す前にスキップする行数。offset と batchSize の合計は、2147483647 未満である必要があります。デフォルト値は、0 です。

orderby

型: String

結果を昇順または降順に並べ替えるための値のカンマ区切りリスト。たとえば、GenderId__c ASC,Occupation__c DESC のように指定します。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutputV2 queryAnsiSqlV2(ConnectApi.CdpQueryInput input)

パラメーター

input

型: ConnectApi.CdpQueryInput

SQL クエリを含む ConnectApi.CdpQueryInput のボディ。

戻り値

型: ConnectApi.CdpQueryOutputV2

使用方法

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryCalculatedInsights(String ciName, String dimensions, String measures, String orderby, String filters, Integer batchSize, Integer offset)

パラメーター

ciName

型: String

計算済みインサイトオブジェクトの名前 (IndividualChildrenCount__cio など)。

dimensions

型: String

プロジェクトに対する最大 10 個のディメンションのカンマ区切りリスト (例: GenderId__c)。指定されていない場合、このパラメーターには、使用可能なすべてのディメンションが含まれます。

measures

型: String

プロジェクトに対する最大 5 個の基準のカンマ区切りリスト (例: TotalSales__c)。指定されていない場合、このパラメーターには、使用可能なすべての基準が含まれます。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

filters

型: String

結果セットをより狭い範囲または特定の種別に絞り込みます (例: [GenderId__c=Male,​FirstName__c=Angel])。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 4999 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryCalculatedInsights(String ciName, String dimensions, String measures, String orderby, String filters, Integer batchSize, Integer offset, String timeGranularity)

パラメーター

ciName

型: String

計算済みインサイトオブジェクトの名前 (IndividualChildrenCount__cio など)。

dimensions

型: String

プロジェクトに対する最大 10 個のディメンションのカンマ区切りリスト (例: GenderId__c)。指定されていない場合、このパラメーターには、使用可能なすべてのディメンションが含まれます。

measures

型: String

プロジェクトに対する最大 5 個の基準のカンマ区切りリスト (例: TotalSales__c)。指定されていない場合、このパラメーターには、使用可能なすべての基準が含まれます。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

filters

型: String

結果セットをより狭い範囲または特定の種別に絞り込みます (例: [GenderId__c=Male,​FirstName__c=Angel])。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 4999 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

timeGranularity

型: String

基準の時間範囲。値は次のとおりです。

• HOUR
• DAY
• MONTH
• QUARTER
• YEAR

指定されていない場合、時間範囲は適用されません。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryProfileApi(String dataModelName, String filters, String fields, Integer batchSize, Integer offset, String orderby)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)。

filters

型: String

角括弧内の等価式のカンマ区切りリスト (例: [FirstName__c=DON])。

fields

型: String

結果に含める最大 50 個の項目名のカンマ区切りリスト (例: Id__c,FirstName__c,​GenderId__c,Occupation__c)。指定されていない場合、Id__c が返されます。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 100 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryProfileApi(String dataModelName, String id, String searchKey, String filters, String fields, Integer batchSize, Integer offset, String orderby)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)。

id

型: String

プライマリキーまたはセカンダリキー項目の値 (例: John)。指定されていない場合は、プライマリキー項目の値にデフォルト設定されます。

searchKey

型: String

プライマリキー以外の項目が使用されている場合のキー項目の名前 (例: FirstName__c)。

filters

型: String

角括弧内の等価式のカンマ区切りリスト (例: [FirstName__c=DON])。

fields

型: String

結果に含める最大 50 個の項目名のカンマ区切りリスト (例: Id__c,FirstName__c,​GenderId__c,Occupation__c)。指定されていない場合、Id__c が返されます。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 100 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryProfileApi(String dataModelName, String id, String childDataModelName, String searchKey, String filters, String fields, Integer batchSize, Integer offset, String orderby)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)。

id

型: String

プライマリキーまたはセカンダリキー項目の値 (例: John)。指定されていない場合は、プライマリキー項目の値にデフォルト設定されます。

childDataModelName

型: String

子データモデルオブジェクトの名前 (例: UnifiedContactPointEmail__dlm)。

searchKey

型: String

プライマリキー以外の項目が使用されている場合のキー項目の名前 (例: FirstName__c)。

filters

型: String

角括弧内の等価式のカンマ区切りリスト (例: [FirstName__c=DON])。検索条件は、親オブジェクトにのみ適用されます。

fields

型: String

結果に含める子オブジェクトの項目名のカンマ区切りリスト (例: Id__c,EmailAddress__c)。指定されていない場合、先頭の 10 件の項目がアルファベット順に並べ替えられて返されます。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 100 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryProfileApi(String dataModelName, String id, String ciName, String searchKey, String dimensions, String measures, String filters, String fields, Integer batchSize, Integer offset, String orderby)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)。

id

型: String

プライマリキーまたはセカンダリキー項目の値 (例: John)。指定されていない場合は、プライマリキー項目の値にデフォルト設定されます。

ciName

型: String

計算済みインサイトオブジェクトの名前 (IndividualChildrenCount__cio など)。

searchKey

型: String

プライマリキー以外の項目が使用されている場合のキー項目の名前 (例: FirstName__c)。

dimensions

型: String

プロジェクトに対する最大 10 個のディメンションのカンマ区切りリスト (例: GenderId__c)。指定されていない場合、このパラメーターには、使用可能なすべてのディメンションが含まれます。

measures

型: String

プロジェクトに対する最大 5 個の基準のカンマ区切りリスト (例: TotalSales__c)。指定されていない場合、このパラメーターには、使用可能なすべての基準が含まれます。

filters

型: String

角括弧内の等価式のカンマ区切りリスト (例: [FirstName__c=DON])。

fields

型: String

結果に含める最大 50 個の項目名のカンマ区切りリスト (例: Id__c,FirstName__c,​GenderId__c,Occupation__c)。指定されていない場合、Id__c が返されます。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 100 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryOutput queryProfileApi(String dataModelName, String id, String ciName, String searchKey, String dimensions, String measures, String filters, String fields, Integer batchSize, Integer offset, String orderby, String timeGranularity)

パラメーター

dataModelName

型: String

データモデルオブジェクトの名前 (UnifiedIndividual__dlm など)。

id

型: String

プライマリキーまたはセカンダリキー項目の値 (例: John)。指定されていない場合は、プライマリキー項目の値にデフォルト設定されます。

ciName

型: String

計算済みインサイトオブジェクトの名前 (IndividualChildrenCount__cio など)。

searchKey

型: String

プライマリキー以外の項目が使用されている場合のキー項目の名前 (例: FirstName__c)。

dimensions

型: String

プロジェクトに対する最大 10 個のディメンションのカンマ区切りリスト (例: GenderId__c)。指定されていない場合、このパラメーターには、使用可能なすべてのディメンションが含まれます。

measures

型: String

プロジェクトに対する最大 5 個の基準のカンマ区切りリスト (例: TotalSales__c)。指定されていない場合、このパラメーターには、使用可能なすべての基準が含まれます。

filters

型: String

角括弧内の等価式のカンマ区切りリスト (例: [FirstName__c=DON])。

fields

型: String

結果に含める最大 50 個の項目名のカンマ区切りリスト (例: Id__c,FirstName__c,​GenderId__c,Occupation__c)。指定されていない場合、Id__c が返されます。

batchSize

型: Integer

返される項目の数。値の範囲は 1 ～ 4,999 です。指定されていない場合、デフォルト値は 100 です。

offset

型: Integer

結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。

orderby

型: String

結果セットの並べ替え順 (例: GenderId__c ASC,​Occupation__c DESC)。指定されていない場合、項目は取得順に返されます。

timeGranularity

型: String

基準の時間範囲。値は次のとおりです。

• HOUR
• DAY
• MONTH
• QUARTER
• YEAR

指定されていない場合、時間範囲は適用されません。

戻り値

型: ConnectApi.CdpQueryOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CdpQueryDataOutput universalIdLookupBySourceId(String entityName, String dataSourceId, String dataSourceObjectId, String sourceRecordId)

パラメーター

entityName

型: String

エンティティ名。

dataSourceId

型: String

データソース ID。

dataSourceObjectId

型: String

データソースオブジェクト ID。

sourceRecordId

型: String

ソースレコード ID。

戻り値

型: ConnectApi.CdpQueryDataOutput