google-ads-api 21.0.1 → 22.0.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.
@@ -533,6 +533,15 @@ export type CampaignDraftResourceName = `customers/${StrNum}/campaignDrafts/${St
533
533
  * @example const campaignDraft: ResourceNames.CampaignDraftResourceName = ResourceNames.campaignDraft(10987417, 21974834, 43949668)
534
534
  */
535
535
  export declare function campaignDraft(customerId: string | number, baseCampaignId: string | number, draftId: string | number): CampaignDraftResourceName;
536
+ export type CampaignGoalConfigResourceName = `customers/${StrNum}/campaignGoalConfigs/${StrNum}~${StrNum}`;
537
+ /**
538
+ * @param {string | number} customerId
539
+ * @param {string | number} campaignId
540
+ * @param {string | number} unifiedGoalId
541
+ * @returns `CampaignGoalConfigResourceName`
542
+ * @example const campaignGoalConfig: ResourceNames.CampaignGoalConfigResourceName = ResourceNames.campaignGoalConfig(10987417, 21974834, 43949668)
543
+ */
544
+ export declare function campaignGoalConfig(customerId: string | number, campaignId: string | number, unifiedGoalId: string | number): CampaignGoalConfigResourceName;
536
545
  export type CampaignGroupResourceName = `customers/${StrNum}/campaignGroups/${StrNum}`;
537
546
  /**
538
547
  * @param {string | number} customerId
@@ -995,6 +1004,14 @@ export type GeographicViewResourceName = `customers/${StrNum}/geographicViews/${
995
1004
  * @example const geographicView: ResourceNames.GeographicViewResourceName = ResourceNames.geographicView(10987417, 21974834, 43949668)
996
1005
  */
997
1006
  export declare function geographicView(customerId: string | number, countryCriterionId: string | number, locationType: string | number): GeographicViewResourceName;
1007
+ export type GoalResourceName = `customers/${StrNum}/goals/${StrNum}`;
1008
+ /**
1009
+ * @param {string | number} customerId
1010
+ * @param {string | number} unifiedGoalId
1011
+ * @returns `GoalResourceName`
1012
+ * @example const goal: ResourceNames.GoalResourceName = ResourceNames.goal(10987417, 21974834)
1013
+ */
1014
+ export declare function goal(customerId: string | number, unifiedGoalId: string | number): GoalResourceName;
998
1015
  export type GoogleAdsFieldResourceName = `googleAdsFields/${StrNum}`;
999
1016
  /**
1000
1017
  * @param {string | number} googleAdsField
@@ -1440,6 +1457,15 @@ export type SmartCampaignSettingResourceName = `customers/${StrNum}/smartCampaig
1440
1457
  * @example const smartCampaignSetting: ResourceNames.SmartCampaignSettingResourceName = ResourceNames.smartCampaignSetting(10987417, 21974834)
1441
1458
  */
1442
1459
  export declare function smartCampaignSetting(customerId: string | number, campaignId: string | number): SmartCampaignSettingResourceName;
1460
+ export type TargetingExpansionViewResourceName = `customers/${StrNum}/targetingExpansionViews/${StrNum}~${StrNum}`;
1461
+ /**
1462
+ * @param {string | number} customerId
1463
+ * @param {string | number} campaignId
1464
+ * @param {string | number} targetingExpansionType
1465
+ * @returns `TargetingExpansionViewResourceName`
1466
+ * @example const targetingExpansionView: ResourceNames.TargetingExpansionViewResourceName = ResourceNames.targetingExpansionView(10987417, 21974834, 43949668)
1467
+ */
1468
+ export declare function targetingExpansionView(customerId: string | number, campaignId: string | number, targetingExpansionType: string | number): TargetingExpansionViewResourceName;
1443
1469
  export type ThirdPartyAppAnalyticsLinkResourceName = `customers/${StrNum}/thirdPartyAppAnalyticsLinks/${StrNum}`;
1444
1470
  /**
1445
1471
  * @param {string | number} customerId
@@ -59,6 +59,7 @@ exports.campaignConversionGoal = campaignConversionGoal;
59
59
  exports.campaignCriterion = campaignCriterion;
60
60
  exports.campaignCustomizer = campaignCustomizer;
61
61
  exports.campaignDraft = campaignDraft;
62
+ exports.campaignGoalConfig = campaignGoalConfig;
62
63
  exports.campaignGroup = campaignGroup;
63
64
  exports.campaignLabel = campaignLabel;
64
65
  exports.campaignLifecycleGoal = campaignLifecycleGoal;
@@ -113,6 +114,7 @@ exports.finalUrlExpansionAssetView = finalUrlExpansionAssetView;
113
114
  exports.genderView = genderView;
114
115
  exports.geoTargetConstant = geoTargetConstant;
115
116
  exports.geographicView = geographicView;
117
+ exports.goal = goal;
116
118
  exports.googleAdsField = googleAdsField;
117
119
  exports.groupContentSuitabilityPlacementView = groupContentSuitabilityPlacementView;
118
120
  exports.groupPlacementView = groupPlacementView;
@@ -167,6 +169,7 @@ exports.shoppingPerformanceView = shoppingPerformanceView;
167
169
  exports.shoppingProduct = shoppingProduct;
168
170
  exports.smartCampaignSearchTermView = smartCampaignSearchTermView;
169
171
  exports.smartCampaignSetting = smartCampaignSetting;
172
+ exports.targetingExpansionView = targetingExpansionView;
170
173
  exports.thirdPartyAppAnalyticsLink = thirdPartyAppAnalyticsLink;
171
174
  exports.topicConstant = topicConstant;
172
175
  exports.topicView = topicView;
@@ -770,6 +773,16 @@ function campaignCustomizer(customerId, campaignId, customizerAttributeId) {
770
773
  function campaignDraft(customerId, baseCampaignId, draftId) {
771
774
  return `customers/${customerId}/campaignDrafts/${baseCampaignId}~${draftId}`;
772
775
  }
776
+ /**
777
+ * @param {string | number} customerId
778
+ * @param {string | number} campaignId
779
+ * @param {string | number} unifiedGoalId
780
+ * @returns `CampaignGoalConfigResourceName`
781
+ * @example const campaignGoalConfig: ResourceNames.CampaignGoalConfigResourceName = ResourceNames.campaignGoalConfig(10987417, 21974834, 43949668)
782
+ */
783
+ function campaignGoalConfig(customerId, campaignId, unifiedGoalId) {
784
+ return `customers/${customerId}/campaignGoalConfigs/${campaignId}~${unifiedGoalId}`;
785
+ }
773
786
  /**
774
787
  * @param {string | number} customerId
775
788
  * @param {string | number} campaignGroupId
@@ -1286,6 +1299,15 @@ function geoTargetConstant(criterionId) {
1286
1299
  function geographicView(customerId, countryCriterionId, locationType) {
1287
1300
  return `customers/${customerId}/geographicViews/${countryCriterionId}~${locationType}`;
1288
1301
  }
1302
+ /**
1303
+ * @param {string | number} customerId
1304
+ * @param {string | number} unifiedGoalId
1305
+ * @returns `GoalResourceName`
1306
+ * @example const goal: ResourceNames.GoalResourceName = ResourceNames.goal(10987417, 21974834)
1307
+ */
1308
+ function goal(customerId, unifiedGoalId) {
1309
+ return `customers/${customerId}/goals/${unifiedGoalId}`;
1310
+ }
1289
1311
  /**
1290
1312
  * @param {string | number} googleAdsField
1291
1313
  * @returns `GoogleAdsFieldResourceName`
@@ -1785,6 +1807,16 @@ function smartCampaignSearchTermView(customerId, campaignId, query) {
1785
1807
  function smartCampaignSetting(customerId, campaignId) {
1786
1808
  return `customers/${customerId}/smartCampaignSettings/${campaignId}`;
1787
1809
  }
1810
+ /**
1811
+ * @param {string | number} customerId
1812
+ * @param {string | number} campaignId
1813
+ * @param {string | number} targetingExpansionType
1814
+ * @returns `TargetingExpansionViewResourceName`
1815
+ * @example const targetingExpansionView: ResourceNames.TargetingExpansionViewResourceName = ResourceNames.targetingExpansionView(10987417, 21974834, 43949668)
1816
+ */
1817
+ function targetingExpansionView(customerId, campaignId, targetingExpansionType) {
1818
+ return `customers/${customerId}/targetingExpansionViews/${campaignId}~${targetingExpansionType}`;
1819
+ }
1788
1820
  /**
1789
1821
  * @param {string | number} customerId
1790
1822
  * @param {string | number} customerLinkId