Newer Version Available

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

AdSpaceSpecification

Represents a specific place or a group of places where an ad creative is served. This object is available in API version 54.0 and later.

Supported Calls

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

Fields

Field Details
AdPageLayoutTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the ad page layout type associated with the ad space specification.
This field is a relationship field.
Relationship Name
AdPageLayoutType
Refers To
AdPageLayoutType
AdServerAdSpaceIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The unique identifier of the ad space specification on the ad server.
AdServerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the ad server associated with the ad space specification.
This is a relationship field.
Relationship Name
AdServerId__r
Relationship Type
Lookup
Refers To
AdServer
AdSpaceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of ad space the ad space specification is a part of.
Possible values are:
  • 1 Page Standard
  • 1/2 Page Horizontal
  • 2 Page Spread
  • 2/3 Page Vertical
  • Billboard
  • Full banner WF DFP
  • Graphic Image
  • Leaderboard
  • Mid-Roll
  • Post-Roll
  • Pre-Roll
  • Skyscraper
AudienceSizeRating
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The audience rating size of the ad space specification.
BroadcastDays
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Specifies the days of the week when the related ad creative can be served.
Possible values are:
  • Friday
  • Monday
  • Saturday
  • Sunday
  • Thursday
  • Tuesday
  • Wednesday
CreativeFormatType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the media format of the creative that's displayed on the ad space.
Possible values are:
  • Display
  • Video or audio
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Specifies the end date and time for a scheduled program specification.
EndTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
Specifies the end time for a scheduled program specification.
EndWeekDay
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the day of the week on which the ad space specification ends.
Possible values are:
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the ad space specification is active.
The default value is 'false'.
IsLiveBroadcast
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a broadcast schedule is a Live Telecast or a Recorded Telecast.
The default value is '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 LastReferenceDateis not null, the user accessed this record or list view indirectly.
MediaChannelId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the media channel related to the ad space specification.
This is a relationship field.
Relationship Name
MediaChannelId__r
Relationship Type
Lookup
Refers To
MediaChannel
MediaContentTitleId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the media content title related to the ad space specification.
This is a relationship field.
Relationship Name
MediaContentTitleId__r
Relationship Type
Lookup
Refers To
MediaContentTitle
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the ad space specification.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of the ad space specification.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
Page
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of page on which the related ad creative is displayed.
Possible values are:
  • Back cover
  • Front cover
  • Page 3
Position
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the position of the related ad creative on the page.
Possible values are:
  • Above the fold
  • Bottom right
  • Top left
Product2Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the product associated with the ad space specification.
This is a relationship field.
Relationship Name
Product2Id__r
Relationship Type
Lookup
Refers To
Product2
ProgramRunType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the schedule type of the ad space specification.
Possible values are:
  • Premiere
  • Regular
  • Repeat
PublisherDayPart
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the day time type for the publisher.
Possible values are:
  • Non Prime Time
  • Prime Time
Section
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Specifies the section where the related ad creative is placed.
Possible values are:
  • Entertainment
  • Politics
  • Sports
StartDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Specifies the start date and time for a scheduled program specification.
StartTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
Specifies the start time for a scheduled program specification.
StartWeekDay
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the day of the week on which the ad space specification begins.
Possible values are:
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
SubSection
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Specifies the subsection where the related ad creative is displayed.
Possible values are:
  • Art
  • Cricket
  • Football
  • India
  • Movies
  • Theatre
  • World
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Required. Specifies the type for ad space specification.
Possible values are:
  • Ad Space
  • Ad Space Group
  • Scheduled Program

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.

AdSpaceSpecificationFeed
Feed tracking is available for the object.
AdSpaceSpecificationHistory
History is available for tracked fields of the object.
AdSpaceSpecificationShare
Sharing is available for the object.