1 | |
2 | type Adhook = { |
3 | token: string |
4 | } |
5 |
|
6 | export async function main( |
7 | auth: Adhook, |
8 | adhookToken: string, |
9 | body: { |
10 | promotionId?: string |
11 | target?: { |
12 | id?: string |
13 | name?: string |
14 | namingTemplateElementValues?: { elementId?: string; value?: string }[] |
15 | gender?: 'ALL' | 'MALE' | 'FEMALE' |
16 | language?: |
17 | | 'ALL' |
18 | | 'DE' |
19 | | 'FR' |
20 | | 'EN' |
21 | | 'IT' |
22 | | 'ES' |
23 | | 'PT' |
24 | | 'NL' |
25 | | 'SV' |
26 | | 'RO' |
27 | | 'CS' |
28 | | 'EL' |
29 | | 'TR' |
30 | | 'PL' |
31 | | 'DA' |
32 | | 'EU' |
33 | | 'CY' |
34 | | 'CA' |
35 | | 'HU' |
36 | | 'SK' |
37 | | 'SL' |
38 | | 'SQ' |
39 | | 'HY' |
40 | | 'BS' |
41 | | 'BG' |
42 | | 'HR' |
43 | | 'UK' |
44 | | 'NO' |
45 | | 'FI' |
46 | additionalLanguages?: |
47 | | 'ALL' |
48 | | 'DE' |
49 | | 'FR' |
50 | | 'EN' |
51 | | 'IT' |
52 | | 'ES' |
53 | | 'PT' |
54 | | 'NL' |
55 | | 'SV' |
56 | | 'RO' |
57 | | 'CS' |
58 | | 'EL' |
59 | | 'TR' |
60 | | 'PL' |
61 | | 'DA' |
62 | | 'EU' |
63 | | 'CY' |
64 | | 'CA' |
65 | | 'HU' |
66 | | 'SK' |
67 | | 'SL' |
68 | | 'SQ' |
69 | | 'HY' |
70 | | 'BS' |
71 | | 'BG' |
72 | | 'HR' |
73 | | 'UK' |
74 | | 'NO' |
75 | | 'FI'[] |
76 | linkedInTargetingEntityLinkOperator?: 'AND' | 'OR' |
77 | linkedInTargetingCriterias?: { |
78 | facetUrn?: string |
79 | urn?: string |
80 | name?: string |
81 | children?: {}[] |
82 | parentUrn?: string |
83 | }[] |
84 | linkedInTargetingCriteriaGroups?: { |
85 | linkedInTargetingEntityLinkOperator?: 'AND' | 'OR' |
86 | linkedInTargetingCriterias?: { |
87 | facetUrn?: string |
88 | urn?: string |
89 | name?: string |
90 | children?: {}[] |
91 | parentUrn?: string |
92 | }[] |
93 | }[] |
94 | googleAdGroups?: { |
95 | id?: string |
96 | name?: string |
97 | type?: 'STANDARD' | 'DYNAMIC' |
98 | googleKeywords?: { |
99 | name?: string |
100 | competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN' |
101 | averageMonghtlySearchVolume?: number |
102 | averageCpc?: number |
103 | cpc?: number |
104 | cpm?: number |
105 | link?: string |
106 | status?: |
107 | | 'IS_RUNNING' |
108 | | 'STOP' |
109 | | 'IN_REVIEW' |
110 | | 'REMOVED' |
111 | | 'COMPLETED' |
112 | | 'DISAPPROVED' |
113 | | 'IS_STOPPING' |
114 | bid?: number |
115 | finalUrl?: string |
116 | averageImpressionsPerMonth?: number |
117 | }[] |
118 | status?: |
119 | | 'IS_RUNNING' |
120 | | 'STOP' |
121 | | 'IN_REVIEW' |
122 | | 'REMOVED' |
123 | | 'COMPLETED' |
124 | | 'DISAPPROVED' |
125 | | 'IS_STOPPING' |
126 | bid?: number |
127 | targetCpa?: number |
128 | targetReturnOnAdSpendPercentage?: number |
129 | trackingUrlTemplate?: string |
130 | customParameters?: { key?: string; value?: string }[] |
131 | adGroupExclusion?: { |
132 | googleKeywords?: { |
133 | name?: string |
134 | competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN' |
135 | averageMonghtlySearchVolume?: number |
136 | averageCpc?: number |
137 | cpc?: number |
138 | cpm?: number |
139 | link?: string |
140 | status?: |
141 | | 'IS_RUNNING' |
142 | | 'STOP' |
143 | | 'IN_REVIEW' |
144 | | 'REMOVED' |
145 | | 'COMPLETED' |
146 | | 'DISAPPROVED' |
147 | | 'IS_STOPPING' |
148 | bid?: number |
149 | finalUrl?: string |
150 | averageImpressionsPerMonth?: number |
151 | }[] |
152 | retargeting?: { |
153 | googleUserLists?: { |
154 | retargetingList?: { |
155 | googleCustomerId?: string |
156 | facebookAccountId?: string |
157 | channel?: |
158 | | 'FACEBOOK' |
159 | | 'INSTAGRAM' |
160 | | 'GOOGLE_ADWORDS' |
161 | | 'GOOGLE_DISPLAY_NETWORK' |
162 | | 'GOOGLE_ANALYTICS' |
163 | | 'YOUTUBE' |
164 | | 'XING' |
165 | | 'LINKED_IN' |
166 | | 'TWITTER' |
167 | | 'GOOGLE_MY_BUSINESS' |
168 | | 'TIKTOK' |
169 | | 'BITLY' |
170 | name?: string |
171 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
172 | userId?: string |
173 | googleRetargetingListId?: string |
174 | facebookCustomAudienceId?: string |
175 | linkedInAudienceId?: string |
176 | twitterAudienceId?: string |
177 | tikTokAudienceId?: string |
178 | urlPath?: string |
179 | engagementSource?: |
180 | | 'FACEBOOK' |
181 | | 'INSTAGRAM' |
182 | | 'GOOGLE_ADWORDS' |
183 | | 'GOOGLE_DISPLAY_NETWORK' |
184 | | 'GOOGLE_ANALYTICS' |
185 | | 'YOUTUBE' |
186 | | 'XING' |
187 | | 'LINKED_IN' |
188 | | 'TWITTER' |
189 | | 'GOOGLE_MY_BUSINESS' |
190 | | 'TIKTOK' |
191 | | 'BITLY' |
192 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
193 | description?: string |
194 | audienceSize?: number |
195 | retentionDays?: number |
196 | } |
197 | bidModifier?: number |
198 | bidModifierType?: 'INCREASE' | 'DECREASE' |
199 | }[] |
200 | facebookCustomAudiences?: { |
201 | retargetingList?: { |
202 | googleCustomerId?: string |
203 | facebookAccountId?: string |
204 | channel?: |
205 | | 'FACEBOOK' |
206 | | 'INSTAGRAM' |
207 | | 'GOOGLE_ADWORDS' |
208 | | 'GOOGLE_DISPLAY_NETWORK' |
209 | | 'GOOGLE_ANALYTICS' |
210 | | 'YOUTUBE' |
211 | | 'XING' |
212 | | 'LINKED_IN' |
213 | | 'TWITTER' |
214 | | 'GOOGLE_MY_BUSINESS' |
215 | | 'TIKTOK' |
216 | | 'BITLY' |
217 | name?: string |
218 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
219 | userId?: string |
220 | googleRetargetingListId?: string |
221 | facebookCustomAudienceId?: string |
222 | linkedInAudienceId?: string |
223 | twitterAudienceId?: string |
224 | tikTokAudienceId?: string |
225 | urlPath?: string |
226 | engagementSource?: |
227 | | 'FACEBOOK' |
228 | | 'INSTAGRAM' |
229 | | 'GOOGLE_ADWORDS' |
230 | | 'GOOGLE_DISPLAY_NETWORK' |
231 | | 'GOOGLE_ANALYTICS' |
232 | | 'YOUTUBE' |
233 | | 'XING' |
234 | | 'LINKED_IN' |
235 | | 'TWITTER' |
236 | | 'GOOGLE_MY_BUSINESS' |
237 | | 'TIKTOK' |
238 | | 'BITLY' |
239 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
240 | description?: string |
241 | audienceSize?: number |
242 | retentionDays?: number |
243 | } |
244 | }[] |
245 | linkedInMatchedAudiences?: { |
246 | retargetingList?: { |
247 | googleCustomerId?: string |
248 | facebookAccountId?: string |
249 | channel?: |
250 | | 'FACEBOOK' |
251 | | 'INSTAGRAM' |
252 | | 'GOOGLE_ADWORDS' |
253 | | 'GOOGLE_DISPLAY_NETWORK' |
254 | | 'GOOGLE_ANALYTICS' |
255 | | 'YOUTUBE' |
256 | | 'XING' |
257 | | 'LINKED_IN' |
258 | | 'TWITTER' |
259 | | 'GOOGLE_MY_BUSINESS' |
260 | | 'TIKTOK' |
261 | | 'BITLY' |
262 | name?: string |
263 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
264 | userId?: string |
265 | googleRetargetingListId?: string |
266 | facebookCustomAudienceId?: string |
267 | linkedInAudienceId?: string |
268 | twitterAudienceId?: string |
269 | tikTokAudienceId?: string |
270 | urlPath?: string |
271 | engagementSource?: |
272 | | 'FACEBOOK' |
273 | | 'INSTAGRAM' |
274 | | 'GOOGLE_ADWORDS' |
275 | | 'GOOGLE_DISPLAY_NETWORK' |
276 | | 'GOOGLE_ANALYTICS' |
277 | | 'YOUTUBE' |
278 | | 'XING' |
279 | | 'LINKED_IN' |
280 | | 'TWITTER' |
281 | | 'GOOGLE_MY_BUSINESS' |
282 | | 'TIKTOK' |
283 | | 'BITLY' |
284 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
285 | description?: string |
286 | audienceSize?: number |
287 | retentionDays?: number |
288 | } |
289 | }[] |
290 | twitterCustomAudiences?: { |
291 | retargetingList?: { |
292 | googleCustomerId?: string |
293 | facebookAccountId?: string |
294 | channel?: |
295 | | 'FACEBOOK' |
296 | | 'INSTAGRAM' |
297 | | 'GOOGLE_ADWORDS' |
298 | | 'GOOGLE_DISPLAY_NETWORK' |
299 | | 'GOOGLE_ANALYTICS' |
300 | | 'YOUTUBE' |
301 | | 'XING' |
302 | | 'LINKED_IN' |
303 | | 'TWITTER' |
304 | | 'GOOGLE_MY_BUSINESS' |
305 | | 'TIKTOK' |
306 | | 'BITLY' |
307 | name?: string |
308 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
309 | userId?: string |
310 | googleRetargetingListId?: string |
311 | facebookCustomAudienceId?: string |
312 | linkedInAudienceId?: string |
313 | twitterAudienceId?: string |
314 | tikTokAudienceId?: string |
315 | urlPath?: string |
316 | engagementSource?: |
317 | | 'FACEBOOK' |
318 | | 'INSTAGRAM' |
319 | | 'GOOGLE_ADWORDS' |
320 | | 'GOOGLE_DISPLAY_NETWORK' |
321 | | 'GOOGLE_ANALYTICS' |
322 | | 'YOUTUBE' |
323 | | 'XING' |
324 | | 'LINKED_IN' |
325 | | 'TWITTER' |
326 | | 'GOOGLE_MY_BUSINESS' |
327 | | 'TIKTOK' |
328 | | 'BITLY' |
329 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
330 | description?: string |
331 | audienceSize?: number |
332 | retentionDays?: number |
333 | } |
334 | }[] |
335 | tikTokAudiences?: { |
336 | retargetingList?: { |
337 | googleCustomerId?: string |
338 | facebookAccountId?: string |
339 | channel?: |
340 | | 'FACEBOOK' |
341 | | 'INSTAGRAM' |
342 | | 'GOOGLE_ADWORDS' |
343 | | 'GOOGLE_DISPLAY_NETWORK' |
344 | | 'GOOGLE_ANALYTICS' |
345 | | 'YOUTUBE' |
346 | | 'XING' |
347 | | 'LINKED_IN' |
348 | | 'TWITTER' |
349 | | 'GOOGLE_MY_BUSINESS' |
350 | | 'TIKTOK' |
351 | | 'BITLY' |
352 | name?: string |
353 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
354 | userId?: string |
355 | googleRetargetingListId?: string |
356 | facebookCustomAudienceId?: string |
357 | linkedInAudienceId?: string |
358 | twitterAudienceId?: string |
359 | tikTokAudienceId?: string |
360 | urlPath?: string |
361 | engagementSource?: |
362 | | 'FACEBOOK' |
363 | | 'INSTAGRAM' |
364 | | 'GOOGLE_ADWORDS' |
365 | | 'GOOGLE_DISPLAY_NETWORK' |
366 | | 'GOOGLE_ANALYTICS' |
367 | | 'YOUTUBE' |
368 | | 'XING' |
369 | | 'LINKED_IN' |
370 | | 'TWITTER' |
371 | | 'GOOGLE_MY_BUSINESS' |
372 | | 'TIKTOK' |
373 | | 'BITLY' |
374 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
375 | description?: string |
376 | audienceSize?: number |
377 | retentionDays?: number |
378 | } |
379 | }[] |
380 | } |
381 | } |
382 | retargeting?: { |
383 | googleUserLists?: { |
384 | retargetingList?: { |
385 | googleCustomerId?: string |
386 | facebookAccountId?: string |
387 | channel?: |
388 | | 'FACEBOOK' |
389 | | 'INSTAGRAM' |
390 | | 'GOOGLE_ADWORDS' |
391 | | 'GOOGLE_DISPLAY_NETWORK' |
392 | | 'GOOGLE_ANALYTICS' |
393 | | 'YOUTUBE' |
394 | | 'XING' |
395 | | 'LINKED_IN' |
396 | | 'TWITTER' |
397 | | 'GOOGLE_MY_BUSINESS' |
398 | | 'TIKTOK' |
399 | | 'BITLY' |
400 | name?: string |
401 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
402 | userId?: string |
403 | googleRetargetingListId?: string |
404 | facebookCustomAudienceId?: string |
405 | linkedInAudienceId?: string |
406 | twitterAudienceId?: string |
407 | tikTokAudienceId?: string |
408 | urlPath?: string |
409 | engagementSource?: |
410 | | 'FACEBOOK' |
411 | | 'INSTAGRAM' |
412 | | 'GOOGLE_ADWORDS' |
413 | | 'GOOGLE_DISPLAY_NETWORK' |
414 | | 'GOOGLE_ANALYTICS' |
415 | | 'YOUTUBE' |
416 | | 'XING' |
417 | | 'LINKED_IN' |
418 | | 'TWITTER' |
419 | | 'GOOGLE_MY_BUSINESS' |
420 | | 'TIKTOK' |
421 | | 'BITLY' |
422 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
423 | description?: string |
424 | audienceSize?: number |
425 | retentionDays?: number |
426 | } |
427 | bidModifier?: number |
428 | bidModifierType?: 'INCREASE' | 'DECREASE' |
429 | }[] |
430 | facebookCustomAudiences?: { |
431 | retargetingList?: { |
432 | googleCustomerId?: string |
433 | facebookAccountId?: string |
434 | channel?: |
435 | | 'FACEBOOK' |
436 | | 'INSTAGRAM' |
437 | | 'GOOGLE_ADWORDS' |
438 | | 'GOOGLE_DISPLAY_NETWORK' |
439 | | 'GOOGLE_ANALYTICS' |
440 | | 'YOUTUBE' |
441 | | 'XING' |
442 | | 'LINKED_IN' |
443 | | 'TWITTER' |
444 | | 'GOOGLE_MY_BUSINESS' |
445 | | 'TIKTOK' |
446 | | 'BITLY' |
447 | name?: string |
448 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
449 | userId?: string |
450 | googleRetargetingListId?: string |
451 | facebookCustomAudienceId?: string |
452 | linkedInAudienceId?: string |
453 | twitterAudienceId?: string |
454 | tikTokAudienceId?: string |
455 | urlPath?: string |
456 | engagementSource?: |
457 | | 'FACEBOOK' |
458 | | 'INSTAGRAM' |
459 | | 'GOOGLE_ADWORDS' |
460 | | 'GOOGLE_DISPLAY_NETWORK' |
461 | | 'GOOGLE_ANALYTICS' |
462 | | 'YOUTUBE' |
463 | | 'XING' |
464 | | 'LINKED_IN' |
465 | | 'TWITTER' |
466 | | 'GOOGLE_MY_BUSINESS' |
467 | | 'TIKTOK' |
468 | | 'BITLY' |
469 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
470 | description?: string |
471 | audienceSize?: number |
472 | retentionDays?: number |
473 | } |
474 | }[] |
475 | linkedInMatchedAudiences?: { |
476 | retargetingList?: { |
477 | googleCustomerId?: string |
478 | facebookAccountId?: string |
479 | channel?: |
480 | | 'FACEBOOK' |
481 | | 'INSTAGRAM' |
482 | | 'GOOGLE_ADWORDS' |
483 | | 'GOOGLE_DISPLAY_NETWORK' |
484 | | 'GOOGLE_ANALYTICS' |
485 | | 'YOUTUBE' |
486 | | 'XING' |
487 | | 'LINKED_IN' |
488 | | 'TWITTER' |
489 | | 'GOOGLE_MY_BUSINESS' |
490 | | 'TIKTOK' |
491 | | 'BITLY' |
492 | name?: string |
493 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
494 | userId?: string |
495 | googleRetargetingListId?: string |
496 | facebookCustomAudienceId?: string |
497 | linkedInAudienceId?: string |
498 | twitterAudienceId?: string |
499 | tikTokAudienceId?: string |
500 | urlPath?: string |
501 | engagementSource?: |
502 | | 'FACEBOOK' |
503 | | 'INSTAGRAM' |
504 | | 'GOOGLE_ADWORDS' |
505 | | 'GOOGLE_DISPLAY_NETWORK' |
506 | | 'GOOGLE_ANALYTICS' |
507 | | 'YOUTUBE' |
508 | | 'XING' |
509 | | 'LINKED_IN' |
510 | | 'TWITTER' |
511 | | 'GOOGLE_MY_BUSINESS' |
512 | | 'TIKTOK' |
513 | | 'BITLY' |
514 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
515 | description?: string |
516 | audienceSize?: number |
517 | retentionDays?: number |
518 | } |
519 | }[] |
520 | twitterCustomAudiences?: { |
521 | retargetingList?: { |
522 | googleCustomerId?: string |
523 | facebookAccountId?: string |
524 | channel?: |
525 | | 'FACEBOOK' |
526 | | 'INSTAGRAM' |
527 | | 'GOOGLE_ADWORDS' |
528 | | 'GOOGLE_DISPLAY_NETWORK' |
529 | | 'GOOGLE_ANALYTICS' |
530 | | 'YOUTUBE' |
531 | | 'XING' |
532 | | 'LINKED_IN' |
533 | | 'TWITTER' |
534 | | 'GOOGLE_MY_BUSINESS' |
535 | | 'TIKTOK' |
536 | | 'BITLY' |
537 | name?: string |
538 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
539 | userId?: string |
540 | googleRetargetingListId?: string |
541 | facebookCustomAudienceId?: string |
542 | linkedInAudienceId?: string |
543 | twitterAudienceId?: string |
544 | tikTokAudienceId?: string |
545 | urlPath?: string |
546 | engagementSource?: |
547 | | 'FACEBOOK' |
548 | | 'INSTAGRAM' |
549 | | 'GOOGLE_ADWORDS' |
550 | | 'GOOGLE_DISPLAY_NETWORK' |
551 | | 'GOOGLE_ANALYTICS' |
552 | | 'YOUTUBE' |
553 | | 'XING' |
554 | | 'LINKED_IN' |
555 | | 'TWITTER' |
556 | | 'GOOGLE_MY_BUSINESS' |
557 | | 'TIKTOK' |
558 | | 'BITLY' |
559 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
560 | description?: string |
561 | audienceSize?: number |
562 | retentionDays?: number |
563 | } |
564 | }[] |
565 | tikTokAudiences?: { |
566 | retargetingList?: { |
567 | googleCustomerId?: string |
568 | facebookAccountId?: string |
569 | channel?: |
570 | | 'FACEBOOK' |
571 | | 'INSTAGRAM' |
572 | | 'GOOGLE_ADWORDS' |
573 | | 'GOOGLE_DISPLAY_NETWORK' |
574 | | 'GOOGLE_ANALYTICS' |
575 | | 'YOUTUBE' |
576 | | 'XING' |
577 | | 'LINKED_IN' |
578 | | 'TWITTER' |
579 | | 'GOOGLE_MY_BUSINESS' |
580 | | 'TIKTOK' |
581 | | 'BITLY' |
582 | name?: string |
583 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
584 | userId?: string |
585 | googleRetargetingListId?: string |
586 | facebookCustomAudienceId?: string |
587 | linkedInAudienceId?: string |
588 | twitterAudienceId?: string |
589 | tikTokAudienceId?: string |
590 | urlPath?: string |
591 | engagementSource?: |
592 | | 'FACEBOOK' |
593 | | 'INSTAGRAM' |
594 | | 'GOOGLE_ADWORDS' |
595 | | 'GOOGLE_DISPLAY_NETWORK' |
596 | | 'GOOGLE_ANALYTICS' |
597 | | 'YOUTUBE' |
598 | | 'XING' |
599 | | 'LINKED_IN' |
600 | | 'TWITTER' |
601 | | 'GOOGLE_MY_BUSINESS' |
602 | | 'TIKTOK' |
603 | | 'BITLY' |
604 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
605 | description?: string |
606 | audienceSize?: number |
607 | retentionDays?: number |
608 | } |
609 | }[] |
610 | } |
611 | devices?: { |
612 | showOnMobile?: false | true |
613 | showOnTablet?: false | true |
614 | showOnDesktop?: false | true |
615 | mobileBidModifier?: number |
616 | mobileBidModifierType?: 'INCREASE' | 'DECREASE' |
617 | tabletBidModifier?: number |
618 | tabletBidModifierType?: 'INCREASE' | 'DECREASE' |
619 | desktopBidModifier?: number |
620 | desktopBidModifierType?: 'INCREASE' | 'DECREASE' |
621 | } |
622 | extension?: { |
623 | sitelinkExtensions?: { |
624 | feedId?: number |
625 | feedItemId?: number |
626 | assetId?: number |
627 | adwordsCustomerId?: string |
628 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
629 | extensionRunStatus?: |
630 | | 'ADDED_CAMPAIGN' |
631 | | 'ADDED_ADGROUP' |
632 | | 'ADDED_ACCOUNT' |
633 | | 'IS_CAMPAIGN_LINKED' |
634 | | 'IS_ADGROUP_LINKED' |
635 | | 'UNLINKING' |
636 | | 'UNLINKED' |
637 | sitelinkName?: string |
638 | sitelinkUrl?: string |
639 | sitelinkDescription1?: string |
640 | sitelinkDescription2?: string |
641 | finalUrls?: string[] |
642 | finalMobileUrls?: string[] |
643 | sitelinkTrackingUrl?: string |
644 | }[] |
645 | calloutExtensions?: { |
646 | feedId?: number |
647 | feedItemId?: number |
648 | assetId?: number |
649 | adwordsCustomerId?: string |
650 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
651 | extensionRunStatus?: |
652 | | 'ADDED_CAMPAIGN' |
653 | | 'ADDED_ADGROUP' |
654 | | 'ADDED_ACCOUNT' |
655 | | 'IS_CAMPAIGN_LINKED' |
656 | | 'IS_ADGROUP_LINKED' |
657 | | 'UNLINKING' |
658 | | 'UNLINKED' |
659 | calloutText?: string |
660 | }[] |
661 | callExtensions?: { |
662 | feedId?: number |
663 | feedItemId?: number |
664 | assetId?: number |
665 | adwordsCustomerId?: string |
666 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
667 | extensionRunStatus?: |
668 | | 'ADDED_CAMPAIGN' |
669 | | 'ADDED_ADGROUP' |
670 | | 'ADDED_ACCOUNT' |
671 | | 'IS_CAMPAIGN_LINKED' |
672 | | 'IS_ADGROUP_LINKED' |
673 | | 'UNLINKING' |
674 | | 'UNLINKED' |
675 | phoneNumber?: string |
676 | country?: string |
677 | }[] |
678 | } |
679 | adRotationMode?: 'OPTIMIZE' | 'CONVERSION_OPTIMIZE' | 'ROTATE' | 'ROTATE_INDEFINITELY' |
680 | createdFromTargetingTemplateId?: string |
681 | }[] |
682 | twitterTargetingCriterias?: { |
683 | type?: 'KEYWORD' | 'FOLLOWER_LOOKALIKE' |
684 | value?: string |
685 | twitterId?: string |
686 | }[] |
687 | tikTokTargetingCriterias?: { |
688 | id?: string |
689 | name?: string |
690 | type?: |
691 | | 'INTEREST_CATEGORY' |
692 | | 'INTEREST_KEYWORD' |
693 | | 'ACTION_CATEGORY_VIDEO' |
694 | | 'ACTION_CATEGORY_CREATOR' |
695 | | 'HASHTAG' |
696 | children?: {}[] |
697 | }[] |
698 | facebookInterestGroups?: { |
699 | facebookInterests?: { |
700 | id?: string |
701 | type?: string |
702 | name?: string |
703 | audience_size?: number |
704 | children?: {}[] |
705 | path?: string[] |
706 | }[] |
707 | }[] |
708 | facebookInterests?: { |
709 | id?: string |
710 | type?: string |
711 | name?: string |
712 | audience_size?: number |
713 | children?: {}[] |
714 | path?: string[] |
715 | }[] |
716 | facebookAdGroups?: { |
717 | id?: string |
718 | name?: string |
719 | facebookInterests?: { |
720 | id?: string |
721 | type?: string |
722 | name?: string |
723 | audience_size?: number |
724 | children?: {}[] |
725 | path?: string[] |
726 | }[] |
727 | status?: |
728 | | 'IS_RUNNING' |
729 | | 'STOP' |
730 | | 'IN_REVIEW' |
731 | | 'REMOVED' |
732 | | 'COMPLETED' |
733 | | 'DISAPPROVED' |
734 | | 'IS_STOPPING' |
735 | bid?: number |
736 | retargeting?: { |
737 | googleUserLists?: { |
738 | retargetingList?: { |
739 | googleCustomerId?: string |
740 | facebookAccountId?: string |
741 | channel?: |
742 | | 'FACEBOOK' |
743 | | 'INSTAGRAM' |
744 | | 'GOOGLE_ADWORDS' |
745 | | 'GOOGLE_DISPLAY_NETWORK' |
746 | | 'GOOGLE_ANALYTICS' |
747 | | 'YOUTUBE' |
748 | | 'XING' |
749 | | 'LINKED_IN' |
750 | | 'TWITTER' |
751 | | 'GOOGLE_MY_BUSINESS' |
752 | | 'TIKTOK' |
753 | | 'BITLY' |
754 | name?: string |
755 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
756 | userId?: string |
757 | googleRetargetingListId?: string |
758 | facebookCustomAudienceId?: string |
759 | linkedInAudienceId?: string |
760 | twitterAudienceId?: string |
761 | tikTokAudienceId?: string |
762 | urlPath?: string |
763 | engagementSource?: |
764 | | 'FACEBOOK' |
765 | | 'INSTAGRAM' |
766 | | 'GOOGLE_ADWORDS' |
767 | | 'GOOGLE_DISPLAY_NETWORK' |
768 | | 'GOOGLE_ANALYTICS' |
769 | | 'YOUTUBE' |
770 | | 'XING' |
771 | | 'LINKED_IN' |
772 | | 'TWITTER' |
773 | | 'GOOGLE_MY_BUSINESS' |
774 | | 'TIKTOK' |
775 | | 'BITLY' |
776 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
777 | description?: string |
778 | audienceSize?: number |
779 | retentionDays?: number |
780 | } |
781 | bidModifier?: number |
782 | bidModifierType?: 'INCREASE' | 'DECREASE' |
783 | }[] |
784 | facebookCustomAudiences?: { |
785 | retargetingList?: { |
786 | googleCustomerId?: string |
787 | facebookAccountId?: string |
788 | channel?: |
789 | | 'FACEBOOK' |
790 | | 'INSTAGRAM' |
791 | | 'GOOGLE_ADWORDS' |
792 | | 'GOOGLE_DISPLAY_NETWORK' |
793 | | 'GOOGLE_ANALYTICS' |
794 | | 'YOUTUBE' |
795 | | 'XING' |
796 | | 'LINKED_IN' |
797 | | 'TWITTER' |
798 | | 'GOOGLE_MY_BUSINESS' |
799 | | 'TIKTOK' |
800 | | 'BITLY' |
801 | name?: string |
802 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
803 | userId?: string |
804 | googleRetargetingListId?: string |
805 | facebookCustomAudienceId?: string |
806 | linkedInAudienceId?: string |
807 | twitterAudienceId?: string |
808 | tikTokAudienceId?: string |
809 | urlPath?: string |
810 | engagementSource?: |
811 | | 'FACEBOOK' |
812 | | 'INSTAGRAM' |
813 | | 'GOOGLE_ADWORDS' |
814 | | 'GOOGLE_DISPLAY_NETWORK' |
815 | | 'GOOGLE_ANALYTICS' |
816 | | 'YOUTUBE' |
817 | | 'XING' |
818 | | 'LINKED_IN' |
819 | | 'TWITTER' |
820 | | 'GOOGLE_MY_BUSINESS' |
821 | | 'TIKTOK' |
822 | | 'BITLY' |
823 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
824 | description?: string |
825 | audienceSize?: number |
826 | retentionDays?: number |
827 | } |
828 | }[] |
829 | linkedInMatchedAudiences?: { |
830 | retargetingList?: { |
831 | googleCustomerId?: string |
832 | facebookAccountId?: string |
833 | channel?: |
834 | | 'FACEBOOK' |
835 | | 'INSTAGRAM' |
836 | | 'GOOGLE_ADWORDS' |
837 | | 'GOOGLE_DISPLAY_NETWORK' |
838 | | 'GOOGLE_ANALYTICS' |
839 | | 'YOUTUBE' |
840 | | 'XING' |
841 | | 'LINKED_IN' |
842 | | 'TWITTER' |
843 | | 'GOOGLE_MY_BUSINESS' |
844 | | 'TIKTOK' |
845 | | 'BITLY' |
846 | name?: string |
847 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
848 | userId?: string |
849 | googleRetargetingListId?: string |
850 | facebookCustomAudienceId?: string |
851 | linkedInAudienceId?: string |
852 | twitterAudienceId?: string |
853 | tikTokAudienceId?: string |
854 | urlPath?: string |
855 | engagementSource?: |
856 | | 'FACEBOOK' |
857 | | 'INSTAGRAM' |
858 | | 'GOOGLE_ADWORDS' |
859 | | 'GOOGLE_DISPLAY_NETWORK' |
860 | | 'GOOGLE_ANALYTICS' |
861 | | 'YOUTUBE' |
862 | | 'XING' |
863 | | 'LINKED_IN' |
864 | | 'TWITTER' |
865 | | 'GOOGLE_MY_BUSINESS' |
866 | | 'TIKTOK' |
867 | | 'BITLY' |
868 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
869 | description?: string |
870 | audienceSize?: number |
871 | retentionDays?: number |
872 | } |
873 | }[] |
874 | twitterCustomAudiences?: { |
875 | retargetingList?: { |
876 | googleCustomerId?: string |
877 | facebookAccountId?: string |
878 | channel?: |
879 | | 'FACEBOOK' |
880 | | 'INSTAGRAM' |
881 | | 'GOOGLE_ADWORDS' |
882 | | 'GOOGLE_DISPLAY_NETWORK' |
883 | | 'GOOGLE_ANALYTICS' |
884 | | 'YOUTUBE' |
885 | | 'XING' |
886 | | 'LINKED_IN' |
887 | | 'TWITTER' |
888 | | 'GOOGLE_MY_BUSINESS' |
889 | | 'TIKTOK' |
890 | | 'BITLY' |
891 | name?: string |
892 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
893 | userId?: string |
894 | googleRetargetingListId?: string |
895 | facebookCustomAudienceId?: string |
896 | linkedInAudienceId?: string |
897 | twitterAudienceId?: string |
898 | tikTokAudienceId?: string |
899 | urlPath?: string |
900 | engagementSource?: |
901 | | 'FACEBOOK' |
902 | | 'INSTAGRAM' |
903 | | 'GOOGLE_ADWORDS' |
904 | | 'GOOGLE_DISPLAY_NETWORK' |
905 | | 'GOOGLE_ANALYTICS' |
906 | | 'YOUTUBE' |
907 | | 'XING' |
908 | | 'LINKED_IN' |
909 | | 'TWITTER' |
910 | | 'GOOGLE_MY_BUSINESS' |
911 | | 'TIKTOK' |
912 | | 'BITLY' |
913 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
914 | description?: string |
915 | audienceSize?: number |
916 | retentionDays?: number |
917 | } |
918 | }[] |
919 | tikTokAudiences?: { |
920 | retargetingList?: { |
921 | googleCustomerId?: string |
922 | facebookAccountId?: string |
923 | channel?: |
924 | | 'FACEBOOK' |
925 | | 'INSTAGRAM' |
926 | | 'GOOGLE_ADWORDS' |
927 | | 'GOOGLE_DISPLAY_NETWORK' |
928 | | 'GOOGLE_ANALYTICS' |
929 | | 'YOUTUBE' |
930 | | 'XING' |
931 | | 'LINKED_IN' |
932 | | 'TWITTER' |
933 | | 'GOOGLE_MY_BUSINESS' |
934 | | 'TIKTOK' |
935 | | 'BITLY' |
936 | name?: string |
937 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
938 | userId?: string |
939 | googleRetargetingListId?: string |
940 | facebookCustomAudienceId?: string |
941 | linkedInAudienceId?: string |
942 | twitterAudienceId?: string |
943 | tikTokAudienceId?: string |
944 | urlPath?: string |
945 | engagementSource?: |
946 | | 'FACEBOOK' |
947 | | 'INSTAGRAM' |
948 | | 'GOOGLE_ADWORDS' |
949 | | 'GOOGLE_DISPLAY_NETWORK' |
950 | | 'GOOGLE_ANALYTICS' |
951 | | 'YOUTUBE' |
952 | | 'XING' |
953 | | 'LINKED_IN' |
954 | | 'TWITTER' |
955 | | 'GOOGLE_MY_BUSINESS' |
956 | | 'TIKTOK' |
957 | | 'BITLY' |
958 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
959 | description?: string |
960 | audienceSize?: number |
961 | retentionDays?: number |
962 | } |
963 | }[] |
964 | } |
965 | devices?: { |
966 | showOnMobile?: false | true |
967 | showOnTablet?: false | true |
968 | showOnDesktop?: false | true |
969 | mobileBidModifier?: number |
970 | mobileBidModifierType?: 'INCREASE' | 'DECREASE' |
971 | tabletBidModifier?: number |
972 | tabletBidModifierType?: 'INCREASE' | 'DECREASE' |
973 | desktopBidModifier?: number |
974 | desktopBidModifierType?: 'INCREASE' | 'DECREASE' |
975 | } |
976 | }[] |
977 | targetRegions?: { |
978 | type?: 'CITY' | 'REGION' | 'ZIP' | 'COORDINATE' |
979 | city?: string |
980 | useRadius?: false | true |
981 | radiusInKm?: number |
982 | countryCode?: string |
983 | lat?: number |
984 | lon?: number |
985 | bidModifier?: number |
986 | bidModifierType?: 'INCREASE' | 'DECREASE' |
987 | linkedInUrn?: string |
988 | twitterTargetingValue?: string |
989 | tikTokLocationId?: string |
990 | channel?: |
991 | | 'FACEBOOK' |
992 | | 'INSTAGRAM' |
993 | | 'GOOGLE_ADWORDS' |
994 | | 'GOOGLE_DISPLAY_NETWORK' |
995 | | 'GOOGLE_ANALYTICS' |
996 | | 'YOUTUBE' |
997 | | 'XING' |
998 | | 'LINKED_IN' |
999 | | 'TWITTER' |
1000 | | 'GOOGLE_MY_BUSINESS' |
1001 | | 'TIKTOK' |
1002 | | 'BITLY' |
1003 | externalPlaceId?: string |
1004 | regionReviewEnabled?: false | true |
1005 | regionReviewStatus?: 'PENDING_APPROVAL' | 'APPROVED' | 'NOT_APPROVED' |
1006 | }[] |
1007 | targetRegionBehaviour?: { |
1008 | interestedInThatRegion?: false | true |
1009 | locatedInThatRegion?: false | true |
1010 | } |
1011 | age?: { value?: number[] } |
1012 | yearsOfExperience?: { enabled?: false | true; value?: number[] } |
1013 | devices?: { |
1014 | showOnMobile?: false | true |
1015 | showOnTablet?: false | true |
1016 | showOnDesktop?: false | true |
1017 | mobileBidModifier?: number |
1018 | mobileBidModifierType?: 'INCREASE' | 'DECREASE' |
1019 | tabletBidModifier?: number |
1020 | tabletBidModifierType?: 'INCREASE' | 'DECREASE' |
1021 | desktopBidModifier?: number |
1022 | desktopBidModifierType?: 'INCREASE' | 'DECREASE' |
1023 | } |
1024 | targetExclusion?: { |
1025 | facebookInterests?: { |
1026 | id?: string |
1027 | type?: string |
1028 | name?: string |
1029 | audience_size?: number |
1030 | children?: {}[] |
1031 | path?: string[] |
1032 | }[] |
1033 | linkedInTargetingCriterias?: { |
1034 | facetUrn?: string |
1035 | urn?: string |
1036 | name?: string |
1037 | children?: {}[] |
1038 | parentUrn?: string |
1039 | }[] |
1040 | googleKeywords?: { |
1041 | name?: string |
1042 | competition?: 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN' |
1043 | averageMonghtlySearchVolume?: number |
1044 | averageCpc?: number |
1045 | cpc?: number |
1046 | cpm?: number |
1047 | link?: string |
1048 | status?: |
1049 | | 'IS_RUNNING' |
1050 | | 'STOP' |
1051 | | 'IN_REVIEW' |
1052 | | 'REMOVED' |
1053 | | 'COMPLETED' |
1054 | | 'DISAPPROVED' |
1055 | | 'IS_STOPPING' |
1056 | bid?: number |
1057 | finalUrl?: string |
1058 | averageImpressionsPerMonth?: number |
1059 | }[] |
1060 | targetRegions?: { |
1061 | type?: 'CITY' | 'REGION' | 'ZIP' | 'COORDINATE' |
1062 | city?: string |
1063 | useRadius?: false | true |
1064 | radiusInKm?: number |
1065 | countryCode?: string |
1066 | lat?: number |
1067 | lon?: number |
1068 | bidModifier?: number |
1069 | bidModifierType?: 'INCREASE' | 'DECREASE' |
1070 | linkedInUrn?: string |
1071 | twitterTargetingValue?: string |
1072 | tikTokLocationId?: string |
1073 | channel?: |
1074 | | 'FACEBOOK' |
1075 | | 'INSTAGRAM' |
1076 | | 'GOOGLE_ADWORDS' |
1077 | | 'GOOGLE_DISPLAY_NETWORK' |
1078 | | 'GOOGLE_ANALYTICS' |
1079 | | 'YOUTUBE' |
1080 | | 'XING' |
1081 | | 'LINKED_IN' |
1082 | | 'TWITTER' |
1083 | | 'GOOGLE_MY_BUSINESS' |
1084 | | 'TIKTOK' |
1085 | | 'BITLY' |
1086 | externalPlaceId?: string |
1087 | regionReviewEnabled?: false | true |
1088 | regionReviewStatus?: 'PENDING_APPROVAL' | 'APPROVED' | 'NOT_APPROVED' |
1089 | }[] |
1090 | retargeting?: { |
1091 | googleUserLists?: { |
1092 | retargetingList?: { |
1093 | googleCustomerId?: string |
1094 | facebookAccountId?: string |
1095 | channel?: |
1096 | | 'FACEBOOK' |
1097 | | 'INSTAGRAM' |
1098 | | 'GOOGLE_ADWORDS' |
1099 | | 'GOOGLE_DISPLAY_NETWORK' |
1100 | | 'GOOGLE_ANALYTICS' |
1101 | | 'YOUTUBE' |
1102 | | 'XING' |
1103 | | 'LINKED_IN' |
1104 | | 'TWITTER' |
1105 | | 'GOOGLE_MY_BUSINESS' |
1106 | | 'TIKTOK' |
1107 | | 'BITLY' |
1108 | name?: string |
1109 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1110 | userId?: string |
1111 | googleRetargetingListId?: string |
1112 | facebookCustomAudienceId?: string |
1113 | linkedInAudienceId?: string |
1114 | twitterAudienceId?: string |
1115 | tikTokAudienceId?: string |
1116 | urlPath?: string |
1117 | engagementSource?: |
1118 | | 'FACEBOOK' |
1119 | | 'INSTAGRAM' |
1120 | | 'GOOGLE_ADWORDS' |
1121 | | 'GOOGLE_DISPLAY_NETWORK' |
1122 | | 'GOOGLE_ANALYTICS' |
1123 | | 'YOUTUBE' |
1124 | | 'XING' |
1125 | | 'LINKED_IN' |
1126 | | 'TWITTER' |
1127 | | 'GOOGLE_MY_BUSINESS' |
1128 | | 'TIKTOK' |
1129 | | 'BITLY' |
1130 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1131 | description?: string |
1132 | audienceSize?: number |
1133 | retentionDays?: number |
1134 | } |
1135 | bidModifier?: number |
1136 | bidModifierType?: 'INCREASE' | 'DECREASE' |
1137 | }[] |
1138 | facebookCustomAudiences?: { |
1139 | retargetingList?: { |
1140 | googleCustomerId?: string |
1141 | facebookAccountId?: string |
1142 | channel?: |
1143 | | 'FACEBOOK' |
1144 | | 'INSTAGRAM' |
1145 | | 'GOOGLE_ADWORDS' |
1146 | | 'GOOGLE_DISPLAY_NETWORK' |
1147 | | 'GOOGLE_ANALYTICS' |
1148 | | 'YOUTUBE' |
1149 | | 'XING' |
1150 | | 'LINKED_IN' |
1151 | | 'TWITTER' |
1152 | | 'GOOGLE_MY_BUSINESS' |
1153 | | 'TIKTOK' |
1154 | | 'BITLY' |
1155 | name?: string |
1156 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1157 | userId?: string |
1158 | googleRetargetingListId?: string |
1159 | facebookCustomAudienceId?: string |
1160 | linkedInAudienceId?: string |
1161 | twitterAudienceId?: string |
1162 | tikTokAudienceId?: string |
1163 | urlPath?: string |
1164 | engagementSource?: |
1165 | | 'FACEBOOK' |
1166 | | 'INSTAGRAM' |
1167 | | 'GOOGLE_ADWORDS' |
1168 | | 'GOOGLE_DISPLAY_NETWORK' |
1169 | | 'GOOGLE_ANALYTICS' |
1170 | | 'YOUTUBE' |
1171 | | 'XING' |
1172 | | 'LINKED_IN' |
1173 | | 'TWITTER' |
1174 | | 'GOOGLE_MY_BUSINESS' |
1175 | | 'TIKTOK' |
1176 | | 'BITLY' |
1177 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1178 | description?: string |
1179 | audienceSize?: number |
1180 | retentionDays?: number |
1181 | } |
1182 | }[] |
1183 | linkedInMatchedAudiences?: { |
1184 | retargetingList?: { |
1185 | googleCustomerId?: string |
1186 | facebookAccountId?: string |
1187 | channel?: |
1188 | | 'FACEBOOK' |
1189 | | 'INSTAGRAM' |
1190 | | 'GOOGLE_ADWORDS' |
1191 | | 'GOOGLE_DISPLAY_NETWORK' |
1192 | | 'GOOGLE_ANALYTICS' |
1193 | | 'YOUTUBE' |
1194 | | 'XING' |
1195 | | 'LINKED_IN' |
1196 | | 'TWITTER' |
1197 | | 'GOOGLE_MY_BUSINESS' |
1198 | | 'TIKTOK' |
1199 | | 'BITLY' |
1200 | name?: string |
1201 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1202 | userId?: string |
1203 | googleRetargetingListId?: string |
1204 | facebookCustomAudienceId?: string |
1205 | linkedInAudienceId?: string |
1206 | twitterAudienceId?: string |
1207 | tikTokAudienceId?: string |
1208 | urlPath?: string |
1209 | engagementSource?: |
1210 | | 'FACEBOOK' |
1211 | | 'INSTAGRAM' |
1212 | | 'GOOGLE_ADWORDS' |
1213 | | 'GOOGLE_DISPLAY_NETWORK' |
1214 | | 'GOOGLE_ANALYTICS' |
1215 | | 'YOUTUBE' |
1216 | | 'XING' |
1217 | | 'LINKED_IN' |
1218 | | 'TWITTER' |
1219 | | 'GOOGLE_MY_BUSINESS' |
1220 | | 'TIKTOK' |
1221 | | 'BITLY' |
1222 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1223 | description?: string |
1224 | audienceSize?: number |
1225 | retentionDays?: number |
1226 | } |
1227 | }[] |
1228 | twitterCustomAudiences?: { |
1229 | retargetingList?: { |
1230 | googleCustomerId?: string |
1231 | facebookAccountId?: string |
1232 | channel?: |
1233 | | 'FACEBOOK' |
1234 | | 'INSTAGRAM' |
1235 | | 'GOOGLE_ADWORDS' |
1236 | | 'GOOGLE_DISPLAY_NETWORK' |
1237 | | 'GOOGLE_ANALYTICS' |
1238 | | 'YOUTUBE' |
1239 | | 'XING' |
1240 | | 'LINKED_IN' |
1241 | | 'TWITTER' |
1242 | | 'GOOGLE_MY_BUSINESS' |
1243 | | 'TIKTOK' |
1244 | | 'BITLY' |
1245 | name?: string |
1246 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1247 | userId?: string |
1248 | googleRetargetingListId?: string |
1249 | facebookCustomAudienceId?: string |
1250 | linkedInAudienceId?: string |
1251 | twitterAudienceId?: string |
1252 | tikTokAudienceId?: string |
1253 | urlPath?: string |
1254 | engagementSource?: |
1255 | | 'FACEBOOK' |
1256 | | 'INSTAGRAM' |
1257 | | 'GOOGLE_ADWORDS' |
1258 | | 'GOOGLE_DISPLAY_NETWORK' |
1259 | | 'GOOGLE_ANALYTICS' |
1260 | | 'YOUTUBE' |
1261 | | 'XING' |
1262 | | 'LINKED_IN' |
1263 | | 'TWITTER' |
1264 | | 'GOOGLE_MY_BUSINESS' |
1265 | | 'TIKTOK' |
1266 | | 'BITLY' |
1267 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1268 | description?: string |
1269 | audienceSize?: number |
1270 | retentionDays?: number |
1271 | } |
1272 | }[] |
1273 | tikTokAudiences?: { |
1274 | retargetingList?: { |
1275 | googleCustomerId?: string |
1276 | facebookAccountId?: string |
1277 | channel?: |
1278 | | 'FACEBOOK' |
1279 | | 'INSTAGRAM' |
1280 | | 'GOOGLE_ADWORDS' |
1281 | | 'GOOGLE_DISPLAY_NETWORK' |
1282 | | 'GOOGLE_ANALYTICS' |
1283 | | 'YOUTUBE' |
1284 | | 'XING' |
1285 | | 'LINKED_IN' |
1286 | | 'TWITTER' |
1287 | | 'GOOGLE_MY_BUSINESS' |
1288 | | 'TIKTOK' |
1289 | | 'BITLY' |
1290 | name?: string |
1291 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1292 | userId?: string |
1293 | googleRetargetingListId?: string |
1294 | facebookCustomAudienceId?: string |
1295 | linkedInAudienceId?: string |
1296 | twitterAudienceId?: string |
1297 | tikTokAudienceId?: string |
1298 | urlPath?: string |
1299 | engagementSource?: |
1300 | | 'FACEBOOK' |
1301 | | 'INSTAGRAM' |
1302 | | 'GOOGLE_ADWORDS' |
1303 | | 'GOOGLE_DISPLAY_NETWORK' |
1304 | | 'GOOGLE_ANALYTICS' |
1305 | | 'YOUTUBE' |
1306 | | 'XING' |
1307 | | 'LINKED_IN' |
1308 | | 'TWITTER' |
1309 | | 'GOOGLE_MY_BUSINESS' |
1310 | | 'TIKTOK' |
1311 | | 'BITLY' |
1312 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1313 | description?: string |
1314 | audienceSize?: number |
1315 | retentionDays?: number |
1316 | } |
1317 | }[] |
1318 | } |
1319 | linkedInTargetingEntityLinkOperator?: 'AND' | 'OR' |
1320 | twitterTargetingCriterias?: { |
1321 | type?: 'KEYWORD' | 'FOLLOWER_LOOKALIKE' |
1322 | value?: string |
1323 | twitterId?: string |
1324 | }[] |
1325 | } |
1326 | retargeting?: { |
1327 | googleUserLists?: { |
1328 | retargetingList?: { |
1329 | googleCustomerId?: string |
1330 | facebookAccountId?: string |
1331 | channel?: |
1332 | | 'FACEBOOK' |
1333 | | 'INSTAGRAM' |
1334 | | 'GOOGLE_ADWORDS' |
1335 | | 'GOOGLE_DISPLAY_NETWORK' |
1336 | | 'GOOGLE_ANALYTICS' |
1337 | | 'YOUTUBE' |
1338 | | 'XING' |
1339 | | 'LINKED_IN' |
1340 | | 'TWITTER' |
1341 | | 'GOOGLE_MY_BUSINESS' |
1342 | | 'TIKTOK' |
1343 | | 'BITLY' |
1344 | name?: string |
1345 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1346 | userId?: string |
1347 | googleRetargetingListId?: string |
1348 | facebookCustomAudienceId?: string |
1349 | linkedInAudienceId?: string |
1350 | twitterAudienceId?: string |
1351 | tikTokAudienceId?: string |
1352 | urlPath?: string |
1353 | engagementSource?: |
1354 | | 'FACEBOOK' |
1355 | | 'INSTAGRAM' |
1356 | | 'GOOGLE_ADWORDS' |
1357 | | 'GOOGLE_DISPLAY_NETWORK' |
1358 | | 'GOOGLE_ANALYTICS' |
1359 | | 'YOUTUBE' |
1360 | | 'XING' |
1361 | | 'LINKED_IN' |
1362 | | 'TWITTER' |
1363 | | 'GOOGLE_MY_BUSINESS' |
1364 | | 'TIKTOK' |
1365 | | 'BITLY' |
1366 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1367 | description?: string |
1368 | audienceSize?: number |
1369 | retentionDays?: number |
1370 | } |
1371 | bidModifier?: number |
1372 | bidModifierType?: 'INCREASE' | 'DECREASE' |
1373 | }[] |
1374 | facebookCustomAudiences?: { |
1375 | retargetingList?: { |
1376 | googleCustomerId?: string |
1377 | facebookAccountId?: string |
1378 | channel?: |
1379 | | 'FACEBOOK' |
1380 | | 'INSTAGRAM' |
1381 | | 'GOOGLE_ADWORDS' |
1382 | | 'GOOGLE_DISPLAY_NETWORK' |
1383 | | 'GOOGLE_ANALYTICS' |
1384 | | 'YOUTUBE' |
1385 | | 'XING' |
1386 | | 'LINKED_IN' |
1387 | | 'TWITTER' |
1388 | | 'GOOGLE_MY_BUSINESS' |
1389 | | 'TIKTOK' |
1390 | | 'BITLY' |
1391 | name?: string |
1392 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1393 | userId?: string |
1394 | googleRetargetingListId?: string |
1395 | facebookCustomAudienceId?: string |
1396 | linkedInAudienceId?: string |
1397 | twitterAudienceId?: string |
1398 | tikTokAudienceId?: string |
1399 | urlPath?: string |
1400 | engagementSource?: |
1401 | | 'FACEBOOK' |
1402 | | 'INSTAGRAM' |
1403 | | 'GOOGLE_ADWORDS' |
1404 | | 'GOOGLE_DISPLAY_NETWORK' |
1405 | | 'GOOGLE_ANALYTICS' |
1406 | | 'YOUTUBE' |
1407 | | 'XING' |
1408 | | 'LINKED_IN' |
1409 | | 'TWITTER' |
1410 | | 'GOOGLE_MY_BUSINESS' |
1411 | | 'TIKTOK' |
1412 | | 'BITLY' |
1413 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1414 | description?: string |
1415 | audienceSize?: number |
1416 | retentionDays?: number |
1417 | } |
1418 | }[] |
1419 | linkedInMatchedAudiences?: { |
1420 | retargetingList?: { |
1421 | googleCustomerId?: string |
1422 | facebookAccountId?: string |
1423 | channel?: |
1424 | | 'FACEBOOK' |
1425 | | 'INSTAGRAM' |
1426 | | 'GOOGLE_ADWORDS' |
1427 | | 'GOOGLE_DISPLAY_NETWORK' |
1428 | | 'GOOGLE_ANALYTICS' |
1429 | | 'YOUTUBE' |
1430 | | 'XING' |
1431 | | 'LINKED_IN' |
1432 | | 'TWITTER' |
1433 | | 'GOOGLE_MY_BUSINESS' |
1434 | | 'TIKTOK' |
1435 | | 'BITLY' |
1436 | name?: string |
1437 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1438 | userId?: string |
1439 | googleRetargetingListId?: string |
1440 | facebookCustomAudienceId?: string |
1441 | linkedInAudienceId?: string |
1442 | twitterAudienceId?: string |
1443 | tikTokAudienceId?: string |
1444 | urlPath?: string |
1445 | engagementSource?: |
1446 | | 'FACEBOOK' |
1447 | | 'INSTAGRAM' |
1448 | | 'GOOGLE_ADWORDS' |
1449 | | 'GOOGLE_DISPLAY_NETWORK' |
1450 | | 'GOOGLE_ANALYTICS' |
1451 | | 'YOUTUBE' |
1452 | | 'XING' |
1453 | | 'LINKED_IN' |
1454 | | 'TWITTER' |
1455 | | 'GOOGLE_MY_BUSINESS' |
1456 | | 'TIKTOK' |
1457 | | 'BITLY' |
1458 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1459 | description?: string |
1460 | audienceSize?: number |
1461 | retentionDays?: number |
1462 | } |
1463 | }[] |
1464 | twitterCustomAudiences?: { |
1465 | retargetingList?: { |
1466 | googleCustomerId?: string |
1467 | facebookAccountId?: string |
1468 | channel?: |
1469 | | 'FACEBOOK' |
1470 | | 'INSTAGRAM' |
1471 | | 'GOOGLE_ADWORDS' |
1472 | | 'GOOGLE_DISPLAY_NETWORK' |
1473 | | 'GOOGLE_ANALYTICS' |
1474 | | 'YOUTUBE' |
1475 | | 'XING' |
1476 | | 'LINKED_IN' |
1477 | | 'TWITTER' |
1478 | | 'GOOGLE_MY_BUSINESS' |
1479 | | 'TIKTOK' |
1480 | | 'BITLY' |
1481 | name?: string |
1482 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1483 | userId?: string |
1484 | googleRetargetingListId?: string |
1485 | facebookCustomAudienceId?: string |
1486 | linkedInAudienceId?: string |
1487 | twitterAudienceId?: string |
1488 | tikTokAudienceId?: string |
1489 | urlPath?: string |
1490 | engagementSource?: |
1491 | | 'FACEBOOK' |
1492 | | 'INSTAGRAM' |
1493 | | 'GOOGLE_ADWORDS' |
1494 | | 'GOOGLE_DISPLAY_NETWORK' |
1495 | | 'GOOGLE_ANALYTICS' |
1496 | | 'YOUTUBE' |
1497 | | 'XING' |
1498 | | 'LINKED_IN' |
1499 | | 'TWITTER' |
1500 | | 'GOOGLE_MY_BUSINESS' |
1501 | | 'TIKTOK' |
1502 | | 'BITLY' |
1503 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1504 | description?: string |
1505 | audienceSize?: number |
1506 | retentionDays?: number |
1507 | } |
1508 | }[] |
1509 | tikTokAudiences?: { |
1510 | retargetingList?: { |
1511 | googleCustomerId?: string |
1512 | facebookAccountId?: string |
1513 | channel?: |
1514 | | 'FACEBOOK' |
1515 | | 'INSTAGRAM' |
1516 | | 'GOOGLE_ADWORDS' |
1517 | | 'GOOGLE_DISPLAY_NETWORK' |
1518 | | 'GOOGLE_ANALYTICS' |
1519 | | 'YOUTUBE' |
1520 | | 'XING' |
1521 | | 'LINKED_IN' |
1522 | | 'TWITTER' |
1523 | | 'GOOGLE_MY_BUSINESS' |
1524 | | 'TIKTOK' |
1525 | | 'BITLY' |
1526 | name?: string |
1527 | status?: 'OPEN' | 'NOT_ENOUGH_USERS' | 'CLOSED' |
1528 | userId?: string |
1529 | googleRetargetingListId?: string |
1530 | facebookCustomAudienceId?: string |
1531 | linkedInAudienceId?: string |
1532 | twitterAudienceId?: string |
1533 | tikTokAudienceId?: string |
1534 | urlPath?: string |
1535 | engagementSource?: |
1536 | | 'FACEBOOK' |
1537 | | 'INSTAGRAM' |
1538 | | 'GOOGLE_ADWORDS' |
1539 | | 'GOOGLE_DISPLAY_NETWORK' |
1540 | | 'GOOGLE_ANALYTICS' |
1541 | | 'YOUTUBE' |
1542 | | 'XING' |
1543 | | 'LINKED_IN' |
1544 | | 'TWITTER' |
1545 | | 'GOOGLE_MY_BUSINESS' |
1546 | | 'TIKTOK' |
1547 | | 'BITLY' |
1548 | engagementType?: 'ENGAGED' | 'FOLLOWER' |
1549 | description?: string |
1550 | audienceSize?: number |
1551 | retentionDays?: number |
1552 | } |
1553 | }[] |
1554 | } |
1555 | shoppingSettings?: { |
1556 | googleMerchantAccount?: { merchantAccountId?: string; name?: string } |
1557 | salesCountry?: string |
1558 | enableLocal?: false | true |
1559 | googleShoppingCampaignType?: 'CLASSIC' | 'SMART' |
1560 | productScopeType?: 'NONE' | 'FILTER' |
1561 | productScopes?: { |
1562 | productDimension?: |
1563 | | 'BRAND' |
1564 | | 'PRODUCT_NR' |
1565 | | 'STATE' |
1566 | | 'PRODUCT_TYPE' |
1567 | | 'CUSTOM_LABEL_0' |
1568 | | 'CUSTOM_LABEL_1' |
1569 | | 'CUSTOM_LABEL_2' |
1570 | | 'CUSTOM_LABEL_3' |
1571 | | 'CUSTOM_LABEL_4' |
1572 | | 'CHANNEL' |
1573 | | 'CHANNEL_EXCLUSIVE' |
1574 | value?: string |
1575 | }[] |
1576 | facebookProductCatalog?: { |
1577 | id?: string |
1578 | name?: string |
1579 | nbrOfProducts?: number |
1580 | nbrOfQualifiedProducts?: number |
1581 | } |
1582 | facebookDynamicAdsTargetingType?: 'RETARGETING' | 'BROAD' |
1583 | facebookProductSet?: { |
1584 | id?: string |
1585 | name?: string |
1586 | nbrOfProducts?: number |
1587 | } |
1588 | facebookRetargetingIncludedRetentionDays?: number |
1589 | facebookRetargetingExcludedRetentionDays?: number |
1590 | } |
1591 | dynamicSearchSettings?: { domainName?: string; languageCode?: string } |
1592 | extension?: { |
1593 | sitelinkExtensions?: { |
1594 | feedId?: number |
1595 | feedItemId?: number |
1596 | assetId?: number |
1597 | adwordsCustomerId?: string |
1598 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
1599 | extensionRunStatus?: |
1600 | | 'ADDED_CAMPAIGN' |
1601 | | 'ADDED_ADGROUP' |
1602 | | 'ADDED_ACCOUNT' |
1603 | | 'IS_CAMPAIGN_LINKED' |
1604 | | 'IS_ADGROUP_LINKED' |
1605 | | 'UNLINKING' |
1606 | | 'UNLINKED' |
1607 | sitelinkName?: string |
1608 | sitelinkUrl?: string |
1609 | sitelinkDescription1?: string |
1610 | sitelinkDescription2?: string |
1611 | finalUrls?: string[] |
1612 | finalMobileUrls?: string[] |
1613 | sitelinkTrackingUrl?: string |
1614 | }[] |
1615 | calloutExtensions?: { |
1616 | feedId?: number |
1617 | feedItemId?: number |
1618 | assetId?: number |
1619 | adwordsCustomerId?: string |
1620 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
1621 | extensionRunStatus?: |
1622 | | 'ADDED_CAMPAIGN' |
1623 | | 'ADDED_ADGROUP' |
1624 | | 'ADDED_ACCOUNT' |
1625 | | 'IS_CAMPAIGN_LINKED' |
1626 | | 'IS_ADGROUP_LINKED' |
1627 | | 'UNLINKING' |
1628 | | 'UNLINKED' |
1629 | calloutText?: string |
1630 | }[] |
1631 | callExtensions?: { |
1632 | feedId?: number |
1633 | feedItemId?: number |
1634 | assetId?: number |
1635 | adwordsCustomerId?: string |
1636 | extensionStatus?: 'ACCOUNT' | 'CAMPAIGN' | 'ADGROUP' | 'NONE' |
1637 | extensionRunStatus?: |
1638 | | 'ADDED_CAMPAIGN' |
1639 | | 'ADDED_ADGROUP' |
1640 | | 'ADDED_ACCOUNT' |
1641 | | 'IS_CAMPAIGN_LINKED' |
1642 | | 'IS_ADGROUP_LINKED' |
1643 | | 'UNLINKING' |
1644 | | 'UNLINKED' |
1645 | phoneNumber?: string |
1646 | country?: string |
1647 | }[] |
1648 | } |
1649 | status?: |
1650 | | 'IS_RUNNING' |
1651 | | 'STOP' |
1652 | | 'IN_REVIEW' |
1653 | | 'REMOVED' |
1654 | | 'COMPLETED' |
1655 | | 'DISAPPROVED' |
1656 | | 'IS_STOPPING' |
1657 | createdFromTargetingTemplateId?: string |
1658 | facebookSpecialAdCategory?: |
1659 | | 'NONE' |
1660 | | 'CREDIT' |
1661 | | 'EMPLOYMENT' |
1662 | | 'HOUSING' |
1663 | | 'ISSUES_ELECTIONS_POLITICS' |
1664 | | 'ONLINE_GAMBLING_AND_GAMING' |
1665 | facebookSpecialAdCategoryCountry?: string |
1666 | } |
1667 | budgetChannel?: { |
1668 | channel?: |
1669 | | 'FACEBOOK' |
1670 | | 'INSTAGRAM' |
1671 | | 'GOOGLE_ADWORDS' |
1672 | | 'GOOGLE_DISPLAY_NETWORK' |
1673 | | 'GOOGLE_ANALYTICS' |
1674 | | 'YOUTUBE' |
1675 | | 'XING' |
1676 | | 'LINKED_IN' |
1677 | | 'TWITTER' |
1678 | | 'GOOGLE_MY_BUSINESS' |
1679 | | 'TIKTOK' |
1680 | | 'BITLY' |
1681 | placement?: |
1682 | | 'GOOGLE_DISPLAY_NETWORK' |
1683 | | 'YOUTUBE' |
1684 | | 'GOOGLE_MY_BUSINESS' |
1685 | | 'GOOGLE_SEARCH_NETWORK' |
1686 | | 'FACEBOOK_TIMELINE' |
1687 | | 'FACEBOOK_AUDIENCE_NETWORK' |
1688 | | 'INSTAGRAM_TIMELINE' |
1689 | | 'GOOGLE_SHOPPING' |
1690 | | 'FACEBOOK_MESSENGER' |
1691 | | 'LINKEDIN_CONTENT' |
1692 | | 'LINKEDIN_TEXT' |
1693 | | 'LINKEDIN_INMAIL' |
1694 | | 'LINKEDIN_DYNAMIC' |
1695 | | 'FACEBOOK_STORIES' |
1696 | | 'FACEBOOK_INSTANT_ARTICLES' |
1697 | | 'FACEBOOK_RIGHT_HAND_COLUMN' |
1698 | | 'FACEBOOK_MARKETPLACE' |
1699 | | 'INSTAGRAM_STORIES' |
1700 | | 'FACEBOOK_MESSENGER_STORIES' |
1701 | | 'FACEBOOK_SEARCH' |
1702 | | 'FACEBOOK_INSTREAM_VIDEO' |
1703 | | 'FACEBOOK_REELS' |
1704 | | 'INSTAGRAM_EXPLORE_HOME' |
1705 | | 'INSTAGRAM_PROFILE_FEED' |
1706 | | 'INSTAGRAM_PROFILE_REELS' |
1707 | | 'LINKEDIN_AUDIENCE_NETWORK' |
1708 | | 'TWITTER_ALL' |
1709 | | 'TWITTER_PUBLISHER_NETWORK' |
1710 | | 'TWITTER_SEARCH' |
1711 | | 'TWITTER_TIMELINE' |
1712 | | 'TWITTER_PROFILE' |
1713 | | 'FACEBOOK_UNKNOWN' |
1714 | | 'FACEBOOK_VIDEO_FEED' |
1715 | | 'INSTAGRAM_REELS' |
1716 | | 'INSTAGRAM_SHOP' |
1717 | | 'INSTAGRAM_EXPLORE' |
1718 | | 'TIKTOK_FEED' |
1719 | | 'META_AUTOMATIC' |
1720 | selected?: false | true |
1721 | totalCost?: number |
1722 | bid?: number |
1723 | maxBid?: number |
1724 | costType?: 'CPC' | 'CPM' |
1725 | bidType?: 'AUTOMATIC' | 'MANUAL' |
1726 | linkedInBiddingOptimization?: |
1727 | | 'MAXIMIZE_CLICKS' |
1728 | | 'MAXIMIZE_IMPRESSIONS' |
1729 | | 'MAXIMIZE_CONVERSIONS' |
1730 | | 'MAXIMIZE_LEADS' |
1731 | linkedInDailyBudget?: number |
1732 | facebookBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'ADSET_BUDGET_OPTIMIZATION' |
1733 | facebookTrafficOptimization?: 'LINK_CLICKS' | 'LANDING_PAGE_VIEWS' |
1734 | twitterBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'AD_GROUP_BUDGET_OPTIMIZATION' |
1735 | tikTokBudgetOptimization?: 'CAMPAIGN_BUDGET_OPTIMIZATION' | 'AD_GROUP_BUDGET_OPTIMIZATION' |
1736 | targetBudgets?: { |
1737 | targetId?: string |
1738 | budget?: number |
1739 | linkedInDailyBudget?: number |
1740 | metaBudgetSplit?: { |
1741 | facebookBudget?: number |
1742 | instagramBudget?: number |
1743 | storyBudget?: number |
1744 | reelsBudget?: number |
1745 | } |
1746 | }[] |
1747 | } |
1748 | lifetimeBudget?: number |
1749 | nbrOfDays?: number |
1750 | currency?: string |
1751 | costType?: 'CPC' | 'CPM' |
1752 | } |
1753 | ) { |
1754 | const url = new URL(`https://app.adhook.io/v1/promotions/linkedin/suggestedBids`) |
1755 |
|
1756 | const response = await fetch(url, { |
1757 | method: 'POST', |
1758 | headers: { |
1759 | adhookToken: adhookToken, |
1760 | Authorization: `Bearer ${auth.token}`, |
1761 | 'Content-Type': 'application/json' |
1762 | }, |
1763 | body: JSON.stringify(body) |
1764 | }) |
1765 |
|
1766 | if (!response.ok) { |
1767 | const text = await response.text() |
1768 | throw new Error(`${response.status} ${text}`) |
1769 | } |
1770 |
|
1771 | return await response.json() |
1772 | } |
1773 |
|