//native
type Adhook = {
token: string
}
export async function main(
auth: Adhook,
adhookToken: string,
Origin: string,
body: {
id?: string
type?:
| 'TRAFFIC'
| 'CONVERSIONS'
| 'RETARGETING'
| 'SHOPPING'
| 'CARS'
| 'REAL_ESTATE'
| 'JOBS'
| 'EVENTS'
| 'APP'
| 'ENGAGEMENT'
| 'VIDEO_VIEWS'
| 'CALLS'
| 'REACH'
| 'FOLLOWERS'
| 'PROFILE_VIEWS'
| 'LEADS'
| 'PERFORMANCE_MAX'
customGoal?: string
creationDate?: string
template?: {
imageAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
textAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
videoAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
collectionAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
carouselAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
documentAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
shoppingAds?: {
adId?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
target?: { id?: string; name?: string }
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
businessName?: string
longTitle?: string
adTextType?:
| 'TEXT_AD'
| 'DYNAMIC_TEXT_AD'
| 'CLICK_TO_CALL_AD'
| 'SHOPPING_AD'
| 'SHOPPING_SHOWCASE_AD'
textType?: 'SHORT' | 'LONG'
slides?: {
descriptions?: string[]
links?: string[]
titles?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
displayLinks?: string[]
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
}[]
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
}[]
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
twitterUser?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: string
}
titles?: string[]
title2s?: string[]
title3s?: string[]
descriptions?: string[]
description2s?: string[]
pinnedTitles?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
pinnedDescriptions?: {
textAssetIndex?: number
position?: 'NOT_PINNED' | 'POSITION_1' | 'POSITION_2' | 'POSITION_3'
}[]
dynamicAdDescriptions1?: string[]
dynamicAdDescriptions2?: string[]
phoneNumber?: string
countryCode?: string
callOnlyDescriptions1?: string[]
callOnlyDescriptions2?: string[]
images?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
verticalImages?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
logos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
squareLogos?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}[]
links?: string[]
paths?: { path1?: string; path2?: string }[]
displayLinks?: string[]
linkDescriptions?: string[]
videos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
verticalVideos?: {
url?: string
size?: number
fileExtension?: string
facebookVideoId?: string
tikTokVideoId?: string
width?: number
height?: number
thumbnailImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
thumbnailTimePosition?: number
cutStartTimePosition?: number
cutEndTimePosition?: number
cutUrl?: string
mediaStatus?: 'READY' | 'PROCESSING' | 'DELETED'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
youTubeVideos?: { url?: string; id?: string }[]
callToActions?:
| 'APPLY_NOW'
| 'BOOK_NOW'
| 'CONTACT_US'
| 'DOWNLOAD'
| 'MORE_OF_THIS'
| 'SHOP_NOW'
| 'ORDER_NOW'
| 'REGISTER'
| 'WATCH_MORE'
| 'NO_BUTTON'
| 'CALL_NOW'
| 'SUBSCRIBE'
| 'GET_QUOTE'
| 'GET_OFFER'
| 'LEARN_MORE'
| 'SIGN_UP'
| 'JOIN'
| 'ATTEND'
| 'REQUEST_DEMO'
| 'LISTEN_NOW'
| 'GET_SHOWTIMES'
| 'UNLOCK_FULL_DOCUMENT'[]
facebookPostId?: string
instagramPostId?: string
twitterTweetId?: string
linkedInPostId?: string
searchAdType?: 'EXPANDED' | 'RESPONSIVE'
carouselMultiShareEndCard?: false | true
carouselMultiShareOptimized?: false | true
useTikTokSparkAd?: false | true
tikTokProfileName?: string
tikTokProfileImage?: {
thumbnailUrl?: string
url?: string
croppedUrl?: string
croppedImageSize?: number
croppedWidth?: number
croppedHeight?: number
facebookImageUrl?: string
tikTokImageId?: string
tags?: { x?: number; y?: number; name?: string }[]
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
link?: string
linkTitle?: string
linkDescription?: string
order?: number
}
adStatus?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
facebookInstantExperienceId?: string
facebookInstantExperienceThumbnails?: {
elementId?: string
photoId?: string
height?: number
width?: number
cropTopLeft?: number[]
cropBottomRight?: number[]
}[]
tikTokPostId?: string
ignoredForDistribution?: false | true
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
deactivateComments?: false | true
type?: 'SHORT' | 'LONG'
}[]
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
finalUrlSuffix?: string
url?: string
createdFromAdTemplateId?: string
facebookLeadForm?: {
id?: string
name?: string
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
}
linkedInLeadForm?: {
id?: string
name?: string
facebookPage?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
}
automaticPostPromotion?: {
enabled?: false | true
name?: string
target?: { id?: string; name?: string }
platforms?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'[]
postType?: 'ALL' | 'LINK' | 'IMAGE' | 'VIDEO'
nbrOfDays?: number
maxPostPublishedDateInDays?: number
postMessageKeywords?: string[]
minimumOrganicResultMetric?: 'REACH' | 'CLICKS' | 'LIKES' | 'IMPRESSIONS'
minimumOrganicResultValue?: number
placements?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'[]
customLinkParams?: string
}
automaticPostPromotions?: {
enabled?: false | true
name?: string
target?: { id?: string; name?: string }
platforms?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'[]
postType?: 'ALL' | 'LINK' | 'IMAGE' | 'VIDEO'
nbrOfDays?: number
maxPostPublishedDateInDays?: number
postMessageKeywords?: string[]
minimumOrganicResultMetric?: 'REACH' | 'CLICKS' | 'LIKES' | 'IMPRESSIONS'
minimumOrganicResultValue?: number
placements?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'[]
customLinkParams?: string
}[]
}
status?:
| 'IN_REVIEW'
| 'COMPLETED'
| 'READY'
| 'DELETED'
| 'CREATED'
| 'PLANNED'
| 'BLOCKED'
| 'IN_PROGRESS'
| 'STOPPED'
| 'ERROR'
| 'ACTIVATING'
| 'IMPORTING'
| 'READY_FOR_PAYMENT'
| 'LOCKED'
| 'PRODUCT_SYNCHRONIZING'
| 'CHECK_REVIEW_FEEDBACK'
statusBeforeActivation?:
| 'IN_REVIEW'
| 'COMPLETED'
| 'READY'
| 'DELETED'
| 'CREATED'
| 'PLANNED'
| 'BLOCKED'
| 'IN_PROGRESS'
| 'STOPPED'
| 'ERROR'
| 'ACTIVATING'
| 'IMPORTING'
| 'READY_FOR_PAYMENT'
| 'LOCKED'
| 'PRODUCT_SYNCHRONIZING'
| 'CHECK_REVIEW_FEEDBACK'
importOrigin?: 'FACEBOOK' | 'GOOGLE_ADWORDS' | 'LINKED_IN' | 'TWITTER' | 'TIKTOK'
source?: 'TARGETING_TOOL' | 'TEMPLATE' | 'LEAD_CHATBOT' | 'GENERATION'
createdByUserId?: string
createdByUserEmail?: string
assigneeUserId?: string
assigneeUserEmail?: string
title?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
tags?: {
id?: string
userId?: string
tenantId?: string
subtenantId?: string
text?: string
color?: string
}[]
topics?: { id?: string; name?: string }[]
channelConfigurations?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
selected?: false | true
googleUser?: {
emailAddress?: string
googleCredentials?: string
customerId?: string
mccCustomerId?: string
analyticsProfileId?: string
analyticsType?: 'UNIVERSAL' | 'GA4'
name?: string
accountType?: 'AD_ACCOUNT' | 'USER_ACCOUNT'
currency?: string
youTubeChannelId?: string
}
facebookUser?: {
internalId?: string
name?: string
accessToken?: string
accountId?: string
email?: string
accountType?: 'AD_ACCOUNT' | 'USER_ACCOUNT'
currency?: string
}
linkedInUser?: {
name?: string
accessToken?: string
accountId?: string
email?: string
expires?: string
accountType?: 'AD_ACCOUNT' | 'USER_ACCOUNT'
currency?: string
refreshToken?: string
refreshTokenExpires?: string
status?: 'REMOVED' | 'ACTIVE' | 'CANCELED' | 'DRAFT'
}
twitterUser?: {
name?: string
accessToken?: string
accessTokenSecret?: string
accountId?: string
email?: string
accountType?: 'AD_ACCOUNT' | 'USER_ACCOUNT'
currency?: string
}
tikTokUser?: {
name?: string
accessToken?: string
expires?: string
refreshToken?: string
refreshTokenExpires?: string
accessTokenSecret?: string
accountId?: string
email?: string
accountType?: 'AD_ACCOUNT' | 'USER_ACCOUNT'
currency?: string
displayName?: string
profileImageUrl?: string
profileImageId?: string
}
campaignGroup?: {
id?: string
name?: string
status?: 'REMOVED' | 'ACTIVE' | 'CANCELED' | 'DRAFT' | 'ARCHIVED' | 'PAUSED'
}
}[]
targets?: {
id?: string
name?: string
namingTemplateElementValues?: { elementId?: string; value?: string }[]
gender?: 'ALL' | 'MALE' | 'FEMALE'
language?:
| 'ALL'
| 'DE'
| 'FR'
| 'EN'
| 'IT'
| 'ES'
| 'PT'
| 'NL'
| 'SV'
| 'RO'
| 'CS'
| 'EL'
| 'TR'
| 'PL'
| 'DA'
| 'EU'
| 'CY'
| 'CA'
| 'HU'
| 'SK'
| 'SL'
| 'SQ'
| 'HY'
| 'BS'
| 'BG'
| 'HR'
| 'UK'
| 'NO'
| 'FI'
additionalLanguages?:
| 'ALL'
| 'DE'
| 'FR'
| 'EN'
| 'IT'
| 'ES'
| 'PT'
| 'NL'
| 'SV'
| 'RO'
| 'CS'
| 'EL'
| 'TR'
| 'PL'
| 'DA'
| 'EU'
| 'CY'
| 'CA'
| 'HU'
| 'SK'
| 'SL'
| 'SQ'
| 'HY'
| 'BS'
| 'BG'
| 'HR'
| 'UK'
| 'NO'
| 'FI'[]
linkedInTargetingEntityLinkOperator?: 'AND' | 'OR'
linkedInTargetingCriterias?: {
facetUrn?: string
urn?: string
name?: string
children?: {}[]
parentUrn?: string
}[]
linkedInTargetingCriteriaGroups?: {
linkedInTargetingEntityLinkOperator?: 'AND' | 'OR'
linkedInTargetingCriterias?: {
facetUrn?: string
urn?: string
name?: string
children?: {}[]
parentUrn?: string
}[]
}[]
googleAdGroups?: {
id?: string
name?: string
type?: 'STANDARD' | 'DYNAMIC'
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
trackingUrlTemplate?: string
customParameters?: { key?: string; value?: string }[]
adGroupExclusion?: {
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY'
createdFromTargetingTemplateId?: string
}[]
twitterTargetingCriterias?: {
type?: 'KEYWORD' | 'FOLLOWER_LOOKALIKE'
value?: string
twitterId?: string
}[]
tikTokTargetingCriterias?: {
id?: string
name?: string
type?:
| 'INTEREST_CATEGORY'
| 'INTEREST_KEYWORD'
| 'ACTION_CATEGORY_VIDEO'
| 'ACTION_CATEGORY_CREATOR'
| 'HASHTAG'
children?: {}[]
}[]
facebookInterestGroups?: {
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
}[]
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
facebookAdGroups?: {
id?: string
name?: string
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
}[]
targetRegions?: {
type?: 'CITY' | 'REGION' | 'ZIP' | 'COORDINATE'
city?: string
useRadius?: false | true
radiusInKm?: number
countryCode?: string
lat?: number
lon?: number
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
linkedInUrn?: string
twitterTargetingValue?: string
tikTokLocationId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
externalPlaceId?: string
regionReviewEnabled?: false | true
regionReviewStatus?: 'PENDING_APPROVAL' | 'APPROVED' | 'NOT_APPROVED'
}[]
targetRegionBehaviour?: {
interestedInThatRegion?: false | true
locatedInThatRegion?: false | true
}
age?: { value?: number[] }
yearsOfExperience?: { enabled?: false | true; value?: number[] }
devices?: {
showOnMobile?: false | true
showOnTablet?: false | true
showOnDesktop?: false | true
mobileBidModifier?: number
mobileBidModifierType?: 'INCREASE' | 'DECREASE'
tabletBidModifier?: number
tabletBidModifierType?: 'INCREASE' | 'DECREASE'
desktopBidModifier?: number
desktopBidModifierType?: 'INCREASE' | 'DECREASE'
}
targetExclusion?: {
facebookInterests?: {
id?: string
type?: string
name?: string
audience_size?: number
children?: {}[]
path?: string[]
}[]
linkedInTargetingCriterias?: {
facetUrn?: string
urn?: string
name?: string
children?: {}[]
parentUrn?: string
}[]
googleKeywords?: {
name?: string
competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
averageMonghtlySearchVolume?: number
averageCpc?: number
cpc?: number
cpm?: number
link?: string
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
targetRegions?: {
type?: 'CITY' | 'REGION' | 'ZIP' | 'COORDINATE'
city?: string
useRadius?: false | true
radiusInKm?: number
countryCode?: string
lat?: number
lon?: number
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
linkedInUrn?: string
twitterTargetingValue?: string
tikTokLocationId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
externalPlaceId?: string
regionReviewEnabled?: false | true
regionReviewStatus?: 'PENDING_APPROVAL' | 'APPROVED' | 'NOT_APPROVED'
}[]
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
linkedInTargetingEntityLinkOperator?: 'AND' | 'OR'
twitterTargetingCriterias?: {
type?: 'KEYWORD' | 'FOLLOWER_LOOKALIKE'
value?: string
twitterId?: string
}[]
}
retargeting?: {
googleUserLists?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
bidModifier?: number
bidModifierType?: 'INCREASE' | 'DECREASE'
}[]
facebookCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
linkedInMatchedAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
twitterCustomAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
tikTokAudiences?: {
retargetingList?: {
googleCustomerId?: string
facebookAccountId?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED'
userId?: string
googleRetargetingListId?: string
facebookCustomAudienceId?: string
linkedInAudienceId?: string
twitterAudienceId?: string
tikTokAudienceId?: string
urlPath?: string
engagementSource?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
engagementType?: 'ENGAGED' | 'FOLLOWER'
description?: string
audienceSize?: number
retentionDays?: number
}
}[]
}
shoppingSettings?: {
googleMerchantAccount?: { merchantAccountId?: string; name?: string }
salesCountry?: string
enableLocal?: false | true
googleShoppingCampaignType?: 'CLASSIC' | 'SMART'
productScopeType?: 'NONE' | 'FILTER'
productScopes?: {
productDimension?:
| 'BRAND'
| 'PRODUCT_NR'
| 'STATE'
| 'PRODUCT_TYPE'
| 'CUSTOM_LABEL_0'
| 'CUSTOM_LABEL_1'
| 'CUSTOM_LABEL_2'
| 'CUSTOM_LABEL_3'
| 'CUSTOM_LABEL_4'
| 'CHANNEL'
| 'CHANNEL_EXCLUSIVE'
value?: string
}[]
facebookProductCatalog?: {
id?: string
name?: string
nbrOfProducts?: number
nbrOfQualifiedProducts?: number
}
facebookDynamicAdsTargetingType?: 'RETARGETING' | 'BROAD'
facebookProductSet?: {
id?: string
name?: string
nbrOfProducts?: number
}
facebookRetargetingIncludedRetentionDays?: number
facebookRetargetingExcludedRetentionDays?: number
}
dynamicSearchSettings?: { domainName?: string; languageCode?: string }
extension?: {
sitelinkExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
sitelinkName?: string
sitelinkUrl?: string
sitelinkDescription1?: string
sitelinkDescription2?: string
finalUrls?: string[]
finalMobileUrls?: string[]
sitelinkTrackingUrl?: string
}[]
calloutExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
calloutText?: string
}[]
callExtensions?: {
feedId?: number
feedItemId?: number
assetId?: number
adwordsCustomerId?: string
extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE'
extensionRunStatus?:
| 'ADDED_CAMPAIGN'
| 'ADDED_ADGROUP'
| 'ADDED_ACCOUNT'
| 'IS_CAMPAIGN_LINKED'
| 'IS_ADGROUP_LINKED'
| 'UNLINKING'
| 'UNLINKED'
phoneNumber?: string
country?: string
}[]
}
status?:
| 'IS_RUNNING'
| 'STOP'
| 'IN_REVIEW'
| 'REMOVED'
| 'COMPLETED'
| 'DISAPPROVED'
| 'IS_STOPPING'
createdFromTargetingTemplateId?: string
facebookSpecialAdCategory?:
| 'NONE'
| 'CREDIT'
| 'EMPLOYMENT'
| 'HOUSING'
| 'ISSUES_ELECTIONS_POLITICS'
| 'ONLINE_GAMBLING_AND_GAMING'
facebookSpecialAdCategoryCountry?: string
}[]
budget?: {
totalCost?: number
budgetChannels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
placement?:
| 'GOOGLE_DISPLAY_NETWORK'
| 'YOUTUBE'
| 'GOOGLE_MY_BUSINESS'
| 'GOOGLE_SEARCH_NETWORK'
| 'FACEBOOK_TIMELINE'
| 'FACEBOOK_AUDIENCE_NETWORK'
| 'INSTAGRAM_TIMELINE'
| 'GOOGLE_SHOPPING'
| 'FACEBOOK_MESSENGER'
| 'LINKEDIN_CONTENT'
| 'LINKEDIN_TEXT'
| 'LINKEDIN_INMAIL'
| 'LINKEDIN_DYNAMIC'
| 'FACEBOOK_STORIES'
| 'FACEBOOK_INSTANT_ARTICLES'
| 'FACEBOOK_RIGHT_HAND_COLUMN'
| 'FACEBOOK_MARKETPLACE'
| 'INSTAGRAM_STORIES'
| 'FACEBOOK_MESSENGER_STORIES'
| 'FACEBOOK_SEARCH'
| 'FACEBOOK_INSTREAM_VIDEO'
| 'FACEBOOK_REELS'
| 'INSTAGRAM_EXPLORE_HOME'
| 'INSTAGRAM_PROFILE_FEED'
| 'INSTAGRAM_PROFILE_REELS'
| 'LINKEDIN_AUDIENCE_NETWORK'
| 'TWITTER_ALL'
| 'TWITTER_PUBLISHER_NETWORK'
| 'TWITTER_SEARCH'
| 'TWITTER_TIMELINE'
| 'TWITTER_PROFILE'
| 'FACEBOOK_UNKNOWN'
| 'FACEBOOK_VIDEO_FEED'
| 'INSTAGRAM_REELS'
| 'INSTAGRAM_SHOP'
| 'INSTAGRAM_EXPLORE'
| 'TIKTOK_FEED'
| 'META_AUTOMATIC'
selected?: false | true
totalCost?: number
bid?: number
maxBid?: number
costType?: 'CPC' | 'CPM'
bidType?: 'AUTOMATIC' | 'MANUAL'
linkedInBiddingOptimization?:
| 'MAXIMIZE_CLICKS'
| 'MAXIMIZE_IMPRESSIONS'
| 'MAXIMIZE_CONVERSIONS'
| 'MAXIMIZE_LEADS'
linkedInDailyBudget?: number
facebookBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'ADSET_BUDGET_OPTIMIZATION'
facebookTrafficOptimization?: 'LINK_CLICKS' | 'LANDING_PAGE_VIEWS'
twitterBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'AD_GROUP_BUDGET_OPTIMIZATION'
tikTokBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'AD_GROUP_BUDGET_OPTIMIZATION'
targetBudgets?: {
targetId?: string
budget?: number
linkedInDailyBudget?: number
metaBudgetSplit?: {
facebookBudget?: number
instagramBudget?: number
storyBudget?: number
reelsBudget?: number
}
}[]
}[]
overallMaxBid?: number
adWordsPageOneGoal?: 'ANY_POSITION' | 'TOP_POSITION'
higherThanCompetitorPercentage?: number
competitorDomain?: string
targetCpa?: number
targetReturnOnAdSpendPercentage?: number
enhancedManualCpc?: false | true
conversionTracking?: {
facebookConversionTracker?: {
id?: string
googleCustomerId?: string
facebookAccountId?: string
facebookCustomConversionId?: string
facebookCustomConversionEventName?: string
facebookStandardEventName?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'ACTIVE' | 'INACTIVE'
snippet?: string
revenueValue?: number
userId?: string
tenantId?: string
currency?: string
pixelSnippet?: string
googleTrackerId?: string
googleGlobalSiteTag?: string
twitterWebEventTag?: string
linkedInConversionId?: string
googleConversionId?: string
googleConversionLabel?: string
tikTokAccountId?: string
tikTokPixelId?: string
tikTokEventName?: string
}
googleConversionTracker?: {
id?: string
googleCustomerId?: string
facebookAccountId?: string
facebookCustomConversionId?: string
facebookCustomConversionEventName?: string
facebookStandardEventName?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'ACTIVE' | 'INACTIVE'
snippet?: string
revenueValue?: number
userId?: string
tenantId?: string
currency?: string
pixelSnippet?: string
googleTrackerId?: string
googleGlobalSiteTag?: string
twitterWebEventTag?: string
linkedInConversionId?: string
googleConversionId?: string
googleConversionLabel?: string
tikTokAccountId?: string
tikTokPixelId?: string
tikTokEventName?: string
}
linkedInConversionTracker?: {
id?: string
googleCustomerId?: string
facebookAccountId?: string
facebookCustomConversionId?: string
facebookCustomConversionEventName?: string
facebookStandardEventName?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'ACTIVE' | 'INACTIVE'
snippet?: string
revenueValue?: number
userId?: string
tenantId?: string
currency?: string
pixelSnippet?: string
googleTrackerId?: string
googleGlobalSiteTag?: string
twitterWebEventTag?: string
linkedInConversionId?: string
googleConversionId?: string
googleConversionLabel?: string
tikTokAccountId?: string
tikTokPixelId?: string
tikTokEventName?: string
}
twitterConversionTracker?: {
id?: string
googleCustomerId?: string
facebookAccountId?: string
facebookCustomConversionId?: string
facebookCustomConversionEventName?: string
facebookStandardEventName?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'ACTIVE' | 'INACTIVE'
snippet?: string
revenueValue?: number
userId?: string
tenantId?: string
currency?: string
pixelSnippet?: string
googleTrackerId?: string
googleGlobalSiteTag?: string
twitterWebEventTag?: string
linkedInConversionId?: string
googleConversionId?: string
googleConversionLabel?: string
tikTokAccountId?: string
tikTokPixelId?: string
tikTokEventName?: string
}
tikTokConversionTracker?: {
id?: string
googleCustomerId?: string
facebookAccountId?: string
facebookCustomConversionId?: string
facebookCustomConversionEventName?: string
facebookStandardEventName?: string
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
name?: string
status?: 'ACTIVE' | 'INACTIVE'
snippet?: string
revenueValue?: number
userId?: string
tenantId?: string
currency?: string
pixelSnippet?: string
googleTrackerId?: string
googleGlobalSiteTag?: string
twitterWebEventTag?: string
linkedInConversionId?: string
googleConversionId?: string
googleConversionLabel?: string
tikTokAccountId?: string
tikTokPixelId?: string
tikTokEventName?: string
}
}
biddingOptimization?:
| 'UNKNOWN'
| 'MANUAL'
| 'MAXIMIZE_CONVERSIONS'
| 'AUTOMATIC_CHANNELS'
| 'ENHANCED_CPC'
| 'PAGE_ONE_PROMOTED'
| 'TARGET_OUTRANK_SHARE'
| 'TARGET_CPA'
| 'TARGET_ROAS'
| 'TARGET_SPEND'
| 'MANUAL_CPV'
| 'MANUAL_CPM'
| 'AUTOMATIC_ADHOOK'
| 'MAXIMIZE_CONVERSIONS_VALUE'
| 'PERCENT_CPC'
| 'TARGET_CPM'
| 'TARGET_IMPRESSION_SHARE'
adWordsBiddingStrategyId?: string
adWordsBiddingStrategyName?: string
adWordsBiddingStrategyMode?: 'STANDARD' | 'PORTFOLIO'
deliveryMethod?: 'STANDARD' | 'ACCELERATED'
portfolioCreationMode?: 'EXISTING_PORTFOLIO' | 'NEW_PORTFOLIO'
marginSpecification?: 'NET' | 'GROSS'
}
timeRange?: {
start?: string
end?: string
nbrOfDays?: number
durationType?: 'SHORT_TERM' | 'LONG_TERM'
targetSchedule?: {
start?: string
end?: string
nbrOfDays?: number
targetId?: string
}[]
}
currency?:
| 'ALL'
| 'CHF'
| 'USD'
| 'EUR'
| 'AED'
| 'AFN'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BOV'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHE'
| 'CHW'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'COU'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EGP'
| 'ERN'
| 'ETB'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SLL'
| 'SOS'
| 'SRD'
| 'SSP'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'UYI'
| 'UYU'
| 'UYW'
| 'UZS'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'XSU'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZWL'
version?: number
tenantId?: string
subtenantId?: string
marginPercentage?: number
processReviewMessage?: string
processReviewFeedback?: string
processReviewFeedbackAnswer?: string
processTaskAssigneeUserId?: string
processTaskAssigneeUserIds?: string[]
regionReviewUserIds?: string[]
createdFromCampaignGenerationId?: string
createdFromPostId?: string
activationStatus?: 'COMPLETED' | 'ERROR' | 'PENDING'
activationErrorMessage?: string
activationErrorChannel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
color?: string
pausedAt?: string
externalPlatformDataSynchronizedAt?: string
}
) {
const url = new URL(`https://app.adhook.io/v1/promotions`)
const response = await fetch(url, {
method: 'POST',
headers: {
adhookToken: adhookToken,
Authorization: `Bearer ${auth.token}`,
Origin: Origin,
'Content-Type': 'application/json'
},
body: JSON.stringify(body)
})
if (!response.ok) {
const text = await response.text()
throw new Error(`${response.status} ${text}`)
}
return await response.json()
}
Submitted by hugo697 519 days ago