google-ads-api 8.1.0 → 10.0.1
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/parser.js +15 -6
- package/build/src/protos/autogen/enums.d.ts +777 -324
- package/build/src/protos/autogen/enums.js +800 -315
- package/build/src/protos/autogen/fields.d.ts +235 -127
- package/build/src/protos/autogen/fields.js +74 -0
- package/build/src/protos/autogen/resourceNames.d.ts +194 -0
- package/build/src/protos/autogen/resourceNames.js +242 -3
- package/build/src/protos/autogen/serviceFactory.d.ts +428 -1128
- package/build/src/protos/autogen/serviceFactory.js +5695 -7023
- package/build/src/protos/index.d.ts +6 -6
- package/build/src/protos/index.js +5 -5
- package/build/src/version.d.ts +1 -1
- package/build/src/version.js +1 -1
- package/package.json +3 -3
|
@@ -14,14 +14,17 @@ var fields;
|
|
|
14
14
|
"ad_group.resource_name",
|
|
15
15
|
"ad_group_ad.ad.resource_name",
|
|
16
16
|
"ad_group_ad.resource_name",
|
|
17
|
+
"ad_group_ad_asset_combination_view.resource_name",
|
|
17
18
|
"ad_group_ad_asset_view.resource_name",
|
|
18
19
|
"ad_group_ad_label.resource_name",
|
|
19
20
|
"ad_group_asset.resource_name",
|
|
20
21
|
"ad_group_audience_view.resource_name",
|
|
21
22
|
"ad_group_bid_modifier.resource_name",
|
|
22
23
|
"ad_group_criterion.resource_name",
|
|
24
|
+
"ad_group_criterion_customizer.resource_name",
|
|
23
25
|
"ad_group_criterion_label.resource_name",
|
|
24
26
|
"ad_group_criterion_simulation.resource_name",
|
|
27
|
+
"ad_group_customizer.resource_name",
|
|
25
28
|
"ad_group_extension_setting.resource_name",
|
|
26
29
|
"ad_group_feed.resource_name",
|
|
27
30
|
"ad_group_label.resource_name",
|
|
@@ -30,6 +33,14 @@ var fields;
|
|
|
30
33
|
"age_range_view.resource_name",
|
|
31
34
|
"asset.resource_name",
|
|
32
35
|
"asset_field_type_view.resource_name",
|
|
36
|
+
"asset_group.resource_name",
|
|
37
|
+
"asset_group_asset.resource_name",
|
|
38
|
+
"asset_group_listing_group_filter.resource_name",
|
|
39
|
+
"asset_group_product_group_view.resource_name",
|
|
40
|
+
"asset_group_signal.resource_name",
|
|
41
|
+
"asset_set.resource_name",
|
|
42
|
+
"asset_set_asset.resource_name",
|
|
43
|
+
"audience.resource_name",
|
|
33
44
|
"batch_job.resource_name",
|
|
34
45
|
"bidding_data_exclusion.resource_name",
|
|
35
46
|
"bidding_seasonality_adjustment.resource_name",
|
|
@@ -39,11 +50,14 @@ var fields;
|
|
|
39
50
|
"call_view.resource_name",
|
|
40
51
|
"campaign.resource_name",
|
|
41
52
|
"campaign_asset.resource_name",
|
|
53
|
+
"campaign_asset_set.resource_name",
|
|
42
54
|
"campaign_audience_view.resource_name",
|
|
43
55
|
"campaign_bid_modifier.resource_name",
|
|
44
56
|
"campaign_budget.resource_name",
|
|
57
|
+
"campaign_conversion_goal.resource_name",
|
|
45
58
|
"campaign_criterion.resource_name",
|
|
46
59
|
"campaign_criterion_simulation.resource_name",
|
|
60
|
+
"campaign_customizer.resource_name",
|
|
47
61
|
"campaign_draft.resource_name",
|
|
48
62
|
"campaign_experiment.resource_name",
|
|
49
63
|
"campaign_extension_setting.resource_name",
|
|
@@ -58,15 +72,19 @@ var fields;
|
|
|
58
72
|
"combined_audience.resource_name",
|
|
59
73
|
"conversion_action.resource_name",
|
|
60
74
|
"conversion_custom_variable.resource_name",
|
|
75
|
+
"conversion_goal_campaign_config.resource_name",
|
|
61
76
|
"conversion_value_rule.resource_name",
|
|
62
77
|
"conversion_value_rule_set.resource_name",
|
|
63
78
|
"currency_constant.resource_name",
|
|
64
79
|
"custom_audience.resource_name",
|
|
80
|
+
"custom_conversion_goal.resource_name",
|
|
65
81
|
"custom_interest.resource_name",
|
|
66
82
|
"customer.resource_name",
|
|
67
83
|
"customer_asset.resource_name",
|
|
68
84
|
"customer_client.resource_name",
|
|
69
85
|
"customer_client_link.resource_name",
|
|
86
|
+
"customer_conversion_goal.resource_name",
|
|
87
|
+
"customer_customizer.resource_name",
|
|
70
88
|
"customer_extension_setting.resource_name",
|
|
71
89
|
"customer_feed.resource_name",
|
|
72
90
|
"customer_label.resource_name",
|
|
@@ -74,12 +92,15 @@ var fields;
|
|
|
74
92
|
"customer_negative_criterion.resource_name",
|
|
75
93
|
"customer_user_access.resource_name",
|
|
76
94
|
"customer_user_access_invitation.resource_name",
|
|
95
|
+
"customizer_attribute.resource_name",
|
|
77
96
|
"detail_placement_view.resource_name",
|
|
78
97
|
"detailed_demographic.resource_name",
|
|
79
98
|
"distance_view.resource_name",
|
|
80
99
|
"domain_category.resource_name",
|
|
81
100
|
"dynamic_search_ads_search_term_view.resource_name",
|
|
82
101
|
"expanded_landing_page_view.resource_name",
|
|
102
|
+
"experiment.resource_name",
|
|
103
|
+
"experiment_arm.resource_name",
|
|
83
104
|
"extension_feed_item.resource_name",
|
|
84
105
|
"feed.resource_name",
|
|
85
106
|
"feed_item.resource_name",
|
|
@@ -92,6 +113,7 @@ var fields;
|
|
|
92
113
|
"geographic_view.resource_name",
|
|
93
114
|
"group_placement_view.resource_name",
|
|
94
115
|
"hotel_group_view.resource_name",
|
|
116
|
+
"hotel_reconciliation.resource_name",
|
|
95
117
|
"income_range_view.resource_name",
|
|
96
118
|
"keyword_plan.resource_name",
|
|
97
119
|
"keyword_plan_ad_group.resource_name",
|
|
@@ -165,6 +187,7 @@ var fields;
|
|
|
165
187
|
"ad_group_ad.ad.responsive_display_ad.format_setting": "DisplayAdFormatSetting",
|
|
166
188
|
"ad_group_ad.ad.system_managed_resource_source": "SystemManagedResourceSource",
|
|
167
189
|
"ad_group_ad.ad.type": "AdType",
|
|
190
|
+
"ad_group_ad.ad.video_ad.in_feed.thumbnail": "VideoThumbnail",
|
|
168
191
|
"ad_group_ad.ad_strength": "AdStrength",
|
|
169
192
|
"ad_group_ad.policy_summary.approval_status": "PolicyApprovalStatus",
|
|
170
193
|
"ad_group_ad.policy_summary.review_status": "PolicyReviewStatus",
|
|
@@ -202,8 +225,12 @@ var fields;
|
|
|
202
225
|
"ad_group_criterion.status": "AdGroupCriterionStatus",
|
|
203
226
|
"ad_group_criterion.system_serving_status": "CriterionSystemServingStatus",
|
|
204
227
|
"ad_group_criterion.type": "CriterionType",
|
|
228
|
+
"ad_group_criterion_customizer.status": "CustomizerValueStatus",
|
|
229
|
+
"ad_group_criterion_customizer.value.type": "CustomizerAttributeType",
|
|
205
230
|
"ad_group_criterion_simulation.modification_method": "SimulationModificationMethod",
|
|
206
231
|
"ad_group_criterion_simulation.type": "SimulationType",
|
|
232
|
+
"ad_group_customizer.status": "CustomizerValueStatus",
|
|
233
|
+
"ad_group_customizer.value.type": "CustomizerAttributeType",
|
|
207
234
|
"ad_group_extension_setting.device": "ExtensionSettingDevice",
|
|
208
235
|
"ad_group_extension_setting.extension_type": "ExtensionType",
|
|
209
236
|
"ad_group_feed.matching_function.operator": "MatchingFunctionOperator",
|
|
@@ -211,16 +238,38 @@ var fields;
|
|
|
211
238
|
"ad_group_feed.status": "FeedLinkStatus",
|
|
212
239
|
"ad_group_simulation.modification_method": "SimulationModificationMethod",
|
|
213
240
|
"ad_group_simulation.type": "SimulationType",
|
|
241
|
+
"asset.call_asset.call_conversion_reporting_state": "CallConversionReportingState",
|
|
242
|
+
"asset.call_to_action_asset.call_to_action": "CallToActionType",
|
|
214
243
|
"asset.image_asset.mime_type": "MimeType",
|
|
215
244
|
"asset.lead_form_asset.call_to_action_type": "LeadFormCallToActionType",
|
|
216
245
|
"asset.lead_form_asset.desired_intent": "LeadFormDesiredIntent",
|
|
217
246
|
"asset.lead_form_asset.post_submit_call_to_action_type": "LeadFormPostSubmitCallToActionType",
|
|
247
|
+
"asset.mobile_app_asset.app_store": "MobileAppVendor",
|
|
218
248
|
"asset.policy_summary.approval_status": "PolicyApprovalStatus",
|
|
219
249
|
"asset.policy_summary.review_status": "PolicyReviewStatus",
|
|
250
|
+
"asset.price_asset.price_qualifier": "PriceExtensionPriceQualifier",
|
|
251
|
+
"asset.price_asset.type": "PriceExtensionType",
|
|
220
252
|
"asset.promotion_asset.discount_modifier": "PromotionExtensionDiscountModifier",
|
|
221
253
|
"asset.promotion_asset.occasion": "PromotionExtensionOccasion",
|
|
222
254
|
"asset.type": "AssetType",
|
|
223
255
|
"asset_field_type_view.field_type": "AssetFieldType",
|
|
256
|
+
"asset_group.status": "AssetGroupStatus",
|
|
257
|
+
"asset_group_asset.field_type": "AssetFieldType",
|
|
258
|
+
"asset_group_asset.performance_label": "AssetPerformanceLabel",
|
|
259
|
+
"asset_group_asset.policy_summary.approval_status": "PolicyApprovalStatus",
|
|
260
|
+
"asset_group_asset.policy_summary.review_status": "PolicyReviewStatus",
|
|
261
|
+
"asset_group_asset.status": "AssetLinkStatus",
|
|
262
|
+
"asset_group_listing_group_filter.case_value.product_bidding_category.level": "ListingGroupFilterBiddingCategoryLevel",
|
|
263
|
+
"asset_group_listing_group_filter.case_value.product_channel.channel": "ListingGroupFilterProductChannel",
|
|
264
|
+
"asset_group_listing_group_filter.case_value.product_condition.condition": "ListingGroupFilterProductCondition",
|
|
265
|
+
"asset_group_listing_group_filter.case_value.product_custom_attribute.index": "ListingGroupFilterCustomAttributeIndex",
|
|
266
|
+
"asset_group_listing_group_filter.case_value.product_type.level": "ListingGroupFilterProductTypeLevel",
|
|
267
|
+
"asset_group_listing_group_filter.type": "ListingGroupFilterType",
|
|
268
|
+
"asset_group_listing_group_filter.vertical": "ListingGroupFilterVertical",
|
|
269
|
+
"asset_set.status": "AssetSetStatus",
|
|
270
|
+
"asset_set.type": "AssetSetType",
|
|
271
|
+
"asset_set_asset.status": "AssetSetAssetStatus",
|
|
272
|
+
"audience.status": "AudienceStatus",
|
|
224
273
|
"batch_job.status": "BatchJobStatus",
|
|
225
274
|
"bidding_data_exclusion.advertising_channel_types": "AdvertisingChannelType",
|
|
226
275
|
"bidding_data_exclusion.devices": "Device",
|
|
@@ -261,11 +310,14 @@ var fields;
|
|
|
261
310
|
"campaign.video_brand_safety_suitability": "BrandSafetySuitability",
|
|
262
311
|
"campaign_asset.field_type": "AssetFieldType",
|
|
263
312
|
"campaign_asset.status": "AssetLinkStatus",
|
|
313
|
+
"campaign_asset_set.status": "AssetSetLinkStatus",
|
|
264
314
|
"campaign_bid_modifier.interaction_type.type": "InteractionType",
|
|
265
315
|
"campaign_budget.delivery_method": "BudgetDeliveryMethod",
|
|
266
316
|
"campaign_budget.period": "BudgetPeriod",
|
|
267
317
|
"campaign_budget.status": "BudgetStatus",
|
|
268
318
|
"campaign_budget.type": "BudgetType",
|
|
319
|
+
"campaign_conversion_goal.category": "ConversionActionCategory",
|
|
320
|
+
"campaign_conversion_goal.origin": "ConversionOrigin",
|
|
269
321
|
"campaign_criterion.ad_schedule.day_of_week": "DayOfWeek",
|
|
270
322
|
"campaign_criterion.ad_schedule.end_minute": "MinuteOfHour",
|
|
271
323
|
"campaign_criterion.ad_schedule.start_minute": "MinuteOfHour",
|
|
@@ -281,6 +333,8 @@ var fields;
|
|
|
281
333
|
"campaign_criterion.type": "CriterionType",
|
|
282
334
|
"campaign_criterion_simulation.modification_method": "SimulationModificationMethod",
|
|
283
335
|
"campaign_criterion_simulation.type": "SimulationType",
|
|
336
|
+
"campaign_customizer.status": "CustomizerValueStatus",
|
|
337
|
+
"campaign_customizer.value.type": "CustomizerAttributeType",
|
|
284
338
|
"campaign_draft.status": "CampaignDraftStatus",
|
|
285
339
|
"campaign_experiment.status": "CampaignExperimentStatus",
|
|
286
340
|
"campaign_experiment.traffic_split_type": "CampaignExperimentTrafficSplitType",
|
|
@@ -304,25 +358,36 @@ var fields;
|
|
|
304
358
|
"conversion_action.category": "ConversionActionCategory",
|
|
305
359
|
"conversion_action.counting_type": "ConversionActionCountingType",
|
|
306
360
|
"conversion_action.mobile_app_vendor": "MobileAppVendor",
|
|
361
|
+
"conversion_action.origin": "ConversionOrigin",
|
|
307
362
|
"conversion_action.status": "ConversionActionStatus",
|
|
308
363
|
"conversion_action.type": "ConversionActionType",
|
|
309
364
|
"conversion_custom_variable.status": "ConversionCustomVariableStatus",
|
|
365
|
+
"conversion_goal_campaign_config.goal_config_level": "GoalConfigLevel",
|
|
310
366
|
"conversion_value_rule.action.operation": "ValueRuleOperation",
|
|
311
367
|
"conversion_value_rule.device_condition.device_types": "ValueRuleDeviceType",
|
|
312
368
|
"conversion_value_rule.geo_location_condition.excluded_geo_match_type": "ValueRuleGeoLocationMatchType",
|
|
313
369
|
"conversion_value_rule.geo_location_condition.geo_match_type": "ValueRuleGeoLocationMatchType",
|
|
314
370
|
"conversion_value_rule.status": "ConversionValueRuleStatus",
|
|
315
371
|
"conversion_value_rule_set.attachment_type": "ValueRuleSetAttachmentType",
|
|
372
|
+
"conversion_value_rule_set.conversion_action_categories": "ConversionActionCategory",
|
|
316
373
|
"conversion_value_rule_set.dimensions": "ValueRuleSetDimension",
|
|
317
374
|
"conversion_value_rule_set.status": "ConversionValueRuleSetStatus",
|
|
318
375
|
"custom_audience.status": "CustomAudienceStatus",
|
|
319
376
|
"custom_audience.type": "CustomAudienceType",
|
|
377
|
+
"custom_conversion_goal.status": "CustomConversionGoalStatus",
|
|
320
378
|
"custom_interest.status": "CustomInterestStatus",
|
|
321
379
|
"custom_interest.type": "CustomInterestType",
|
|
380
|
+
"customer.conversion_tracking_setting.conversion_tracking_status": "ConversionTrackingStatus",
|
|
322
381
|
"customer.pay_per_conversion_eligibility_failure_reasons": "CustomerPayPerConversionEligibilityFailureReason",
|
|
382
|
+
"customer.status": "CustomerStatus",
|
|
323
383
|
"customer_asset.field_type": "AssetFieldType",
|
|
324
384
|
"customer_asset.status": "AssetLinkStatus",
|
|
385
|
+
"customer_client.status": "CustomerStatus",
|
|
325
386
|
"customer_client_link.status": "ManagerLinkStatus",
|
|
387
|
+
"customer_conversion_goal.category": "ConversionActionCategory",
|
|
388
|
+
"customer_conversion_goal.origin": "ConversionOrigin",
|
|
389
|
+
"customer_customizer.status": "CustomizerValueStatus",
|
|
390
|
+
"customer_customizer.value.type": "CustomizerAttributeType",
|
|
326
391
|
"customer_extension_setting.device": "ExtensionSettingDevice",
|
|
327
392
|
"customer_extension_setting.extension_type": "ExtensionType",
|
|
328
393
|
"customer_feed.matching_function.operator": "MatchingFunctionOperator",
|
|
@@ -334,8 +399,13 @@ var fields;
|
|
|
334
399
|
"customer_user_access.access_role": "AccessRole",
|
|
335
400
|
"customer_user_access_invitation.access_role": "AccessRole",
|
|
336
401
|
"customer_user_access_invitation.invitation_status": "AccessInvitationStatus",
|
|
402
|
+
"customizer_attribute.status": "CustomizerAttributeStatus",
|
|
403
|
+
"customizer_attribute.type": "CustomizerAttributeType",
|
|
337
404
|
"detail_placement_view.placement_type": "PlacementType",
|
|
338
405
|
"distance_view.distance_bucket": "DistanceBucket",
|
|
406
|
+
"experiment.promote_status": "AsyncActionStatus",
|
|
407
|
+
"experiment.status": "ExperimentStatus",
|
|
408
|
+
"experiment.type": "ExperimentType",
|
|
339
409
|
"extension_feed_item.app_feed_item.app_store": "AppStore",
|
|
340
410
|
"extension_feed_item.call_feed_item.call_conversion_reporting_state": "CallConversionReportingState",
|
|
341
411
|
"extension_feed_item.device": "FeedItemTargetDevice",
|
|
@@ -365,6 +435,7 @@ var fields;
|
|
|
365
435
|
"geo_target_constant.status": "GeoTargetConstantStatus",
|
|
366
436
|
"geographic_view.location_type": "GeoTargetingType",
|
|
367
437
|
"group_placement_view.placement_type": "PlacementType",
|
|
438
|
+
"hotel_reconciliation.status": "HotelReconciliationStatus",
|
|
368
439
|
"keyword_plan_ad_group_keyword.match_type": "KeywordMatchType",
|
|
369
440
|
"keyword_plan_campaign.keyword_plan_network": "KeywordPlanNetwork",
|
|
370
441
|
"keyword_plan_campaign_keyword.match_type": "KeywordMatchType",
|
|
@@ -377,6 +448,7 @@ var fields;
|
|
|
377
448
|
"metrics.interaction_event_types": "InteractionEventType",
|
|
378
449
|
"mobile_device_constant.type": "MobileDeviceType",
|
|
379
450
|
"offline_user_data_job.failure_reason": "OfflineUserDataJobFailureReason",
|
|
451
|
+
"offline_user_data_job.operation_metadata.match_rate_range": "OfflineUserDataJobMatchRateRange",
|
|
380
452
|
"offline_user_data_job.status": "OfflineUserDataJobStatus",
|
|
381
453
|
"offline_user_data_job.type": "OfflineUserDataJobType",
|
|
382
454
|
"operating_system_version_constant.operator_type": "OperatingSystemVersionOperatorType",
|
|
@@ -409,6 +481,8 @@ var fields;
|
|
|
409
481
|
"segments.recommendation_type": "RecommendationType",
|
|
410
482
|
"segments.search_engine_results_page_type": "SearchEngineResultsPageType",
|
|
411
483
|
"segments.search_term_match_type": "SearchTermMatchType",
|
|
484
|
+
"segments.sk_ad_network_ad_event_type": "SkAdNetworkAdEventType",
|
|
485
|
+
"segments.sk_ad_network_user_type": "SkAdNetworkUserType",
|
|
412
486
|
"segments.slot": "Slot",
|
|
413
487
|
"shared_criterion.keyword.match_type": "KeywordMatchType",
|
|
414
488
|
"shared_criterion.type": "CriterionType",
|
|
@@ -56,6 +56,17 @@ export declare type AdGroupAdResourceName = `customers/${StrNum}/adGroupAds/${St
|
|
|
56
56
|
* @example const adGroupAd: ResourceNames.AdGroupAdResourceName = ResourceNames.adGroupAd(10987417, 21974834, 43949668)
|
|
57
57
|
*/
|
|
58
58
|
export declare function adGroupAd(customerId: string | number, adGroupId: string | number, adId: string | number): AdGroupAdResourceName;
|
|
59
|
+
export declare type AdGroupAdAssetCombinationViewResourceName = `customers/${StrNum}/adGroupAdAssetCombinationViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
60
|
+
/**
|
|
61
|
+
* @param {string | number} customerId
|
|
62
|
+
* @param {string | number} adGroupId
|
|
63
|
+
* @param {string | number} adId
|
|
64
|
+
* @param {string | number} assetCombinationIdLow
|
|
65
|
+
* @param {string | number} assetCombinationIdHigh
|
|
66
|
+
* @returns `AdGroupAdAssetCombinationViewResourceName`
|
|
67
|
+
* @example const adGroupAdAssetCombinationView: ResourceNames.AdGroupAdAssetCombinationViewResourceName = ResourceNames.adGroupAdAssetCombinationView(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
68
|
+
*/
|
|
69
|
+
export declare function adGroupAdAssetCombinationView(customerId: string | number, adGroupId: string | number, adId: string | number, assetCombinationIdLow: string | number, assetCombinationIdHigh: string | number): AdGroupAdAssetCombinationViewResourceName;
|
|
59
70
|
export declare type AdGroupAdAssetViewResourceName = `customers/${StrNum}/adGroupAdAssetViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
60
71
|
/**
|
|
61
72
|
* @param {string | number} customerId
|
|
@@ -114,6 +125,16 @@ export declare type AdGroupCriterionResourceName = `customers/${StrNum}/adGroupC
|
|
|
114
125
|
* @example const adGroupCriterion: ResourceNames.AdGroupCriterionResourceName = ResourceNames.adGroupCriterion(10987417, 21974834, 43949668)
|
|
115
126
|
*/
|
|
116
127
|
export declare function adGroupCriterion(customerId: string | number, adGroupId: string | number, criterionId: string | number): AdGroupCriterionResourceName;
|
|
128
|
+
export declare type AdGroupCriterionCustomizerResourceName = `customers/${StrNum}/adGroupCriterionCustomizers/${StrNum}~${StrNum}~${StrNum}`;
|
|
129
|
+
/**
|
|
130
|
+
* @param {string | number} customerId
|
|
131
|
+
* @param {string | number} adGroupId
|
|
132
|
+
* @param {string | number} criterionId
|
|
133
|
+
* @param {string | number} customizerAttributeId
|
|
134
|
+
* @returns `AdGroupCriterionCustomizerResourceName`
|
|
135
|
+
* @example const adGroupCriterionCustomizer: ResourceNames.AdGroupCriterionCustomizerResourceName = ResourceNames.adGroupCriterionCustomizer(10987417, 21974834, 43949668, 87899336)
|
|
136
|
+
*/
|
|
137
|
+
export declare function adGroupCriterionCustomizer(customerId: string | number, adGroupId: string | number, criterionId: string | number, customizerAttributeId: string | number): AdGroupCriterionCustomizerResourceName;
|
|
117
138
|
export declare type AdGroupCriterionLabelResourceName = `customers/${StrNum}/adGroupCriterionLabels/${StrNum}~${StrNum}~${StrNum}`;
|
|
118
139
|
/**
|
|
119
140
|
* @param {string | number} customerId
|
|
@@ -137,6 +158,15 @@ export declare type AdGroupCriterionSimulationResourceName = `customers/${StrNum
|
|
|
137
158
|
* @example const adGroupCriterionSimulation: ResourceNames.AdGroupCriterionSimulationResourceName = ResourceNames.adGroupCriterionSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344, 703194688)
|
|
138
159
|
*/
|
|
139
160
|
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;
|
|
161
|
+
export declare type AdGroupCustomizerResourceName = `customers/${StrNum}/adGroupCustomizers/${StrNum}~${StrNum}`;
|
|
162
|
+
/**
|
|
163
|
+
* @param {string | number} customerId
|
|
164
|
+
* @param {string | number} adGroupId
|
|
165
|
+
* @param {string | number} customizerAttributeId
|
|
166
|
+
* @returns `AdGroupCustomizerResourceName`
|
|
167
|
+
* @example const adGroupCustomizer: ResourceNames.AdGroupCustomizerResourceName = ResourceNames.adGroupCustomizer(10987417, 21974834, 43949668)
|
|
168
|
+
*/
|
|
169
|
+
export declare function adGroupCustomizer(customerId: string | number, adGroupId: string | number, customizerAttributeId: string | number): AdGroupCustomizerResourceName;
|
|
140
170
|
export declare type AdGroupExtensionSettingResourceName = `customers/${StrNum}/adGroupExtensionSettings/${StrNum}~${StrNum}`;
|
|
141
171
|
/**
|
|
142
172
|
* @param {string | number} customerId
|
|
@@ -220,6 +250,76 @@ export declare type AssetFieldTypeViewResourceName = `customers/${StrNum}/assetF
|
|
|
220
250
|
* @example const assetFieldTypeView: ResourceNames.AssetFieldTypeViewResourceName = ResourceNames.assetFieldTypeView(10987417, 21974834)
|
|
221
251
|
*/
|
|
222
252
|
export declare function assetFieldTypeView(customerId: string | number, fieldType: string | number): AssetFieldTypeViewResourceName;
|
|
253
|
+
export declare type AssetGroupResourceName = `customers/${StrNum}/assetGroups/${StrNum}`;
|
|
254
|
+
/**
|
|
255
|
+
* @param {string | number} customerId
|
|
256
|
+
* @param {string | number} assetGroupId
|
|
257
|
+
* @returns `AssetGroupResourceName`
|
|
258
|
+
* @example const assetGroup: ResourceNames.AssetGroupResourceName = ResourceNames.assetGroup(10987417, 21974834)
|
|
259
|
+
*/
|
|
260
|
+
export declare function assetGroup(customerId: string | number, assetGroupId: string | number): AssetGroupResourceName;
|
|
261
|
+
export declare type AssetGroupAssetResourceName = `customers/${StrNum}/assetGroupAssets/${StrNum}~${StrNum}~${StrNum}`;
|
|
262
|
+
/**
|
|
263
|
+
* @param {string | number} customerId
|
|
264
|
+
* @param {string | number} assetGroupId
|
|
265
|
+
* @param {string | number} assetId
|
|
266
|
+
* @param {string | number} fieldType
|
|
267
|
+
* @returns `AssetGroupAssetResourceName`
|
|
268
|
+
* @example const assetGroupAsset: ResourceNames.AssetGroupAssetResourceName = ResourceNames.assetGroupAsset(10987417, 21974834, 43949668, 87899336)
|
|
269
|
+
*/
|
|
270
|
+
export declare function assetGroupAsset(customerId: string | number, assetGroupId: string | number, assetId: string | number, fieldType: string | number): AssetGroupAssetResourceName;
|
|
271
|
+
export declare type AssetGroupListingGroupFilterResourceName = `customers/${StrNum}/assetGroupListingGroupFilters/${StrNum}~${StrNum}`;
|
|
272
|
+
/**
|
|
273
|
+
* @param {string | number} customerId
|
|
274
|
+
* @param {string | number} assetGroupId
|
|
275
|
+
* @param {string | number} listingGroupFilterId
|
|
276
|
+
* @returns `AssetGroupListingGroupFilterResourceName`
|
|
277
|
+
* @example const assetGroupListingGroupFilter: ResourceNames.AssetGroupListingGroupFilterResourceName = ResourceNames.assetGroupListingGroupFilter(10987417, 21974834, 43949668)
|
|
278
|
+
*/
|
|
279
|
+
export declare function assetGroupListingGroupFilter(customerId: string | number, assetGroupId: string | number, listingGroupFilterId: string | number): AssetGroupListingGroupFilterResourceName;
|
|
280
|
+
export declare type AssetGroupProductGroupViewResourceName = `customers/${StrNum}/assetGroupProductGroupViews/${StrNum}~${StrNum}`;
|
|
281
|
+
/**
|
|
282
|
+
* @param {string | number} customerId
|
|
283
|
+
* @param {string | number} assetGroupId
|
|
284
|
+
* @param {string | number} listingGroupFilterId
|
|
285
|
+
* @returns `AssetGroupProductGroupViewResourceName`
|
|
286
|
+
* @example const assetGroupProductGroupView: ResourceNames.AssetGroupProductGroupViewResourceName = ResourceNames.assetGroupProductGroupView(10987417, 21974834, 43949668)
|
|
287
|
+
*/
|
|
288
|
+
export declare function assetGroupProductGroupView(customerId: string | number, assetGroupId: string | number, listingGroupFilterId: string | number): AssetGroupProductGroupViewResourceName;
|
|
289
|
+
export declare type AssetGroupSignalResourceName = `customers/${StrNum}/assetGroupSignals/${StrNum}~${StrNum}`;
|
|
290
|
+
/**
|
|
291
|
+
* @param {string | number} customerId
|
|
292
|
+
* @param {string | number} assetGroupId
|
|
293
|
+
* @param {string | number} criterionId
|
|
294
|
+
* @returns `AssetGroupSignalResourceName`
|
|
295
|
+
* @example const assetGroupSignal: ResourceNames.AssetGroupSignalResourceName = ResourceNames.assetGroupSignal(10987417, 21974834, 43949668)
|
|
296
|
+
*/
|
|
297
|
+
export declare function assetGroupSignal(customerId: string | number, assetGroupId: string | number, criterionId: string | number): AssetGroupSignalResourceName;
|
|
298
|
+
export declare type AssetSetResourceName = `customers/${StrNum}/assetSets/${StrNum}`;
|
|
299
|
+
/**
|
|
300
|
+
* @param {string | number} customerId
|
|
301
|
+
* @param {string | number} assetSetId
|
|
302
|
+
* @returns `AssetSetResourceName`
|
|
303
|
+
* @example const assetSet: ResourceNames.AssetSetResourceName = ResourceNames.assetSet(10987417, 21974834)
|
|
304
|
+
*/
|
|
305
|
+
export declare function assetSet(customerId: string | number, assetSetId: string | number): AssetSetResourceName;
|
|
306
|
+
export declare type AssetSetAssetResourceName = `customers/${StrNum}/assetSetAssets/${StrNum}~${StrNum}`;
|
|
307
|
+
/**
|
|
308
|
+
* @param {string | number} customerId
|
|
309
|
+
* @param {string | number} assetSetId
|
|
310
|
+
* @param {string | number} assetId
|
|
311
|
+
* @returns `AssetSetAssetResourceName`
|
|
312
|
+
* @example const assetSetAsset: ResourceNames.AssetSetAssetResourceName = ResourceNames.assetSetAsset(10987417, 21974834, 43949668)
|
|
313
|
+
*/
|
|
314
|
+
export declare function assetSetAsset(customerId: string | number, assetSetId: string | number, assetId: string | number): AssetSetAssetResourceName;
|
|
315
|
+
export declare type AudienceResourceName = `customers/${StrNum}/audiences/${StrNum}`;
|
|
316
|
+
/**
|
|
317
|
+
* @param {string | number} customerId
|
|
318
|
+
* @param {string | number} audienceId
|
|
319
|
+
* @returns `AudienceResourceName`
|
|
320
|
+
* @example const audience: ResourceNames.AudienceResourceName = ResourceNames.audience(10987417, 21974834)
|
|
321
|
+
*/
|
|
322
|
+
export declare function audience(customerId: string | number, audienceId: string | number): AudienceResourceName;
|
|
223
323
|
export declare type BatchJobResourceName = `customers/${StrNum}/batchJobs/${StrNum}`;
|
|
224
324
|
/**
|
|
225
325
|
* @param {string | number} customerId
|
|
@@ -298,6 +398,15 @@ export declare type CampaignAssetResourceName = `customers/${StrNum}/campaignAss
|
|
|
298
398
|
* @example const campaignAsset: ResourceNames.CampaignAssetResourceName = ResourceNames.campaignAsset(10987417, 21974834, 43949668, 87899336)
|
|
299
399
|
*/
|
|
300
400
|
export declare function campaignAsset(customerId: string | number, campaignId: string | number, assetId: string | number, fieldType: string | number): CampaignAssetResourceName;
|
|
401
|
+
export declare type CampaignAssetSetResourceName = `customers/${StrNum}/campaignAssetSets/${StrNum}~${StrNum}`;
|
|
402
|
+
/**
|
|
403
|
+
* @param {string | number} customerId
|
|
404
|
+
* @param {string | number} campaignId
|
|
405
|
+
* @param {string | number} assetSetId
|
|
406
|
+
* @returns `CampaignAssetSetResourceName`
|
|
407
|
+
* @example const campaignAssetSet: ResourceNames.CampaignAssetSetResourceName = ResourceNames.campaignAssetSet(10987417, 21974834, 43949668)
|
|
408
|
+
*/
|
|
409
|
+
export declare function campaignAssetSet(customerId: string | number, campaignId: string | number, assetSetId: string | number): CampaignAssetSetResourceName;
|
|
301
410
|
export declare type CampaignAudienceViewResourceName = `customers/${StrNum}/campaignAudienceViews/${StrNum}~${StrNum}`;
|
|
302
411
|
/**
|
|
303
412
|
* @param {string | number} customerId
|
|
@@ -324,6 +433,16 @@ export declare type CampaignBudgetResourceName = `customers/${StrNum}/campaignBu
|
|
|
324
433
|
* @example const campaignBudget: ResourceNames.CampaignBudgetResourceName = ResourceNames.campaignBudget(10987417, 21974834)
|
|
325
434
|
*/
|
|
326
435
|
export declare function campaignBudget(customerId: string | number, campaignBudgetId: string | number): CampaignBudgetResourceName;
|
|
436
|
+
export declare type CampaignConversionGoalResourceName = `customers/${StrNum}/campaignConversionGoals/${StrNum}~${StrNum}~${StrNum}`;
|
|
437
|
+
/**
|
|
438
|
+
* @param {string | number} customerId
|
|
439
|
+
* @param {string | number} campaignId
|
|
440
|
+
* @param {string | number} category
|
|
441
|
+
* @param {string | number} source
|
|
442
|
+
* @returns `CampaignConversionGoalResourceName`
|
|
443
|
+
* @example const campaignConversionGoal: ResourceNames.CampaignConversionGoalResourceName = ResourceNames.campaignConversionGoal(10987417, 21974834, 43949668, 87899336)
|
|
444
|
+
*/
|
|
445
|
+
export declare function campaignConversionGoal(customerId: string | number, campaignId: string | number, category: string | number, source: string | number): CampaignConversionGoalResourceName;
|
|
327
446
|
export declare type CampaignCriterionResourceName = `customers/${StrNum}/campaignCriteria/${StrNum}~${StrNum}`;
|
|
328
447
|
/**
|
|
329
448
|
* @param {string | number} customerId
|
|
@@ -346,6 +465,15 @@ export declare type CampaignCriterionSimulationResourceName = `customers/${StrNu
|
|
|
346
465
|
* @example const campaignCriterionSimulation: ResourceNames.CampaignCriterionSimulationResourceName = ResourceNames.campaignCriterionSimulation(10987417, 21974834, 43949668, 87899336, 175798672, 351597344, 703194688)
|
|
347
466
|
*/
|
|
348
467
|
export declare function campaignCriterionSimulation(customerId: string | number, campaignId: string | number, criterionId: string | number, type: string | number, modificationMethod: string | number, startDate: string | number, endDate: string | number): CampaignCriterionSimulationResourceName;
|
|
468
|
+
export declare type CampaignCustomizerResourceName = `customers/${StrNum}/campaignCustomizers/${StrNum}~${StrNum}`;
|
|
469
|
+
/**
|
|
470
|
+
* @param {string | number} customerId
|
|
471
|
+
* @param {string | number} campaignId
|
|
472
|
+
* @param {string | number} customizerAttributeId
|
|
473
|
+
* @returns `CampaignCustomizerResourceName`
|
|
474
|
+
* @example const campaignCustomizer: ResourceNames.CampaignCustomizerResourceName = ResourceNames.campaignCustomizer(10987417, 21974834, 43949668)
|
|
475
|
+
*/
|
|
476
|
+
export declare function campaignCustomizer(customerId: string | number, campaignId: string | number, customizerAttributeId: string | number): CampaignCustomizerResourceName;
|
|
349
477
|
export declare type CampaignDraftResourceName = `customers/${StrNum}/campaignDrafts/${StrNum}~${StrNum}`;
|
|
350
478
|
/**
|
|
351
479
|
* @param {string | number} customerId
|
|
@@ -469,6 +597,14 @@ export declare type ConversionCustomVariableResourceName = `customers/${StrNum}/
|
|
|
469
597
|
* @example const conversionCustomVariable: ResourceNames.ConversionCustomVariableResourceName = ResourceNames.conversionCustomVariable(10987417, 21974834)
|
|
470
598
|
*/
|
|
471
599
|
export declare function conversionCustomVariable(customerId: string | number, conversionCustomVariableId: string | number): ConversionCustomVariableResourceName;
|
|
600
|
+
export declare type ConversionGoalCampaignConfigResourceName = `customers/${StrNum}/conversionGoalCampaignConfigs/${StrNum}`;
|
|
601
|
+
/**
|
|
602
|
+
* @param {string | number} customerId
|
|
603
|
+
* @param {string | number} campaignId
|
|
604
|
+
* @returns `ConversionGoalCampaignConfigResourceName`
|
|
605
|
+
* @example const conversionGoalCampaignConfig: ResourceNames.ConversionGoalCampaignConfigResourceName = ResourceNames.conversionGoalCampaignConfig(10987417, 21974834)
|
|
606
|
+
*/
|
|
607
|
+
export declare function conversionGoalCampaignConfig(customerId: string | number, campaignId: string | number): ConversionGoalCampaignConfigResourceName;
|
|
472
608
|
export declare type ConversionValueRuleResourceName = `customers/${StrNum}/conversionValueRules/${StrNum}`;
|
|
473
609
|
/**
|
|
474
610
|
* @param {string | number} customerId
|
|
@@ -500,6 +636,14 @@ export declare type CustomAudienceResourceName = `customers/${StrNum}/customAudi
|
|
|
500
636
|
* @example const customAudience: ResourceNames.CustomAudienceResourceName = ResourceNames.customAudience(10987417, 21974834)
|
|
501
637
|
*/
|
|
502
638
|
export declare function customAudience(customerId: string | number, customAudienceId: string | number): CustomAudienceResourceName;
|
|
639
|
+
export declare type CustomConversionGoalResourceName = `customers/${StrNum}/customConversionGoals/${StrNum}`;
|
|
640
|
+
/**
|
|
641
|
+
* @param {string | number} customerId
|
|
642
|
+
* @param {string | number} goalId
|
|
643
|
+
* @returns `CustomConversionGoalResourceName`
|
|
644
|
+
* @example const customConversionGoal: ResourceNames.CustomConversionGoalResourceName = ResourceNames.customConversionGoal(10987417, 21974834)
|
|
645
|
+
*/
|
|
646
|
+
export declare function customConversionGoal(customerId: string | number, goalId: string | number): CustomConversionGoalResourceName;
|
|
503
647
|
export declare type CustomInterestResourceName = `customers/${StrNum}/customInterests/${StrNum}`;
|
|
504
648
|
/**
|
|
505
649
|
* @param {string | number} customerId
|
|
@@ -541,6 +685,23 @@ export declare type CustomerClientLinkResourceName = `customers/${StrNum}/custom
|
|
|
541
685
|
* @example const customerClientLink: ResourceNames.CustomerClientLinkResourceName = ResourceNames.customerClientLink(10987417, 21974834, 43949668)
|
|
542
686
|
*/
|
|
543
687
|
export declare function customerClientLink(customerId: string | number, clientCustomerId: string | number, managerLinkId: string | number): CustomerClientLinkResourceName;
|
|
688
|
+
export declare type CustomerConversionGoalResourceName = `customers/${StrNum}/customerConversionGoals/${StrNum}~${StrNum}`;
|
|
689
|
+
/**
|
|
690
|
+
* @param {string | number} customerId
|
|
691
|
+
* @param {string | number} category
|
|
692
|
+
* @param {string | number} source
|
|
693
|
+
* @returns `CustomerConversionGoalResourceName`
|
|
694
|
+
* @example const customerConversionGoal: ResourceNames.CustomerConversionGoalResourceName = ResourceNames.customerConversionGoal(10987417, 21974834, 43949668)
|
|
695
|
+
*/
|
|
696
|
+
export declare function customerConversionGoal(customerId: string | number, category: string | number, source: string | number): CustomerConversionGoalResourceName;
|
|
697
|
+
export declare type CustomerCustomizerResourceName = `customers/${StrNum}/customerCustomizers/${StrNum}`;
|
|
698
|
+
/**
|
|
699
|
+
* @param {string | number} customerId
|
|
700
|
+
* @param {string | number} customizerAttributeId
|
|
701
|
+
* @returns `CustomerCustomizerResourceName`
|
|
702
|
+
* @example const customerCustomizer: ResourceNames.CustomerCustomizerResourceName = ResourceNames.customerCustomizer(10987417, 21974834)
|
|
703
|
+
*/
|
|
704
|
+
export declare function customerCustomizer(customerId: string | number, customizerAttributeId: string | number): CustomerCustomizerResourceName;
|
|
544
705
|
export declare type CustomerExtensionSettingResourceName = `customers/${StrNum}/customerExtensionSettings/${StrNum}`;
|
|
545
706
|
/**
|
|
546
707
|
* @param {string | number} customerId
|
|
@@ -598,6 +759,14 @@ export declare type CustomerUserAccessInvitationResourceName = `customers/${StrN
|
|
|
598
759
|
* @example const customerUserAccessInvitation: ResourceNames.CustomerUserAccessInvitationResourceName = ResourceNames.customerUserAccessInvitation(10987417, 21974834)
|
|
599
760
|
*/
|
|
600
761
|
export declare function customerUserAccessInvitation(customerId: string | number, invitationId: string | number): CustomerUserAccessInvitationResourceName;
|
|
762
|
+
export declare type CustomizerAttributeResourceName = `customers/${StrNum}/customizerAttributes/${StrNum}`;
|
|
763
|
+
/**
|
|
764
|
+
* @param {string | number} customerId
|
|
765
|
+
* @param {string | number} customizerAttributeId
|
|
766
|
+
* @returns `CustomizerAttributeResourceName`
|
|
767
|
+
* @example const customizerAttribute: ResourceNames.CustomizerAttributeResourceName = ResourceNames.customizerAttribute(10987417, 21974834)
|
|
768
|
+
*/
|
|
769
|
+
export declare function customizerAttribute(customerId: string | number, customizerAttributeId: string | number): CustomizerAttributeResourceName;
|
|
601
770
|
export declare type DetailPlacementViewResourceName = `customers/${StrNum}/detailPlacementViews/${StrNum}~${StrNum}`;
|
|
602
771
|
/**
|
|
603
772
|
* @param {string | number} customerId
|
|
@@ -663,6 +832,23 @@ export declare type ExpandedLandingPageViewResourceName = `customers/${StrNum}/e
|
|
|
663
832
|
* @example const expandedLandingPageView: ResourceNames.ExpandedLandingPageViewResourceName = ResourceNames.expandedLandingPageView(10987417, 21974834)
|
|
664
833
|
*/
|
|
665
834
|
export declare function expandedLandingPageView(customerId: string | number, expandedFinalUrlFingerprint: string | number): ExpandedLandingPageViewResourceName;
|
|
835
|
+
export declare type ExperimentResourceName = `customers/${StrNum}/experiments/${StrNum}`;
|
|
836
|
+
/**
|
|
837
|
+
* @param {string | number} customerId
|
|
838
|
+
* @param {string | number} trialId
|
|
839
|
+
* @returns `ExperimentResourceName`
|
|
840
|
+
* @example const experiment: ResourceNames.ExperimentResourceName = ResourceNames.experiment(10987417, 21974834)
|
|
841
|
+
*/
|
|
842
|
+
export declare function experiment(customerId: string | number, trialId: string | number): ExperimentResourceName;
|
|
843
|
+
export declare type ExperimentArmResourceName = `customers/${StrNum}/experimentArms/${StrNum}~${StrNum}`;
|
|
844
|
+
/**
|
|
845
|
+
* @param {string | number} customerId
|
|
846
|
+
* @param {string | number} trialId
|
|
847
|
+
* @param {string | number} trialArmId
|
|
848
|
+
* @returns `ExperimentArmResourceName`
|
|
849
|
+
* @example const experimentArm: ResourceNames.ExperimentArmResourceName = ResourceNames.experimentArm(10987417, 21974834, 43949668)
|
|
850
|
+
*/
|
|
851
|
+
export declare function experimentArm(customerId: string | number, trialId: string | number, trialArmId: string | number): ExperimentArmResourceName;
|
|
666
852
|
export declare type ExtensionFeedItemResourceName = `customers/${StrNum}/extensionFeedItems/${StrNum}`;
|
|
667
853
|
/**
|
|
668
854
|
* @param {string | number} customerId
|
|
@@ -792,6 +978,14 @@ export declare type HotelPerformanceViewResourceName = `customers/${StrNum}/hote
|
|
|
792
978
|
* @example const hotelPerformanceView: ResourceNames.HotelPerformanceViewResourceName = ResourceNames.hotelPerformanceView(10987417)
|
|
793
979
|
*/
|
|
794
980
|
export declare function hotelPerformanceView(customerId: string | number): HotelPerformanceViewResourceName;
|
|
981
|
+
export declare type HotelReconciliationResourceName = `customers/${StrNum}/hotelReconciliations/${StrNum}`;
|
|
982
|
+
/**
|
|
983
|
+
* @param {string | number} customerId
|
|
984
|
+
* @param {string | number} commissionId
|
|
985
|
+
* @returns `HotelReconciliationResourceName`
|
|
986
|
+
* @example const hotelReconciliation: ResourceNames.HotelReconciliationResourceName = ResourceNames.hotelReconciliation(10987417, 21974834)
|
|
987
|
+
*/
|
|
988
|
+
export declare function hotelReconciliation(customerId: string | number, commissionId: string | number): HotelReconciliationResourceName;
|
|
795
989
|
export declare type IncomeRangeViewResourceName = `customers/${StrNum}/incomeRangeViews/${StrNum}~${StrNum}`;
|
|
796
990
|
/**
|
|
797
991
|
* @param {string | number} customerId
|