AdTargetCategorySegment

Represents a segment in an ad target category. This object is available in API version 55.0 and later.

Supported Calls 

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields 

AvailableValues 

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The list of values that are part of the ad target category segment.

Code 

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. The code of the ad target category segment in the ad server.

DataType 

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description: Required. Specifies the type of ad target category segment.

  • Possible values:

    • Text
    • Number
    • Boolean
    • Picklist
    • MultiSelectPicklist

DependentCategorySegmentId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the ad target category segment that the current ad target category segment is dependent on. This is a relationship field.
  • Relationship Name: DependentCategorySegment
  • Relationship Type: Lookup
  • Refers To: AdTargetCategorySegment

Description 

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The description of the ad target category segment. The data for this field can be imported and mapped from an ad server.

DisplaySequence 

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The sequence of the ad target catgory segment in the ad target category it is part of. The sequence number dicedies the sequence in which segments are displayed in a category.

DisplayType 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Specifies the display type of the ad target category segment.

  • Possible values:

    • Checklist
    • RadioButton
    • Checkbox
    • Picklist

IsActive 

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this ad target category segment is active.
  • Default value: false

IsAvailableForSelfService 

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this segment record is available only at the Agent Console or at self care portal as well. By default, once activated all segments are available at Agent Console, but can be available on the Self Service Console only when this field’s value is set to true. Some of the categories contain segments, which can be filled only by the agent and they mainly contain the configurations needed by ad server.
  • Default value: false

LastReferencedDate 

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate 

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

MediaType 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Specifies the media type of the ad target category segment.

  • Possible values:

    • Digital
    • TV
    • Radio
    • Print
    • Outdoor
    • Other

Name 

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the ad target category.

OwnerId 

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The ID of the owner of the ad target category segment. This field is a polymorphic relationship field.
  • Relationship Name: Owner
  • Refers To: Group, User

ProductId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the product associated with the ad target category segment. This is a relationship field.
  • Relationship Name: Product
  • Relationship Type: Lookup
  • Refers To: Product2

TargetCategoryId 

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The ID of the ad target category that the ad target category segment is a part of. This is a relationship field.
  • Relationship Name: TargetCategory
  • Relationship Type: Lookup
  • Refers To: AdTargetCategory

Associated Objects 

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AdTargetCategorySegmentFeed

Feed tracking is available for the object.

AdTargetCategorySegmentHistory

History is available for tracked fields of the object.

AdTargetCategorySegmentShare

Sharing is available for the object.