taboola-backstage-sdk 0.6.2 → 0.6.5
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.
- package/dist/index.cjs +12 -9
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +120 -52
- package/dist/index.d.ts +120 -52
- package/dist/index.js +12 -9
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -105,7 +105,7 @@ type MultiTargetingState = 'ALL' | 'EXISTS' | 'NOT_EXISTS';
|
|
|
105
105
|
*/
|
|
106
106
|
interface MultiTargeting {
|
|
107
107
|
state: MultiTargetingState;
|
|
108
|
-
value:
|
|
108
|
+
value: TargetingValue[] | null;
|
|
109
109
|
href?: string | null;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
@@ -145,7 +145,7 @@ type CampaignStatus = 'RUNNING' | 'PAUSED' | 'PENDING_APPROVAL' | 'REJECTED' | '
|
|
|
145
145
|
/**
|
|
146
146
|
* Status values for items
|
|
147
147
|
*/
|
|
148
|
-
type ItemStatus = 'RUNNING' | 'CRAWLING' | 'CRAWLING_ERROR' | 'NEED_TO_EDIT' | 'PAUSED' | 'STOPPED' | 'PENDING_APPROVAL' | 'REJECTED';
|
|
148
|
+
type ItemStatus = 'RUNNING' | 'CRAWLING' | 'CRAWLING_ERROR' | 'NEED_TO_EDIT' | 'PAUSED' | 'STOPPED' | 'PENDING_APPROVAL' | 'REJECTED' | 'FAILED_TO_CREATE';
|
|
149
149
|
/**
|
|
150
150
|
* Pricing models
|
|
151
151
|
*/
|
|
@@ -187,7 +187,7 @@ type OperatingSystem = 'WINDOWS' | 'MACOSX' | 'LINUX' | 'IOS' | 'ANDROID';
|
|
|
187
187
|
/**
|
|
188
188
|
* Call-to-action button types
|
|
189
189
|
*/
|
|
190
|
-
type CTAType = 'NONE' | 'APPLY_NOW' | 'BOOK_NOW' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'INSTALL' | 'LEARN_MORE' | 'ORDER_NOW' | 'PLAY_NOW' | 'READ_MORE' | 'SEE_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'SUBSCRIBE' | 'WATCH_MORE';
|
|
190
|
+
type CTAType = 'NONE' | 'APPLY_NOW' | 'BOOK_NOW' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'INSTALL' | 'LEARN_MORE' | 'ORDER_NOW' | 'PLAY_NOW' | 'READ_MORE' | 'SEE_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'SUBSCRIBE' | 'WATCH_MORE' | 'INSTALL_NOW' | 'CLICK_HERE' | 'TRY_NOW' | 'SEARCH_NOW';
|
|
191
191
|
/**
|
|
192
192
|
* Item types
|
|
193
193
|
*/
|
|
@@ -212,6 +212,19 @@ type RealtimeCampaignDimension = 'by_hour' | 'by_campaign' | 'by_site' | 'by_cou
|
|
|
212
212
|
* @see https://developers.taboola.com/backstage-api/reference/realtime-ads-report
|
|
213
213
|
*/
|
|
214
214
|
type RealtimeAdsDimension = 'by_item' | 'by_item_by_smallest_time_bucket';
|
|
215
|
+
/**
|
|
216
|
+
* External metadata key-value pair
|
|
217
|
+
*/
|
|
218
|
+
interface ExternalMetadataKeyValue {
|
|
219
|
+
key: string;
|
|
220
|
+
value: string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* External metadata collection
|
|
224
|
+
*/
|
|
225
|
+
interface ExternalMetadata {
|
|
226
|
+
data: ExternalMetadataKeyValue[];
|
|
227
|
+
}
|
|
215
228
|
|
|
216
229
|
/**
|
|
217
230
|
* Authentication types for Taboola Backstage API
|
|
@@ -329,10 +342,10 @@ type NetworkAdvertisersResponse = ListResponse<AdvertiserAccount>;
|
|
|
329
342
|
* Publisher bid modifier entry
|
|
330
343
|
*/
|
|
331
344
|
interface PublisherBidModifier {
|
|
332
|
-
/**
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
|
|
345
|
+
/** Target publisher */
|
|
346
|
+
target: string;
|
|
347
|
+
/** CPC modification value (1.0 = no change, 1.5 = +50%, 0.5 = -50%) */
|
|
348
|
+
cpc_modification: number;
|
|
336
349
|
}
|
|
337
350
|
/**
|
|
338
351
|
* Publisher bid modifier collection
|
|
@@ -344,10 +357,10 @@ interface PublisherBidModifierCollection {
|
|
|
344
357
|
* Publisher bid strategy modifier entry
|
|
345
358
|
*/
|
|
346
359
|
interface PublisherBidStrategyModifier {
|
|
347
|
-
/** Publisher
|
|
348
|
-
|
|
349
|
-
/**
|
|
350
|
-
|
|
360
|
+
/** Publisher name */
|
|
361
|
+
publisher: string;
|
|
362
|
+
/** Bid strategy for this publisher */
|
|
363
|
+
bid_strategy: BidStrategy;
|
|
351
364
|
}
|
|
352
365
|
/**
|
|
353
366
|
* Publisher bid strategy modifier collection
|
|
@@ -411,6 +424,37 @@ interface PolicyReview {
|
|
|
411
424
|
/** Rejection reason if rejected */
|
|
412
425
|
reject_reason: string | null;
|
|
413
426
|
}
|
|
427
|
+
/**
|
|
428
|
+
* Conversion rule reference for campaign attribution
|
|
429
|
+
*/
|
|
430
|
+
interface CampaignConversionRule {
|
|
431
|
+
/** Conversion rule ID (writable) */
|
|
432
|
+
id: number;
|
|
433
|
+
/** Display name of the conversion rule (read-only) */
|
|
434
|
+
display_name?: string;
|
|
435
|
+
/** Rule status (read-only) */
|
|
436
|
+
status?: string;
|
|
437
|
+
/** Whether to include in total conversions (read-only) */
|
|
438
|
+
include_in_total_conversions?: boolean;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* Conversion rules configuration for a campaign
|
|
442
|
+
*/
|
|
443
|
+
interface CampaignConversionRules {
|
|
444
|
+
/** List of conversion rules */
|
|
445
|
+
rules: CampaignConversionRule[];
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* Attribution configuration for conversion tracking
|
|
449
|
+
*/
|
|
450
|
+
interface AttributionConfig {
|
|
451
|
+
/** Lookback window in minutes for click attribution */
|
|
452
|
+
look_back_window_in_minutes?: number;
|
|
453
|
+
/** Lookback window in minutes for view-through attribution */
|
|
454
|
+
vta_look_back_window_in_minutes?: number;
|
|
455
|
+
/** How conversions are counted */
|
|
456
|
+
aggregation_type?: 'AGGREGATED' | 'LAST_VALUE';
|
|
457
|
+
}
|
|
414
458
|
/**
|
|
415
459
|
* Full Campaign object
|
|
416
460
|
*/
|
|
@@ -521,8 +565,14 @@ interface Campaign {
|
|
|
521
565
|
type?: string;
|
|
522
566
|
/** Campaign learning/optimization state (ReadOnly) */
|
|
523
567
|
learning_state?: string;
|
|
568
|
+
/** Conversion rules associated with this campaign */
|
|
569
|
+
conversion_rules?: CampaignConversionRules;
|
|
570
|
+
/** Attribution configuration for conversion tracking */
|
|
571
|
+
conversion_configuration?: AttributionConfig;
|
|
572
|
+
/** External metadata */
|
|
573
|
+
external_metadata?: ExternalMetadata;
|
|
524
574
|
/** Campaign groups (ReadOnly) */
|
|
525
|
-
campaign_groups?:
|
|
575
|
+
campaign_groups?: CampaignsGroup;
|
|
526
576
|
/** Start date in UTC (ReadOnly) */
|
|
527
577
|
start_date_in_utc?: DateString | null;
|
|
528
578
|
/** End date in UTC (ReadOnly) */
|
|
@@ -616,6 +666,12 @@ interface CreateCampaignRequest {
|
|
|
616
666
|
viewability_tag?: ViewabilityTag;
|
|
617
667
|
/** Activity schedule */
|
|
618
668
|
activity_schedule?: ActivitySchedule;
|
|
669
|
+
/** Conversion rules to associate with this campaign */
|
|
670
|
+
conversion_rules?: CampaignConversionRules;
|
|
671
|
+
/** Attribution configuration for conversion tracking */
|
|
672
|
+
conversion_configuration?: AttributionConfig;
|
|
673
|
+
/** External metadata */
|
|
674
|
+
external_metadata?: ExternalMetadata;
|
|
619
675
|
}
|
|
620
676
|
/**
|
|
621
677
|
* Campaign update request
|
|
@@ -710,6 +766,12 @@ interface UpdateCampaignRequest {
|
|
|
710
766
|
viewability_tag?: ViewabilityTag;
|
|
711
767
|
/** Activity schedule */
|
|
712
768
|
activity_schedule?: ActivitySchedule;
|
|
769
|
+
/** Conversion rules to associate with this campaign */
|
|
770
|
+
conversion_rules?: CampaignConversionRules;
|
|
771
|
+
/** Attribution configuration for conversion tracking */
|
|
772
|
+
conversion_configuration?: AttributionConfig;
|
|
773
|
+
/** External metadata */
|
|
774
|
+
external_metadata?: ExternalMetadata;
|
|
713
775
|
}
|
|
714
776
|
/**
|
|
715
777
|
* Campaign list response
|
|
@@ -800,7 +862,7 @@ interface CampaignBase {
|
|
|
800
862
|
/** Marketing objective */
|
|
801
863
|
marketing_objective?: MarketingObjective;
|
|
802
864
|
/** Campaign groups */
|
|
803
|
-
campaign_groups?:
|
|
865
|
+
campaign_groups?: CampaignsGroup;
|
|
804
866
|
}
|
|
805
867
|
/**
|
|
806
868
|
* Campaign base list response
|
|
@@ -838,6 +900,16 @@ interface DuplicateCampaignRequest {
|
|
|
838
900
|
/** Duplication settings */
|
|
839
901
|
duplicate_settings?: DuplicateSettings;
|
|
840
902
|
}
|
|
903
|
+
/**
|
|
904
|
+
* Campaign group with shared budget reference
|
|
905
|
+
*/
|
|
906
|
+
interface CampaignsGroup {
|
|
907
|
+
shared_budget: {
|
|
908
|
+
id: number;
|
|
909
|
+
name: string;
|
|
910
|
+
status: string;
|
|
911
|
+
};
|
|
912
|
+
}
|
|
841
913
|
|
|
842
914
|
/**
|
|
843
915
|
* Campaign Item (Ad) types for Taboola Backstage API
|
|
@@ -847,16 +919,14 @@ interface DuplicateCampaignRequest {
|
|
|
847
919
|
* Creative focus type
|
|
848
920
|
* @deprecated Use automatic cropping instead
|
|
849
921
|
*/
|
|
850
|
-
type CreativeFocusType = 'AUTOMATIC' | '
|
|
922
|
+
type CreativeFocusType = 'AUTOMATIC' | 'COORDINATES';
|
|
851
923
|
/**
|
|
852
924
|
* Coordinates for custom creative focus
|
|
853
925
|
* @deprecated
|
|
854
926
|
*/
|
|
855
927
|
interface Coordinates {
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
right: number;
|
|
859
|
-
bottom: number;
|
|
928
|
+
x: number;
|
|
929
|
+
y: number;
|
|
860
930
|
}
|
|
861
931
|
/**
|
|
862
932
|
* Creative focus configuration
|
|
@@ -967,6 +1037,8 @@ interface CampaignItem {
|
|
|
967
1037
|
start_date?: string;
|
|
968
1038
|
/** Item end date */
|
|
969
1039
|
end_date?: string;
|
|
1040
|
+
/** External metadata */
|
|
1041
|
+
external_metadata?: ExternalMetadata;
|
|
970
1042
|
}
|
|
971
1043
|
/**
|
|
972
1044
|
* Create campaign item request (static ads only)
|
|
@@ -1076,38 +1148,31 @@ interface BulkCreateItemsResponse {
|
|
|
1076
1148
|
}[];
|
|
1077
1149
|
}
|
|
1078
1150
|
/**
|
|
1079
|
-
* Bulk item update request
|
|
1151
|
+
* Bulk item update request
|
|
1080
1152
|
*/
|
|
1081
1153
|
interface BulkUpdateItemsRequest {
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
campaign_id: string;
|
|
1087
|
-
/** Ad title */
|
|
1088
|
-
title?: string;
|
|
1089
|
-
/** Landing page URL */
|
|
1090
|
-
url?: string;
|
|
1091
|
-
/** Ad description */
|
|
1092
|
-
description?: string;
|
|
1093
|
-
/** Thumbnail image URL */
|
|
1094
|
-
thumbnail_url?: string;
|
|
1095
|
-
/** Whether item is active */
|
|
1096
|
-
is_active?: boolean;
|
|
1097
|
-
/** CTA configuration */
|
|
1098
|
-
cta?: CTA;
|
|
1099
|
-
}[];
|
|
1154
|
+
/** Item IDs to update */
|
|
1155
|
+
items_to_update: number[];
|
|
1156
|
+
/** Baseline item with fields to apply to all items */
|
|
1157
|
+
baseline_item: UpdateItemRequest;
|
|
1100
1158
|
}
|
|
1101
1159
|
/**
|
|
1102
|
-
* Bulk item delete request
|
|
1160
|
+
* Bulk item delete request
|
|
1103
1161
|
*/
|
|
1104
1162
|
interface BulkDeleteItemsRequest {
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1163
|
+
/** Item IDs to delete */
|
|
1164
|
+
items_to_update: number[];
|
|
1165
|
+
/** Baseline item (typically empty or with minimal fields) */
|
|
1166
|
+
baseline_item: Partial<UpdateItemRequest>;
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* Bulk create items across multiple campaigns request
|
|
1170
|
+
*/
|
|
1171
|
+
interface BulkCreateItemsAcrossCampaignsRequest {
|
|
1172
|
+
/** Campaign IDs to create items in */
|
|
1173
|
+
campaign_ids: number[];
|
|
1174
|
+
/** Items to create */
|
|
1175
|
+
items: BulkCreateItemData[];
|
|
1111
1176
|
}
|
|
1112
1177
|
/**
|
|
1113
1178
|
* RSS child item
|
|
@@ -1286,6 +1351,11 @@ interface ContextualSegment {
|
|
|
1286
1351
|
provider?: string | null;
|
|
1287
1352
|
allowed_countries?: string[] | null;
|
|
1288
1353
|
size?: number | null;
|
|
1354
|
+
articles?: number | null;
|
|
1355
|
+
is_targetable?: boolean | null;
|
|
1356
|
+
is_bundle?: boolean | null;
|
|
1357
|
+
is_active?: boolean | null;
|
|
1358
|
+
taxonomy_label?: string | null;
|
|
1289
1359
|
}
|
|
1290
1360
|
/**
|
|
1291
1361
|
* Campaign property enums response
|
|
@@ -1375,7 +1445,7 @@ interface UpdateBlockedPublishersRequest {
|
|
|
1375
1445
|
*/
|
|
1376
1446
|
interface TargetingRestriction<T> {
|
|
1377
1447
|
collection: T[];
|
|
1378
|
-
type: 'INCLUDE' | 'EXCLUDE';
|
|
1448
|
+
type: 'INCLUDE' | 'EXCLUDE' | 'ALL';
|
|
1379
1449
|
}
|
|
1380
1450
|
/**
|
|
1381
1451
|
* Lookalike audience item for targeting
|
|
@@ -1635,7 +1705,7 @@ interface ConversionRule {
|
|
|
1635
1705
|
/**
|
|
1636
1706
|
* Conversion rule status
|
|
1637
1707
|
*/
|
|
1638
|
-
type ConversionRuleStatus = 'ACTIVE' | 'DISABLED' | 'ARCHIVED';
|
|
1708
|
+
type ConversionRuleStatus = 'ACTIVE' | 'DISABLED' | 'ARCHIVED' | 'NO_RECENT_ACTIVITY' | 'NO_ACTIVITY_YET' | 'READY' | 'PROCESSING' | 'ERROR' | 'GAINING_SCALE' | 'ERROR_SEED_SIZE_TOO_SMALL';
|
|
1639
1709
|
/**
|
|
1640
1710
|
* Conversion rule type
|
|
1641
1711
|
*
|
|
@@ -2679,9 +2749,7 @@ declare class ItemsAPI {
|
|
|
2679
2749
|
* ]);
|
|
2680
2750
|
* ```
|
|
2681
2751
|
*/
|
|
2682
|
-
bulkCreateAcrossCampaigns(accountId: string,
|
|
2683
|
-
campaign_id: string;
|
|
2684
|
-
})[]): Promise<BulkCreateItemsResponse>;
|
|
2752
|
+
bulkCreateAcrossCampaigns(accountId: string, request: BulkCreateItemsAcrossCampaignsRequest): Promise<BulkCreateItemsResponse>;
|
|
2685
2753
|
/**
|
|
2686
2754
|
* Bulk update items across multiple campaigns
|
|
2687
2755
|
*
|
|
@@ -2698,7 +2766,7 @@ declare class ItemsAPI {
|
|
|
2698
2766
|
* });
|
|
2699
2767
|
* ```
|
|
2700
2768
|
*/
|
|
2701
|
-
bulkUpdate(accountId: string, request: BulkUpdateItemsRequest): Promise<CampaignItemListResponse>;
|
|
2769
|
+
bulkUpdate(accountId: string, request: BulkUpdateItemsRequest, isAtomic?: boolean): Promise<CampaignItemListResponse>;
|
|
2702
2770
|
/**
|
|
2703
2771
|
* Bulk delete items across multiple campaigns
|
|
2704
2772
|
*
|
|
@@ -2715,7 +2783,7 @@ declare class ItemsAPI {
|
|
|
2715
2783
|
* });
|
|
2716
2784
|
* ```
|
|
2717
2785
|
*/
|
|
2718
|
-
bulkDelete(accountId: string, request: BulkDeleteItemsRequest): Promise<void>;
|
|
2786
|
+
bulkDelete(accountId: string, request: BulkDeleteItemsRequest, isAtomic?: boolean): Promise<void>;
|
|
2719
2787
|
/**
|
|
2720
2788
|
* Get children of an RSS item
|
|
2721
2789
|
*
|
|
@@ -3698,4 +3766,4 @@ declare class TaboolaServerError extends TaboolaError {
|
|
|
3698
3766
|
*/
|
|
3699
3767
|
declare function parseApiError(statusCode: number, response: unknown, url: string): TaboolaError;
|
|
3700
3768
|
|
|
3701
|
-
export { type Account, type AccountType, AccountsAPI, type ActivitySchedule, type ActivityScheduleRule, type AdvertiserAccount, type AllowedAccountsResponse, type ApprovalState, type AudienceTargeting, type AudienceUserClusterItem, type AudienceUserIdentity, type AudienceUsersRequest, type AvailableAudience, type AvailableAudiencesResponse, type BidStrategy, type BlockedPublishersResponse, type BrandSafetyProvider, type Browser, type BulkCampaignUpdateRequest, type BulkCreateItemsRequest, type BulkCreateItemsResponse, type BulkDeleteItemsRequest, type BulkUpdateItemsRequest, type CTA, type CTAType, type Campaign, type CampaignBase, type CampaignBaseListResponse, type CampaignEnums, type CampaignItem, type CampaignItemListResponse, type CampaignListResponse, type CampaignPatchRequest, type CampaignReachEstimatorRequest, type CampaignReachEstimatorResponse, type CampaignStatus, type CampaignSummaryReport, type CampaignSummaryReportParams, type CampaignSummaryRow, type CampaignTargetingCollection, type CampaignType, CampaignsAPI, type CombinedAudience, type CombinedAudienceListResponse, type CombinedAudienceRule, CombinedAudiencesAPI, type ConnectionType, type ContextualSegment, type ContextualTargeting, type ConversionCategory, type ConversionCondition, type ConversionConditionPredicate, type ConversionEffect, type ConversionRule, type ConversionRuleListResponse, type ConversionRuleStatus, type ConversionRuleType, type ConversionRuleWithData, type ConversionRuleWithDataListResponse, type Coordinates, type Country, type CreateCampaignRequest, type CreateCombinedAudienceRequest, type CreateConversionRuleRequest, type CreateCustomAudienceRuleRequest, type CreateFirstPartyAudienceRequest, type CreateItemRequest, type CreateSharedBudgetRequest, type CreativeFocus, type CreativeFocusType, type CurrencyCode, type CustomAudienceCondition, type CustomAudienceConditionOperator, type CustomAudienceConditionType, type CustomAudienceRule, type CustomAudienceRuleListResponse, type CustomAudienceRuleStatus, DEFAULT_BASE_URL, type DMA, type DailyAdDeliveryModel, type DateString, type DayOfWeek, DictionaryAPI, type DuplicateCampaignRequest, type DuplicateSettings, type ExternalBrandSafety, type FirstPartyAudience, type FirstPartyAudienceTargeting, FirstPartyAudiencesAPI, HttpClient, type HttpClientOptions, type ImageLibraryItem, type ImageLibrarySearchParams, type ImageLibrarySearchResponse, type ImageUploadResponse, type ItemEnums, type ItemPolicyReview, type ItemStatus, type ItemType, type ItemVerificationPixel, type ItemViewabilityTag, ItemsAPI, type ListCampaignsOptions, type ListItemsOptions, type ListResponse, type LookalikeAudience, type LookalikeAudienceItem, type LookalikeAudienceTargeting, type MarketingObjective, type MarketplaceAudience, type MarkingLabelsTargeting, type MinimumCPC, type MultiTargeting, type MultiTargetingState, type NetworkAdvertisersResponse, OAuthManager, type OSVersion, type OperatingSystem, type OperatingSystemInfo, type PaginationParams, type PartnerType, type PatchOperation, PixelAPI, type Platform, type PlatformType, type PolicyReview, type PostalCode, type PostalCodeTargeting, type PricingModel, type Publisher, type PublisherBidModifier, type PublisherBidModifierCollection, type PublisherBidStrategyModifier, type PublisherBidStrategyModifierCollection, type PublisherListResponse, PublishersAPI, type RSSChildItem, type RSSChildrenListResponse, type RealtimeAdsDimension, type RealtimeAdsReport, type RealtimeAdsReportParams, type RealtimeAdsRow, type RealtimeCampaignDimension, type RealtimeCampaignReport, type RealtimeCampaignReportParams, type RealtimeCampaignRow, type Region, type ReportDimension, type ReportMetadata, ReportsAPI, type SharedBudget, SharedBudgetAPI, type SharedBudgetBase, type SharedBudgetBaseListResponse, type SharedBudgetCampaign, type SharedBudgetCampaignAttribute, type SpendingLimitModel, type StoredToken, TaboolaAuthError, TaboolaClient, type TaboolaConfig, TaboolaError, TaboolaForbiddenError, TaboolaNotFoundError, TaboolaRateLimitError, TaboolaServerError, TaboolaValidationError, TargetingAPI, type TargetingRestriction, type TargetingType, type TargetingValue, type TokenResponse, type TopCampaignContentReport, type TopCampaignContentReportParams, type TopCampaignContentRow, type TrafficAllocationMode, type UpdateAudienceTargetingRequest, type UpdateBlockedPublishersRequest, type UpdateCampaignRequest, type UpdateCombinedAudienceRequest, type UpdateContextualTargetingRequest, type UpdateConversionRuleRequest, type UpdateCustomAudienceRuleRequest, type UpdateFirstPartyAudienceTargetingRequest, type UpdateItemRequest, type UpdateLookalikeAudienceTargetingRequest, type UpdateMarkingLabelsTargetingRequest, type UpdatePostalCodeTargetingRequest, type UpdateSharedBudgetRequest, type VerificationPixel, type ViewabilityTag, createClient, parseApiError };
|
|
3769
|
+
export { type Account, type AccountType, AccountsAPI, type ActivitySchedule, type ActivityScheduleRule, type AdvertiserAccount, type AllowedAccountsResponse, type ApprovalState, type AttributionConfig, type AudienceTargeting, type AudienceUserClusterItem, type AudienceUserIdentity, type AudienceUsersRequest, type AvailableAudience, type AvailableAudiencesResponse, type BidStrategy, type BlockedPublishersResponse, type BrandSafetyProvider, type Browser, type BulkCampaignUpdateRequest, type BulkCreateItemsAcrossCampaignsRequest, type BulkCreateItemsRequest, type BulkCreateItemsResponse, type BulkDeleteItemsRequest, type BulkUpdateItemsRequest, type CTA, type CTAType, type Campaign, type CampaignBase, type CampaignBaseListResponse, type CampaignConversionRule, type CampaignConversionRules, type CampaignEnums, type CampaignItem, type CampaignItemListResponse, type CampaignListResponse, type CampaignPatchRequest, type CampaignReachEstimatorRequest, type CampaignReachEstimatorResponse, type CampaignStatus, type CampaignSummaryReport, type CampaignSummaryReportParams, type CampaignSummaryRow, type CampaignTargetingCollection, type CampaignType, CampaignsAPI, type CampaignsGroup, type CombinedAudience, type CombinedAudienceListResponse, type CombinedAudienceRule, CombinedAudiencesAPI, type ConnectionType, type ContextualSegment, type ContextualTargeting, type ConversionCategory, type ConversionCondition, type ConversionConditionPredicate, type ConversionEffect, type ConversionRule, type ConversionRuleListResponse, type ConversionRuleStatus, type ConversionRuleType, type ConversionRuleWithData, type ConversionRuleWithDataListResponse, type Coordinates, type Country, type CreateCampaignRequest, type CreateCombinedAudienceRequest, type CreateConversionRuleRequest, type CreateCustomAudienceRuleRequest, type CreateFirstPartyAudienceRequest, type CreateItemRequest, type CreateSharedBudgetRequest, type CreativeFocus, type CreativeFocusType, type CurrencyCode, type CustomAudienceCondition, type CustomAudienceConditionOperator, type CustomAudienceConditionType, type CustomAudienceRule, type CustomAudienceRuleListResponse, type CustomAudienceRuleStatus, DEFAULT_BASE_URL, type DMA, type DailyAdDeliveryModel, type DateString, type DayOfWeek, DictionaryAPI, type DuplicateCampaignRequest, type DuplicateSettings, type ExternalBrandSafety, type ExternalMetadata, type ExternalMetadataKeyValue, type FirstPartyAudience, type FirstPartyAudienceTargeting, FirstPartyAudiencesAPI, HttpClient, type HttpClientOptions, type ImageLibraryItem, type ImageLibrarySearchParams, type ImageLibrarySearchResponse, type ImageUploadResponse, type ItemEnums, type ItemPolicyReview, type ItemStatus, type ItemType, type ItemVerificationPixel, type ItemViewabilityTag, ItemsAPI, type ListCampaignsOptions, type ListItemsOptions, type ListResponse, type LookalikeAudience, type LookalikeAudienceItem, type LookalikeAudienceTargeting, type MarketingObjective, type MarketplaceAudience, type MarkingLabelsTargeting, type MinimumCPC, type MultiTargeting, type MultiTargetingState, type NetworkAdvertisersResponse, OAuthManager, type OSVersion, type OperatingSystem, type OperatingSystemInfo, type PaginationParams, type PartnerType, type PatchOperation, PixelAPI, type Platform, type PlatformType, type PolicyReview, type PostalCode, type PostalCodeTargeting, type PricingModel, type Publisher, type PublisherBidModifier, type PublisherBidModifierCollection, type PublisherBidStrategyModifier, type PublisherBidStrategyModifierCollection, type PublisherListResponse, PublishersAPI, type RSSChildItem, type RSSChildrenListResponse, type RealtimeAdsDimension, type RealtimeAdsReport, type RealtimeAdsReportParams, type RealtimeAdsRow, type RealtimeCampaignDimension, type RealtimeCampaignReport, type RealtimeCampaignReportParams, type RealtimeCampaignRow, type Region, type ReportDimension, type ReportMetadata, ReportsAPI, type SharedBudget, SharedBudgetAPI, type SharedBudgetBase, type SharedBudgetBaseListResponse, type SharedBudgetCampaign, type SharedBudgetCampaignAttribute, type SpendingLimitModel, type StoredToken, TaboolaAuthError, TaboolaClient, type TaboolaConfig, TaboolaError, TaboolaForbiddenError, TaboolaNotFoundError, TaboolaRateLimitError, TaboolaServerError, TaboolaValidationError, TargetingAPI, type TargetingRestriction, type TargetingType, type TargetingValue, type TokenResponse, type TopCampaignContentReport, type TopCampaignContentReportParams, type TopCampaignContentRow, type TrafficAllocationMode, type UpdateAudienceTargetingRequest, type UpdateBlockedPublishersRequest, type UpdateCampaignRequest, type UpdateCombinedAudienceRequest, type UpdateContextualTargetingRequest, type UpdateConversionRuleRequest, type UpdateCustomAudienceRuleRequest, type UpdateFirstPartyAudienceTargetingRequest, type UpdateItemRequest, type UpdateLookalikeAudienceTargetingRequest, type UpdateMarkingLabelsTargetingRequest, type UpdatePostalCodeTargetingRequest, type UpdateSharedBudgetRequest, type VerificationPixel, type ViewabilityTag, createClient, parseApiError };
|
package/dist/index.js
CHANGED
|
@@ -773,8 +773,8 @@ var ItemsAPI = class {
|
|
|
773
773
|
* ]);
|
|
774
774
|
* ```
|
|
775
775
|
*/
|
|
776
|
-
async bulkCreateAcrossCampaigns(accountId,
|
|
777
|
-
return this.http.put(`${accountId}/items/bulk`,
|
|
776
|
+
async bulkCreateAcrossCampaigns(accountId, request) {
|
|
777
|
+
return this.http.put(`${accountId}/items/bulk`, request);
|
|
778
778
|
}
|
|
779
779
|
/**
|
|
780
780
|
* Bulk update items across multiple campaigns
|
|
@@ -792,8 +792,11 @@ var ItemsAPI = class {
|
|
|
792
792
|
* });
|
|
793
793
|
* ```
|
|
794
794
|
*/
|
|
795
|
-
async bulkUpdate(accountId, request) {
|
|
796
|
-
return this.http.post(
|
|
795
|
+
async bulkUpdate(accountId, request, isAtomic = false) {
|
|
796
|
+
return this.http.post(
|
|
797
|
+
`${accountId}/items/bulk?is_atomic=${String(isAtomic)}`,
|
|
798
|
+
request
|
|
799
|
+
);
|
|
797
800
|
}
|
|
798
801
|
/**
|
|
799
802
|
* Bulk delete items across multiple campaigns
|
|
@@ -811,8 +814,8 @@ var ItemsAPI = class {
|
|
|
811
814
|
* });
|
|
812
815
|
* ```
|
|
813
816
|
*/
|
|
814
|
-
async bulkDelete(accountId, request) {
|
|
815
|
-
await this.http.delete(`${accountId}/items/bulk`, {
|
|
817
|
+
async bulkDelete(accountId, request, isAtomic = false) {
|
|
818
|
+
await this.http.delete(`${accountId}/items/bulk?is_atomic=${String(isAtomic)}`, {
|
|
816
819
|
json: request
|
|
817
820
|
});
|
|
818
821
|
}
|
|
@@ -927,7 +930,7 @@ var DictionaryAPI = class {
|
|
|
927
930
|
*/
|
|
928
931
|
async getOperatingSystems() {
|
|
929
932
|
const response = await this.http.get(
|
|
930
|
-
"resources/
|
|
933
|
+
"resources/campaigns_properties/operating_systems"
|
|
931
934
|
);
|
|
932
935
|
return response.results;
|
|
933
936
|
}
|
|
@@ -936,7 +939,7 @@ var DictionaryAPI = class {
|
|
|
936
939
|
*/
|
|
937
940
|
async getIOSVersions() {
|
|
938
941
|
const response = await this.http.get(
|
|
939
|
-
"resources/
|
|
942
|
+
"resources/campaigns_properties/operating_systems/IOS"
|
|
940
943
|
);
|
|
941
944
|
return response.results;
|
|
942
945
|
}
|
|
@@ -945,7 +948,7 @@ var DictionaryAPI = class {
|
|
|
945
948
|
*/
|
|
946
949
|
async getAndroidVersions() {
|
|
947
950
|
const response = await this.http.get(
|
|
948
|
-
"resources/
|
|
951
|
+
"resources/campaigns_properties/operating_systems/ANDROID"
|
|
949
952
|
);
|
|
950
953
|
return response.results;
|
|
951
954
|
}
|