CdpSegment クラス
名前空間
CdpSegment のメソッド
createSegment(input)
API バージョン
55.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentOutput createSegment(ConnectApi.CdpSegmentInput input)
パラメーター
- input
- 型: ConnectApi.CdpSegmentInput
- ConnectApi.CdpSegmentInput クラス。
戻り値
createSegment(input, dataspace)
API バージョン
58.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentOutput createSegment(ConnectApi.CdpSegmentInput input, String dataspace)
パラメーター
- input
- 型: ConnectApi.CdpSegmentInput
- ConnectApi.CdpSegmentInput クラス。
- dataspace
- 型: String
- アクションを実行するデータスペースの名前。ユーザーはこのデータスペースに対する権限を持っている必要があります。セグメントを一括でリストする場合は省略可能です。指定しない場合、デフォルトは default データスペースです。
戻り値
deleteSegment(segmentApiName)
API バージョン
56.0
Chatter が必要かどうか
いいえ
署名
public static Void deleteSegment(String segmentApiName)
パラメーター
- segmentApiName
- 型: String
- セグメントの API 参照名。
戻り値
型: Void
executePublishAdhoc(segmentId)
API バージョン
56.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentActionOutput executePublishAdhoc(String segmentId)
パラメーター
- segmentId
- 型: String
- 公開するセグメントの ID。
getSegment(segmentApiName)
API バージョン
56.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentContainerOutput getSegment(String segmentApiName)
パラメーター
- segmentApiName
- 型: String
- セグメントの API 参照名。
getSegmentMembers(limit, offset, orderBy, segmentApiName, filters, fields)
API バージョン
58.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentMemberOutput getSegmentMembers(Integer limit, Integer offset, String orderBy, String segmentApiName, String filters, List<String> fields)
パラメーター
- limit
- 型: Integer
- 返す行の最大数 (1 ~ 1000)。指定されていない場合、デフォルトの行数は 100 です。
- offset
- 型: Integer
- 結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。
- orderBy
- 型: String
- 結果セットの並べ替え順 (例: Name ASC または MarketSegmentType DESC.)。指定されていない場合、項目は ID の昇順で返されます。
- segmentApiName
- 型: String
- セグメントの API 参照名。
- filters
- 型: String
- 結果セットをより狭い範囲または特定の種別に絞り込みます (例: [Delta_Type__C in('new') AND timestamp__C > '2023-04-02'])。
- fields
- 型: List<String>
- 結果に含める最大 50 個の項目名のカンマ区切りリスト (例: Id__c, Delta_Type__C)。指定されていない場合、Id__c が返されます。
getSegments()
API バージョン
55.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentContainerOutput getSegments()
getSegmentsPaginated(batchSize, offset, orderBy)
API バージョン
56.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentContainerOutput getSegmentsPaginated(Integer batchSize, Integer offset, String orderBy)
パラメーター
getSegmentsPaginated(batchSize, offset, orderBy, dataspace)
API バージョン
58.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentContainerOutput getSegmentsPaginated(Integer batchSize, Integer offset, String orderBy, String dataspace)
パラメーター
- batchSize
- 型: Integer
- 返される項目の数。値の範囲は 1 ~ 200 です。指定されていない場合、デフォルト値は 20 です。
- offset
- 型: Integer
- 結果を返す前にスキップする行数。指定されていない場合、行はスキップされません。
- orderBy
- 型: String
- 結果セットの並べ替え順 (例: Name ASC または MarketSegmentType DESC.)。指定されていない場合、項目は ID の昇順で返されます。
- dataspace
- 型: String
- アクションを実行するデータスペースの名前。ユーザーはこのデータスペースに対する権限を持っている必要があります。セグメントを一括でリストする場合は省略可能です。指定しない場合、デフォルトは default データスペースです。
updateSegment(segmentApiName, input)
API バージョン
56.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CdpSegmentOutput updateSegment(String segmentApiName, ConnectApi.CdpSegmentInput input)
パラメーター
- segmentApiName
- 型: String
- セグメントの API 参照名。
- input
- 型: ConnectApi.CdpSegmentInput
- 更新を含む ConnectApi.CdpSegmentInput クラス。