google-ads-api 8.0.0 → 9.0.0

package/build/src/protos/autogen/resourceNames.js

@@ -1,9 +1,9 @@
 "use strict";
 /* Autogenerated File! Do Not Edit */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.conversionCustomVariable = exports.conversionAction = exports.combinedAudience = exports.clickView = exports.changeStatus = exports.changeEvent = exports.carrierConstant = exports.campaignSimulation = exports.campaignSharedSet = exports.campaignLabel = exports.campaignFeed = exports.campaignExtensionSetting = exports.campaignExperiment = exports.campaignDraft = exports.campaignCriterionSimulation = exports.campaignCriterion = exports.campaignBudget = exports.campaignBidModifier = exports.campaignAudienceView = exports.campaignAsset = exports.campaign = exports.callView = exports.billingSetup = exports.biddingStrategySimulation = exports.biddingStrategy = exports.batchJob = exports.assetFieldTypeView = exports.asset = exports.ageRangeView = exports.adScheduleView = exports.adParameter = exports.adGroupSimulation = exports.adGroupLabel = exports.adGroupFeed = exports.adGroupExtensionSetting = exports.adGroupCriterionSimulation = exports.adGroupCriterionLabel = exports.adGroupCriterion = exports.adGroupBidModifier = exports.adGroupAudienceView = exports.adGroupAsset = exports.adGroupAdLabel = exports.adGroupAdAssetView = exports.adGroupAd = exports.adGroup = exports.ad = exports.accountLink = exports.accountBudgetProposal = exports.accountBudget = exports.accessibleBiddingStrategy = void 0;
-exports.locationView = exports.lifeEvent = 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.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.expandedLandingPageView = exports.dynamicSearchAdsSearchTermView = exports.domainCategory = exports.distanceView = exports.displayKeywordView = exports.detailedDemographic = exports.detailPlacementView = exports.customerUserAccessInvitation = exports.customerUserAccess = exports.customerNegativeCriterion = exports.customerManagerLink = exports.customerLabel = exports.customerFeed = exports.customerExtensionSetting = exports.customerClientLink = exports.customerClient = exports.customerAsset = exports.customer = exports.customInterest = exports.customAudience = exports.currencyConstant = void 0;
-exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = exports.smartCampaignSearchTermView = exports.shoppingPerformanceView = exports.sharedSet = exports.sharedCriterion = exports.searchTermView = exports.remarketingAction = exports.recommendation = exports.productGroupView = exports.productBiddingCategoryConstant = exports.paymentsAccount = exports.parentalStatusView = exports.paidOrganicSearchTermView = exports.operatingSystemVersionConstant = exports.offlineUserDataJob = exports.mobileDeviceConstant = exports.mobileAppCategoryConstant = exports.merchantCenterLink = exports.mediaFile = exports.managedPlacementView = void 0;
+exports.campaignDraft = exports.campaignCustomizer = exports.campaignCriterionSimulation = exports.campaignCriterion = exports.campaignConversionGoal = 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.assetSetAsset = exports.assetSet = 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.adGroupAsset = exports.adGroupAdLabel = exports.adGroupAdAssetView = exports.adGroupAd = exports.adGroup = exports.ad = exports.accountLink = exports.accountBudgetProposal = exports.accountBudget = exports.accessibleBiddingStrategy = void 0;
+exports.genderView = exports.feedPlaceholderView = exports.feedMapping = exports.feedItemTarget = exports.feedItemSetLink = exports.feedItemSet = exports.feedItem = exports.feed = exports.extensionFeedItem = 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.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.campaignFeed = exports.campaignExtensionSetting = exports.campaignExperiment = void 0;
+exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = exports.smartCampaignSearchTermView = exports.shoppingPerformanceView = exports.sharedSet = exports.sharedCriterion = exports.searchTermView = exports.remarketingAction = exports.recommendation = exports.productGroupView = exports.productBiddingCategoryConstant = 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.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 = void 0;
 /**
  * @param {string | number} customerId
  * @param {string | number} biddingStrategyId
@@ -145,6 +145,18 @@ function adGroupCriterion(customerId, adGroupId, criterionId) {
     return "customers/" + customerId + "/adGroupCriteria/" + adGroupId + "~" + criterionId;
 }
 exports.adGroupCriterion = adGroupCriterion;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} adGroupId
+ * @param {string | number} criterionId
+ * @param {string | number} customizerAttributeId
+ * @returns `AdGroupCriterionCustomizerResourceName`
+ * @example const adGroupCriterionCustomizer: ResourceNames.AdGroupCriterionCustomizerResourceName = ResourceNames.adGroupCriterionCustomizer(10987417, 21974834, 43949668, 87899336)
+ */
+function adGroupCriterionCustomizer(customerId, adGroupId, criterionId, customizerAttributeId) {
+    return "customers/" + customerId + "/adGroupCriterionCustomizers/" + adGroupId + "~" + criterionId + "~" + customizerAttributeId;
+}
+exports.adGroupCriterionCustomizer = adGroupCriterionCustomizer;
 /**
  * @param {string | number} customerId
  * @param {string | number} adGroupId
@@ -172,6 +184,17 @@ function adGroupCriterionSimulation(customerId, adGroupId, criterionId, type, mo
     return "customers/" + customerId + "/adGroupCriterionSimulations/" + adGroupId + "~" + criterionId + "~" + type + "~" + modificationMethod + "~" + startDate + "~" + endDate;
 }
 exports.adGroupCriterionSimulation = adGroupCriterionSimulation;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} adGroupId
+ * @param {string | number} customizerAttributeId
+ * @returns `AdGroupCustomizerResourceName`
+ * @example const adGroupCustomizer: ResourceNames.AdGroupCustomizerResourceName = ResourceNames.adGroupCustomizer(10987417, 21974834, 43949668)
+ */
+function adGroupCustomizer(customerId, adGroupId, customizerAttributeId) {
+    return "customers/" + customerId + "/adGroupCustomizers/" + adGroupId + "~" + customizerAttributeId;
+}
+exports.adGroupCustomizer = adGroupCustomizer;
 /**
  * @param {string | number} customerId
  * @param {string | number} adGroupId
@@ -273,6 +296,71 @@ function assetFieldTypeView(customerId, fieldType) {
     return "customers/" + customerId + "/assetFieldTypeViews/" + fieldType;
 }
 exports.assetFieldTypeView = assetFieldTypeView;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetGroupId
+ * @returns `AssetGroupResourceName`
+ * @example const assetGroup: ResourceNames.AssetGroupResourceName = ResourceNames.assetGroup(10987417, 21974834)
+ */
+function assetGroup(customerId, assetGroupId) {
+    return "customers/" + customerId + "/assetGroups/" + assetGroupId;
+}
+exports.assetGroup = assetGroup;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetGroupId
+ * @param {string | number} assetId
+ * @param {string | number} fieldType
+ * @returns `AssetGroupAssetResourceName`
+ * @example const assetGroupAsset: ResourceNames.AssetGroupAssetResourceName = ResourceNames.assetGroupAsset(10987417, 21974834, 43949668, 87899336)
+ */
+function assetGroupAsset(customerId, assetGroupId, assetId, fieldType) {
+    return "customers/" + customerId + "/assetGroupAssets/" + assetGroupId + "~" + assetId + "~" + fieldType;
+}
+exports.assetGroupAsset = assetGroupAsset;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetGroupId
+ * @param {string | number} listingGroupFilterId
+ * @returns `AssetGroupListingGroupFilterResourceName`
+ * @example const assetGroupListingGroupFilter: ResourceNames.AssetGroupListingGroupFilterResourceName = ResourceNames.assetGroupListingGroupFilter(10987417, 21974834, 43949668)
+ */
+function assetGroupListingGroupFilter(customerId, assetGroupId, listingGroupFilterId) {
+    return "customers/" + customerId + "/assetGroupListingGroupFilters/" + assetGroupId + "~" + listingGroupFilterId;
+}
+exports.assetGroupListingGroupFilter = assetGroupListingGroupFilter;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetGroupId
+ * @param {string | number} listingGroupFilterId
+ * @returns `AssetGroupProductGroupViewResourceName`
+ * @example const assetGroupProductGroupView: ResourceNames.AssetGroupProductGroupViewResourceName = ResourceNames.assetGroupProductGroupView(10987417, 21974834, 43949668)
+ */
+function assetGroupProductGroupView(customerId, assetGroupId, listingGroupFilterId) {
+    return "customers/" + customerId + "/assetGroupProductGroupViews/" + assetGroupId + "~" + listingGroupFilterId;
+}
+exports.assetGroupProductGroupView = assetGroupProductGroupView;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetSetId
+ * @returns `AssetSetResourceName`
+ * @example const assetSet: ResourceNames.AssetSetResourceName = ResourceNames.assetSet(10987417, 21974834)
+ */
+function assetSet(customerId, assetSetId) {
+    return "customers/" + customerId + "/assetSets/" + assetSetId;
+}
+exports.assetSet = assetSet;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetSetId
+ * @param {string | number} assetId
+ * @returns `AssetSetAssetResourceName`
+ * @example const assetSetAsset: ResourceNames.AssetSetAssetResourceName = ResourceNames.assetSetAsset(10987417, 21974834, 43949668)
+ */
+function assetSetAsset(customerId, assetSetId, assetId) {
+    return "customers/" + customerId + "/assetSetAssets/" + assetSetId + "~" + assetId;
+}
+exports.assetSetAsset = assetSetAsset;
 /**
  * @param {string | number} customerId
  * @param {string | number} batchJobId
@@ -283,6 +371,26 @@ function batchJob(customerId, batchJobId) {
     return "customers/" + customerId + "/batchJobs/" + batchJobId;
 }
 exports.batchJob = batchJob;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} seasonalityEventId
+ * @returns `BiddingDataExclusionResourceName`
+ * @example const biddingDataExclusion: ResourceNames.BiddingDataExclusionResourceName = ResourceNames.biddingDataExclusion(10987417, 21974834)
+ */
+function biddingDataExclusion(customerId, seasonalityEventId) {
+    return "customers/" + customerId + "/biddingDataExclusions/" + seasonalityEventId;
+}
+exports.biddingDataExclusion = biddingDataExclusion;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} seasonalityEventId
+ * @returns `BiddingSeasonalityAdjustmentResourceName`
+ * @example const biddingSeasonalityAdjustment: ResourceNames.BiddingSeasonalityAdjustmentResourceName = ResourceNames.biddingSeasonalityAdjustment(10987417, 21974834)
+ */
+function biddingSeasonalityAdjustment(customerId, seasonalityEventId) {
+    return "customers/" + customerId + "/biddingSeasonalityAdjustments/" + seasonalityEventId;
+}
+exports.biddingSeasonalityAdjustment = biddingSeasonalityAdjustment;
 /**
  * @param {string | number} customerId
  * @param {string | number} biddingStrategyId
@@ -349,6 +457,17 @@ function campaignAsset(customerId, campaignId, assetId, fieldType) {
     return "customers/" + customerId + "/campaignAssets/" + campaignId + "~" + assetId + "~" + fieldType;
 }
 exports.campaignAsset = campaignAsset;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} assetSetId
+ * @returns `CampaignAssetSetResourceName`
+ * @example const campaignAssetSet: ResourceNames.CampaignAssetSetResourceName = ResourceNames.campaignAssetSet(10987417, 21974834, 43949668)
+ */
+function campaignAssetSet(customerId, campaignId, assetSetId) {
+    return "customers/" + customerId + "/campaignAssetSets/" + campaignId + "~" + assetSetId;
+}
+exports.campaignAssetSet = campaignAssetSet;
 /**
  * @param {string | number} customerId
  * @param {string | number} campaignId
@@ -381,6 +500,18 @@ function campaignBudget(customerId, campaignBudgetId) {
     return "customers/" + customerId + "/campaignBudgets/" + campaignBudgetId;
 }
 exports.campaignBudget = campaignBudget;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} category
+ * @param {string | number} source
+ * @returns `CampaignConversionGoalResourceName`
+ * @example const campaignConversionGoal: ResourceNames.CampaignConversionGoalResourceName = ResourceNames.campaignConversionGoal(10987417, 21974834, 43949668, 87899336)
+ */
+function campaignConversionGoal(customerId, campaignId, category, source) {
+    return "customers/" + customerId + "/campaignConversionGoals/" + campaignId + "~" + category + "~" + source;
+}
+exports.campaignConversionGoal = campaignConversionGoal;
 /**
  * @param {string | number} customerId
  * @param {string | number} campaignId
@@ -407,6 +538,17 @@ function campaignCriterionSimulation(customerId, campaignId, criterionId, type,
     return "customers/" + customerId + "/campaignCriterionSimulations/" + campaignId + "~" + criterionId + "~" + type + "~" + modificationMethod + "~" + startDate + "~" + endDate;
 }
 exports.campaignCriterionSimulation = campaignCriterionSimulation;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} customizerAttributeId
+ * @returns `CampaignCustomizerResourceName`
+ * @example const campaignCustomizer: ResourceNames.CampaignCustomizerResourceName = ResourceNames.campaignCustomizer(10987417, 21974834, 43949668)
+ */
+function campaignCustomizer(customerId, campaignId, customizerAttributeId) {
+    return "customers/" + customerId + "/campaignCustomizers/" + campaignId + "~" + customizerAttributeId;
+}
+exports.campaignCustomizer = campaignCustomizer;
 /**
  * @param {string | number} customerId
  * @param {string | number} baseCampaignId
@@ -558,6 +700,36 @@ function conversionCustomVariable(customerId, conversionCustomVariableId) {
     return "customers/" + customerId + "/conversionCustomVariables/" + conversionCustomVariableId;
 }
 exports.conversionCustomVariable = conversionCustomVariable;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @returns `ConversionGoalCampaignConfigResourceName`
+ * @example const conversionGoalCampaignConfig: ResourceNames.ConversionGoalCampaignConfigResourceName = ResourceNames.conversionGoalCampaignConfig(10987417, 21974834)
+ */
+function conversionGoalCampaignConfig(customerId, campaignId) {
+    return "customers/" + customerId + "/conversionGoalCampaignConfigs/" + campaignId;
+}
+exports.conversionGoalCampaignConfig = conversionGoalCampaignConfig;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} conversionValueRuleId
+ * @returns `ConversionValueRuleResourceName`
+ * @example const conversionValueRule: ResourceNames.ConversionValueRuleResourceName = ResourceNames.conversionValueRule(10987417, 21974834)
+ */
+function conversionValueRule(customerId, conversionValueRuleId) {
+    return "customers/" + customerId + "/conversionValueRules/" + conversionValueRuleId;
+}
+exports.conversionValueRule = conversionValueRule;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} conversionValueRuleSetId
+ * @returns `ConversionValueRuleSetResourceName`
+ * @example const conversionValueRuleSet: ResourceNames.ConversionValueRuleSetResourceName = ResourceNames.conversionValueRuleSet(10987417, 21974834)
+ */
+function conversionValueRuleSet(customerId, conversionValueRuleSetId) {
+    return "customers/" + customerId + "/conversionValueRuleSets/" + conversionValueRuleSetId;
+}
+exports.conversionValueRuleSet = conversionValueRuleSet;
 /**
  * @param {string | number} code
  * @returns `CurrencyConstantResourceName`
@@ -577,6 +749,16 @@ function customAudience(customerId, customAudienceId) {
     return "customers/" + customerId + "/customAudiences/" + customAudienceId;
 }
 exports.customAudience = customAudience;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} goalId
+ * @returns `CustomConversionGoalResourceName`
+ * @example const customConversionGoal: ResourceNames.CustomConversionGoalResourceName = ResourceNames.customConversionGoal(10987417, 21974834)
+ */
+function customConversionGoal(customerId, goalId) {
+    return "customers/" + customerId + "/customConversionGoals/" + goalId;
+}
+exports.customConversionGoal = customConversionGoal;
 /**
  * @param {string | number} customerId
  * @param {string | number} customInterestId
@@ -628,6 +810,27 @@ function customerClientLink(customerId, clientCustomerId, managerLinkId) {
     return "customers/" + customerId + "/customerClientLinks/" + clientCustomerId + "~" + managerLinkId;
 }
 exports.customerClientLink = customerClientLink;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} category
+ * @param {string | number} source
+ * @returns `CustomerConversionGoalResourceName`
+ * @example const customerConversionGoal: ResourceNames.CustomerConversionGoalResourceName = ResourceNames.customerConversionGoal(10987417, 21974834, 43949668)
+ */
+function customerConversionGoal(customerId, category, source) {
+    return "customers/" + customerId + "/customerConversionGoals/" + category + "~" + source;
+}
+exports.customerConversionGoal = customerConversionGoal;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} customizerAttributeId
+ * @returns `CustomerCustomizerResourceName`
+ * @example const customerCustomizer: ResourceNames.CustomerCustomizerResourceName = ResourceNames.customerCustomizer(10987417, 21974834)
+ */
+function customerCustomizer(customerId, customizerAttributeId) {
+    return "customers/" + customerId + "/customerCustomizers/" + customizerAttributeId;
+}
+exports.customerCustomizer = customerCustomizer;
 /**
  * @param {string | number} customerId
  * @param {string | number} extensionType
@@ -699,6 +902,16 @@ function customerUserAccessInvitation(customerId, invitationId) {
     return "customers/" + customerId + "/customerUserAccessInvitations/" + invitationId;
 }
 exports.customerUserAccessInvitation = customerUserAccessInvitation;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} customizerAttributeId
+ * @returns `CustomizerAttributeResourceName`
+ * @example const customizerAttribute: ResourceNames.CustomizerAttributeResourceName = ResourceNames.customizerAttribute(10987417, 21974834)
+ */
+function customizerAttribute(customerId, customizerAttributeId) {
+    return "customers/" + customerId + "/customizerAttributes/" + customizerAttributeId;
+}
+exports.customizerAttribute = customizerAttribute;
 /**
  * @param {string | number} customerId
  * @param {string | number} adGroupId
@@ -937,6 +1150,16 @@ function hotelPerformanceView(customerId) {
     return "customers/" + customerId + "/hotelPerformanceView";
 }
 exports.hotelPerformanceView = hotelPerformanceView;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} commissionId
+ * @returns `HotelReconciliationResourceName`
+ * @example const hotelReconciliation: ResourceNames.HotelReconciliationResourceName = ResourceNames.hotelReconciliation(10987417, 21974834)
+ */
+function hotelReconciliation(customerId, commissionId) {
+    return "customers/" + customerId + "/hotelReconciliations/" + commissionId;
+}
+exports.hotelReconciliation = hotelReconciliation;
 /**
  * @param {string | number} customerId
  * @param {string | number} adGroupId