google-ads-api 23.0.1 → 24.1.0

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.
@@ -269,6 +269,16 @@ export type AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = `customers/${
269
269
  * @example const androidPrivacySharedKeyGoogleNetworkType: ResourceNames.AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = ResourceNames.androidPrivacySharedKeyGoogleNetworkType(10987417, 21974834, 43949668, 87899336, 175798672)
270
270
  */
271
271
  export declare function androidPrivacySharedKeyGoogleNetworkType(customerId: string | number, campaignId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyNetworkType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleNetworkTypeResourceName;
272
+ export type AppTopCombinationViewResourceName = `customers/${StrNum}/appTopCombinationViews/${StrNum}~${StrNum}~${StrNum}`;
273
+ /**
274
+ * @param {string | number} customerId
275
+ * @param {string | number} adGroupId
276
+ * @param {string | number} adId
277
+ * @param {string | number} assetCombinationCategory
278
+ * @returns `AppTopCombinationViewResourceName`
279
+ * @example const appTopCombinationView: ResourceNames.AppTopCombinationViewResourceName = ResourceNames.appTopCombinationView(10987417, 21974834, 43949668, 87899336)
280
+ */
281
+ export declare function appTopCombinationView(customerId: string | number, adGroupId: string | number, adId: string | number, assetCombinationCategory: string | number): AppTopCombinationViewResourceName;
272
282
  export type AppliedIncentiveResourceName = `customers/${StrNum}/appliedIncentives/${StrNum}`;
273
283
  /**
274
284
  * @param {string | number} customerId
@@ -621,6 +631,13 @@ export type CarrierConstantResourceName = `carrierConstants/${StrNum}`;
621
631
  * @example const carrierConstant: ResourceNames.CarrierConstantResourceName = ResourceNames.carrierConstant(10987417)
622
632
  */
623
633
  export declare function carrierConstant(criterionId: string | number): CarrierConstantResourceName;
634
+ export type CartDataSalesViewResourceName = `customers/${StrNum}/cartDataSalesView`;
635
+ /**
636
+ * @param {string | number} customerId
637
+ * @returns `CartDataSalesViewResourceName`
638
+ * @example const cartDataSalesView: ResourceNames.CartDataSalesViewResourceName = ResourceNames.cartDataSalesView(10987417)
639
+ */
640
+ export declare function cartDataSalesView(customerId: string | number): CartDataSalesViewResourceName;
624
641
  export type ChangeEventResourceName = `customers/${StrNum}/changeEvents/${StrNum}~${StrNum}~${StrNum}`;
625
642
  /**
626
643
  * @param {string | number} customerId
@@ -1564,6 +1581,14 @@ export type VideoResourceName = `customers/${StrNum}/videos/${StrNum}`;
1564
1581
  * @example const video: ResourceNames.VideoResourceName = ResourceNames.video(10987417, 21974834)
1565
1582
  */
1566
1583
  export declare function video(customerId: string | number, videoId: string | number): VideoResourceName;
1584
+ export type VideoEnhancementResourceName = `customers/${StrNum}/videoEnhancements/${StrNum}`;
1585
+ /**
1586
+ * @param {string | number} customerId
1587
+ * @param {string | number} videoEnhancement
1588
+ * @returns `VideoEnhancementResourceName`
1589
+ * @example const videoEnhancement: ResourceNames.VideoEnhancementResourceName = ResourceNames.videoEnhancement(10987417, 21974834)
1590
+ */
1591
+ export declare function videoEnhancement(customerId: string | number, videoEnhancement: string | number): VideoEnhancementResourceName;
1567
1592
  export type WebpageViewResourceName = `customers/${StrNum}/webpageViews/${StrNum}~${StrNum}`;
1568
1593
  /**
1569
1594
  * @param {string | number} customerId
@@ -1573,4 +1598,12 @@ export type WebpageViewResourceName = `customers/${StrNum}/webpageViews/${StrNum
1573
1598
  * @example const webpageView: ResourceNames.WebpageViewResourceName = ResourceNames.webpageView(10987417, 21974834, 43949668)
1574
1599
  */
1575
1600
  export declare function webpageView(customerId: string | number, adGroupId: string | number, criterionId: string | number): WebpageViewResourceName;
1601
+ export type YouTubeVideoUploadResourceName = `customers/${StrNum}/youTubeVideoUploads/${StrNum}`;
1602
+ /**
1603
+ * @param {string | number} customerId
1604
+ * @param {string | number} videoUploadId
1605
+ * @returns `YouTubeVideoUploadResourceName`
1606
+ * @example const youTubeVideoUpload: ResourceNames.YouTubeVideoUploadResourceName = ResourceNames.youTubeVideoUpload(10987417, 21974834)
1607
+ */
1608
+ export declare function youTubeVideoUpload(customerId: string | number, videoUploadId: string | number): YouTubeVideoUploadResourceName;
1576
1609
  export {};
@@ -29,6 +29,7 @@ exports.aiMaxSearchTermAdCombinationView = aiMaxSearchTermAdCombinationView;
29
29
  exports.androidPrivacySharedKeyGoogleAdGroup = androidPrivacySharedKeyGoogleAdGroup;
30
30
  exports.androidPrivacySharedKeyGoogleCampaign = androidPrivacySharedKeyGoogleCampaign;
31
31
  exports.androidPrivacySharedKeyGoogleNetworkType = androidPrivacySharedKeyGoogleNetworkType;
32
+ exports.appTopCombinationView = appTopCombinationView;
32
33
  exports.appliedIncentive = appliedIncentive;
33
34
  exports.asset = asset;
34
35
  exports.assetFieldTypeView = assetFieldTypeView;
@@ -69,6 +70,7 @@ exports.campaignSearchTermView = campaignSearchTermView;
69
70
  exports.campaignSharedSet = campaignSharedSet;
70
71
  exports.campaignSimulation = campaignSimulation;
71
72
  exports.carrierConstant = carrierConstant;
73
+ exports.cartDataSalesView = cartDataSalesView;
72
74
  exports.changeEvent = changeEvent;
73
75
  exports.changeStatus = changeStatus;
74
76
  exports.channelAggregateAssetView = channelAggregateAssetView;
@@ -182,7 +184,9 @@ exports.userList = userList;
182
184
  exports.userListCustomerType = userListCustomerType;
183
185
  exports.userLocationView = userLocationView;
184
186
  exports.video = video;
187
+ exports.videoEnhancement = videoEnhancement;
185
188
  exports.webpageView = webpageView;
189
+ exports.youTubeVideoUpload = youTubeVideoUpload;
186
190
  /**
187
191
  * @param {string | number} customerId
188
192
  * @param {string | number} biddingStrategyId
@@ -481,6 +485,17 @@ function androidPrivacySharedKeyGoogleCampaign(customerId, campaignId, androidPr
481
485
  function androidPrivacySharedKeyGoogleNetworkType(customerId, campaignId, androidPrivacyInteractionType, androidPrivacyNetworkType, androidPrivacyInteractionDate) {
482
486
  return `customers/${customerId}/androidPrivacySharedKeyGoogleNetworkTypes/${campaignId}~${androidPrivacyInteractionType}~${androidPrivacyNetworkType}~${androidPrivacyInteractionDate}`;
483
487
  }
488
+ /**
489
+ * @param {string | number} customerId
490
+ * @param {string | number} adGroupId
491
+ * @param {string | number} adId
492
+ * @param {string | number} assetCombinationCategory
493
+ * @returns `AppTopCombinationViewResourceName`
494
+ * @example const appTopCombinationView: ResourceNames.AppTopCombinationViewResourceName = ResourceNames.appTopCombinationView(10987417, 21974834, 43949668, 87899336)
495
+ */
496
+ function appTopCombinationView(customerId, adGroupId, adId, assetCombinationCategory) {
497
+ return `customers/${customerId}/appTopCombinationViews/${adGroupId}~${adId}~${assetCombinationCategory}`;
498
+ }
484
499
  /**
485
500
  * @param {string | number} customerId
486
501
  * @param {string | number} couponCode
@@ -873,6 +888,14 @@ function campaignSimulation(customerId, campaignId, type, modificationMethod, st
873
888
  function carrierConstant(criterionId) {
874
889
  return `carrierConstants/${criterionId}`;
875
890
  }
891
+ /**
892
+ * @param {string | number} customerId
893
+ * @returns `CartDataSalesViewResourceName`
894
+ * @example const cartDataSalesView: ResourceNames.CartDataSalesViewResourceName = ResourceNames.cartDataSalesView(10987417)
895
+ */
896
+ function cartDataSalesView(customerId) {
897
+ return `customers/${customerId}/cartDataSalesView`;
898
+ }
876
899
  /**
877
900
  * @param {string | number} customerId
878
901
  * @param {string | number} timestampMicros
@@ -1929,6 +1952,15 @@ function userLocationView(customerId, countryCriterionId, isTargetingLocation) {
1929
1952
  function video(customerId, videoId) {
1930
1953
  return `customers/${customerId}/videos/${videoId}`;
1931
1954
  }
1955
+ /**
1956
+ * @param {string | number} customerId
1957
+ * @param {string | number} videoEnhancement
1958
+ * @returns `VideoEnhancementResourceName`
1959
+ * @example const videoEnhancement: ResourceNames.VideoEnhancementResourceName = ResourceNames.videoEnhancement(10987417, 21974834)
1960
+ */
1961
+ function videoEnhancement(customerId, videoEnhancement) {
1962
+ return `customers/${customerId}/videoEnhancements/${videoEnhancement}`;
1963
+ }
1932
1964
  /**
1933
1965
  * @param {string | number} customerId
1934
1966
  * @param {string | number} adGroupId
@@ -1939,3 +1971,12 @@ function video(customerId, videoId) {
1939
1971
  function webpageView(customerId, adGroupId, criterionId) {
1940
1972
  return `customers/${customerId}/webpageViews/${adGroupId}~${criterionId}`;
1941
1973
  }
1974
+ /**
1975
+ * @param {string | number} customerId
1976
+ * @param {string | number} videoUploadId
1977
+ * @returns `YouTubeVideoUploadResourceName`
1978
+ * @example const youTubeVideoUpload: ResourceNames.YouTubeVideoUploadResourceName = ResourceNames.youTubeVideoUpload(10987417, 21974834)
1979
+ */
1980
+ function youTubeVideoUpload(customerId, videoUploadId) {
1981
+ return `customers/${customerId}/youTubeVideoUploads/${videoUploadId}`;
1982
+ }