@apteva/integrations 0.15.6 → 0.15.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -77,7 +77,10 @@
77
77
  "input_schema": {
78
78
  "type": "object",
79
79
  "properties": {
80
- "UserId": { "type": "integer", "default": 0 }
80
+ "UserId": {
81
+ "type": "integer",
82
+ "default": 0
83
+ }
81
84
  }
82
85
  }
83
86
  },
@@ -91,15 +94,24 @@
91
94
  "properties": {
92
95
  "Predicates": {
93
96
  "type": "array",
94
- "items": { "type": "object" },
97
+ "items": {
98
+ "type": "object"
99
+ },
95
100
  "description": "Array of {Field, Operator, Value} predicates"
96
101
  },
97
- "Ordering": { "type": "array", "items": { "type": "object" } },
102
+ "Ordering": {
103
+ "type": "array",
104
+ "items": {
105
+ "type": "object"
106
+ }
107
+ },
98
108
  "PageInfo": {
99
109
  "type": "object",
100
110
  "description": "{\"Index\": 0, \"Size\": 100}"
101
111
  },
102
- "ReturnAdditionalFields": { "type": "string" }
112
+ "ReturnAdditionalFields": {
113
+ "type": "string"
114
+ }
103
115
  }
104
116
  }
105
117
  },
@@ -111,15 +123,21 @@
111
123
  "input_schema": {
112
124
  "type": "object",
113
125
  "properties": {
114
- "AccountId": { "type": "integer" },
126
+ "AccountId": {
127
+ "type": "integer"
128
+ },
115
129
  "CampaignType": {
116
130
  "type": "string",
117
131
  "default": "Search Shopping DynamicSearchAds Audience",
118
132
  "description": "Space-separated flags"
119
133
  },
120
- "ReturnAdditionalFields": { "type": "string" }
134
+ "ReturnAdditionalFields": {
135
+ "type": "string"
136
+ }
121
137
  },
122
- "required": ["AccountId"]
138
+ "required": [
139
+ "AccountId"
140
+ ]
123
141
  }
124
142
  },
125
143
  {
@@ -130,14 +148,21 @@
130
148
  "input_schema": {
131
149
  "type": "object",
132
150
  "properties": {
133
- "AccountId": { "type": "integer" },
151
+ "AccountId": {
152
+ "type": "integer"
153
+ },
134
154
  "Campaigns": {
135
155
  "type": "array",
136
- "items": { "type": "object" },
156
+ "items": {
157
+ "type": "object"
158
+ },
137
159
  "description": "Array of Campaign objects"
138
160
  }
139
161
  },
140
- "required": ["AccountId", "Campaigns"]
162
+ "required": [
163
+ "AccountId",
164
+ "Campaigns"
165
+ ]
141
166
  }
142
167
  },
143
168
  {
@@ -148,10 +173,20 @@
148
173
  "input_schema": {
149
174
  "type": "object",
150
175
  "properties": {
151
- "AccountId": { "type": "integer" },
152
- "Campaigns": { "type": "array", "items": { "type": "object" } }
176
+ "AccountId": {
177
+ "type": "integer"
178
+ },
179
+ "Campaigns": {
180
+ "type": "array",
181
+ "items": {
182
+ "type": "object"
183
+ }
184
+ }
153
185
  },
154
- "required": ["AccountId", "Campaigns"]
186
+ "required": [
187
+ "AccountId",
188
+ "Campaigns"
189
+ ]
155
190
  }
156
191
  },
157
192
  {
@@ -162,10 +197,16 @@
162
197
  "input_schema": {
163
198
  "type": "object",
164
199
  "properties": {
165
- "CampaignId": { "type": "integer" },
166
- "ReturnAdditionalFields": { "type": "string" }
200
+ "CampaignId": {
201
+ "type": "integer"
202
+ },
203
+ "ReturnAdditionalFields": {
204
+ "type": "string"
205
+ }
167
206
  },
168
- "required": ["CampaignId"]
207
+ "required": [
208
+ "CampaignId"
209
+ ]
169
210
  }
170
211
  },
171
212
  {
@@ -176,10 +217,20 @@
176
217
  "input_schema": {
177
218
  "type": "object",
178
219
  "properties": {
179
- "CampaignId": { "type": "integer" },
180
- "AdGroups": { "type": "array", "items": { "type": "object" } }
220
+ "CampaignId": {
221
+ "type": "integer"
222
+ },
223
+ "AdGroups": {
224
+ "type": "array",
225
+ "items": {
226
+ "type": "object"
227
+ }
228
+ }
181
229
  },
182
- "required": ["CampaignId", "AdGroups"]
230
+ "required": [
231
+ "CampaignId",
232
+ "AdGroups"
233
+ ]
183
234
  }
184
235
  },
185
236
  {
@@ -190,13 +241,17 @@
190
241
  "input_schema": {
191
242
  "type": "object",
192
243
  "properties": {
193
- "AdGroupId": { "type": "integer" },
244
+ "AdGroupId": {
245
+ "type": "integer"
246
+ },
194
247
  "AdTypes": {
195
248
  "type": "string",
196
249
  "default": "ResponsiveSearch ResponsiveAd Text ExpandedText"
197
250
  }
198
251
  },
199
- "required": ["AdGroupId"]
252
+ "required": [
253
+ "AdGroupId"
254
+ ]
200
255
  }
201
256
  },
202
257
  {
@@ -207,10 +262,20 @@
207
262
  "input_schema": {
208
263
  "type": "object",
209
264
  "properties": {
210
- "AdGroupId": { "type": "integer" },
211
- "Keywords": { "type": "array", "items": { "type": "object" } }
265
+ "AdGroupId": {
266
+ "type": "integer"
267
+ },
268
+ "Keywords": {
269
+ "type": "array",
270
+ "items": {
271
+ "type": "object"
272
+ }
273
+ }
212
274
  },
213
- "required": ["AdGroupId", "Keywords"]
275
+ "required": [
276
+ "AdGroupId",
277
+ "Keywords"
278
+ ]
214
279
  }
215
280
  },
216
281
  {
@@ -226,7 +291,9 @@
226
291
  "description": "Typed report request with @odata.type field, e.g. \"#Microsoft.Advertising.Reporting.Api.CampaignPerformanceReportRequest\""
227
292
  }
228
293
  },
229
- "required": ["ReportRequest"]
294
+ "required": [
295
+ "ReportRequest"
296
+ ]
230
297
  }
231
298
  },
232
299
  {
@@ -237,9 +304,396 @@
237
304
  "input_schema": {
238
305
  "type": "object",
239
306
  "properties": {
240
- "ReportRequestId": { "type": "string" }
307
+ "ReportRequestId": {
308
+ "type": "string"
309
+ }
310
+ },
311
+ "required": [
312
+ "ReportRequestId"
313
+ ]
314
+ }
315
+ },
316
+ {
317
+ "name": "delete_campaigns",
318
+ "description": "Delete one or more campaigns by ID. Use update_campaigns with Status=Paused when you want a reversible pause instead.",
319
+ "method": "POST",
320
+ "path": "/Campaigns/Delete",
321
+ "input_schema": {
322
+ "type": "object",
323
+ "properties": {
324
+ "AccountId": {
325
+ "type": "integer"
326
+ },
327
+ "CampaignIds": {
328
+ "type": "array",
329
+ "items": {
330
+ "type": "integer"
331
+ }
332
+ }
333
+ },
334
+ "required": [
335
+ "AccountId",
336
+ "CampaignIds"
337
+ ]
338
+ }
339
+ },
340
+ {
341
+ "name": "update_ad_groups",
342
+ "description": "Update one or more ad groups. Each ad group must include Id and only changed fields.",
343
+ "method": "PUT",
344
+ "path": "/AdGroups",
345
+ "input_schema": {
346
+ "type": "object",
347
+ "properties": {
348
+ "CampaignId": {
349
+ "type": "integer"
350
+ },
351
+ "AdGroups": {
352
+ "type": "array",
353
+ "items": {
354
+ "type": "object"
355
+ }
356
+ }
357
+ },
358
+ "required": [
359
+ "CampaignId",
360
+ "AdGroups"
361
+ ]
362
+ }
363
+ },
364
+ {
365
+ "name": "delete_ad_groups",
366
+ "description": "Delete one or more ad groups by ID.",
367
+ "method": "POST",
368
+ "path": "/AdGroups/Delete",
369
+ "input_schema": {
370
+ "type": "object",
371
+ "properties": {
372
+ "CampaignId": {
373
+ "type": "integer"
374
+ },
375
+ "AdGroupIds": {
376
+ "type": "array",
377
+ "items": {
378
+ "type": "integer"
379
+ }
380
+ }
381
+ },
382
+ "required": [
383
+ "CampaignId",
384
+ "AdGroupIds"
385
+ ]
386
+ }
387
+ },
388
+ {
389
+ "name": "add_ads",
390
+ "description": "Add one or more ads to an ad group. Supports responsive search ads, expanded text ads, product ads, app ads, and audience ads depending on account/campaign type.",
391
+ "method": "POST",
392
+ "path": "/Ads",
393
+ "input_schema": {
394
+ "type": "object",
395
+ "properties": {
396
+ "AdGroupId": {
397
+ "type": "integer"
398
+ },
399
+ "Ads": {
400
+ "type": "array",
401
+ "items": {
402
+ "type": "object"
403
+ }
404
+ }
405
+ },
406
+ "required": [
407
+ "AdGroupId",
408
+ "Ads"
409
+ ]
410
+ }
411
+ },
412
+ {
413
+ "name": "update_ads",
414
+ "description": "Update one or more ads. Each ad must include Id and type-specific fields to mutate.",
415
+ "method": "PUT",
416
+ "path": "/Ads",
417
+ "input_schema": {
418
+ "type": "object",
419
+ "properties": {
420
+ "AdGroupId": {
421
+ "type": "integer"
422
+ },
423
+ "Ads": {
424
+ "type": "array",
425
+ "items": {
426
+ "type": "object"
427
+ }
428
+ }
429
+ },
430
+ "required": [
431
+ "AdGroupId",
432
+ "Ads"
433
+ ]
434
+ }
435
+ },
436
+ {
437
+ "name": "delete_ads",
438
+ "description": "Delete one or more ads by ID.",
439
+ "method": "POST",
440
+ "path": "/Ads/Delete",
441
+ "input_schema": {
442
+ "type": "object",
443
+ "properties": {
444
+ "AdGroupId": {
445
+ "type": "integer"
446
+ },
447
+ "AdIds": {
448
+ "type": "array",
449
+ "items": {
450
+ "type": "integer"
451
+ }
452
+ }
453
+ },
454
+ "required": [
455
+ "AdGroupId",
456
+ "AdIds"
457
+ ]
458
+ }
459
+ },
460
+ {
461
+ "name": "get_audiences_by_account",
462
+ "description": "List audiences under an account. AudienceType can include Custom, RemarketingList, InMarket, Product, SimilarRemarketingList, CombinedList, CustomerList, or ImpressionBasedRemarketingList depending on account access.",
463
+ "method": "POST",
464
+ "path": "/AudiencesByAccountId/Query",
465
+ "input_schema": {
466
+ "type": "object",
467
+ "properties": {
468
+ "AccountId": {
469
+ "type": "integer"
470
+ },
471
+ "AudienceType": {
472
+ "type": "string"
473
+ },
474
+ "ReturnAdditionalFields": {
475
+ "type": "string"
476
+ }
477
+ },
478
+ "required": [
479
+ "AccountId"
480
+ ]
481
+ }
482
+ },
483
+ {
484
+ "name": "add_audiences",
485
+ "description": "Create one or more audiences such as remarketing lists, custom audiences, customer lists, or combined lists.",
486
+ "method": "POST",
487
+ "path": "/Audiences",
488
+ "input_schema": {
489
+ "type": "object",
490
+ "properties": {
491
+ "AccountId": {
492
+ "type": "integer"
493
+ },
494
+ "Audiences": {
495
+ "type": "array",
496
+ "items": {
497
+ "type": "object"
498
+ }
499
+ }
500
+ },
501
+ "required": [
502
+ "AccountId",
503
+ "Audiences"
504
+ ]
505
+ }
506
+ },
507
+ {
508
+ "name": "update_audiences",
509
+ "description": "Update one or more audiences. Each audience must include Id and changed fields.",
510
+ "method": "PUT",
511
+ "path": "/Audiences",
512
+ "input_schema": {
513
+ "type": "object",
514
+ "properties": {
515
+ "AccountId": {
516
+ "type": "integer"
517
+ },
518
+ "Audiences": {
519
+ "type": "array",
520
+ "items": {
521
+ "type": "object"
522
+ }
523
+ }
524
+ },
525
+ "required": [
526
+ "AccountId",
527
+ "Audiences"
528
+ ]
529
+ }
530
+ },
531
+ {
532
+ "name": "delete_audiences",
533
+ "description": "Delete one or more audiences by ID.",
534
+ "method": "POST",
535
+ "path": "/Audiences/Delete",
536
+ "input_schema": {
537
+ "type": "object",
538
+ "properties": {
539
+ "AccountId": {
540
+ "type": "integer"
541
+ },
542
+ "AudienceIds": {
543
+ "type": "array",
544
+ "items": {
545
+ "type": "integer"
546
+ }
547
+ }
548
+ },
549
+ "required": [
550
+ "AccountId",
551
+ "AudienceIds"
552
+ ]
553
+ }
554
+ },
555
+ {
556
+ "name": "add_media",
557
+ "description": "Upload image/media assets for ads. Media objects carry Type, Data, MediaType, Text, or URL fields depending on media kind.",
558
+ "method": "POST",
559
+ "path": "/Media",
560
+ "input_schema": {
561
+ "type": "object",
562
+ "properties": {
563
+ "AccountId": {
564
+ "type": "integer"
565
+ },
566
+ "Media": {
567
+ "type": "array",
568
+ "items": {
569
+ "type": "object"
570
+ }
571
+ }
572
+ },
573
+ "required": [
574
+ "AccountId",
575
+ "Media",
576
+ "Media"
577
+ ]
578
+ }
579
+ },
580
+ {
581
+ "name": "get_media_meta_data_by_account",
582
+ "description": "List uploaded media metadata for an account.",
583
+ "method": "POST",
584
+ "path": "/MediaMetaDataByAccountId/Query",
585
+ "input_schema": {
586
+ "type": "object",
587
+ "properties": {
588
+ "AccountId": {
589
+ "type": "integer"
590
+ },
591
+ "MediaEnabledEntities": {
592
+ "type": "string"
593
+ },
594
+ "PageInfo": {
595
+ "type": "object",
596
+ "description": "{Index, Size}"
597
+ }
598
+ },
599
+ "required": [
600
+ "AccountId"
601
+ ]
602
+ }
603
+ },
604
+ {
605
+ "name": "create_ads",
606
+ "description": "Generic alias for add_ads: create one or more ads in an ad group.",
607
+ "method": "POST",
608
+ "path": "/Ads",
609
+ "input_schema": {
610
+ "type": "object",
611
+ "properties": {
612
+ "AdGroupId": {
613
+ "type": "integer"
614
+ },
615
+ "Ads": {
616
+ "type": "array",
617
+ "items": {
618
+ "type": "object"
619
+ }
620
+ }
621
+ },
622
+ "required": [
623
+ "AdGroupId",
624
+ "Ads"
625
+ ]
626
+ }
627
+ },
628
+ {
629
+ "name": "list_audiences",
630
+ "description": "Generic alias for get_audiences_by_account: list audiences under an account.",
631
+ "method": "POST",
632
+ "path": "/AudiencesByAccountId/Query",
633
+ "input_schema": {
634
+ "type": "object",
635
+ "properties": {
636
+ "AccountId": {
637
+ "type": "integer"
638
+ },
639
+ "AudienceType": {
640
+ "type": "string"
641
+ },
642
+ "ReturnAdditionalFields": {
643
+ "type": "string"
644
+ }
645
+ },
646
+ "required": [
647
+ "AccountId"
648
+ ]
649
+ }
650
+ },
651
+ {
652
+ "name": "create_audience",
653
+ "description": "Generic alias for add_audiences: create audiences under an account.",
654
+ "method": "POST",
655
+ "path": "/Audiences",
656
+ "input_schema": {
657
+ "type": "object",
658
+ "properties": {
659
+ "AccountId": {
660
+ "type": "integer"
661
+ },
662
+ "Audiences": {
663
+ "type": "array",
664
+ "items": {
665
+ "type": "object"
666
+ }
667
+ }
668
+ },
669
+ "required": [
670
+ "AccountId",
671
+ "Audiences"
672
+ ]
673
+ }
674
+ },
675
+ {
676
+ "name": "create_creative_asset",
677
+ "description": "Generic alias for add_media: upload image/media creative assets.",
678
+ "method": "POST",
679
+ "path": "/Media",
680
+ "input_schema": {
681
+ "type": "object",
682
+ "properties": {
683
+ "AccountId": {
684
+ "type": "integer"
685
+ },
686
+ "Media": {
687
+ "type": "array",
688
+ "items": {
689
+ "type": "object"
690
+ }
691
+ }
241
692
  },
242
- "required": ["ReportRequestId"]
693
+ "required": [
694
+ "AccountId",
695
+ "Media"
696
+ ]
243
697
  }
244
698
  }
245
699
  ]