google-ads-api 14.2.0 → 16.0.0

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

@@ -1,10 +1,10 @@
 "use strict";
 /* Autogenerated File! Do Not Edit */
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
-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;
-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;
-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;
+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.assetGroupTopCombinationView = exports.assetGroupSignal = exports.assetGroupProductGroupView = exports.assetGroupListingGroupFilter = exports.assetGroupAsset = exports.assetGroup = exports.assetFieldTypeView = exports.asset = exports.androidPrivacySharedKeyGoogleNetworkType = exports.androidPrivacySharedKeyGoogleCampaign = exports.androidPrivacySharedKeyGoogleAdGroup = 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;
+exports.detailedDemographic = exports.detailPlacementView = exports.customizerAttribute = exports.customerUserAccessInvitation = exports.customerUserAccess = exports.customerSkAdNetworkConversionValueSchema = exports.customerSearchTermInsight = exports.customerNegativeCriterion = exports.customerManagerLink = exports.customerLifecycleGoal = 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.campaignLifecycleGoal = exports.campaignLabel = exports.campaignGroup = exports.campaignFeed = exports.campaignExtensionSetting = exports.campaignDraft = exports.campaignCustomizer = exports.campaignCriterion = exports.campaignConversionGoal = exports.campaignBudget = exports.campaignBidModifier = exports.campaignAudienceView = exports.campaignAssetSet = void 0;
+exports.paidOrganicSearchTermView = exports.operatingSystemVersionConstant = exports.offlineUserDataJob = exports.offlineConversionUploadClientSummary = exports.mobileDeviceConstant = exports.mobileAppCategoryConstant = exports.mediaFile = exports.managedPlacementView = exports.locationView = exports.localServicesVerificationArtifact = exports.localServicesLeadConversation = exports.localServicesLead = exports.localServicesEmployee = 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 = exports.experiment = exports.expandedLandingPageView = exports.dynamicSearchAdsSearchTermView = exports.domainCategory = exports.distanceView = exports.displayKeywordView = void 0;
+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 = exports.searchTermView = exports.remarketingAction = exports.recommendationSubscription = exports.recommendation = exports.qualifyingQuestion = exports.productLinkInvitation = exports.productLink = exports.productGroupView = exports.productCategoryConstant = exports.perStoreView = exports.paymentsAccount = exports.parentalStatusView = void 0;
 /**
  * @param {string | number} customerId
  * @param {string | number} biddingStrategyId
@@ -301,6 +301,45 @@ function ageRangeView(customerId, adGroupId, criterionId) {
     return `customers/${customerId}/ageRangeViews/${adGroupId}~${criterionId}`;
 }
 exports.ageRangeView = ageRangeView;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} adGroupId
+ * @param {string | number} androidPrivacyInteractionType
+ * @param {string | number} androidPrivacyNetworkType
+ * @param {string | number} androidPrivacyInteractionDate
+ * @returns `AndroidPrivacySharedKeyGoogleAdGroupResourceName`
+ * @example const androidPrivacySharedKeyGoogleAdGroup: ResourceNames.AndroidPrivacySharedKeyGoogleAdGroupResourceName = ResourceNames.androidPrivacySharedKeyGoogleAdGroup(10987417, 21974834, 43949668, 87899336, 175798672, 351597344)
+ */
+function androidPrivacySharedKeyGoogleAdGroup(customerId, campaignId, adGroupId, androidPrivacyInteractionType, androidPrivacyNetworkType, androidPrivacyInteractionDate) {
+    return `customers/${customerId}/androidPrivacySharedKeyGoogleAdGroups/${campaignId}~${adGroupId}~${androidPrivacyInteractionType}~${androidPrivacyNetworkType}~${androidPrivacyInteractionDate}`;
+}
+exports.androidPrivacySharedKeyGoogleAdGroup = androidPrivacySharedKeyGoogleAdGroup;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} androidPrivacyInteractionType
+ * @param {string | number} androidPrivacyInteractionDate
+ * @returns `AndroidPrivacySharedKeyGoogleCampaignResourceName`
+ * @example const androidPrivacySharedKeyGoogleCampaign: ResourceNames.AndroidPrivacySharedKeyGoogleCampaignResourceName = ResourceNames.androidPrivacySharedKeyGoogleCampaign(10987417, 21974834, 43949668, 87899336)
+ */
+function androidPrivacySharedKeyGoogleCampaign(customerId, campaignId, androidPrivacyInteractionType, androidPrivacyInteractionDate) {
+    return `customers/${customerId}/androidPrivacySharedKeyGoogleCampaigns/${campaignId}~${androidPrivacyInteractionType}~${androidPrivacyInteractionDate}`;
+}
+exports.androidPrivacySharedKeyGoogleCampaign = androidPrivacySharedKeyGoogleCampaign;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @param {string | number} androidPrivacyInteractionType
+ * @param {string | number} androidPrivacyNetworkType
+ * @param {string | number} androidPrivacyInteractionDate
+ * @returns `AndroidPrivacySharedKeyGoogleNetworkTypeResourceName`
+ * @example const androidPrivacySharedKeyGoogleNetworkType: ResourceNames.AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = ResourceNames.androidPrivacySharedKeyGoogleNetworkType(10987417, 21974834, 43949668, 87899336, 175798672)
+ */
+function androidPrivacySharedKeyGoogleNetworkType(customerId, campaignId, androidPrivacyInteractionType, androidPrivacyNetworkType, androidPrivacyInteractionDate) {
+    return `customers/${customerId}/androidPrivacySharedKeyGoogleNetworkTypes/${campaignId}~${androidPrivacyInteractionType}~${androidPrivacyNetworkType}~${androidPrivacyInteractionDate}`;
+}
+exports.androidPrivacySharedKeyGoogleNetworkType = androidPrivacySharedKeyGoogleNetworkType;
 /**
  * @param {string | number} customerId
  * @param {string | number} assetId
@@ -376,6 +415,17 @@ function assetGroupSignal(customerId, assetGroupId, criterionId) {
     return `customers/${customerId}/assetGroupSignals/${assetGroupId}~${criterionId}`;
 }
 exports.assetGroupSignal = assetGroupSignal;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} assetGroupId
+ * @param {string | number} assetCombinationCategory
+ * @returns `AssetGroupTopCombinationViewResourceName`
+ * @example const assetGroupTopCombinationView: ResourceNames.AssetGroupTopCombinationViewResourceName = ResourceNames.assetGroupTopCombinationView(10987417, 21974834, 43949668)
+ */
+function assetGroupTopCombinationView(customerId, assetGroupId, assetCombinationCategory) {
+    return `customers/${customerId}/assetGroupTopCombinationViews/${assetGroupId}~${assetCombinationCategory}`;
+}
+exports.assetGroupTopCombinationView = assetGroupTopCombinationView;
 /**
  * @param {string | number} customerId
  * @param {string | number} assetSetId
@@ -644,6 +694,16 @@ function campaignLabel(customerId, campaignId, labelId) {
     return `customers/${customerId}/campaignLabels/${campaignId}~${labelId}`;
 }
 exports.campaignLabel = campaignLabel;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} campaignId
+ * @returns `CampaignLifecycleGoalResourceName`
+ * @example const campaignLifecycleGoal: ResourceNames.CampaignLifecycleGoalResourceName = ResourceNames.campaignLifecycleGoal(10987417, 21974834)
+ */
+function campaignLifecycleGoal(customerId, campaignId) {
+    return `customers/${customerId}/campaignLifecycleGoals/${campaignId}`;
+}
+exports.campaignLifecycleGoal = campaignLifecycleGoal;
 /**
  * @param {string | number} customerId
  * @param {string | number} campaignId
@@ -923,6 +983,15 @@ function customerLabel(customerId, labelId) {
     return `customers/${customerId}/customerLabels/${labelId}`;
 }
 exports.customerLabel = customerLabel;
+/**
+ * @param {string | number} customerId
+ * @returns `CustomerLifecycleGoalResourceName`
+ * @example const customerLifecycleGoal: ResourceNames.CustomerLifecycleGoalResourceName = ResourceNames.customerLifecycleGoal(10987417)
+ */
+function customerLifecycleGoal(customerId) {
+    return `customers/${customerId}/customerLifecycleGoals`;
+}
+exports.customerLifecycleGoal = customerLifecycleGoal;
 /**
  * @param {string | number} customerId
  * @param {string | number} managerCustomerId
@@ -1404,6 +1473,46 @@ function lifeEvent(customerId, lifeEventId) {
     return `customers/${customerId}/lifeEvents/${lifeEventId}`;
 }
 exports.lifeEvent = lifeEvent;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} glsEmployeeId
+ * @returns `LocalServicesEmployeeResourceName`
+ * @example const localServicesEmployee: ResourceNames.LocalServicesEmployeeResourceName = ResourceNames.localServicesEmployee(10987417, 21974834)
+ */
+function localServicesEmployee(customerId, glsEmployeeId) {
+    return `customers/${customerId}/localServicesEmployees/${glsEmployeeId}`;
+}
+exports.localServicesEmployee = localServicesEmployee;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} localServicesLeadId
+ * @returns `LocalServicesLeadResourceName`
+ * @example const localServicesLead: ResourceNames.LocalServicesLeadResourceName = ResourceNames.localServicesLead(10987417, 21974834)
+ */
+function localServicesLead(customerId, localServicesLeadId) {
+    return `customers/${customerId}/localServicesLeads/${localServicesLeadId}`;
+}
+exports.localServicesLead = localServicesLead;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} localServicesLeadConversationId
+ * @returns `LocalServicesLeadConversationResourceName`
+ * @example const localServicesLeadConversation: ResourceNames.LocalServicesLeadConversationResourceName = ResourceNames.localServicesLeadConversation(10987417, 21974834)
+ */
+function localServicesLeadConversation(customerId, localServicesLeadConversationId) {
+    return `customers/${customerId}/localServicesLeadConversations/${localServicesLeadConversationId}`;
+}
+exports.localServicesLeadConversation = localServicesLeadConversation;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} glsVerificationArtifactId
+ * @returns `LocalServicesVerificationArtifactResourceName`
+ * @example const localServicesVerificationArtifact: ResourceNames.LocalServicesVerificationArtifactResourceName = ResourceNames.localServicesVerificationArtifact(10987417, 21974834)
+ */
+function localServicesVerificationArtifact(customerId, glsVerificationArtifactId) {
+    return `customers/${customerId}/localServicesVerificationArtifacts/${glsVerificationArtifactId}`;
+}
+exports.localServicesVerificationArtifact = localServicesVerificationArtifact;
 /**
  * @param {string | number} customerId
  * @param {string | number} campaignId
@@ -1436,16 +1545,6 @@ function mediaFile(customerId, mediaFileId) {
     return `customers/${customerId}/mediaFiles/${mediaFileId}`;
 }
 exports.mediaFile = mediaFile;
-/**
- * @param {string | number} customerId
- * @param {string | number} merchantCenterId
- * @returns `MerchantCenterLinkResourceName`
- * @example const merchantCenterLink: ResourceNames.MerchantCenterLinkResourceName = ResourceNames.merchantCenterLink(10987417, 21974834)
- */
-function merchantCenterLink(customerId, merchantCenterId) {
-    return `customers/${customerId}/merchantCenterLinks/${merchantCenterId}`;
-}
-exports.merchantCenterLink = merchantCenterLink;
 /**
  * @param {string | number} mobileAppCategoryId
  * @returns `MobileAppCategoryConstantResourceName`
@@ -1464,6 +1563,16 @@ function mobileDeviceConstant(criterionId) {
     return `mobileDeviceConstants/${criterionId}`;
 }
 exports.mobileDeviceConstant = mobileDeviceConstant;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} client
+ * @returns `OfflineConversionUploadClientSummaryResourceName`
+ * @example const offlineConversionUploadClientSummary: ResourceNames.OfflineConversionUploadClientSummaryResourceName = ResourceNames.offlineConversionUploadClientSummary(10987417, 21974834)
+ */
+function offlineConversionUploadClientSummary(customerId, client) {
+    return `customers/${customerId}/offlineConversionUploadClientSummaries/${client}`;
+}
+exports.offlineConversionUploadClientSummary = offlineConversionUploadClientSummary;
 /**
  * @param {string | number} customerId
  * @param {string | number} offlineUserDataUpdateId
@@ -1527,16 +1636,15 @@ function perStoreView(customerId, placeId) {
 }
 exports.perStoreView = perStoreView;
 /**
- * @param {string | number} countryCode
  * @param {string | number} level
- * @param {string | number} id
- * @returns `ProductBiddingCategoryConstantResourceName`
- * @example const productBiddingCategoryConstant: ResourceNames.ProductBiddingCategoryConstantResourceName = ResourceNames.productBiddingCategoryConstant(10987417, 21974834, 43949668)
+ * @param {string | number} categoryId
+ * @returns `ProductCategoryConstantResourceName`
+ * @example const productCategoryConstant: ResourceNames.ProductCategoryConstantResourceName = ResourceNames.productCategoryConstant(10987417, 21974834)
  */
-function productBiddingCategoryConstant(countryCode, level, id) {
-    return `productBiddingCategoryConstants/${countryCode}~${level}~${id}`;
+function productCategoryConstant(level, categoryId) {
+    return `productCategoryConstants/${level}~${categoryId}`;
 }
-exports.productBiddingCategoryConstant = productBiddingCategoryConstant;
+exports.productCategoryConstant = productCategoryConstant;
 /**
  * @param {string | number} customerId
  * @param {string | number} adgroupId
@@ -1558,6 +1666,16 @@ function productLink(customerId, productLinkId) {
     return `customers/${customerId}/productLinks/${productLinkId}`;
 }
 exports.productLink = productLink;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} customerInvitationId
+ * @returns `ProductLinkInvitationResourceName`
+ * @example const productLinkInvitation: ResourceNames.ProductLinkInvitationResourceName = ResourceNames.productLinkInvitation(10987417, 21974834)
+ */
+function productLinkInvitation(customerId, customerInvitationId) {
+    return `customers/${customerId}/productLinkInvitations/${customerInvitationId}`;
+}
+exports.productLinkInvitation = productLinkInvitation;
 /**
  * @param {string | number} qualifyingQuestionId
  * @returns `QualifyingQuestionResourceName`
@@ -1577,6 +1695,16 @@ function recommendation(customerId, recommendationId) {
     return `customers/${customerId}/recommendations/${recommendationId}`;
 }
 exports.recommendation = recommendation;
+/**
+ * @param {string | number} customerId
+ * @param {string | number} recommendationType
+ * @returns `RecommendationSubscriptionResourceName`
+ * @example const recommendationSubscription: ResourceNames.RecommendationSubscriptionResourceName = ResourceNames.recommendationSubscription(10987417, 21974834)
+ */
+function recommendationSubscription(customerId, recommendationType) {
+    return `customers/${customerId}/recommendationSubscriptions/${recommendationType}`;
+}
+exports.recommendationSubscription = recommendationSubscription;
 /**
  * @param {string | number} customerId
  * @param {string | number} remarketingActionId