google-ads-api 13.0.0 → 14.1.0-beta-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.
@@ -58,13 +58,13 @@ var fields;
58
58
  "campaign_budget.resource_name",
59
59
  "campaign_conversion_goal.resource_name",
60
60
  "campaign_criterion.resource_name",
61
- "campaign_criterion_simulation.resource_name",
62
61
  "campaign_customizer.resource_name",
63
62
  "campaign_draft.resource_name",
64
63
  "campaign_extension_setting.resource_name",
65
64
  "campaign_feed.resource_name",
66
65
  "campaign_group.resource_name",
67
66
  "campaign_label.resource_name",
67
+ "campaign_search_term_insight.resource_name",
68
68
  "campaign_shared_set.resource_name",
69
69
  "campaign_simulation.resource_name",
70
70
  "carrier_constant.resource_name",
@@ -93,6 +93,7 @@ var fields;
93
93
  "customer_label.resource_name",
94
94
  "customer_manager_link.resource_name",
95
95
  "customer_negative_criterion.resource_name",
96
+ "customer_search_term_insight.resource_name",
96
97
  "customer_user_access.resource_name",
97
98
  "customer_user_access_invitation.resource_name",
98
99
  "customizer_attribute.resource_name",
@@ -269,11 +270,15 @@ var fields;
269
270
  "asset.type": "AssetType",
270
271
  "asset_field_type_view.field_type": "AssetFieldType",
271
272
  "asset_group.ad_strength": "AdStrength",
273
+ "asset_group.primary_status": "AssetGroupPrimaryStatus",
274
+ "asset_group.primary_status_reasons": "AssetGroupPrimaryStatusReason",
272
275
  "asset_group.status": "AssetGroupStatus",
273
276
  "asset_group_asset.field_type": "AssetFieldType",
274
277
  "asset_group_asset.performance_label": "AssetPerformanceLabel",
275
278
  "asset_group_asset.policy_summary.approval_status": "PolicyApprovalStatus",
276
279
  "asset_group_asset.policy_summary.review_status": "PolicyReviewStatus",
280
+ "asset_group_asset.primary_status": "AssetLinkPrimaryStatus",
281
+ "asset_group_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
277
282
  "asset_group_asset.status": "AssetLinkStatus",
278
283
  "asset_group_listing_group_filter.case_value.product_bidding_category.level": "ListingGroupFilterBiddingCategoryLevel",
279
284
  "asset_group_listing_group_filter.case_value.product_channel.channel": "ListingGroupFilterProductChannel",
@@ -321,6 +326,7 @@ var fields;
321
326
  "campaign.experiment_type": "CampaignExperimentType",
322
327
  "campaign.geo_target_type_setting.negative_geo_target_type": "NegativeGeoTargetType",
323
328
  "campaign.geo_target_type_setting.positive_geo_target_type": "PositiveGeoTargetType",
329
+ "campaign.listing_type": "ListingType",
324
330
  "campaign.local_campaign_setting.location_source_type": "LocationSourceType",
325
331
  "campaign.optimization_goal_setting.optimization_goal_types": "OptimizationGoalType",
326
332
  "campaign.payment_mode": "PaymentMode",
@@ -360,8 +366,6 @@ var fields;
360
366
  "campaign_criterion.proximity.radius_units": "ProximityRadiusUnits",
361
367
  "campaign_criterion.status": "CampaignCriterionStatus",
362
368
  "campaign_criterion.type": "CriterionType",
363
- "campaign_criterion_simulation.modification_method": "SimulationModificationMethod",
364
- "campaign_criterion_simulation.type": "SimulationType",
365
369
  "campaign_customizer.status": "CustomizerValueStatus",
366
370
  "campaign_customizer.value.type": "CustomizerAttributeType",
367
371
  "campaign_draft.status": "CampaignDraftStatus",
@@ -507,6 +511,7 @@ var fields;
507
511
  "segments.hotel_rate_type": "HotelRateType",
508
512
  "segments.keyword.info.match_type": "KeywordMatchType",
509
513
  "segments.month_of_year": "MonthOfYear",
514
+ "segments.new_versus_returning_customers": "ConvertingUserPriorEngagementTypeAndLtvBucket",
510
515
  "segments.placeholder_type": "PlaceholderType",
511
516
  "segments.product_channel": "ProductChannel",
512
517
  "segments.product_channel_exclusivity": "ProductChannelExclusivity",
@@ -469,19 +469,6 @@ export declare type CampaignCriterionResourceName = `customers/${StrNum}/campaig
469
469
  * @example const campaignCriterion: ResourceNames.CampaignCriterionResourceName = ResourceNames.campaignCriterion(10987417, 21974834, 43949668)
470
470
  */
471
471
  export declare function campaignCriterion(customerId: string | number, campaignId: string | number, criterionId: string | number): CampaignCriterionResourceName;
472
- export declare type CampaignCriterionSimulationResourceName = `customers/${StrNum}/campaignCriterionSimulations/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
473
- /**
474
- * @param {string | number} customerId
475
- * @param {string | number} campaignId
476
- * @param {string | number} criterionId
477
- * @param {string | number} type
478
- * @param {string | number} modificationMethod
479
- * @param {string | number} startDate
480
- * @param {string | number} endDate
481
- * @returns `CampaignCriterionSimulationResourceName`
482
- * @example const campaignCriterionSimulation: ResourceNames.CampaignCriterionSimulationResourceName = ResourceNames.campaignCriterionSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344, 703194688)
483
- */
484
- export declare function campaignCriterionSimulation(customerId: string | number, campaignId: string | number, criterionId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): CampaignCriterionSimulationResourceName;
485
472
  export declare type CampaignCustomizerResourceName = `customers/${StrNum}/campaignCustomizers/${StrNum}~${StrNum}`;
486
473
  /**
487
474
  * @param {string | number} customerId
@@ -535,6 +522,15 @@ export declare type CampaignLabelResourceName = `customers/${StrNum}/campaignLab
535
522
  * @example const campaignLabel: ResourceNames.CampaignLabelResourceName = ResourceNames.campaignLabel(10987417, 21974834, 43949668)
536
523
  */
537
524
  export declare function campaignLabel(customerId: string | number, campaignId: string | number, labelId: string | number): CampaignLabelResourceName;
525
+ export declare type CampaignSearchTermInsightResourceName = `customers/${StrNum}/campaignSearchTermInsights/${StrNum}~${StrNum}`;
526
+ /**
527
+ * @param {string | number} customerId
528
+ * @param {string | number} campaignId
529
+ * @param {string | number} clusterId
530
+ * @returns `CampaignSearchTermInsightResourceName`
531
+ * @example const campaignSearchTermInsight: ResourceNames.CampaignSearchTermInsightResourceName = ResourceNames.campaignSearchTermInsight(10987417, 21974834, 43949668)
532
+ */
533
+ export declare function campaignSearchTermInsight(customerId: string | number, campaignId: string | number, clusterId: string | number): CampaignSearchTermInsightResourceName;
538
534
  export declare type CampaignSharedSetResourceName = `customers/${StrNum}/campaignSharedSets/${StrNum}~${StrNum}`;
539
535
  /**
540
536
  * @param {string | number} customerId
@@ -768,6 +764,22 @@ export declare type CustomerNegativeCriterionResourceName = `customers/${StrNum}
768
764
  * @example const customerNegativeCriterion: ResourceNames.CustomerNegativeCriterionResourceName = ResourceNames.customerNegativeCriterion(10987417, 21974834)
769
765
  */
770
766
  export declare function customerNegativeCriterion(customerId: string | number, criterionId: string | number): CustomerNegativeCriterionResourceName;
767
+ export declare type CustomerSearchTermInsightResourceName = `customers/${StrNum}/customerSearchTermInsights/${StrNum}`;
768
+ /**
769
+ * @param {string | number} customerId
770
+ * @param {string | number} clusterId
771
+ * @returns `CustomerSearchTermInsightResourceName`
772
+ * @example const customerSearchTermInsight: ResourceNames.CustomerSearchTermInsightResourceName = ResourceNames.customerSearchTermInsight(10987417, 21974834)
773
+ */
774
+ export declare function customerSearchTermInsight(customerId: string | number, clusterId: string | number): CustomerSearchTermInsightResourceName;
775
+ export declare type CustomerSkAdNetworkConversionValueSchemaResourceName = `customers/${StrNum}/customerSkAdNetworkConversionValueSchemas/${StrNum}`;
776
+ /**
777
+ * @param {string | number} customerId
778
+ * @param {string | number} accountLinkId
779
+ * @returns `CustomerSkAdNetworkConversionValueSchemaResourceName`
780
+ * @example const customerSkAdNetworkConversionValueSchema: ResourceNames.CustomerSkAdNetworkConversionValueSchemaResourceName = ResourceNames.customerSkAdNetworkConversionValueSchema(10987417, 21974834)
781
+ */
782
+ export declare function customerSkAdNetworkConversionValueSchema(customerId: string | number, accountLinkId: string | number): CustomerSkAdNetworkConversionValueSchemaResourceName;
771
783
  export declare type CustomerUserAccessResourceName = `customers/${StrNum}/customerUserAccesses/${StrNum}`;
772
784
  /**
773
785
  * @param {string | number} customerId
@@ -2,9 +2,9 @@
2
2
  /* Autogenerated File! Do Not Edit */
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.campaignBudget = exports.campaignBidModifier = exports.campaignAudienceView = exports.campaignAssetSet = exports.campaignAsset = exports.campaign = exports.callView = exports.billingSetup = exports.biddingStrategySimulation = exports.biddingStrategy = exports.biddingSeasonalityAdjustment = exports.biddingDataExclusion = exports.batchJob = exports.audience = exports.assetSetTypeView = exports.assetSetAsset = exports.assetSet = exports.assetGroupSignal = exports.assetGroupProductGroupView = exports.assetGroupListingGroupFilter = exports.assetGroupAsset = exports.assetGroup = exports.assetFieldTypeView = exports.asset = exports.ageRangeView = exports.adScheduleView = exports.adParameter = exports.adGroupSimulation = exports.adGroupLabel = exports.adGroupFeed = exports.adGroupExtensionSetting = exports.adGroupCustomizer = exports.adGroupCriterionSimulation = exports.adGroupCriterionLabel = exports.adGroupCriterionCustomizer = exports.adGroupCriterion = exports.adGroupBidModifier = exports.adGroupAudienceView = exports.adGroupAssetSet = exports.adGroupAsset = exports.adGroupAdLabel = exports.adGroupAdAssetView = exports.adGroupAdAssetCombinationView = exports.adGroupAd = exports.adGroup = exports.ad = exports.accountLink = exports.accountBudgetProposal = exports.accountBudget = exports.accessibleBiddingStrategy = void 0;
5
- exports.extensionFeedItem = exports.experimentArm = exports.experiment = exports.expandedLandingPageView = exports.dynamicSearchAdsSearchTermView = exports.domainCategory = exports.distanceView = exports.displayKeywordView = exports.detailedDemographic = exports.detailPlacementView = exports.customizerAttribute = exports.customerUserAccessInvitation = exports.customerUserAccess = exports.customerNegativeCriterion = exports.customerManagerLink = exports.customerLabel = exports.customerFeed = exports.customerExtensionSetting = exports.customerCustomizer = exports.customerConversionGoal = exports.customerClientLink = exports.customerClient = exports.customerAssetSet = exports.customerAsset = exports.customer = exports.customInterest = exports.customConversionGoal = exports.customAudience = exports.currencyConstant = exports.conversionValueRuleSet = exports.conversionValueRule = exports.conversionGoalCampaignConfig = exports.conversionCustomVariable = exports.conversionAction = exports.combinedAudience = exports.clickView = exports.changeStatus = exports.changeEvent = exports.carrierConstant = exports.campaignSimulation = exports.campaignSharedSet = exports.campaignLabel = exports.campaignGroup = exports.campaignFeed = exports.campaignExtensionSetting = exports.campaignDraft = exports.campaignCustomizer = exports.campaignCriterionSimulation = exports.campaignCriterion = exports.campaignConversionGoal = void 0;
6
- exports.sharedSet = exports.sharedCriterion = exports.searchTermView = exports.remarketingAction = exports.recommendation = exports.qualifyingQuestion = exports.productLink = exports.productGroupView = exports.productBiddingCategoryConstant = exports.perStoreView = exports.paymentsAccount = exports.parentalStatusView = exports.paidOrganicSearchTermView = exports.operatingSystemVersionConstant = exports.offlineUserDataJob = exports.mobileDeviceConstant = exports.mobileAppCategoryConstant = exports.merchantCenterLink = exports.mediaFile = exports.managedPlacementView = exports.locationView = exports.lifeEvent = exports.leadFormSubmissionData = exports.languageConstant = exports.landingPageView = exports.label = exports.keywordView = exports.keywordThemeConstant = exports.keywordPlanCampaignKeyword = exports.keywordPlanCampaign = exports.keywordPlanAdGroupKeyword = exports.keywordPlanAdGroup = exports.keywordPlan = exports.invoice = exports.incomeRangeView = exports.hotelReconciliation = exports.hotelPerformanceView = exports.hotelGroupView = exports.groupPlacementView = exports.googleAdsField = exports.geographicView = exports.geoTargetConstant = exports.genderView = exports.feedPlaceholderView = exports.feedMapping = exports.feedItemTarget = exports.feedItemSetLink = exports.feedItemSet = exports.feedItem = exports.feed = void 0;
7
- exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.travelActivityPerformanceView = exports.travelActivityGroupView = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = exports.smartCampaignSearchTermView = exports.shoppingPerformanceView = void 0;
5
+ exports.experiment = exports.expandedLandingPageView = exports.dynamicSearchAdsSearchTermView = exports.domainCategory = exports.distanceView = exports.displayKeywordView = exports.detailedDemographic = exports.detailPlacementView = exports.customizerAttribute = exports.customerUserAccessInvitation = exports.customerUserAccess = exports.customerSkAdNetworkConversionValueSchema = exports.customerSearchTermInsight = exports.customerNegativeCriterion = exports.customerManagerLink = exports.customerLabel = exports.customerFeed = exports.customerExtensionSetting = exports.customerCustomizer = exports.customerConversionGoal = exports.customerClientLink = exports.customerClient = exports.customerAssetSet = exports.customerAsset = exports.customer = exports.customInterest = exports.customConversionGoal = exports.customAudience = exports.currencyConstant = exports.conversionValueRuleSet = exports.conversionValueRule = exports.conversionGoalCampaignConfig = exports.conversionCustomVariable = exports.conversionAction = exports.combinedAudience = exports.clickView = exports.changeStatus = exports.changeEvent = exports.carrierConstant = exports.campaignSimulation = exports.campaignSharedSet = exports.campaignSearchTermInsight = exports.campaignLabel = exports.campaignGroup = exports.campaignFeed = exports.campaignExtensionSetting = exports.campaignDraft = exports.campaignCustomizer = exports.campaignCriterion = exports.campaignConversionGoal = void 0;
6
+ exports.searchTermView = exports.remarketingAction = exports.recommendation = exports.qualifyingQuestion = exports.productLink = exports.productGroupView = exports.productBiddingCategoryConstant = exports.perStoreView = exports.paymentsAccount = exports.parentalStatusView = exports.paidOrganicSearchTermView = exports.operatingSystemVersionConstant = exports.offlineUserDataJob = exports.mobileDeviceConstant = exports.mobileAppCategoryConstant = exports.merchantCenterLink = exports.mediaFile = exports.managedPlacementView = exports.locationView = exports.lifeEvent = exports.leadFormSubmissionData = exports.languageConstant = exports.landingPageView = exports.label = exports.keywordView = exports.keywordThemeConstant = exports.keywordPlanCampaignKeyword = exports.keywordPlanCampaign = exports.keywordPlanAdGroupKeyword = exports.keywordPlanAdGroup = exports.keywordPlan = exports.invoice = exports.incomeRangeView = exports.hotelReconciliation = exports.hotelPerformanceView = exports.hotelGroupView = exports.groupPlacementView = exports.googleAdsField = exports.geographicView = exports.geoTargetConstant = exports.genderView = exports.feedPlaceholderView = exports.feedMapping = exports.feedItemTarget = exports.feedItemSetLink = exports.feedItemSet = exports.feedItem = exports.feed = exports.extensionFeedItem = exports.experimentArm = void 0;
7
+ exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.travelActivityPerformanceView = exports.travelActivityGroupView = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = exports.smartCampaignSearchTermView = exports.shoppingPerformanceView = exports.sharedSet = exports.sharedCriterion = void 0;
8
8
  /**
9
9
  * @param {string | number} customerId
10
10
  * @param {string | number} biddingStrategyId
@@ -579,21 +579,6 @@ function campaignCriterion(customerId, campaignId, criterionId) {
579
579
  return `customers/${customerId}/campaignCriteria/${campaignId}~${criterionId}`;
580
580
  }
581
581
  exports.campaignCriterion = campaignCriterion;
582
- /**
583
- * @param {string | number} customerId
584
- * @param {string | number} campaignId
585
- * @param {string | number} criterionId
586
- * @param {string | number} type
587
- * @param {string | number} modificationMethod
588
- * @param {string | number} startDate
589
- * @param {string | number} endDate
590
- * @returns `CampaignCriterionSimulationResourceName`
591
- * @example const campaignCriterionSimulation: ResourceNames.CampaignCriterionSimulationResourceName = ResourceNames.campaignCriterionSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344, 703194688)
592
- */
593
- function campaignCriterionSimulation(customerId, campaignId, criterionId, type, modificationMethod, startDate, endDate) {
594
- return `customers/${customerId}/campaignCriterionSimulations/${campaignId}~${criterionId}~${type}~${modificationMethod}~${startDate}~${endDate}`;
595
- }
596
- exports.campaignCriterionSimulation = campaignCriterionSimulation;
597
582
  /**
598
583
  * @param {string | number} customerId
599
584
  * @param {string | number} campaignId
@@ -659,6 +644,17 @@ function campaignLabel(customerId, campaignId, labelId) {
659
644
  return `customers/${customerId}/campaignLabels/${campaignId}~${labelId}`;
660
645
  }
661
646
  exports.campaignLabel = campaignLabel;
647
+ /**
648
+ * @param {string | number} customerId
649
+ * @param {string | number} campaignId
650
+ * @param {string | number} clusterId
651
+ * @returns `CampaignSearchTermInsightResourceName`
652
+ * @example const campaignSearchTermInsight: ResourceNames.CampaignSearchTermInsightResourceName = ResourceNames.campaignSearchTermInsight(10987417, 21974834, 43949668)
653
+ */
654
+ function campaignSearchTermInsight(customerId, campaignId, clusterId) {
655
+ return `customers/${customerId}/campaignSearchTermInsights/${campaignId}~${clusterId}`;
656
+ }
657
+ exports.campaignSearchTermInsight = campaignSearchTermInsight;
662
658
  /**
663
659
  * @param {string | number} customerId
664
660
  * @param {string | number} campaignId
@@ -948,6 +944,26 @@ function customerNegativeCriterion(customerId, criterionId) {
948
944
  return `customers/${customerId}/customerNegativeCriteria/${criterionId}`;
949
945
  }
950
946
  exports.customerNegativeCriterion = customerNegativeCriterion;
947
+ /**
948
+ * @param {string | number} customerId
949
+ * @param {string | number} clusterId
950
+ * @returns `CustomerSearchTermInsightResourceName`
951
+ * @example const customerSearchTermInsight: ResourceNames.CustomerSearchTermInsightResourceName = ResourceNames.customerSearchTermInsight(10987417, 21974834)
952
+ */
953
+ function customerSearchTermInsight(customerId, clusterId) {
954
+ return `customers/${customerId}/customerSearchTermInsights/${clusterId}`;
955
+ }
956
+ exports.customerSearchTermInsight = customerSearchTermInsight;
957
+ /**
958
+ * @param {string | number} customerId
959
+ * @param {string | number} accountLinkId
960
+ * @returns `CustomerSkAdNetworkConversionValueSchemaResourceName`
961
+ * @example const customerSkAdNetworkConversionValueSchema: ResourceNames.CustomerSkAdNetworkConversionValueSchemaResourceName = ResourceNames.customerSkAdNetworkConversionValueSchema(10987417, 21974834)
962
+ */
963
+ function customerSkAdNetworkConversionValueSchema(customerId, accountLinkId) {
964
+ return `customers/${customerId}/customerSkAdNetworkConversionValueSchemas/${accountLinkId}`;
965
+ }
966
+ exports.customerSkAdNetworkConversionValueSchema = customerSkAdNetworkConversionValueSchema;
951
967
  /**
952
968
  * @param {string | number} customerId
953
969
  * @param {string | number} userId