google-ads-api
Version:
Google Ads API Client Library for Node.js
765 lines • 96.3 kB
TypeScript
type StrNum = string | number;
export type AccessibleBiddingStrategyResourceName = `customers/${StrNum}/accessibleBiddingStrategies/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} biddingStrategyId
* @returns `AccessibleBiddingStrategyResourceName`
* @example const accessibleBiddingStrategy: ResourceNames.AccessibleBiddingStrategyResourceName = ResourceNames.accessibleBiddingStrategy(10987417, 21974834)
*/
export declare function accessibleBiddingStrategy(customerId: string | number, biddingStrategyId: string | number): AccessibleBiddingStrategyResourceName;
export type AccountBudgetResourceName = `customers/${StrNum}/accountBudgets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} accountBudgetId
* @returns `AccountBudgetResourceName`
* @example const accountBudget: ResourceNames.AccountBudgetResourceName = ResourceNames.accountBudget(10987417, 21974834)
*/
export declare function accountBudget(customerId: string | number, accountBudgetId: string | number): AccountBudgetResourceName;
export type AccountBudgetProposalResourceName = `customers/${StrNum}/accountBudgetProposals/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} accountBudgetProposalId
* @returns `AccountBudgetProposalResourceName`
* @example const accountBudgetProposal: ResourceNames.AccountBudgetProposalResourceName = ResourceNames.accountBudgetProposal(10987417, 21974834)
*/
export declare function accountBudgetProposal(customerId: string | number, accountBudgetProposalId: string | number): AccountBudgetProposalResourceName;
export type AccountLinkResourceName = `customers/${StrNum}/accountLinks/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} accountLinkId
* @returns `AccountLinkResourceName`
* @example const accountLink: ResourceNames.AccountLinkResourceName = ResourceNames.accountLink(10987417, 21974834)
*/
export declare function accountLink(customerId: string | number, accountLinkId: string | number): AccountLinkResourceName;
export type AdResourceName = `customers/${StrNum}/ads/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adId
* @returns `AdResourceName`
* @example const ad: ResourceNames.AdResourceName = ResourceNames.ad(10987417, 21974834)
*/
export declare function ad(customerId: string | number, adId: string | number): AdResourceName;
export type AdGroupResourceName = `customers/${StrNum}/adGroups/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @returns `AdGroupResourceName`
* @example const adGroup: ResourceNames.AdGroupResourceName = ResourceNames.adGroup(10987417, 21974834)
*/
export declare function adGroup(customerId: string | number, adGroupId: string | number): AdGroupResourceName;
export type AdGroupAdResourceName = `customers/${StrNum}/adGroupAds/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} adId
* @returns `AdGroupAdResourceName`
* @example const adGroupAd: ResourceNames.AdGroupAdResourceName = ResourceNames.adGroupAd(10987417, 21974834, 43949668)
*/
export declare function adGroupAd(customerId: string | number, adGroupId: string | number, adId: string | number): AdGroupAdResourceName;
export type AdGroupAdAssetCombinationViewResourceName = `customers/${StrNum}/adGroupAdAssetCombinationViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupAdAssetCombinationView(customerId: string | number, adGroupId: string | number, adId: string | number, assetCombinationIdLow: string | number, assetCombinationIdHigh: string | number): AdGroupAdAssetCombinationViewResourceName;
export type AdGroupAdAssetViewResourceName = `customers/${StrNum}/adGroupAdAssetViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupAdAssetView(customerId: string | number, adGroupId: string | number, adId: string | number, assetId: string | number, fieldType: string | number): AdGroupAdAssetViewResourceName;
export type AdGroupAdLabelResourceName = `customers/${StrNum}/adGroupAdLabels/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupAdLabel(customerId: string | number, adGroupId: string | number, adId: string | number, labelId: string | number): AdGroupAdLabelResourceName;
export type AdGroupAssetResourceName = `customers/${StrNum}/adGroupAssets/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupAsset(customerId: string | number, adGroupId: string | number, assetId: string | number, fieldType: string | number): AdGroupAssetResourceName;
export type AdGroupAssetSetResourceName = `customers/${StrNum}/adGroupAssetSets/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} assetSetId
* @returns `AdGroupAssetSetResourceName`
* @example const adGroupAssetSet: ResourceNames.AdGroupAssetSetResourceName = ResourceNames.adGroupAssetSet(10987417, 21974834, 43949668)
*/
export declare function adGroupAssetSet(customerId: string | number, adGroupId: string | number, assetSetId: string | number): AdGroupAssetSetResourceName;
export type AdGroupAudienceViewResourceName = `customers/${StrNum}/adGroupAudienceViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} criterionId
* @returns `AdGroupAudienceViewResourceName`
* @example const adGroupAudienceView: ResourceNames.AdGroupAudienceViewResourceName = ResourceNames.adGroupAudienceView(10987417, 21974834, 43949668)
*/
export declare function adGroupAudienceView(customerId: string | number, adGroupId: string | number, criterionId: string | number): AdGroupAudienceViewResourceName;
export type AdGroupBidModifierResourceName = `customers/${StrNum}/adGroupBidModifiers/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} criterionId
* @returns `AdGroupBidModifierResourceName`
* @example const adGroupBidModifier: ResourceNames.AdGroupBidModifierResourceName = ResourceNames.adGroupBidModifier(10987417, 21974834, 43949668)
*/
export declare function adGroupBidModifier(customerId: string | number, adGroupId: string | number, criterionId: string | number): AdGroupBidModifierResourceName;
export type AdGroupCriterionResourceName = `customers/${StrNum}/adGroupCriteria/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} criterionId
* @returns `AdGroupCriterionResourceName`
* @example const adGroupCriterion: ResourceNames.AdGroupCriterionResourceName = ResourceNames.adGroupCriterion(10987417, 21974834, 43949668)
*/
export declare function adGroupCriterion(customerId: string | number, adGroupId: string | number, criterionId: string | number): AdGroupCriterionResourceName;
export type AdGroupCriterionCustomizerResourceName = `customers/${StrNum}/adGroupCriterionCustomizers/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupCriterionCustomizer(customerId: string | number, adGroupId: string | number, criterionId: string | number, customizerAttributeId: string | number): AdGroupCriterionCustomizerResourceName;
export type AdGroupCriterionLabelResourceName = `customers/${StrNum}/adGroupCriterionLabels/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupCriterionLabel(customerId: string | number, adGroupId: string | number, criterionId: string | number, labelId: string | number): AdGroupCriterionLabelResourceName;
export type AdGroupCriterionSimulationResourceName = `customers/${StrNum}/adGroupCriterionSimulations/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupCriterionSimulation(customerId: string | number, adGroupId: string | number, criterionId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): AdGroupCriterionSimulationResourceName;
export type AdGroupCustomizerResourceName = `customers/${StrNum}/adGroupCustomizers/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} customizerAttributeId
* @returns `AdGroupCustomizerResourceName`
* @example const adGroupCustomizer: ResourceNames.AdGroupCustomizerResourceName = ResourceNames.adGroupCustomizer(10987417, 21974834, 43949668)
*/
export declare function adGroupCustomizer(customerId: string | number, adGroupId: string | number, customizerAttributeId: string | number): AdGroupCustomizerResourceName;
export type AdGroupLabelResourceName = `customers/${StrNum}/adGroupLabels/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} labelId
* @returns `AdGroupLabelResourceName`
* @example const adGroupLabel: ResourceNames.AdGroupLabelResourceName = ResourceNames.adGroupLabel(10987417, 21974834, 43949668)
*/
export declare function adGroupLabel(customerId: string | number, adGroupId: string | number, labelId: string | number): AdGroupLabelResourceName;
export type AdGroupSimulationResourceName = `customers/${StrNum}/adGroupSimulations/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adGroupSimulation(customerId: string | number, adGroupId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): AdGroupSimulationResourceName;
export type AdParameterResourceName = `customers/${StrNum}/adParameters/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function adParameter(customerId: string | number, adGroupId: string | number, criterionId: string | number, parameterIndex: string | number): AdParameterResourceName;
export type AdScheduleViewResourceName = `customers/${StrNum}/adScheduleViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} criterionId
* @returns `AdScheduleViewResourceName`
* @example const adScheduleView: ResourceNames.AdScheduleViewResourceName = ResourceNames.adScheduleView(10987417, 21974834, 43949668)
*/
export declare function adScheduleView(customerId: string | number, campaignId: string | number, criterionId: string | number): AdScheduleViewResourceName;
export type AgeRangeViewResourceName = `customers/${StrNum}/ageRangeViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} criterionId
* @returns `AgeRangeViewResourceName`
* @example const ageRangeView: ResourceNames.AgeRangeViewResourceName = ResourceNames.ageRangeView(10987417, 21974834, 43949668)
*/
export declare function ageRangeView(customerId: string | number, adGroupId: string | number, criterionId: string | number): AgeRangeViewResourceName;
export type AndroidPrivacySharedKeyGoogleAdGroupResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleAdGroups/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function androidPrivacySharedKeyGoogleAdGroup(customerId: string | number, campaignId: string | number, adGroupId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyNetworkType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleAdGroupResourceName;
export type AndroidPrivacySharedKeyGoogleCampaignResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleCampaigns/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function androidPrivacySharedKeyGoogleCampaign(customerId: string | number, campaignId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleCampaignResourceName;
export type AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleNetworkTypes/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function androidPrivacySharedKeyGoogleNetworkType(customerId: string | number, campaignId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyNetworkType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleNetworkTypeResourceName;
export type AssetResourceName = `customers/${StrNum}/assets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetId
* @returns `AssetResourceName`
* @example const asset: ResourceNames.AssetResourceName = ResourceNames.asset(10987417, 21974834)
*/
export declare function asset(customerId: string | number, assetId: string | number): AssetResourceName;
export type AssetFieldTypeViewResourceName = `customers/${StrNum}/assetFieldTypeViews/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} fieldType
* @returns `AssetFieldTypeViewResourceName`
* @example const assetFieldTypeView: ResourceNames.AssetFieldTypeViewResourceName = ResourceNames.assetFieldTypeView(10987417, 21974834)
*/
export declare function assetFieldTypeView(customerId: string | number, fieldType: string | number): AssetFieldTypeViewResourceName;
export type AssetGroupResourceName = `customers/${StrNum}/assetGroups/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetGroupId
* @returns `AssetGroupResourceName`
* @example const assetGroup: ResourceNames.AssetGroupResourceName = ResourceNames.assetGroup(10987417, 21974834)
*/
export declare function assetGroup(customerId: string | number, assetGroupId: string | number): AssetGroupResourceName;
export type AssetGroupAssetResourceName = `customers/${StrNum}/assetGroupAssets/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function assetGroupAsset(customerId: string | number, assetGroupId: string | number, assetId: string | number, fieldType: string | number): AssetGroupAssetResourceName;
export type AssetGroupListingGroupFilterResourceName = `customers/${StrNum}/assetGroupListingGroupFilters/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetGroupId
* @param {string | number} listingGroupFilterId
* @returns `AssetGroupListingGroupFilterResourceName`
* @example const assetGroupListingGroupFilter: ResourceNames.AssetGroupListingGroupFilterResourceName = ResourceNames.assetGroupListingGroupFilter(10987417, 21974834, 43949668)
*/
export declare function assetGroupListingGroupFilter(customerId: string | number, assetGroupId: string | number, listingGroupFilterId: string | number): AssetGroupListingGroupFilterResourceName;
export type AssetGroupProductGroupViewResourceName = `customers/${StrNum}/assetGroupProductGroupViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetGroupId
* @param {string | number} listingGroupFilterId
* @returns `AssetGroupProductGroupViewResourceName`
* @example const assetGroupProductGroupView: ResourceNames.AssetGroupProductGroupViewResourceName = ResourceNames.assetGroupProductGroupView(10987417, 21974834, 43949668)
*/
export declare function assetGroupProductGroupView(customerId: string | number, assetGroupId: string | number, listingGroupFilterId: string | number): AssetGroupProductGroupViewResourceName;
export type AssetGroupSignalResourceName = `customers/${StrNum}/assetGroupSignals/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetGroupId
* @param {string | number} criterionId
* @returns `AssetGroupSignalResourceName`
* @example const assetGroupSignal: ResourceNames.AssetGroupSignalResourceName = ResourceNames.assetGroupSignal(10987417, 21974834, 43949668)
*/
export declare function assetGroupSignal(customerId: string | number, assetGroupId: string | number, criterionId: string | number): AssetGroupSignalResourceName;
export type AssetGroupTopCombinationViewResourceName = `customers/${StrNum}/assetGroupTopCombinationViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetGroupId
* @param {string | number} assetCombinationCategory
* @returns `AssetGroupTopCombinationViewResourceName`
* @example const assetGroupTopCombinationView: ResourceNames.AssetGroupTopCombinationViewResourceName = ResourceNames.assetGroupTopCombinationView(10987417, 21974834, 43949668)
*/
export declare function assetGroupTopCombinationView(customerId: string | number, assetGroupId: string | number, assetCombinationCategory: string | number): AssetGroupTopCombinationViewResourceName;
export type AssetSetResourceName = `customers/${StrNum}/assetSets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetSetId
* @returns `AssetSetResourceName`
* @example const assetSet: ResourceNames.AssetSetResourceName = ResourceNames.assetSet(10987417, 21974834)
*/
export declare function assetSet(customerId: string | number, assetSetId: string | number): AssetSetResourceName;
export type AssetSetAssetResourceName = `customers/${StrNum}/assetSetAssets/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetSetId
* @param {string | number} assetId
* @returns `AssetSetAssetResourceName`
* @example const assetSetAsset: ResourceNames.AssetSetAssetResourceName = ResourceNames.assetSetAsset(10987417, 21974834, 43949668)
*/
export declare function assetSetAsset(customerId: string | number, assetSetId: string | number, assetId: string | number): AssetSetAssetResourceName;
export type AssetSetTypeViewResourceName = `customers/${StrNum}/assetSetTypeViews/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetSetType
* @returns `AssetSetTypeViewResourceName`
* @example const assetSetTypeView: ResourceNames.AssetSetTypeViewResourceName = ResourceNames.assetSetTypeView(10987417, 21974834)
*/
export declare function assetSetTypeView(customerId: string | number, assetSetType: string | number): AssetSetTypeViewResourceName;
export type AudienceResourceName = `customers/${StrNum}/audiences/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} audienceId
* @returns `AudienceResourceName`
* @example const audience: ResourceNames.AudienceResourceName = ResourceNames.audience(10987417, 21974834)
*/
export declare function audience(customerId: string | number, audienceId: string | number): AudienceResourceName;
export type BatchJobResourceName = `customers/${StrNum}/batchJobs/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} batchJobId
* @returns `BatchJobResourceName`
* @example const batchJob: ResourceNames.BatchJobResourceName = ResourceNames.batchJob(10987417, 21974834)
*/
export declare function batchJob(customerId: string | number, batchJobId: string | number): BatchJobResourceName;
export type BiddingDataExclusionResourceName = `customers/${StrNum}/biddingDataExclusions/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} seasonalityEventId
* @returns `BiddingDataExclusionResourceName`
* @example const biddingDataExclusion: ResourceNames.BiddingDataExclusionResourceName = ResourceNames.biddingDataExclusion(10987417, 21974834)
*/
export declare function biddingDataExclusion(customerId: string | number, seasonalityEventId: string | number): BiddingDataExclusionResourceName;
export type BiddingSeasonalityAdjustmentResourceName = `customers/${StrNum}/biddingSeasonalityAdjustments/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} seasonalityEventId
* @returns `BiddingSeasonalityAdjustmentResourceName`
* @example const biddingSeasonalityAdjustment: ResourceNames.BiddingSeasonalityAdjustmentResourceName = ResourceNames.biddingSeasonalityAdjustment(10987417, 21974834)
*/
export declare function biddingSeasonalityAdjustment(customerId: string | number, seasonalityEventId: string | number): BiddingSeasonalityAdjustmentResourceName;
export type BiddingStrategyResourceName = `customers/${StrNum}/biddingStrategies/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} biddingStrategyId
* @returns `BiddingStrategyResourceName`
* @example const biddingStrategy: ResourceNames.BiddingStrategyResourceName = ResourceNames.biddingStrategy(10987417, 21974834)
*/
export declare function biddingStrategy(customerId: string | number, biddingStrategyId: string | number): BiddingStrategyResourceName;
export type BiddingStrategySimulationResourceName = `customers/${StrNum}/biddingStrategySimulations/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function biddingStrategySimulation(customerId: string | number, biddingStrategyId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): BiddingStrategySimulationResourceName;
export type BillingSetupResourceName = `customers/${StrNum}/billingSetups/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} billingSetupId
* @returns `BillingSetupResourceName`
* @example const billingSetup: ResourceNames.BillingSetupResourceName = ResourceNames.billingSetup(10987417, 21974834)
*/
export declare function billingSetup(customerId: string | number, billingSetupId: string | number): BillingSetupResourceName;
export type CallViewResourceName = `customers/${StrNum}/callViews/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} callDetailId
* @returns `CallViewResourceName`
* @example const callView: ResourceNames.CallViewResourceName = ResourceNames.callView(10987417, 21974834)
*/
export declare function callView(customerId: string | number, callDetailId: string | number): CallViewResourceName;
export type CampaignResourceName = `customers/${StrNum}/campaigns/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @returns `CampaignResourceName`
* @example const campaign: ResourceNames.CampaignResourceName = ResourceNames.campaign(10987417, 21974834)
*/
export declare function campaign(customerId: string | number, campaignId: string | number): CampaignResourceName;
export type CampaignAggregateAssetViewResourceName = `customers/${StrNum}/campaignAggregateAssetViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function campaignAggregateAssetView(customerId: string | number, campaignId: string | number, assetId: string | number, assetLinkSource: string | number, fieldType: string | number): CampaignAggregateAssetViewResourceName;
export type CampaignAssetResourceName = `customers/${StrNum}/campaignAssets/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function campaignAsset(customerId: string | number, campaignId: string | number, assetId: string | number, fieldType: string | number): CampaignAssetResourceName;
export type CampaignAssetSetResourceName = `customers/${StrNum}/campaignAssetSets/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} assetSetId
* @returns `CampaignAssetSetResourceName`
* @example const campaignAssetSet: ResourceNames.CampaignAssetSetResourceName = ResourceNames.campaignAssetSet(10987417, 21974834, 43949668)
*/
export declare function campaignAssetSet(customerId: string | number, campaignId: string | number, assetSetId: string | number): CampaignAssetSetResourceName;
export type CampaignAudienceViewResourceName = `customers/${StrNum}/campaignAudienceViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} criterionId
* @returns `CampaignAudienceViewResourceName`
* @example const campaignAudienceView: ResourceNames.CampaignAudienceViewResourceName = ResourceNames.campaignAudienceView(10987417, 21974834, 43949668)
*/
export declare function campaignAudienceView(customerId: string | number, campaignId: string | number, criterionId: string | number): CampaignAudienceViewResourceName;
export type CampaignBidModifierResourceName = `customers/${StrNum}/campaignBidModifiers/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} criterionId
* @returns `CampaignBidModifierResourceName`
* @example const campaignBidModifier: ResourceNames.CampaignBidModifierResourceName = ResourceNames.campaignBidModifier(10987417, 21974834, 43949668)
*/
export declare function campaignBidModifier(customerId: string | number, campaignId: string | number, criterionId: string | number): CampaignBidModifierResourceName;
export type CampaignBudgetResourceName = `customers/${StrNum}/campaignBudgets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignBudgetId
* @returns `CampaignBudgetResourceName`
* @example const campaignBudget: ResourceNames.CampaignBudgetResourceName = ResourceNames.campaignBudget(10987417, 21974834)
*/
export declare function campaignBudget(customerId: string | number, campaignBudgetId: string | number): CampaignBudgetResourceName;
export type CampaignConversionGoalResourceName = `customers/${StrNum}/campaignConversionGoals/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function campaignConversionGoal(customerId: string | number, campaignId: string | number, category: string | number, source: string | number): CampaignConversionGoalResourceName;
export type CampaignCriterionResourceName = `customers/${StrNum}/campaignCriteria/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} criterionId
* @returns `CampaignCriterionResourceName`
* @example const campaignCriterion: ResourceNames.CampaignCriterionResourceName = ResourceNames.campaignCriterion(10987417, 21974834, 43949668)
*/
export declare function campaignCriterion(customerId: string | number, campaignId: string | number, criterionId: string | number): CampaignCriterionResourceName;
export type CampaignCustomizerResourceName = `customers/${StrNum}/campaignCustomizers/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} customizerAttributeId
* @returns `CampaignCustomizerResourceName`
* @example const campaignCustomizer: ResourceNames.CampaignCustomizerResourceName = ResourceNames.campaignCustomizer(10987417, 21974834, 43949668)
*/
export declare function campaignCustomizer(customerId: string | number, campaignId: string | number, customizerAttributeId: string | number): CampaignCustomizerResourceName;
export type CampaignDraftResourceName = `customers/${StrNum}/campaignDrafts/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} baseCampaignId
* @param {string | number} draftId
* @returns `CampaignDraftResourceName`
* @example const campaignDraft: ResourceNames.CampaignDraftResourceName = ResourceNames.campaignDraft(10987417, 21974834, 43949668)
*/
export declare function campaignDraft(customerId: string | number, baseCampaignId: string | number, draftId: string | number): CampaignDraftResourceName;
export type CampaignGroupResourceName = `customers/${StrNum}/campaignGroups/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignGroupId
* @returns `CampaignGroupResourceName`
* @example const campaignGroup: ResourceNames.CampaignGroupResourceName = ResourceNames.campaignGroup(10987417, 21974834)
*/
export declare function campaignGroup(customerId: string | number, campaignGroupId: string | number): CampaignGroupResourceName;
export type CampaignLabelResourceName = `customers/${StrNum}/campaignLabels/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} labelId
* @returns `CampaignLabelResourceName`
* @example const campaignLabel: ResourceNames.CampaignLabelResourceName = ResourceNames.campaignLabel(10987417, 21974834, 43949668)
*/
export declare function campaignLabel(customerId: string | number, campaignId: string | number, labelId: string | number): CampaignLabelResourceName;
export type CampaignLifecycleGoalResourceName = `customers/${StrNum}/campaignLifecycleGoals/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @returns `CampaignLifecycleGoalResourceName`
* @example const campaignLifecycleGoal: ResourceNames.CampaignLifecycleGoalResourceName = ResourceNames.campaignLifecycleGoal(10987417, 21974834)
*/
export declare function campaignLifecycleGoal(customerId: string | number, campaignId: string | number): CampaignLifecycleGoalResourceName;
export type CampaignSearchTermInsightResourceName = `customers/${StrNum}/campaignSearchTermInsights/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} clusterId
* @returns `CampaignSearchTermInsightResourceName`
* @example const campaignSearchTermInsight: ResourceNames.CampaignSearchTermInsightResourceName = ResourceNames.campaignSearchTermInsight(10987417, 21974834, 43949668)
*/
export declare function campaignSearchTermInsight(customerId: string | number, campaignId: string | number, clusterId: string | number): CampaignSearchTermInsightResourceName;
export type CampaignSharedSetResourceName = `customers/${StrNum}/campaignSharedSets/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @param {string | number} sharedSetId
* @returns `CampaignSharedSetResourceName`
* @example const campaignSharedSet: ResourceNames.CampaignSharedSetResourceName = ResourceNames.campaignSharedSet(10987417, 21974834, 43949668)
*/
export declare function campaignSharedSet(customerId: string | number, campaignId: string | number, sharedSetId: string | number): CampaignSharedSetResourceName;
export type CampaignSimulationResourceName = `customers/${StrNum}/campaignSimulations/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function campaignSimulation(customerId: string | number, campaignId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): CampaignSimulationResourceName;
export type CarrierConstantResourceName = `carrierConstants/${StrNum}`;
/**
* @param {string | number} criterionId
* @returns `CarrierConstantResourceName`
* @example const carrierConstant: ResourceNames.CarrierConstantResourceName = ResourceNames.carrierConstant(10987417)
*/
export declare function carrierConstant(criterionId: string | number): CarrierConstantResourceName;
export type ChangeEventResourceName = `customers/${StrNum}/changeEvents/${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function changeEvent(customerId: string | number, timestampMicros: string | number, commandIndex: string | number, mutateIndex: string | number): ChangeEventResourceName;
export type ChangeStatusResourceName = `customers/${StrNum}/changeStatus/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} changeStatusId
* @returns `ChangeStatusResourceName`
* @example const changeStatus: ResourceNames.ChangeStatusResourceName = ResourceNames.changeStatus(10987417, 21974834)
*/
export declare function changeStatus(customerId: string | number, changeStatusId: string | number): ChangeStatusResourceName;
export type ChannelAggregateAssetViewResourceName = `customers/${StrNum}/channelAggregateAssetViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
/**
* @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)
*/
export declare function channelAggregateAssetView(customerId: string | number, advertisingChannelType: string | number, assetId: string | number, assetSource: string | number, fieldType: string | number): ChannelAggregateAssetViewResourceName;
export type ClickViewResourceName = `customers/${StrNum}/clickViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} date
* @param {string | number} gclid
* @returns `ClickViewResourceName`
* @example const clickView: ResourceNames.ClickViewResourceName = ResourceNames.clickView(10987417, 21974834, 43949668)
*/
export declare function clickView(customerId: string | number, date: string | number, gclid: string | number): ClickViewResourceName;
export type CombinedAudienceResourceName = `customers/${StrNum}/combinedAudiences/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} combinedAudienceId
* @returns `CombinedAudienceResourceName`
* @example const combinedAudience: ResourceNames.CombinedAudienceResourceName = ResourceNames.combinedAudience(10987417, 21974834)
*/
export declare function combinedAudience(customerId: string | number, combinedAudienceId: string | number): CombinedAudienceResourceName;
export type ContentCriterionViewResourceName = `customers/${StrNum}/contentCriterionViews/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} adGroupId
* @param {string | number} criterionId
* @returns `ContentCriterionViewResourceName`
* @example const contentCriterionView: ResourceNames.ContentCriterionViewResourceName = ResourceNames.contentCriterionView(10987417, 21974834, 43949668)
*/
export declare function contentCriterionView(customerId: string | number, adGroupId: string | number, criterionId: string | number): ContentCriterionViewResourceName;
export type ConversionActionResourceName = `customers/${StrNum}/conversionActions/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} conversionActionId
* @returns `ConversionActionResourceName`
* @example const conversionAction: ResourceNames.ConversionActionResourceName = ResourceNames.conversionAction(10987417, 21974834)
*/
export declare function conversionAction(customerId: string | number, conversionActionId: string | number): ConversionActionResourceName;
export type ConversionCustomVariableResourceName = `customers/${StrNum}/conversionCustomVariables/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} conversionCustomVariableId
* @returns `ConversionCustomVariableResourceName`
* @example const conversionCustomVariable: ResourceNames.ConversionCustomVariableResourceName = ResourceNames.conversionCustomVariable(10987417, 21974834)
*/
export declare function conversionCustomVariable(customerId: string | number, conversionCustomVariableId: string | number): ConversionCustomVariableResourceName;
export type ConversionGoalCampaignConfigResourceName = `customers/${StrNum}/conversionGoalCampaignConfigs/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} campaignId
* @returns `ConversionGoalCampaignConfigResourceName`
* @example const conversionGoalCampaignConfig: ResourceNames.ConversionGoalCampaignConfigResourceName = ResourceNames.conversionGoalCampaignConfig(10987417, 21974834)
*/
export declare function conversionGoalCampaignConfig(customerId: string | number, campaignId: string | number): ConversionGoalCampaignConfigResourceName;
export type ConversionValueRuleResourceName = `customers/${StrNum}/conversionValueRules/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} conversionValueRuleId
* @returns `ConversionValueRuleResourceName`
* @example const conversionValueRule: ResourceNames.ConversionValueRuleResourceName = ResourceNames.conversionValueRule(10987417, 21974834)
*/
export declare function conversionValueRule(customerId: string | number, conversionValueRuleId: string | number): ConversionValueRuleResourceName;
export type ConversionValueRuleSetResourceName = `customers/${StrNum}/conversionValueRuleSets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} conversionValueRuleSetId
* @returns `ConversionValueRuleSetResourceName`
* @example const conversionValueRuleSet: ResourceNames.ConversionValueRuleSetResourceName = ResourceNames.conversionValueRuleSet(10987417, 21974834)
*/
export declare function conversionValueRuleSet(customerId: string | number, conversionValueRuleSetId: string | number): ConversionValueRuleSetResourceName;
export type CurrencyConstantResourceName = `currencyConstants/${StrNum}`;
/**
* @param {string | number} code
* @returns `CurrencyConstantResourceName`
* @example const currencyConstant: ResourceNames.CurrencyConstantResourceName = ResourceNames.currencyConstant(10987417)
*/
export declare function currencyConstant(code: string | number): CurrencyConstantResourceName;
export type CustomAudienceResourceName = `customers/${StrNum}/customAudiences/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} customAudienceId
* @returns `CustomAudienceResourceName`
* @example const customAudience: ResourceNames.CustomAudienceResourceName = ResourceNames.customAudience(10987417, 21974834)
*/
export declare function customAudience(customerId: string | number, customAudienceId: string | number): CustomAudienceResourceName;
export type CustomConversionGoalResourceName = `customers/${StrNum}/customConversionGoals/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} goalId
* @returns `CustomConversionGoalResourceName`
* @example const customConversionGoal: ResourceNames.CustomConversionGoalResourceName = ResourceNames.customConversionGoal(10987417, 21974834)
*/
export declare function customConversionGoal(customerId: string | number, goalId: string | number): CustomConversionGoalResourceName;
export type CustomInterestResourceName = `customers/${StrNum}/customInterests/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} customInterestId
* @returns `CustomInterestResourceName`
* @example const customInterest: ResourceNames.CustomInterestResourceName = ResourceNames.customInterest(10987417, 21974834)
*/
export declare function customInterest(customerId: string | number, customInterestId: string | number): CustomInterestResourceName;
export type CustomerResourceName = `customers/${StrNum}`;
/**
* @param {string | number} customerId
* @returns `CustomerResourceName`
* @example const customer: ResourceNames.CustomerResourceName = ResourceNames.customer(10987417)
*/
export declare function customer(customerId: string | number): CustomerResourceName;
export type CustomerAssetResourceName = `customers/${StrNum}/customerAssets/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetId
* @param {string | number} fieldType
* @returns `CustomerAssetResourceName`
* @example const customerAsset: ResourceNames.CustomerAssetResourceName = ResourceNames.customerAsset(10987417, 21974834, 43949668)
*/
export declare function customerAsset(customerId: string | number, assetId: string | number, fieldType: string | number): CustomerAssetResourceName;
export type CustomerAssetSetResourceName = `customers/${StrNum}/customerAssetSets/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} assetSetId
* @returns `CustomerAssetSetResourceName`
* @example const customerAssetSet: ResourceNames.CustomerAssetSetResourceName = ResourceNames.customerAssetSet(10987417, 21974834)
*/
export declare function customerAssetSet(customerId: string | number, assetSetId: string | number): CustomerAssetSetResourceName;
export type CustomerClientResourceName = `customers/${StrNum}/customerClients/${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} clientCustomerId
* @returns `CustomerClientResourceName`
* @example const customerClient: ResourceNames.CustomerClientResourceName = ResourceNames.customerClient(10987417, 21974834)
*/
export declare function customerClient(customerId: string | number, clientCustomerId: string | number): CustomerClientResourceName;
export type CustomerClientLinkResourceName = `customers/${StrNum}/customerClientLinks/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} clientCustomerId
* @param {string | number} managerLinkId
* @returns `CustomerClientLinkResourceName`
* @example const customerClientLink: ResourceNames.CustomerClientLinkResourceName = ResourceNames.customerClientLink(10987417, 21974834, 43949668)
*/
export declare function customerClientLink(customerId: string | number, clientCustomerId: string | number, managerLinkId: string | number): CustomerClientLinkResourceName;
export type CustomerConversionGoalResourceName = `customers/${StrNum}/customerConversionGoals/${StrNum}~${StrNum}`;
/**
* @param {string | number} customerId
* @param {string | number} category
* @param {string | number} source
* @returns `CustomerConversionGoalResourceName`
* @example const customerConversionGoal: ResourceNames.CustomerConversionGoalResourceName = ResourceNames.customerConversionGoal(10987417, 21974834, 43949668)
*/
export declare function customerConversionGoal(customerId: string | number, category: string | number, source: string | number): CustomerConversionGoalResourceName;
export type CustomerCustomizerResourceName = `customers/${StrNum}/customerCustomizers/${StrNum}`;
/**
* @param {st