Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpCalculatedInsight Class
CdpIdentityResolution Class
CdpQuery Class
CdpSegment Class
CdpSegment Methods
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentDelivery Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Developer Preview)
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

CdpSegment Class

Create, delete, get, publish, and update Data Cloud segments.

Namespace

ConnectApi

CdpSegment Methods

The following are methods for CdpSegment. All methods are static.

createSegment(input)

Create a segment.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentOutput createSegment(ConnectApi.CdpSegmentInput input)

Parameters

input
Type: ConnectApi.CdpSegmentInput
A ConnectApi.CdpSegmentInput class.

Return Value

Type: ConnectApi.CdpSegmentOutput

deleteSegment(segmentApiName)

Delete a segment.

API Version

56.0

Requires Chatter

No

Signature

public static Void deleteSegment(String segmentApiName)

Parameters

segmentApiName
Type: String
API name of the segment.

Return Value

Type: Void

executePublishAdhoc(segmentId)

Publish a segment.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentActionOutput executePublishAdhoc(String segmentId)

Parameters

segmentId
Type: String
ID of the segment to publish.

Return Value

Type: ConnectApi.CdpSegmentActionOutput

getSegment(segmentApiName)

Get a segment.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentContainerOutput getSegment(String segmentApiName)

Parameters

segmentApiName
Type: String
API name of the segment.

Return Value

Type: ConnectApi.CdpSegmentContainerOutput

getSegments()

Get segments.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentContainerOutput getSegments()

Return Value

Type: ConnectApi.CdpSegmentContainerOutput

getSegmentsPaginated(batchSize, offset, orderBy)

Get an ordered batch of segments.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentContainerOutput getSegmentsPaginated(Integer batchSize, Integer offset, String orderBy)

Parameters

batchSize
Type: Integer
Number of items to return. Values are from 1–200. If unspecified, the default value is 20.
offset
Type: Integer
Number of rows to skip before returning results. If unspecified, no rows are skipped.
orderBy
Type: String
Sort order for the result set, such as Name ASC or MarketSegmentType DESC. If unspecified, items are returned by name in ascending order.

Return Value

Type: ConnectApi.CdpSegmentContainerOutput

updateSegment(segmentApiName, input)

Update a segment.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentOutput updateSegment(String segmentApiName, ConnectApi.CdpSegmentInput input)

Parameters

segmentApiName
Type: String
API name of the segment.
input
Type: ConnectApi.CdpSegmentInput
A ConnectApi.CdpSegmentInput class with the updates.

Return Value

Type: ConnectApi.CdpSegmentOutput