google-ads-api 12.0.0 → 13.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/build/src/protos/autogen/enums.d.ts +430 -334
- package/build/src/protos/autogen/enums.js +425 -323
- package/build/src/protos/autogen/fields.d.ts +174 -155
- package/build/src/protos/autogen/fields.js +11 -5
- package/build/src/protos/autogen/resourceNames.d.ts +31 -0
- package/build/src/protos/autogen/resourceNames.js +41 -2
- package/build/src/protos/autogen/serviceFactory.d.ts +176 -150
- package/build/src/protos/autogen/serviceFactory.js +418 -150
- package/build/src/protos/index.d.ts +6 -6
- package/build/src/protos/index.js +5 -5
- package/build/src/query.d.ts +5 -1
- package/build/src/query.js +16 -3
- package/build/src/types.d.ts +1 -0
- package/build/src/version.d.ts +1 -1
- package/build/src/version.js +1 -1
- package/package.json +3 -3
|
@@ -139,6 +139,8 @@ var fields;
|
|
|
139
139
|
"per_store_view.resource_name",
|
|
140
140
|
"product_bidding_category_constant.resource_name",
|
|
141
141
|
"product_group_view.resource_name",
|
|
142
|
+
"product_link.resource_name",
|
|
143
|
+
"qualifying_question.resource_name",
|
|
142
144
|
"recommendation.resource_name",
|
|
143
145
|
"remarketing_action.resource_name",
|
|
144
146
|
"search_term_view.resource_name",
|
|
@@ -149,6 +151,7 @@ var fields;
|
|
|
149
151
|
"smart_campaign_setting.resource_name",
|
|
150
152
|
"topic_constant.resource_name",
|
|
151
153
|
"topic_view.resource_name",
|
|
154
|
+
"travel_activity_performance_view.resource_name",
|
|
152
155
|
"user_interest.resource_name",
|
|
153
156
|
"user_list.resource_name",
|
|
154
157
|
"user_location_view.resource_name",
|
|
@@ -202,6 +205,8 @@ var fields;
|
|
|
202
205
|
"ad_group_ad_asset_view.performance_label": "AssetPerformanceLabel",
|
|
203
206
|
"ad_group_ad_asset_view.pinned_field": "ServedAssetFieldType",
|
|
204
207
|
"ad_group_asset.field_type": "AssetFieldType",
|
|
208
|
+
"ad_group_asset.primary_status": "AssetLinkPrimaryStatus",
|
|
209
|
+
"ad_group_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
|
|
205
210
|
"ad_group_asset.source": "AssetSource",
|
|
206
211
|
"ad_group_asset.status": "AssetLinkStatus",
|
|
207
212
|
"ad_group_asset_set.status": "AssetSetLinkStatus",
|
|
@@ -209,7 +214,6 @@ var fields;
|
|
|
209
214
|
"ad_group_bid_modifier.device.type": "Device",
|
|
210
215
|
"ad_group_bid_modifier.hotel_check_in_day.day_of_week": "DayOfWeek",
|
|
211
216
|
"ad_group_bid_modifier.hotel_date_selection_type.type": "HotelDateSelectionType",
|
|
212
|
-
"ad_group_bid_modifier.preferred_content.type": "PreferredContentType",
|
|
213
217
|
"ad_group_criterion.age_range.type": "AgeRangeType",
|
|
214
218
|
"ad_group_criterion.app_payment_model.type": "AppPaymentModelType",
|
|
215
219
|
"ad_group_criterion.approval_status": "AdGroupCriterionApprovalStatus",
|
|
@@ -325,11 +329,14 @@ var fields;
|
|
|
325
329
|
"campaign.primary_status_reasons": "CampaignPrimaryStatusReason",
|
|
326
330
|
"campaign.serving_status": "CampaignServingStatus",
|
|
327
331
|
"campaign.status": "CampaignStatus",
|
|
332
|
+
"campaign.target_cpm.target_frequency_goal.time_unit": "TargetFrequencyTimeUnit",
|
|
328
333
|
"campaign.target_impression_share.location": "TargetImpressionShareLocation",
|
|
329
334
|
"campaign.vanity_pharma.vanity_pharma_display_url_mode": "VanityPharmaDisplayUrlMode",
|
|
330
335
|
"campaign.vanity_pharma.vanity_pharma_text": "VanityPharmaText",
|
|
331
336
|
"campaign.video_brand_safety_suitability": "BrandSafetySuitability",
|
|
332
337
|
"campaign_asset.field_type": "AssetFieldType",
|
|
338
|
+
"campaign_asset.primary_status": "AssetLinkPrimaryStatus",
|
|
339
|
+
"campaign_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
|
|
333
340
|
"campaign_asset.source": "AssetSource",
|
|
334
341
|
"campaign_asset.status": "AssetLinkStatus",
|
|
335
342
|
"campaign_asset_set.status": "AssetSetLinkStatus",
|
|
@@ -402,6 +409,8 @@ var fields;
|
|
|
402
409
|
"customer.pay_per_conversion_eligibility_failure_reasons": "CustomerPayPerConversionEligibilityFailureReason",
|
|
403
410
|
"customer.status": "CustomerStatus",
|
|
404
411
|
"customer_asset.field_type": "AssetFieldType",
|
|
412
|
+
"customer_asset.primary_status": "AssetLinkPrimaryStatus",
|
|
413
|
+
"customer_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
|
|
405
414
|
"customer_asset.source": "AssetSource",
|
|
406
415
|
"customer_asset.status": "AssetLinkStatus",
|
|
407
416
|
"customer_asset_set.status": "AssetSetLinkStatus",
|
|
@@ -477,6 +486,7 @@ var fields;
|
|
|
477
486
|
"operating_system_version_constant.operator_type": "OperatingSystemVersionOperatorType",
|
|
478
487
|
"product_bidding_category_constant.level": "ProductBiddingCategoryLevel",
|
|
479
488
|
"product_bidding_category_constant.status": "ProductBiddingCategoryStatus",
|
|
489
|
+
"product_link.type": "LinkedProductType",
|
|
480
490
|
"recommendation.type": "RecommendationType",
|
|
481
491
|
"search_term_view.status": "SearchTermTargetingStatus",
|
|
482
492
|
"segments.ad_destination_type": "AdDestinationType",
|
|
@@ -519,10 +529,6 @@ var fields;
|
|
|
519
529
|
"user_list.crm_based_user_list.data_source_type": "UserListCrmDataSourceType",
|
|
520
530
|
"user_list.crm_based_user_list.upload_key_type": "CustomerMatchUploadKeyType",
|
|
521
531
|
"user_list.membership_status": "UserListMembershipStatus",
|
|
522
|
-
"user_list.rule_based_user_list.combined_rule_user_list.left_operand.rule_type": "UserListRuleType",
|
|
523
|
-
"user_list.rule_based_user_list.combined_rule_user_list.right_operand.rule_type": "UserListRuleType",
|
|
524
|
-
"user_list.rule_based_user_list.combined_rule_user_list.rule_operator": "UserListCombinedRuleOperator",
|
|
525
|
-
"user_list.rule_based_user_list.expression_rule_user_list.rule.rule_type": "UserListRuleType",
|
|
526
532
|
"user_list.rule_based_user_list.flexible_rule_user_list.inclusive_rule_operator": "UserListFlexibleRuleOperator",
|
|
527
533
|
"user_list.rule_based_user_list.prepopulation_status": "UserListPrepopulationStatus",
|
|
528
534
|
"user_list.size_range_for_display": "UserListSizeRange",
|
|
@@ -1240,6 +1240,21 @@ export declare type ProductGroupViewResourceName = `customers/${StrNum}/productG
|
|
|
1240
1240
|
* @example const productGroupView: ResourceNames.ProductGroupViewResourceName = ResourceNames.productGroupView(10987417, 21974834, 43949668)
|
|
1241
1241
|
*/
|
|
1242
1242
|
export declare function productGroupView(customerId: string | number, adgroupId: string | number, criterionId: string | number): ProductGroupViewResourceName;
|
|
1243
|
+
export declare type ProductLinkResourceName = `customers/${StrNum}/productLinks/${StrNum}`;
|
|
1244
|
+
/**
|
|
1245
|
+
* @param {string | number} customerId
|
|
1246
|
+
* @param {string | number} productLinkId
|
|
1247
|
+
* @returns `ProductLinkResourceName`
|
|
1248
|
+
* @example const productLink: ResourceNames.ProductLinkResourceName = ResourceNames.productLink(10987417, 21974834)
|
|
1249
|
+
*/
|
|
1250
|
+
export declare function productLink(customerId: string | number, productLinkId: string | number): ProductLinkResourceName;
|
|
1251
|
+
export declare type QualifyingQuestionResourceName = `qualifyingQuestions/${StrNum}`;
|
|
1252
|
+
/**
|
|
1253
|
+
* @param {string | number} qualifyingQuestionId
|
|
1254
|
+
* @returns `QualifyingQuestionResourceName`
|
|
1255
|
+
* @example const qualifyingQuestion: ResourceNames.QualifyingQuestionResourceName = ResourceNames.qualifyingQuestion(10987417)
|
|
1256
|
+
*/
|
|
1257
|
+
export declare function qualifyingQuestion(qualifyingQuestionId: string | number): QualifyingQuestionResourceName;
|
|
1243
1258
|
export declare type RecommendationResourceName = `customers/${StrNum}/recommendations/${StrNum}`;
|
|
1244
1259
|
/**
|
|
1245
1260
|
* @param {string | number} customerId
|
|
@@ -1331,6 +1346,22 @@ export declare type TopicViewResourceName = `customers/${StrNum}/topicViews/${St
|
|
|
1331
1346
|
* @example const topicView: ResourceNames.TopicViewResourceName = ResourceNames.topicView(10987417, 21974834, 43949668)
|
|
1332
1347
|
*/
|
|
1333
1348
|
export declare function topicView(customerId: string | number, adGroupId: string | number, criterionId: string | number): TopicViewResourceName;
|
|
1349
|
+
export declare type TravelActivityGroupViewResourceName = `customers/${StrNum}/travelActivityGroupViews/${StrNum}~${StrNum}`;
|
|
1350
|
+
/**
|
|
1351
|
+
* @param {string | number} customerId
|
|
1352
|
+
* @param {string | number} adGroupId
|
|
1353
|
+
* @param {string | number} criterionId
|
|
1354
|
+
* @returns `TravelActivityGroupViewResourceName`
|
|
1355
|
+
* @example const travelActivityGroupView: ResourceNames.TravelActivityGroupViewResourceName = ResourceNames.travelActivityGroupView(10987417, 21974834, 43949668)
|
|
1356
|
+
*/
|
|
1357
|
+
export declare function travelActivityGroupView(customerId: string | number, adGroupId: string | number, criterionId: string | number): TravelActivityGroupViewResourceName;
|
|
1358
|
+
export declare type TravelActivityPerformanceViewResourceName = `customers/${StrNum}/travelActivityPerformanceViews`;
|
|
1359
|
+
/**
|
|
1360
|
+
* @param {string | number} customerId
|
|
1361
|
+
* @returns `TravelActivityPerformanceViewResourceName`
|
|
1362
|
+
* @example const travelActivityPerformanceView: ResourceNames.TravelActivityPerformanceViewResourceName = ResourceNames.travelActivityPerformanceView(10987417)
|
|
1363
|
+
*/
|
|
1364
|
+
export declare function travelActivityPerformanceView(customerId: string | number): TravelActivityPerformanceViewResourceName;
|
|
1334
1365
|
export declare type UserInterestResourceName = `customers/${StrNum}/userInterests/${StrNum}`;
|
|
1335
1366
|
/**
|
|
1336
1367
|
* @param {string | number} customerId
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.campaignBudget = exports.campaignBidModifier = exports.campaignAudienceView = exports.campaignAssetSet = exports.campaignAsset = exports.campaign = exports.callView = exports.billingSetup = exports.biddingStrategySimulation = exports.biddingStrategy = exports.biddingSeasonalityAdjustment = exports.biddingDataExclusion = exports.batchJob = exports.audience = exports.assetSetTypeView = exports.assetSetAsset = exports.assetSet = exports.assetGroupSignal = exports.assetGroupProductGroupView = exports.assetGroupListingGroupFilter = exports.assetGroupAsset = exports.assetGroup = exports.assetFieldTypeView = exports.asset = exports.ageRangeView = exports.adScheduleView = exports.adParameter = exports.adGroupSimulation = exports.adGroupLabel = exports.adGroupFeed = exports.adGroupExtensionSetting = exports.adGroupCustomizer = exports.adGroupCriterionSimulation = exports.adGroupCriterionLabel = exports.adGroupCriterionCustomizer = exports.adGroupCriterion = exports.adGroupBidModifier = exports.adGroupAudienceView = exports.adGroupAssetSet = exports.adGroupAsset = exports.adGroupAdLabel = exports.adGroupAdAssetView = exports.adGroupAdAssetCombinationView = exports.adGroupAd = exports.adGroup = exports.ad = exports.accountLink = exports.accountBudgetProposal = exports.accountBudget = exports.accessibleBiddingStrategy = void 0;
|
|
5
5
|
exports.extensionFeedItem = exports.experimentArm = exports.experiment = exports.expandedLandingPageView = exports.dynamicSearchAdsSearchTermView = exports.domainCategory = exports.distanceView = exports.displayKeywordView = exports.detailedDemographic = exports.detailPlacementView = exports.customizerAttribute = exports.customerUserAccessInvitation = exports.customerUserAccess = exports.customerNegativeCriterion = exports.customerManagerLink = exports.customerLabel = exports.customerFeed = exports.customerExtensionSetting = exports.customerCustomizer = exports.customerConversionGoal = exports.customerClientLink = exports.customerClient = exports.customerAssetSet = exports.customerAsset = exports.customer = exports.customInterest = exports.customConversionGoal = exports.customAudience = exports.currencyConstant = exports.conversionValueRuleSet = exports.conversionValueRule = exports.conversionGoalCampaignConfig = exports.conversionCustomVariable = exports.conversionAction = exports.combinedAudience = exports.clickView = exports.changeStatus = exports.changeEvent = exports.carrierConstant = exports.campaignSimulation = exports.campaignSharedSet = exports.campaignLabel = exports.campaignGroup = exports.campaignFeed = exports.campaignExtensionSetting = exports.campaignDraft = exports.campaignCustomizer = exports.campaignCriterionSimulation = exports.campaignCriterion = exports.campaignConversionGoal = void 0;
|
|
6
|
-
exports.
|
|
7
|
-
exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = void 0;
|
|
6
|
+
exports.sharedSet = exports.sharedCriterion = exports.searchTermView = exports.remarketingAction = exports.recommendation = exports.qualifyingQuestion = exports.productLink = exports.productGroupView = exports.productBiddingCategoryConstant = exports.perStoreView = exports.paymentsAccount = exports.parentalStatusView = exports.paidOrganicSearchTermView = exports.operatingSystemVersionConstant = exports.offlineUserDataJob = exports.mobileDeviceConstant = exports.mobileAppCategoryConstant = exports.merchantCenterLink = exports.mediaFile = exports.managedPlacementView = exports.locationView = exports.lifeEvent = exports.leadFormSubmissionData = exports.languageConstant = exports.landingPageView = exports.label = exports.keywordView = exports.keywordThemeConstant = exports.keywordPlanCampaignKeyword = exports.keywordPlanCampaign = exports.keywordPlanAdGroupKeyword = exports.keywordPlanAdGroup = exports.keywordPlan = exports.invoice = exports.incomeRangeView = exports.hotelReconciliation = exports.hotelPerformanceView = exports.hotelGroupView = exports.groupPlacementView = exports.googleAdsField = exports.geographicView = exports.geoTargetConstant = exports.genderView = exports.feedPlaceholderView = exports.feedMapping = exports.feedItemTarget = exports.feedItemSetLink = exports.feedItemSet = exports.feedItem = exports.feed = void 0;
|
|
7
|
+
exports.webpageView = exports.video = exports.userLocationView = exports.userList = exports.userInterest = exports.travelActivityPerformanceView = exports.travelActivityGroupView = exports.topicView = exports.topicConstant = exports.thirdPartyAppAnalyticsLink = exports.smartCampaignSetting = exports.smartCampaignSearchTermView = exports.shoppingPerformanceView = void 0;
|
|
8
8
|
/**
|
|
9
9
|
* @param {string | number} customerId
|
|
10
10
|
* @param {string | number} biddingStrategyId
|
|
@@ -1532,6 +1532,25 @@ function productGroupView(customerId, adgroupId, criterionId) {
|
|
|
1532
1532
|
return `customers/${customerId}/productGroupViews/${adgroupId}~${criterionId}`;
|
|
1533
1533
|
}
|
|
1534
1534
|
exports.productGroupView = productGroupView;
|
|
1535
|
+
/**
|
|
1536
|
+
* @param {string | number} customerId
|
|
1537
|
+
* @param {string | number} productLinkId
|
|
1538
|
+
* @returns `ProductLinkResourceName`
|
|
1539
|
+
* @example const productLink: ResourceNames.ProductLinkResourceName = ResourceNames.productLink(10987417, 21974834)
|
|
1540
|
+
*/
|
|
1541
|
+
function productLink(customerId, productLinkId) {
|
|
1542
|
+
return `customers/${customerId}/productLinks/${productLinkId}`;
|
|
1543
|
+
}
|
|
1544
|
+
exports.productLink = productLink;
|
|
1545
|
+
/**
|
|
1546
|
+
* @param {string | number} qualifyingQuestionId
|
|
1547
|
+
* @returns `QualifyingQuestionResourceName`
|
|
1548
|
+
* @example const qualifyingQuestion: ResourceNames.QualifyingQuestionResourceName = ResourceNames.qualifyingQuestion(10987417)
|
|
1549
|
+
*/
|
|
1550
|
+
function qualifyingQuestion(qualifyingQuestionId) {
|
|
1551
|
+
return `qualifyingQuestions/${qualifyingQuestionId}`;
|
|
1552
|
+
}
|
|
1553
|
+
exports.qualifyingQuestion = qualifyingQuestion;
|
|
1535
1554
|
/**
|
|
1536
1555
|
* @param {string | number} customerId
|
|
1537
1556
|
* @param {string | number} recommendationId
|
|
@@ -1645,6 +1664,26 @@ function topicView(customerId, adGroupId, criterionId) {
|
|
|
1645
1664
|
return `customers/${customerId}/topicViews/${adGroupId}~${criterionId}`;
|
|
1646
1665
|
}
|
|
1647
1666
|
exports.topicView = topicView;
|
|
1667
|
+
/**
|
|
1668
|
+
* @param {string | number} customerId
|
|
1669
|
+
* @param {string | number} adGroupId
|
|
1670
|
+
* @param {string | number} criterionId
|
|
1671
|
+
* @returns `TravelActivityGroupViewResourceName`
|
|
1672
|
+
* @example const travelActivityGroupView: ResourceNames.TravelActivityGroupViewResourceName = ResourceNames.travelActivityGroupView(10987417, 21974834, 43949668)
|
|
1673
|
+
*/
|
|
1674
|
+
function travelActivityGroupView(customerId, adGroupId, criterionId) {
|
|
1675
|
+
return `customers/${customerId}/travelActivityGroupViews/${adGroupId}~${criterionId}`;
|
|
1676
|
+
}
|
|
1677
|
+
exports.travelActivityGroupView = travelActivityGroupView;
|
|
1678
|
+
/**
|
|
1679
|
+
* @param {string | number} customerId
|
|
1680
|
+
* @returns `TravelActivityPerformanceViewResourceName`
|
|
1681
|
+
* @example const travelActivityPerformanceView: ResourceNames.TravelActivityPerformanceViewResourceName = ResourceNames.travelActivityPerformanceView(10987417)
|
|
1682
|
+
*/
|
|
1683
|
+
function travelActivityPerformanceView(customerId) {
|
|
1684
|
+
return `customers/${customerId}/travelActivityPerformanceViews`;
|
|
1685
|
+
}
|
|
1686
|
+
exports.travelActivityPerformanceView = travelActivityPerformanceView;
|
|
1648
1687
|
/**
|
|
1649
1688
|
* @param {string | number} customerId
|
|
1650
1689
|
* @param {string | number} userInterestId
|