UNPKG

google-ads-api

Version:

Google Ads API Client Library for Node.js

1,048 lines 86.3 kB
"use strict"; /* Autogenerated File! Do Not Edit */ Object.defineProperty(exports, "__esModule", { value: true }); exports.accessibleBiddingStrategy = accessibleBiddingStrategy; exports.accountBudget = accountBudget; exports.accountBudgetProposal = accountBudgetProposal; exports.accountLink = accountLink; exports.ad = ad; exports.adGroup = adGroup; exports.adGroupAd = adGroupAd; exports.adGroupAdAssetCombinationView = adGroupAdAssetCombinationView; exports.adGroupAdAssetView = adGroupAdAssetView; exports.adGroupAdLabel = adGroupAdLabel; exports.adGroupAsset = adGroupAsset; exports.adGroupAssetSet = adGroupAssetSet; exports.adGroupAudienceView = adGroupAudienceView; exports.adGroupBidModifier = adGroupBidModifier; exports.adGroupCriterion = adGroupCriterion; exports.adGroupCriterionCustomizer = adGroupCriterionCustomizer; exports.adGroupCriterionLabel = adGroupCriterionLabel; exports.adGroupCriterionSimulation = adGroupCriterionSimulation; exports.adGroupCustomizer = adGroupCustomizer; exports.adGroupLabel = adGroupLabel; exports.adGroupSimulation = adGroupSimulation; exports.adParameter = adParameter; exports.adScheduleView = adScheduleView; exports.ageRangeView = ageRangeView; exports.androidPrivacySharedKeyGoogleAdGroup = androidPrivacySharedKeyGoogleAdGroup; exports.androidPrivacySharedKeyGoogleCampaign = androidPrivacySharedKeyGoogleCampaign; exports.androidPrivacySharedKeyGoogleNetworkType = androidPrivacySharedKeyGoogleNetworkType; exports.asset = asset; exports.assetFieldTypeView = assetFieldTypeView; exports.assetGroup = assetGroup; exports.assetGroupAsset = assetGroupAsset; exports.assetGroupListingGroupFilter = assetGroupListingGroupFilter; exports.assetGroupProductGroupView = assetGroupProductGroupView; exports.assetGroupSignal = assetGroupSignal; exports.assetGroupTopCombinationView = assetGroupTopCombinationView; exports.assetSet = assetSet; exports.assetSetAsset = assetSetAsset; exports.assetSetTypeView = assetSetTypeView; exports.audience = audience; exports.batchJob = batchJob; exports.biddingDataExclusion = biddingDataExclusion; exports.biddingSeasonalityAdjustment = biddingSeasonalityAdjustment; exports.biddingStrategy = biddingStrategy; exports.biddingStrategySimulation = biddingStrategySimulation; exports.billingSetup = billingSetup; exports.callView = callView; exports.campaign = campaign; exports.campaignAggregateAssetView = campaignAggregateAssetView; exports.campaignAsset = campaignAsset; exports.campaignAssetSet = campaignAssetSet; exports.campaignAudienceView = campaignAudienceView; exports.campaignBidModifier = campaignBidModifier; exports.campaignBudget = campaignBudget; exports.campaignConversionGoal = campaignConversionGoal; exports.campaignCriterion = campaignCriterion; exports.campaignCustomizer = campaignCustomizer; exports.campaignDraft = campaignDraft; exports.campaignGroup = campaignGroup; exports.campaignLabel = campaignLabel; exports.campaignLifecycleGoal = campaignLifecycleGoal; exports.campaignSearchTermInsight = campaignSearchTermInsight; exports.campaignSharedSet = campaignSharedSet; exports.campaignSimulation = campaignSimulation; exports.carrierConstant = carrierConstant; exports.changeEvent = changeEvent; exports.changeStatus = changeStatus; exports.channelAggregateAssetView = channelAggregateAssetView; exports.clickView = clickView; exports.combinedAudience = combinedAudience; exports.contentCriterionView = contentCriterionView; exports.conversionAction = conversionAction; exports.conversionCustomVariable = conversionCustomVariable; exports.conversionGoalCampaignConfig = conversionGoalCampaignConfig; exports.conversionValueRule = conversionValueRule; exports.conversionValueRuleSet = conversionValueRuleSet; exports.currencyConstant = currencyConstant; exports.customAudience = customAudience; exports.customConversionGoal = customConversionGoal; exports.customInterest = customInterest; exports.customer = customer; exports.customerAsset = customerAsset; exports.customerAssetSet = customerAssetSet; exports.customerClient = customerClient; exports.customerClientLink = customerClientLink; exports.customerConversionGoal = customerConversionGoal; exports.customerCustomizer = customerCustomizer; exports.customerLabel = customerLabel; exports.customerLifecycleGoal = customerLifecycleGoal; exports.customerManagerLink = customerManagerLink; exports.customerNegativeCriterion = customerNegativeCriterion; exports.customerSearchTermInsight = customerSearchTermInsight; exports.customerSkAdNetworkConversionValueSchema = customerSkAdNetworkConversionValueSchema; exports.customerUserAccess = customerUserAccess; exports.customerUserAccessInvitation = customerUserAccessInvitation; exports.customizerAttribute = customizerAttribute; exports.dataLink = dataLink; exports.detailPlacementView = detailPlacementView; exports.detailedDemographic = detailedDemographic; exports.displayKeywordView = displayKeywordView; exports.distanceView = distanceView; exports.domainCategory = domainCategory; exports.dynamicSearchAdsSearchTermView = dynamicSearchAdsSearchTermView; exports.expandedLandingPageView = expandedLandingPageView; exports.experiment = experiment; exports.experimentArm = experimentArm; exports.genderView = genderView; exports.geoTargetConstant = geoTargetConstant; exports.geographicView = geographicView; exports.googleAdsField = googleAdsField; exports.groupPlacementView = groupPlacementView; exports.hotelGroupView = hotelGroupView; exports.hotelPerformanceView = hotelPerformanceView; exports.hotelReconciliation = hotelReconciliation; exports.incomeRangeView = incomeRangeView; exports.invoice = invoice; exports.keywordPlan = keywordPlan; exports.keywordPlanAdGroup = keywordPlanAdGroup; exports.keywordPlanAdGroupKeyword = keywordPlanAdGroupKeyword; exports.keywordPlanCampaign = keywordPlanCampaign; exports.keywordPlanCampaignKeyword = keywordPlanCampaignKeyword; exports.keywordThemeConstant = keywordThemeConstant; exports.keywordView = keywordView; exports.label = label; exports.landingPageView = landingPageView; exports.languageConstant = languageConstant; exports.leadFormSubmissionData = leadFormSubmissionData; exports.lifeEvent = lifeEvent; exports.localServicesEmployee = localServicesEmployee; exports.localServicesLead = localServicesLead; exports.localServicesLeadConversation = localServicesLeadConversation; exports.localServicesVerificationArtifact = localServicesVerificationArtifact; exports.locationView = locationView; exports.managedPlacementView = managedPlacementView; exports.mediaFile = mediaFile; exports.mobileAppCategoryConstant = mobileAppCategoryConstant; exports.mobileDeviceConstant = mobileDeviceConstant; exports.offlineConversionUploadClientSummary = offlineConversionUploadClientSummary; exports.offlineConversionUploadConversionActionSummary = offlineConversionUploadConversionActionSummary; exports.offlineUserDataJob = offlineUserDataJob; exports.operatingSystemVersionConstant = operatingSystemVersionConstant; exports.paidOrganicSearchTermView = paidOrganicSearchTermView; exports.parentalStatusView = parentalStatusView; exports.paymentsAccount = paymentsAccount; exports.perStoreView = perStoreView; exports.performanceMaxPlacementView = performanceMaxPlacementView; exports.productCategoryConstant = productCategoryConstant; exports.productGroupView = productGroupView; exports.productLink = productLink; exports.productLinkInvitation = productLinkInvitation; exports.qualifyingQuestion = qualifyingQuestion; exports.recommendation = recommendation; exports.recommendationSubscription = recommendationSubscription; exports.remarketingAction = remarketingAction; exports.searchTermView = searchTermView; exports.sharedCriterion = sharedCriterion; exports.sharedSet = sharedSet; exports.shoppingPerformanceView = shoppingPerformanceView; exports.shoppingProduct = shoppingProduct; exports.smartCampaignSearchTermView = smartCampaignSearchTermView; exports.smartCampaignSetting = smartCampaignSetting; exports.thirdPartyAppAnalyticsLink = thirdPartyAppAnalyticsLink; exports.topicConstant = topicConstant; exports.topicView = topicView; exports.travelActivityGroupView = travelActivityGroupView; exports.travelActivityPerformanceView = travelActivityPerformanceView; exports.userInterest = userInterest; exports.userList = userList; exports.userListCustomerType = userListCustomerType; exports.userLocationView = userLocationView; exports.video = video; exports.webpageView = webpageView; /** * @param {string | number} customerId * @param {string | number} biddingStrategyId * @returns `AccessibleBiddingStrategyResourceName` * @example const accessibleBiddingStrategy: ResourceNames.AccessibleBiddingStrategyResourceName = ResourceNames.accessibleBiddingStrategy(10987417, 21974834) */ function accessibleBiddingStrategy(customerId, biddingStrategyId) { return `customers/${customerId}/accessibleBiddingStrategies/${biddingStrategyId}`; } /** * @param {string | number} customerId * @param {string | number} accountBudgetId * @returns `AccountBudgetResourceName` * @example const accountBudget: ResourceNames.AccountBudgetResourceName = ResourceNames.accountBudget(10987417, 21974834) */ function accountBudget(customerId, accountBudgetId) { return `customers/${customerId}/accountBudgets/${accountBudgetId}`; } /** * @param {string | number} customerId * @param {string | number} accountBudgetProposalId * @returns `AccountBudgetProposalResourceName` * @example const accountBudgetProposal: ResourceNames.AccountBudgetProposalResourceName = ResourceNames.accountBudgetProposal(10987417, 21974834) */ function accountBudgetProposal(customerId, accountBudgetProposalId) { return `customers/${customerId}/accountBudgetProposals/${accountBudgetProposalId}`; } /** * @param {string | number} customerId * @param {string | number} accountLinkId * @returns `AccountLinkResourceName` * @example const accountLink: ResourceNames.AccountLinkResourceName = ResourceNames.accountLink(10987417, 21974834) */ function accountLink(customerId, accountLinkId) { return `customers/${customerId}/accountLinks/${accountLinkId}`; } /** * @param {string | number} customerId * @param {string | number} adId * @returns `AdResourceName` * @example const ad: ResourceNames.AdResourceName = ResourceNames.ad(10987417, 21974834) */ function ad(customerId, adId) { return `customers/${customerId}/ads/${adId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @returns `AdGroupResourceName` * @example const adGroup: ResourceNames.AdGroupResourceName = ResourceNames.adGroup(10987417, 21974834) */ function adGroup(customerId, adGroupId) { return `customers/${customerId}/adGroups/${adGroupId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} adId * @returns `AdGroupAdResourceName` * @example const adGroupAd: ResourceNames.AdGroupAdResourceName = ResourceNames.adGroupAd(10987417, 21974834, 43949668) */ function adGroupAd(customerId, adGroupId, adId) { return `customers/${customerId}/adGroupAds/${adGroupId}~${adId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} adId * @param {string | number} assetCombinationIdLow * @param {string | number} assetCombinationIdHigh * @returns `AdGroupAdAssetCombinationViewResourceName` * @example const adGroupAdAssetCombinationView: ResourceNames.AdGroupAdAssetCombinationViewResourceName = ResourceNames.adGroupAdAssetCombinationView(10987417, 21974834, 43949668, 87899336, 175798672) */ function adGroupAdAssetCombinationView(customerId, adGroupId, adId, assetCombinationIdLow, assetCombinationIdHigh) { return `customers/${customerId}/adGroupAdAssetCombinationViews/${adGroupId}~${adId}~${assetCombinationIdLow}~${assetCombinationIdHigh}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} adId * @param {string | number} assetId * @param {string | number} fieldType * @returns `AdGroupAdAssetViewResourceName` * @example const adGroupAdAssetView: ResourceNames.AdGroupAdAssetViewResourceName = ResourceNames.adGroupAdAssetView(10987417, 21974834, 43949668, 87899336, 175798672) */ function adGroupAdAssetView(customerId, adGroupId, adId, assetId, fieldType) { return `customers/${customerId}/adGroupAdAssetViews/${adGroupId}~${adId}~${assetId}~${fieldType}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} adId * @param {string | number} labelId * @returns `AdGroupAdLabelResourceName` * @example const adGroupAdLabel: ResourceNames.AdGroupAdLabelResourceName = ResourceNames.adGroupAdLabel(10987417, 21974834, 43949668, 87899336) */ function adGroupAdLabel(customerId, adGroupId, adId, labelId) { return `customers/${customerId}/adGroupAdLabels/${adGroupId}~${adId}~${labelId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} assetId * @param {string | number} fieldType * @returns `AdGroupAssetResourceName` * @example const adGroupAsset: ResourceNames.AdGroupAssetResourceName = ResourceNames.adGroupAsset(10987417, 21974834, 43949668, 87899336) */ function adGroupAsset(customerId, adGroupId, assetId, fieldType) { return `customers/${customerId}/adGroupAssets/${adGroupId}~${assetId}~${fieldType}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} assetSetId * @returns `AdGroupAssetSetResourceName` * @example const adGroupAssetSet: ResourceNames.AdGroupAssetSetResourceName = ResourceNames.adGroupAssetSet(10987417, 21974834, 43949668) */ function adGroupAssetSet(customerId, adGroupId, assetSetId) { return `customers/${customerId}/adGroupAssetSets/${adGroupId}~${assetSetId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @returns `AdGroupAudienceViewResourceName` * @example const adGroupAudienceView: ResourceNames.AdGroupAudienceViewResourceName = ResourceNames.adGroupAudienceView(10987417, 21974834, 43949668) */ function adGroupAudienceView(customerId, adGroupId, criterionId) { return `customers/${customerId}/adGroupAudienceViews/${adGroupId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @returns `AdGroupBidModifierResourceName` * @example const adGroupBidModifier: ResourceNames.AdGroupBidModifierResourceName = ResourceNames.adGroupBidModifier(10987417, 21974834, 43949668) */ function adGroupBidModifier(customerId, adGroupId, criterionId) { return `customers/${customerId}/adGroupBidModifiers/${adGroupId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @returns `AdGroupCriterionResourceName` * @example const adGroupCriterion: ResourceNames.AdGroupCriterionResourceName = ResourceNames.adGroupCriterion(10987417, 21974834, 43949668) */ function adGroupCriterion(customerId, adGroupId, criterionId) { return `customers/${customerId}/adGroupCriteria/${adGroupId}~${criterionId}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @param {string | number} labelId * @returns `AdGroupCriterionLabelResourceName` * @example const adGroupCriterionLabel: ResourceNames.AdGroupCriterionLabelResourceName = ResourceNames.adGroupCriterionLabel(10987417, 21974834, 43949668, 87899336) */ function adGroupCriterionLabel(customerId, adGroupId, criterionId, labelId) { return `customers/${customerId}/adGroupCriterionLabels/${adGroupId}~${criterionId}~${labelId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @param {string | number} type * @param {string | number} modificationMethod * @param {string | number} startDate * @param {string | number} endDate * @returns `AdGroupCriterionSimulationResourceName` * @example const adGroupCriterionSimulation: ResourceNames.AdGroupCriterionSimulationResourceName = ResourceNames.adGroupCriterionSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344, 703194688) */ function adGroupCriterionSimulation(customerId, adGroupId, criterionId, type, modificationMethod, startDate, endDate) { return `customers/${customerId}/adGroupCriterionSimulations/${adGroupId}~${criterionId}~${type}~${modificationMethod}~${startDate}~${endDate}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} labelId * @returns `AdGroupLabelResourceName` * @example const adGroupLabel: ResourceNames.AdGroupLabelResourceName = ResourceNames.adGroupLabel(10987417, 21974834, 43949668) */ function adGroupLabel(customerId, adGroupId, labelId) { return `customers/${customerId}/adGroupLabels/${adGroupId}~${labelId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} type * @param {string | number} modificationMethod * @param {string | number} startDate * @param {string | number} endDate * @returns `AdGroupSimulationResourceName` * @example const adGroupSimulation: ResourceNames.AdGroupSimulationResourceName = ResourceNames.adGroupSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344) */ function adGroupSimulation(customerId, adGroupId, type, modificationMethod, startDate, endDate) { return `customers/${customerId}/adGroupSimulations/${adGroupId}~${type}~${modificationMethod}~${startDate}~${endDate}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @param {string | number} parameterIndex * @returns `AdParameterResourceName` * @example const adParameter: ResourceNames.AdParameterResourceName = ResourceNames.adParameter(10987417, 21974834, 43949668, 87899336) */ function adParameter(customerId, adGroupId, criterionId, parameterIndex) { return `customers/${customerId}/adParameters/${adGroupId}~${criterionId}~${parameterIndex}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} criterionId * @returns `AdScheduleViewResourceName` * @example const adScheduleView: ResourceNames.AdScheduleViewResourceName = ResourceNames.adScheduleView(10987417, 21974834, 43949668) */ function adScheduleView(customerId, campaignId, criterionId) { return `customers/${customerId}/adScheduleViews/${campaignId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @returns `AgeRangeViewResourceName` * @example const ageRangeView: ResourceNames.AgeRangeViewResourceName = ResourceNames.ageRangeView(10987417, 21974834, 43949668) */ function ageRangeView(customerId, adGroupId, criterionId) { return `customers/${customerId}/ageRangeViews/${adGroupId}~${criterionId}`; } /** * @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}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} assetId * @returns `AssetResourceName` * @example const asset: ResourceNames.AssetResourceName = ResourceNames.asset(10987417, 21974834) */ function asset(customerId, assetId) { return `customers/${customerId}/assets/${assetId}`; } /** * @param {string | number} customerId * @param {string | number} fieldType * @returns `AssetFieldTypeViewResourceName` * @example const assetFieldTypeView: ResourceNames.AssetFieldTypeViewResourceName = ResourceNames.assetFieldTypeView(10987417, 21974834) */ function assetFieldTypeView(customerId, fieldType) { return `customers/${customerId}/assetFieldTypeViews/${fieldType}`; } /** * @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}`; } /** * @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}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} assetGroupId * @param {string | number} criterionId * @returns `AssetGroupSignalResourceName` * @example const assetGroupSignal: ResourceNames.AssetGroupSignalResourceName = ResourceNames.assetGroupSignal(10987417, 21974834, 43949668) */ function assetGroupSignal(customerId, assetGroupId, criterionId) { return `customers/${customerId}/assetGroupSignals/${assetGroupId}~${criterionId}`; } /** * @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}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} assetSetType * @returns `AssetSetTypeViewResourceName` * @example const assetSetTypeView: ResourceNames.AssetSetTypeViewResourceName = ResourceNames.assetSetTypeView(10987417, 21974834) */ function assetSetTypeView(customerId, assetSetType) { return `customers/${customerId}/assetSetTypeViews/${assetSetType}`; } /** * @param {string | number} customerId * @param {string | number} audienceId * @returns `AudienceResourceName` * @example const audience: ResourceNames.AudienceResourceName = ResourceNames.audience(10987417, 21974834) */ function audience(customerId, audienceId) { return `customers/${customerId}/audiences/${audienceId}`; } /** * @param {string | number} customerId * @param {string | number} batchJobId * @returns `BatchJobResourceName` * @example const batchJob: ResourceNames.BatchJobResourceName = ResourceNames.batchJob(10987417, 21974834) */ function batchJob(customerId, batchJobId) { return `customers/${customerId}/batchJobs/${batchJobId}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} biddingStrategyId * @returns `BiddingStrategyResourceName` * @example const biddingStrategy: ResourceNames.BiddingStrategyResourceName = ResourceNames.biddingStrategy(10987417, 21974834) */ function biddingStrategy(customerId, biddingStrategyId) { return `customers/${customerId}/biddingStrategies/${biddingStrategyId}`; } /** * @param {string | number} customerId * @param {string | number} biddingStrategyId * @param {string | number} type * @param {string | number} modificationMethod * @param {string | number} startDate * @param {string | number} endDate * @returns `BiddingStrategySimulationResourceName` * @example const biddingStrategySimulation: ResourceNames.BiddingStrategySimulationResourceName = ResourceNames.biddingStrategySimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344) */ function biddingStrategySimulation(customerId, biddingStrategyId, type, modificationMethod, startDate, endDate) { return `customers/${customerId}/biddingStrategySimulations/${biddingStrategyId}~${type}~${modificationMethod}~${startDate}~${endDate}`; } /** * @param {string | number} customerId * @param {string | number} billingSetupId * @returns `BillingSetupResourceName` * @example const billingSetup: ResourceNames.BillingSetupResourceName = ResourceNames.billingSetup(10987417, 21974834) */ function billingSetup(customerId, billingSetupId) { return `customers/${customerId}/billingSetups/${billingSetupId}`; } /** * @param {string | number} customerId * @param {string | number} callDetailId * @returns `CallViewResourceName` * @example const callView: ResourceNames.CallViewResourceName = ResourceNames.callView(10987417, 21974834) */ function callView(customerId, callDetailId) { return `customers/${customerId}/callViews/${callDetailId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @returns `CampaignResourceName` * @example const campaign: ResourceNames.CampaignResourceName = ResourceNames.campaign(10987417, 21974834) */ function campaign(customerId, campaignId) { return `customers/${customerId}/campaigns/${campaignId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} assetId * @param {string | number} assetLinkSource * @param {string | number} fieldType * @returns `CampaignAggregateAssetViewResourceName` * @example const campaignAggregateAssetView: ResourceNames.CampaignAggregateAssetViewResourceName = ResourceNames.campaignAggregateAssetView(10987417, 21974834, 43949668, 87899336, 175798672) */ function campaignAggregateAssetView(customerId, campaignId, assetId, assetLinkSource, fieldType) { return `customers/${customerId}/campaignAggregateAssetViews/${campaignId}~${assetId}~${assetLinkSource}~${fieldType}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} assetId * @param {string | number} fieldType * @returns `CampaignAssetResourceName` * @example const campaignAsset: ResourceNames.CampaignAssetResourceName = ResourceNames.campaignAsset(10987417, 21974834, 43949668, 87899336) */ function campaignAsset(customerId, campaignId, assetId, fieldType) { return `customers/${customerId}/campaignAssets/${campaignId}~${assetId}~${fieldType}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} criterionId * @returns `CampaignAudienceViewResourceName` * @example const campaignAudienceView: ResourceNames.CampaignAudienceViewResourceName = ResourceNames.campaignAudienceView(10987417, 21974834, 43949668) */ function campaignAudienceView(customerId, campaignId, criterionId) { return `customers/${customerId}/campaignAudienceViews/${campaignId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} criterionId * @returns `CampaignBidModifierResourceName` * @example const campaignBidModifier: ResourceNames.CampaignBidModifierResourceName = ResourceNames.campaignBidModifier(10987417, 21974834, 43949668) */ function campaignBidModifier(customerId, campaignId, criterionId) { return `customers/${customerId}/campaignBidModifiers/${campaignId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} campaignBudgetId * @returns `CampaignBudgetResourceName` * @example const campaignBudget: ResourceNames.CampaignBudgetResourceName = ResourceNames.campaignBudget(10987417, 21974834) */ function campaignBudget(customerId, campaignBudgetId) { return `customers/${customerId}/campaignBudgets/${campaignBudgetId}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} criterionId * @returns `CampaignCriterionResourceName` * @example const campaignCriterion: ResourceNames.CampaignCriterionResourceName = ResourceNames.campaignCriterion(10987417, 21974834, 43949668) */ function campaignCriterion(customerId, campaignId, criterionId) { return `customers/${customerId}/campaignCriteria/${campaignId}~${criterionId}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} baseCampaignId * @param {string | number} draftId * @returns `CampaignDraftResourceName` * @example const campaignDraft: ResourceNames.CampaignDraftResourceName = ResourceNames.campaignDraft(10987417, 21974834, 43949668) */ function campaignDraft(customerId, baseCampaignId, draftId) { return `customers/${customerId}/campaignDrafts/${baseCampaignId}~${draftId}`; } /** * @param {string | number} customerId * @param {string | number} campaignGroupId * @returns `CampaignGroupResourceName` * @example const campaignGroup: ResourceNames.CampaignGroupResourceName = ResourceNames.campaignGroup(10987417, 21974834) */ function campaignGroup(customerId, campaignGroupId) { return `customers/${customerId}/campaignGroups/${campaignGroupId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} labelId * @returns `CampaignLabelResourceName` * @example const campaignLabel: ResourceNames.CampaignLabelResourceName = ResourceNames.campaignLabel(10987417, 21974834, 43949668) */ function campaignLabel(customerId, campaignId, labelId) { return `customers/${customerId}/campaignLabels/${campaignId}~${labelId}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} clusterId * @returns `CampaignSearchTermInsightResourceName` * @example const campaignSearchTermInsight: ResourceNames.CampaignSearchTermInsightResourceName = ResourceNames.campaignSearchTermInsight(10987417, 21974834, 43949668) */ function campaignSearchTermInsight(customerId, campaignId, clusterId) { return `customers/${customerId}/campaignSearchTermInsights/${campaignId}~${clusterId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} sharedSetId * @returns `CampaignSharedSetResourceName` * @example const campaignSharedSet: ResourceNames.CampaignSharedSetResourceName = ResourceNames.campaignSharedSet(10987417, 21974834, 43949668) */ function campaignSharedSet(customerId, campaignId, sharedSetId) { return `customers/${customerId}/campaignSharedSets/${campaignId}~${sharedSetId}`; } /** * @param {string | number} customerId * @param {string | number} campaignId * @param {string | number} type * @param {string | number} modificationMethod * @param {string | number} startDate * @param {string | number} endDate * @returns `CampaignSimulationResourceName` * @example const campaignSimulation: ResourceNames.CampaignSimulationResourceName = ResourceNames.campaignSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344) */ function campaignSimulation(customerId, campaignId, type, modificationMethod, startDate, endDate) { return `customers/${customerId}/campaignSimulations/${campaignId}~${type}~${modificationMethod}~${startDate}~${endDate}`; } /** * @param {string | number} criterionId * @returns `CarrierConstantResourceName` * @example const carrierConstant: ResourceNames.CarrierConstantResourceName = ResourceNames.carrierConstant(10987417) */ function carrierConstant(criterionId) { return `carrierConstants/${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} timestampMicros * @param {string | number} commandIndex * @param {string | number} mutateIndex * @returns `ChangeEventResourceName` * @example const changeEvent: ResourceNames.ChangeEventResourceName = ResourceNames.changeEvent(10987417, 21974834, 43949668, 87899336) */ function changeEvent(customerId, timestampMicros, commandIndex, mutateIndex) { return `customers/${customerId}/changeEvents/${timestampMicros}~${commandIndex}~${mutateIndex}`; } /** * @param {string | number} customerId * @param {string | number} changeStatusId * @returns `ChangeStatusResourceName` * @example const changeStatus: ResourceNames.ChangeStatusResourceName = ResourceNames.changeStatus(10987417, 21974834) */ function changeStatus(customerId, changeStatusId) { return `customers/${customerId}/changeStatus/${changeStatusId}`; } /** * @param {string | number} customerId * @param {string | number} advertisingChannelType * @param {string | number} assetId * @param {string | number} assetSource * @param {string | number} fieldType * @returns `ChannelAggregateAssetViewResourceName` * @example const channelAggregateAssetView: ResourceNames.ChannelAggregateAssetViewResourceName = ResourceNames.channelAggregateAssetView(10987417, 21974834, 43949668, 87899336, 175798672) */ function channelAggregateAssetView(customerId, advertisingChannelType, assetId, assetSource, fieldType) { return `customers/${customerId}/channelAggregateAssetViews/${advertisingChannelType}~${assetId}~${assetSource}~${fieldType}`; } /** * @param {string | number} customerId * @param {string | number} date * @param {string | number} gclid * @returns `ClickViewResourceName` * @example const clickView: ResourceNames.ClickViewResourceName = ResourceNames.clickView(10987417, 21974834, 43949668) */ function clickView(customerId, date, gclid) { return `customers/${customerId}/clickViews/${date}~${gclid}`; } /** * @param {string | number} customerId * @param {string | number} combinedAudienceId * @returns `CombinedAudienceResourceName` * @example const combinedAudience: ResourceNames.CombinedAudienceResourceName = ResourceNames.combinedAudience(10987417, 21974834) */ function combinedAudience(customerId, combinedAudienceId) { return `customers/${customerId}/combinedAudiences/${combinedAudienceId}`; } /** * @param {string | number} customerId * @param {string | number} adGroupId * @param {string | number} criterionId * @returns `ContentCriterionViewResourceName` * @example const contentCriterionView: ResourceNames.ContentCriterionViewResourceName = ResourceNames.contentCriterionView(10987417, 21974834, 43949668) */ function contentCriterionView(customerId, adGroupId, criterionId) { return `customers/${customerId}/contentCriterionViews/${adGroupId}~${criterionId}`; } /** * @param {string | number} customerId * @param {string | number} conversionActionId * @returns `ConversionActionResourceName` * @example const conversionAction: ResourceNames.ConversionActionResourceName = ResourceNames.conversionAction(10987417, 21974834) */ function conversionAction(customerId, conversionActionId) { return `customers/${customerId}/conversionActions/${conversionActionId}`; } /** * @param {string | number} customerId * @param {string | number} conversionCustomVariableId * @returns `ConversionCustomVariableResourceName` * @example const conversionCustomVariable: ResourceNames.ConversionCustomVariableResourceName = ResourceNames.conversionCustomVariable(10987417, 21974834) */ function conversionCustomVariable(customerId, conversionCustomVariableId) { return `customers/${customerId}/conversionCustomVariables/${conversionCustomVariableId}`; } /** * @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}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} code * @returns `CurrencyConstantResourceName` * @example const currencyConstant: ResourceNames.CurrencyConstantResourceName = ResourceNames.currencyConstant(10987417) */ function currencyConstant(code) { return `currencyConstants/${code}`; } /** * @param {string | number} customerId * @param {string | number} customAudienceId * @returns `CustomAudienceResourceName` * @example const customAudience: ResourceNames.CustomAudienceResourceName = ResourceNames.customAudience(10987417, 21974834) */ function customAudience(customerId, customAudienceId) { return `customers/${customerId}/customAudiences/${customAudienceId}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} customInterestId * @returns `CustomInterestResourceName` * @example const customInterest: ResourceNames.CustomInterestResourceName = ResourceNames.customInterest(10987417, 21974834) */ function customInterest(customerId, customInterestId) { return `customers/${customerId}/customInterests/${customInterestId}`; } /** * @param {string | number} customerId * @returns `CustomerResourceName` * @example const customer: ResourceNames.CustomerResourceName = ResourceNames.customer(10987417) */ function customer(customerId) { return `customers/${customerId}`; } /** * @param {string | number} customerId * @param {string | number} assetId * @param {string | number} fieldType * @returns `CustomerAssetResourceName` * @example const customerAsset: ResourceNames.CustomerAssetResourceName = ResourceNames.customerAsset(10987417, 21974834, 43949668) */ function customerAsset(customerId, assetId, fieldType) { return `customers/${customerId}/customerAssets/${assetId}~${fieldType}`; } /** * @param {string | number} customerId * @param {string | number} assetSetId * @returns `CustomerAssetSetResourceName` * @example const customerAssetSet: ResourceNames.CustomerAssetSetResourceName = ResourceNames.customerAssetSet(10987417, 21974834) */ function customerAssetSet(customerId, assetSetId) { return `customers/${customerId}/customerAssetSets/${assetSetId}`; } /** * @param {string | number} customerId * @param {string | number} clientCustomerId * @returns `CustomerClientResourceName` * @example const customerClient: ResourceNames.CustomerClientResourceName = ResourceNames.customerClient(10987417, 21974834) */ function customerClient(customerId, clientCustomerId) { return `customers/${customerId}/customerClients/${clientCustomerId}`; } /** * @param {string | number} customerId * @param {string | number} clientCustomerId * @param {string | number} managerLinkId * @returns `CustomerClientLinkResourceName` * @example const customerClientLink: ResourceNames.CustomerClientLinkResourceName = ResourceNames.customerClientLink(10987417, 21974834, 43949668) */ function customerClientLink(customerId, clientCustomerId, managerLinkId) { return `customers/${customerId}/customerClientLinks/${clientCustomerId}~${managerLinkId}`; } /** * @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}`; } /** * @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}`; } /** * @param {string | number} customerId * @param {string | number} labelId * @returns `CustomerLabelResourceName` * @example const customerLabel: ResourceNames.CustomerLabelResourceName = ResourceNames.customerLabel(10987417, 21974834) */ function customerLabel(customerId, labelId) { return `customers/${customerId}/customerLabels/${labelId}`; } /** * @param {string | number} customerId * @returns `CustomerLifecycleGoalResourceName` * @example const customerLifecycleGoal: ResourceNames.CustomerLifecycleGoalResourceName = ResourceNames.customerLifecycleGoal(10987417) */ function customerLifecycleGoal(customerId) { return `customers/${customerId}/customerLifecycleGoals`; } /** * @para