//native
type Adhook = {
token: string
}
export async function main(
auth: Adhook,
externalId: string,
adhookToken: string,
Origin: string,
body: {
id?: string
name?: string
createdByUserId?: string
createdByUserEmail?: string
assigneeUserId?: string
assigneeUserEmail?: string
translationUserId?: string
translationUserEmail?: string
translationStatus?: 'IN_PROGRESS' | 'COMPLETED'
translationDate?: string
deliverContentTillDate?: string
reviewTillDate?: string
type?:
| 'PERSONAL_POST'
| 'PAGE_POST'
| 'STORY'
| 'REELS'
| 'SHORTS'
| 'LINK_CAROUSEL'
| 'DOCUMENT'
| 'POLL'
tenantId?: string
subtenantId?: string
status?:
| 'CREATED'
| 'READY'
| 'PLANNED'
| 'PUBLISHED'
| 'IN_REVIEW'
| 'ACTIVATING'
| 'MANUALLY_ACTIVATING'
| 'ERROR'
| 'DELETED'
| 'CHECK_REVIEW_FEEDBACK'
| 'IMPORTING'
tags?: {
id?: string
userId?: string
tenantId?: string
subtenantId?: string
text?: string
color?: string
}[]
topics?: { id?: string; name?: string }[]
createdAt?: string
updatedAt?: string
publishAt?: string
schedule?: 'PUBLISH_AS_SOON_AS_POSSIBLE' | 'PLANNED_POST_PUBLISH'
publishedAt?: string
individualSchedulePerPlatform?: false | true
processTaskAssigneeUserId?: string
processTaskAssigneeUserIds?: string[]
processReviewMessage?: string
processReviewFeedback?: string
processReviewFeedbackAnswer?: string
channels?: {
channel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
page?: {
pictureUrl?: string
name?: string
id?: string
search?: string
}
selected?: false | true
accountId?: string
type?:
| 'PERSONAL_POST'
| 'PAGE_POST'
| 'STORY'
| 'REELS'
| 'SHORTS'
| 'LINK_CAROUSEL'
| 'DOCUMENT'
| 'POLL'
shareToFeed?: false | true
collaborators?: { username?: string }[]
poll?: {
question?: string
settings?: {
voteSelectionType?: 'SINGLE_VOTE' | 'MULTIPLE_VOTE'
duration?: 'ONE_DAY' | 'THREE_DAYS' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'
voterVisibleToAuthor?: false | true
}
options?: {
text?: string
voteCount?: number
votedByViewer?: false | true
}[]
uniqueVotersCount?: number
}
message?: string
mentions?: {
type?: 'PERSON' | 'ORGANIZATION'
externalId?: string
name?: 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' | 'DELETED' | 'PROCESSING'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
showLinkPreview?: false | true
link?: string
shortenLink?: false | true
shortenedLink?: string
linkTitle?: string
linkDescription?: string
linkCallToAction?:
| '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'
generatedLinkPreview?: {
link?: string
title?: string
description?: string
imageUrl?: string
}
addLinkToBio?: false | true
publishManually?: false | true
firstComment?: string
customLinkParams?: string
publishAt?: string
}[]
messagePerChannel?: false | true
message?: string
utmTracking?: {
utmSource?: string
utmMedium?: string
utmCampaign?: string
utmTerm?: string
utmContent?: string
customParams?: 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' | 'DELETED' | 'PROCESSING'
mediaVideoId?: string
title?: string
order?: number
fileName?: string
productTags?: {
x?: number
y?: number
productId?: string
productName?: string
}[]
}[]
document?: {
url?: string
fileType?: string
title?: string
size?: number
nbrOfPreviewPages?: number
}
showLinkPreview?: false | true
link?: string
shortenLink?: false | true
shortenedLink?: string
linkTitle?: string
linkDescription?: string
linkCallToAction?:
| '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'
generatedLinkPreview?: {
link?: string
title?: string
description?: string
imageUrl?: string
}
addLinkToBio?: false | true
promotePost?: false | true
selectedMetaPromotion?: { id?: string; name?: string }
selectedTikTokPromotion?: { id?: string; name?: string }
selectedTargetingTemplateId?: string
modifiedTarget?: {
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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| 'DISAPPROVED'
| 'IS_STOPPING'
createdFromTargetingTemplateId?: string
facebookSpecialAdCategory?:
| 'NONE'
| 'CREDIT'
| 'EMPLOYMENT'
| 'HOUSING'
| 'ISSUES_ELECTIONS_POLITICS'
| 'ONLINE_GAMBLING_AND_GAMING'
facebookSpecialAdCategoryCountry?: string
}
targetName?: string
targetInformation?: {
selectedTargetingTemplateId?: string
modifiedTarget?: {
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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| 'DISAPPROVED'
| 'IS_STOPPING'
bid?: number
finalUrl?: string
averageImpressionsPerMonth?: number
}[]
status?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| '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?:
| 'COMPLETED'
| 'IN_REVIEW'
| 'IS_RUNNING'
| 'STOP'
| 'REMOVED'
| 'DISAPPROVED'
| 'IS_STOPPING'
createdFromTargetingTemplateId?: string
facebookSpecialAdCategory?:
| 'NONE'
| 'CREDIT'
| 'EMPLOYMENT'
| 'HOUSING'
| 'ISSUES_ELECTIONS_POLITICS'
| 'ONLINE_GAMBLING_AND_GAMING'
facebookSpecialAdCategoryCountry?: string
}
targetName?: string
channels?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'[]
}[]
adChannels?: {
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
}[]
nbrOfDays?: number
totalBudget?: number
facebookBudget?: number
instagramBudget?: number
linkedInBudget?: number
twitterBudget?: number
tikTokBudget?: number
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'
promotionType?:
| 'RETARGETING'
| 'TRAFFIC'
| 'CONVERSIONS'
| 'SHOPPING'
| 'CARS'
| 'REAL_ESTATE'
| 'JOBS'
| 'EVENTS'
| 'APP'
| 'ENGAGEMENT'
| 'VIDEO_VIEWS'
| 'CALLS'
| 'REACH'
| 'FOLLOWERS'
| 'PROFILE_VIEWS'
| 'LEADS'
| 'PERFORMANCE_MAX'
campaignName?: string
adName?: string
createdFromAdTemplateId?: string
createdFromPostTemplateId?: string
createdFromPostGenerationId?: string
remark?: string
postTargeting?: {
linkedInLanguageTargeting?: false | true
selectedLinkedInLanguages?:
| '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'[]
linkedInRegionTargeting?: false | true
selectedLinkedInRegions?: { id?: string; name?: string }[]
facebookRegionTargeting?: false | true
selectedFacebookCountries?: { id?: string; name?: string }[]
facebookLocaleTargeting?: false | true
selectedFacebookLocales?: { id?: string; name?: string }[]
}
location?: {
id?: string
name?: string
type?: 'CITY' | 'COUNTRY' | 'PAGE'
}
activationErrorMessage?: string
activationErrorChannel?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
facebookBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'ADSET_BUDGET_OPTIMIZATION'
facebookTrafficOptimization?: 'LINK_CLICKS' | 'LANDING_PAGE_VIEWS'
facebookInstagramAdMode?: 'SEPARATE_ADGROUPS' | 'SAME_ADGROUP'
linkedInBidType?: 'AUTOMATIC' | 'MANUAL'
linkedInBiddingOptimization?:
| 'MAXIMIZE_CLICKS'
| 'MAXIMIZE_IMPRESSIONS'
| 'MAXIMIZE_CONVERSIONS'
| 'MAXIMIZE_LEADS'
linkedInCostType?: 'CPC' | 'CPM'
linkedInMaxBid?: number
firstComment?: string
promotionStartDate?: string
promotionEndDate?: string
importOrigin?:
| 'FACEBOOK'
| 'INSTAGRAM'
| 'GOOGLE_ADWORDS'
| 'GOOGLE_DISPLAY_NETWORK'
| 'GOOGLE_ANALYTICS'
| 'YOUTUBE'
| 'XING'
| 'LINKED_IN'
| 'TWITTER'
| 'GOOGLE_MY_BUSINESS'
| 'TIKTOK'
| 'BITLY'
sendNotificationOnPublication?: false | true
externalPlatformDataSynchronizedAt?: string
externalId?: string
}
) {
const url = new URL(`https://app.adhook.io/v1/posts/externalId/${externalId}`)
const response = await fetch(url, {
method: 'PUT',
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 16 days ago