Ad Set
Updated
Ad Objective to Supported Ad Format
AdObjective (adObjective) | Supported Ad Formats (adFormat) |
Website Visit | SINGLE_IMAGE_AD, CAROUSEL_AD, SINGLE_VIDEO_AD, TEXT_AD, MESSAGE_AD, CONVERSATION_AD, SPOTLIGHT, EVENT_AD |
Brand Awareness | SINGLE_IMAGE_AD, CAROUSEL_AD, SINGLE_VIDEO_AD, TEXT_AD, CONVERSATION_AD, DOCUMENT_AD, FOLLOW_COMPANY, SPOTLIGHT, EVENT_AD |
Lead Generation | SINGLE_IMAGE_AD, CAROUSEL_AD, SINGLE_VIDEO_AD, MESSAGE_AD, CONVERSATION_AD, DOCUMENT_AD |
Engagement | SINGLE_IMAGE_AD, CAROUSEL_AD, SINGLE_VIDEO_AD, CONVERSATION_AD, DOCUMENT_AD, FOLLOW_COMPANY, EVENT_AD |
Video Views | SINGLE_VIDEO_AD |
Website Conversion | SINGLE_IMAGE_AD, SPOTLIGHT |
Job Applicant | SINGLE_IMAGE_AD, CAROUSEL_AD, SINGLE_VIDEO_AD, TEXT_AD, MESSAGE_AD, CONVERSATION_AD, SPOTLIGHT |
Ad Format
Ad Format Enum (adFormat) | Label |
SINGLE_IMAGE_AD | Single Image Ad |
SINGLE_VIDEO_AD | Single Video Ad |
CAROUSEL_AD | Carousel Ad |
TEXT_AD | Text Ad |
MESSAGE_AD | Message Ad |
CONVERSATION_AD | Conversation Ad |
SPOTLIGHT | Spotlight Ad |
FOLLOW_COMPANY | Follower Ad |
JOB_APPLICANT | Job Ad |
SINGLE_JOB_AD | Single Job Ad |
EVENT_AD | Event Ad |
DOCUMENT_AD | Document Ad |
Api AdSet Fields (LinkedIn)
Field Name | Field Type | Description | Update Supported | ChangeType |
name | String | Name of the ad set. | Y | NAME |
channelId | String | Campaign Id or Channel Id | N | |
id | String | Unique identifier for the ad set. | N | |
startTime | Long | Start time of the ad set in epoch milliseconds. | Y | START_DATE |
endTime | Long | End time of the ad set in epoch milliseconds. | Y | END_DATE |
adObjective | AdObjective | Objective of the ad campaign (e.g., brand awareness, conversions). | N | |
audienceExpansionEnabled | Boolean | Indicates whether audience expansion is enabled. | N | |
offsiteDelivery | Boolean | Indicates if the ad will be delivered offsite. | N | |
adFormat | LinkedInAdFormat | N | ||
campaignGroupId | String | ID of the campaign group the ad set belongs to. | N | |
campaignGroupName | String | Name of the campaign group. | N | |
adRotationType | Enum | Type of ad rotation (e.g., optimized). | N | |
status | Enum | Current status of the ad set (default: DRAFT, ACTIVE, PAUSED). | Y | STATUS |
adPlacements | List<Enum> | N | ||
pacingType | Enum | LIFETIME, ACCELERATED | N | |
dailyBudget | Double | Daily budget allocated for the ad set. | Y | DAILY_BUDGET |
lifeTimeBudget | Double | Lifetime budget allocated for the ad set. | Y | LIFETIME_BUDGET |
bidType | enum | Type of bidding (e.g., CPC, CPM). https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800578154/AdSet+LinkedIn#Bid-Type-(bidType) | Y | BID_TYPE |
bidAmount | Double | Bid Amount | Y | BID_AMOUNT |
optimiseFor | Enum | Optimization goal for the ad set | Y | OPTIMIZE_FOR |
trackingPixelChannelIds | List<String> | Pixel Ids | Y | PIXEL |
targeting | TargetingRequest | Targeting parameters for the ad set. https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4793958819/Object+Schema#TargetingRequest | Y | TARGETING |
frequency | List<FrequencyRequest> | Frequency capping settings for ad delivery. https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4793958819/Object+Schema#FrequencyRequest | Y | FREQUENCY_CAP |
apiAdVariantRequests | List<PaidApiAdVariant> | Variations of the ad set for A/B testing. | ||
changeTypes | List<String> | When Update Pass Change Types |
Ad Roation Type (adRotationType)
Enum Label | Description |
ROUND_ROBIN | Rotate variations evenly |
OPTIMIZED | Optimize click-through rate |
AdPlacments (adPlacements)
Enum Label | Description |
TABLET | Tablet |
DESKTOP | Desktop |
MOBILE_TABLET | Mobile / Tablet |
Bid Type (bidType)
Enum | Label |
CPC | CPC |
CPM | CPM |
CPV | CPV |
AdObjective To Optimisation Goal Supported
Ad Objective | Optimization Goals (optimiseFor) | |
LINKEDIN_BRAND_AWARENESS | MAX_REACH, NONE, MAX_IMPRESSION, CAP_COST_AND_MAXIMIZE_IMPRESSIONS, TARGET_COST_PER_IMPRESSION, MAX_CLICK | |
LINKEDIN_WEBSITE_VISIT | MAX_CLICK, NONE, ENHANCED_CONVERSION, MAX_IMPRESSION, CAP_COST_AND_MAXIMIZE_CLICKS, TARGET_COST_PER_CLICK | |
LINKEDIN_LEAD_GENERATION | MAX_LEAD, NONE, ENHANCED_CONVERSION, CAP_COST_AND_MAXIMIZE_LEADS, MAX_CLICK, MAX_IMPRESSION | |
LINKEDIN_VIDEO_VIEWS | MAX_VIDEO_VIEW, NONE, MAX_IMPRESSION, TARGET_COST_PER_VIDEO_VIEW, CAP_COST_AND_MAXIMIZE_VIDEO_VIEWS, MAX_CLICK | |
LINKEDIN_ENGAGEMENT | MAX_CLICK, NONE, ENHANCED_CONVERSION, CAP_COST_AND_MAXIMIZE_CLICKS, MAX_IMPRESSION | |
LINKEDIN_WEB_CONVERSION | MAX_CONVERSION, NONE, ENHANCED_CONVERSION, MAX_IMPRESSION, MAX_CLICK | |
LINKEDIN_JOB_APPLICANT | MAX_CLICK, NONE | |
Ad Objective | Optimisation Goal | Bid Type |
LINKEDIN_BRAND_AWARENESS | MAX_REACH | CPM |
LINKEDIN_BRAND_AWARENESS | NONE | CPM, CPC |
LINKEDIN_BRAND_AWARENESS | MAX_IMPRESSION | CPM |
LINKEDIN_BRAND_AWARENESS | CAP_COST_AND_MAXIMIZE_IMPRESSIONS | CPM |
LINKEDIN_BRAND_AWARENESS | TARGET_COST_PER_IMPRESSION | CPM |
LINKEDIN_BRAND_AWARENESS | MAX_CLICK | CPM |
LINKEDIN_WEBSITE_VISIT | MAX_CLICK | CPM |
LINKEDIN_WEBSITE_VISIT | NONE | CPM, CPC |
LINKEDIN_WEBSITE_VISIT | ENHANCED_CONVERSION | CPM, CPC |
LINKEDIN_WEBSITE_VISIT | MAX_IMPRESSION | CPM |
LINKEDIN_WEBSITE_VISIT | CAP_COST_AND_MAXIMIZE_CLICKS | CPM |
LINKEDIN_WEBSITE_VISIT | TARGET_COST_PER_CLICK | CPC |
LINKEDIN_LEAD_GENERATION | MAX_LEAD | CPM |
LINKEDIN_LEAD_GENERATION | NONE | CPM, CPC |
LINKEDIN_LEAD_GENERATION | ENHANCED_CONVERSION | CPM, CPC |
LINKEDIN_LEAD_GENERATION | CAP_COST_AND_MAXIMIZE_LEADS | CPM |
LINKEDIN_LEAD_GENERATION | MAX_CLICK | CPM |
LINKEDIN_LEAD_GENERATION | MAX_IMPRESSION | CPM |
LINKEDIN_VIDEO_VIEWS | MAX_VIDEO_VIEW | CPM |
LINKEDIN_VIDEO_VIEWS | NONE | CPM, CPV, CPC |
LINKEDIN_VIDEO_VIEWS | MAX_IMPRESSION | CPM |
LINKEDIN_VIDEO_VIEWS | TARGET_COST_PER_VIDEO_VIEW | CPV |
LINKEDIN_VIDEO_VIEWS | CAP_COST_AND_MAXIMIZE_VIDEO_VIEWS | CPM |
LINKEDIN_VIDEO_VIEWS | MAX_CLICK | CPM |
LINKEDIN_ENGAGEMENT | MAX_CLICK | CPM |
LINKEDIN_ENGAGEMENT | NONE | CPM, CPC |
LINKEDIN_ENGAGEMENT | ENHANCED_CONVERSION | CPM, CPC |
LINKEDIN_ENGAGEMENT | CAP_COST_AND_MAXIMIZE_CLICKS | CPM |
LINKEDIN_ENGAGEMENT | MAX_IMPRESSION | CPM |
LINKEDIN_WEB_CONVERSION | MAX_CONVERSION | CPM |
LINKEDIN_WEB_CONVERSION | NONE | CPC, CPM |
LINKEDIN_WEB_CONVERSION | ENHANCED_CONVERSION | CPC |
LINKEDIN_WEB_CONVERSION | MAX_IMPRESSION | CPM |
LINKEDIN_WEB_CONVERSION | MAX_CLICK | CPM |
LINKEDIN_JOB_APPLICANT | MAX_CLICK | CPM |
LINKEDIN_JOB_APPLICANT | NONE | CPC, CPM |