Ad Variant
Updated
PaidApiAdVariant Schema
Field Name | Field Type | Description | Update Supported | ChangeType |
channelId | String | Identifier for the ad channel | N | |
id | String | Unique identifier for the ad variant | N | |
name | String | Name of the ad variant | Y | |
status | AdVariantStatus Enum | Status of the ad variant ACTIVE, PAUSED, DRAFT | Y | STATUS |
creativeType | String | Type of creative used. Mandatory For LinkedIn | N | |
creativeObject | CreativeObject | The creative associated with the ad | Y | CREATIVE |
viewTags | List<String> | Tags for tracking ad views | Y | VIEW_TAGS |
clickTags | List<String> | Tags for tracking ad clicks | Y | CLICK_TAGS |
Note : creativeType is mandatory For Update/Create
CreativeObject Schema
Field Name | Field Type | Description |
name | String | Name of the creative |
postType | String | Supported Values LINK, PHOTO, VIDEO, STATUS, DOCUMENT, TEXT |
isDarkPost | Boolean | Whether it is a dark post. Only applicable in VIDEO post |
pageId | String | Company Page Id |
postChannelId | String | ID of the post channel |
title | String | Title of the creative |
description | String | Description of the creative |
linkUrl | String | URL link in the creative |
imageUrl | String | URL of the image |
videoUrl | String | URL of the video |
callToAction | String | Call to action text |
leadFormId | String | Lead form ID |
previewPageCount | Integer | Number of preview pages in document Ads. |
destinationObject | ApiDestinationObject | Destination details |
carouselObjects | List<AdChildMedia> | List of carousel media objects |
documentObject | DocumentObject | Document Creative |
ApiDestinationObject Schema
Field Name | Field Type | Description |
type | String | Type of the destination |
url | String | URL of the destination |
AdChildMedia
Set creativeType to SPONSORED_UPDATE_CAROUSEL when carousel object is set
Field Name | Field Type | Description |
title | String | Card/Media Title |
description | String | Card/Media Description |
linkUrl | String | Card/Media Link URL |
appLink | String | Application-specific link (if applicable) |
imageUrl | String | Card/Media Image URL |
videoUrl | String | Card/Media Video URL. Pass Thumbnail URL in field imageUrl |
callToAction | String | Call-to-action text or identifier |
destinationObject | ApiDestinationObject | Destination object containing navigation details |
isStaticCard | Boolean | Static Card Carousel |
placeData | Object {"locationSourceId":"105538155871626","type":"REALTIME"} | Map Card |
Ad Objective Format → Creative Type
Objective | Format | PostType | CreativeType | Comments |
LINKEDIN_WEBSITE_VISIT | SINGLE_IMAGE_AD | PHOTO | SPONSORED_STATUS_UPDATE | Photo only |
LINKEDIN_WEBSITE_VISIT | SINGLE_IMAGE_AD | LINK | SPONSORED_STATUS_UPDATE | Photo with link |
LINKEDIN_WEBSITE_VISIT | CAROUSEL_AD | LINK | SPONSORED_UPDATE_CAROUSEL | Carousel or Carousel with Link |
LINKEDIN_WEBSITE_VISIT | SINGLE_VIDEO_AD | VIDEO | SPONSORED_VIDEO | Video |
LINKEDIN_WEBSITE_VISIT | TEXT_AD | TEXT | TEXT_AD | Text only |
LINKEDIN_BRAND_AWARENESS | SINGLE_IMAGE_AD | PHOTO | SPONSORED_STATUS_UPDATE | Photo only |
LINKEDIN_BRAND_AWARENESS | SINGLE_IMAGE_AD | LINK | SPONSORED_STATUS_UPDATE | Photo with link |
LINKEDIN_BRAND_AWARENESS | CAROUSEL_AD | LINK | SPONSORED_UPDATE_CAROUSEL | Carousel or Carousel with Link |
LINKEDIN_BRAND_AWARENESS | SINGLE_VIDEO_AD | VIDEO | SPONSORED_VIDEO | Video |
LINKEDIN_BRAND_AWARENESS | DOCUMENT_AD | DOCUMENT | DOCUMENT_AD | Text only |
LINKEDIN_LEAD_GENERATION | SINGLE_IMAGE_AD | PHOTO | SPONSORED_STATUS_UPDATE | Photo only |
LINKEDIN_LEAD_GENERATION | SINGLE_IMAGE_AD | LINK | SPONSORED_STATUS_UPDATE | Photo with link |
LINKEDIN_LEAD_GENERATION | CAROUSEL_AD | LINK | SPONSORED_UPDATE_CAROUSEL | Carousel or Carousel with Link |
LINKEDIN_LEAD_GENERATION | SINGLE_VIDEO_AD | VIDEO | SPONSORED_VIDEO | Video |
LINKEDIN_LEAD_GENERATION | DOCUMENT_AD | DOCUMENT | DOCUMENT_AD | Text only |
LINKEDIN_ENGAGEMENT | SINGLE_IMAGE_AD | PHOTO | SPONSORED_STATUS_UPDATE | Photo only |
LINKEDIN_ENGAGEMENT | SINGLE_IMAGE_AD | LINK | SPONSORED_STATUS_UPDATE | Photo with link |
LINKEDIN_ENGAGEMENT | CAROUSEL_AD | LINK | SPONSORED_UPDATE_CAROUSEL | Carousel or Carousel with Link |
LINKEDIN_ENGAGEMENT | SINGLE_VIDEO_AD | VIDEO | SPONSORED_VIDEO | Video |
LINKEDIN_ENGAGEMENT | DOCUMENT_AD | DOCUMENT_AD | Text only |