google-ads-api 14.2.0 → 16.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 +2 -2
- package/build/src/protos/autogen/enums.d.ts +834 -368
- package/build/src/protos/autogen/enums.js +873 -374
- package/build/src/protos/autogen/fields.d.ts +243 -170
- package/build/src/protos/autogen/fields.js +55 -7
- package/build/src/protos/autogen/resourceNames.d.ts +118 -14
- package/build/src/protos/autogen/resourceNames.js +149 -21
- package/build/src/protos/autogen/serviceFactory.d.ts +225 -178
- package/build/src/protos/autogen/serviceFactory.js +748 -279
- 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 +17 -1
- package/package.json +3 -3
|
@@ -32,6 +32,9 @@ var fields;
|
|
|
32
32
|
"ad_group_simulation.resource_name",
|
|
33
33
|
"ad_parameter.resource_name",
|
|
34
34
|
"age_range_view.resource_name",
|
|
35
|
+
"android_privacy_shared_key_google_ad_group.resource_name",
|
|
36
|
+
"android_privacy_shared_key_google_campaign.resource_name",
|
|
37
|
+
"android_privacy_shared_key_google_network_type.resource_name",
|
|
35
38
|
"asset.resource_name",
|
|
36
39
|
"asset_field_type_view.resource_name",
|
|
37
40
|
"asset_group.resource_name",
|
|
@@ -39,6 +42,7 @@ var fields;
|
|
|
39
42
|
"asset_group_listing_group_filter.resource_name",
|
|
40
43
|
"asset_group_product_group_view.resource_name",
|
|
41
44
|
"asset_group_signal.resource_name",
|
|
45
|
+
"asset_group_top_combination_view.resource_name",
|
|
42
46
|
"asset_set.resource_name",
|
|
43
47
|
"asset_set_asset.resource_name",
|
|
44
48
|
"asset_set_type_view.resource_name",
|
|
@@ -64,6 +68,7 @@ var fields;
|
|
|
64
68
|
"campaign_feed.resource_name",
|
|
65
69
|
"campaign_group.resource_name",
|
|
66
70
|
"campaign_label.resource_name",
|
|
71
|
+
"campaign_lifecycle_goal.resource_name",
|
|
67
72
|
"campaign_search_term_insight.resource_name",
|
|
68
73
|
"campaign_shared_set.resource_name",
|
|
69
74
|
"campaign_simulation.resource_name",
|
|
@@ -91,6 +96,7 @@ var fields;
|
|
|
91
96
|
"customer_extension_setting.resource_name",
|
|
92
97
|
"customer_feed.resource_name",
|
|
93
98
|
"customer_label.resource_name",
|
|
99
|
+
"customer_lifecycle_goal.resource_name",
|
|
94
100
|
"customer_manager_link.resource_name",
|
|
95
101
|
"customer_negative_criterion.resource_name",
|
|
96
102
|
"customer_search_term_insight.resource_name",
|
|
@@ -130,19 +136,26 @@ var fields;
|
|
|
130
136
|
"language_constant.resource_name",
|
|
131
137
|
"lead_form_submission_data.resource_name",
|
|
132
138
|
"life_event.resource_name",
|
|
133
|
-
"
|
|
139
|
+
"local_services_employee.resource_name",
|
|
140
|
+
"local_services_lead.resource_name",
|
|
141
|
+
"local_services_lead_conversation.resource_name",
|
|
142
|
+
"local_services_verification_artifact.resource_name",
|
|
143
|
+
"location_view.resource_name",
|
|
134
144
|
"media_file.resource_name",
|
|
135
145
|
"mobile_app_category_constant.resource_name",
|
|
136
146
|
"mobile_device_constant.resource_name",
|
|
147
|
+
"offline_conversion_upload_client_summary.resource_name",
|
|
137
148
|
"offline_user_data_job.resource_name",
|
|
138
149
|
"operating_system_version_constant.resource_name",
|
|
139
150
|
"parental_status_view.resource_name",
|
|
140
151
|
"per_store_view.resource_name",
|
|
141
|
-
"
|
|
152
|
+
"product_category_constant.resource_name",
|
|
142
153
|
"product_group_view.resource_name",
|
|
143
154
|
"product_link.resource_name",
|
|
155
|
+
"product_link_invitation.resource_name",
|
|
144
156
|
"qualifying_question.resource_name",
|
|
145
157
|
"recommendation.resource_name",
|
|
158
|
+
"recommendation_subscription.resource_name",
|
|
146
159
|
"remarketing_action.resource_name",
|
|
147
160
|
"search_term_view.resource_name",
|
|
148
161
|
"shared_criterion.resource_name",
|
|
@@ -187,6 +200,8 @@ var fields;
|
|
|
187
200
|
"ad_group.effective_target_roas_source": "BiddingSource",
|
|
188
201
|
"ad_group.excluded_parent_asset_field_types": "AssetFieldType",
|
|
189
202
|
"ad_group.excluded_parent_asset_set_types": "AssetSetType",
|
|
203
|
+
"ad_group.primary_status": "AdGroupPrimaryStatus",
|
|
204
|
+
"ad_group.primary_status_reasons": "AdGroupPrimaryStatusReason",
|
|
190
205
|
"ad_group.status": "AdGroupStatus",
|
|
191
206
|
"ad_group.type": "AdGroupType",
|
|
192
207
|
"ad_group_ad.ad.call_ad.conversion_reporting_state": "CallConversionReportingState",
|
|
@@ -201,10 +216,13 @@ var fields;
|
|
|
201
216
|
"ad_group_ad.ad_strength": "AdStrength",
|
|
202
217
|
"ad_group_ad.policy_summary.approval_status": "PolicyApprovalStatus",
|
|
203
218
|
"ad_group_ad.policy_summary.review_status": "PolicyReviewStatus",
|
|
219
|
+
"ad_group_ad.primary_status": "AdGroupAdPrimaryStatus",
|
|
220
|
+
"ad_group_ad.primary_status_reasons": "AdGroupAdPrimaryStatusReason",
|
|
204
221
|
"ad_group_ad.status": "AdGroupAdStatus",
|
|
205
222
|
"ad_group_ad_asset_view.field_type": "AssetFieldType",
|
|
206
223
|
"ad_group_ad_asset_view.performance_label": "AssetPerformanceLabel",
|
|
207
224
|
"ad_group_ad_asset_view.pinned_field": "ServedAssetFieldType",
|
|
225
|
+
"ad_group_ad_asset_view.source": "AssetSource",
|
|
208
226
|
"ad_group_asset.field_type": "AssetFieldType",
|
|
209
227
|
"ad_group_asset.primary_status": "AssetLinkPrimaryStatus",
|
|
210
228
|
"ad_group_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
|
|
@@ -225,7 +243,7 @@ var fields;
|
|
|
225
243
|
"ad_group_criterion.gender.type": "GenderType",
|
|
226
244
|
"ad_group_criterion.income_range.type": "IncomeRangeType",
|
|
227
245
|
"ad_group_criterion.keyword.match_type": "KeywordMatchType",
|
|
228
|
-
"ad_group_criterion.listing_group.case_value.
|
|
246
|
+
"ad_group_criterion.listing_group.case_value.product_category.level": "ProductCategoryLevel",
|
|
229
247
|
"ad_group_criterion.listing_group.case_value.product_channel.channel": "ProductChannel",
|
|
230
248
|
"ad_group_criterion.listing_group.case_value.product_channel_exclusivity.channel_exclusivity": "ProductChannelExclusivity",
|
|
231
249
|
"ad_group_criterion.listing_group.case_value.product_condition.condition": "ProductCondition",
|
|
@@ -252,6 +270,11 @@ var fields;
|
|
|
252
270
|
"ad_group_feed.status": "FeedLinkStatus",
|
|
253
271
|
"ad_group_simulation.modification_method": "SimulationModificationMethod",
|
|
254
272
|
"ad_group_simulation.type": "SimulationType",
|
|
273
|
+
"android_privacy_shared_key_google_ad_group.android_privacy_interaction_type": "AndroidPrivacyInteractionType",
|
|
274
|
+
"android_privacy_shared_key_google_ad_group.android_privacy_network_type": "AndroidPrivacyNetworkType",
|
|
275
|
+
"android_privacy_shared_key_google_campaign.android_privacy_interaction_type": "AndroidPrivacyInteractionType",
|
|
276
|
+
"android_privacy_shared_key_google_network_type.android_privacy_interaction_type": "AndroidPrivacyInteractionType",
|
|
277
|
+
"android_privacy_shared_key_google_network_type.android_privacy_network_type": "AndroidPrivacyNetworkType",
|
|
255
278
|
"asset.call_asset.call_conversion_reporting_state": "CallConversionReportingState",
|
|
256
279
|
"asset.call_to_action_asset.call_to_action": "CallToActionType",
|
|
257
280
|
"asset.image_asset.mime_type": "MimeType",
|
|
@@ -279,14 +302,16 @@ var fields;
|
|
|
279
302
|
"asset_group_asset.policy_summary.review_status": "PolicyReviewStatus",
|
|
280
303
|
"asset_group_asset.primary_status": "AssetLinkPrimaryStatus",
|
|
281
304
|
"asset_group_asset.primary_status_reasons": "AssetLinkPrimaryStatusReason",
|
|
305
|
+
"asset_group_asset.source": "AssetSource",
|
|
282
306
|
"asset_group_asset.status": "AssetLinkStatus",
|
|
283
|
-
"asset_group_listing_group_filter.case_value.
|
|
307
|
+
"asset_group_listing_group_filter.case_value.product_category.level": "ListingGroupFilterProductCategoryLevel",
|
|
284
308
|
"asset_group_listing_group_filter.case_value.product_channel.channel": "ListingGroupFilterProductChannel",
|
|
285
309
|
"asset_group_listing_group_filter.case_value.product_condition.condition": "ListingGroupFilterProductCondition",
|
|
286
310
|
"asset_group_listing_group_filter.case_value.product_custom_attribute.index": "ListingGroupFilterCustomAttributeIndex",
|
|
287
311
|
"asset_group_listing_group_filter.case_value.product_type.level": "ListingGroupFilterProductTypeLevel",
|
|
312
|
+
"asset_group_listing_group_filter.listing_source": "ListingGroupFilterListingSource",
|
|
288
313
|
"asset_group_listing_group_filter.type": "ListingGroupFilterType",
|
|
289
|
-
"
|
|
314
|
+
"asset_group_signal.approval_status": "AssetGroupSignalApprovalStatus",
|
|
290
315
|
"asset_set.business_profile_location_group.dynamic_business_profile_location_group_filter.business_name_filter.filter_type": "LocationStringFilterType",
|
|
291
316
|
"asset_set.location_set.chain_location_set.relationship_type": "ChainRelationshipType",
|
|
292
317
|
"asset_set.location_set.location_ownership_type": "LocationOwnershipType",
|
|
@@ -294,6 +319,7 @@ var fields;
|
|
|
294
319
|
"asset_set.type": "AssetSetType",
|
|
295
320
|
"asset_set_asset.status": "AssetSetAssetStatus",
|
|
296
321
|
"asset_set_type_view.asset_set_type": "AssetSetType",
|
|
322
|
+
"audience.scope": "AudienceScope",
|
|
297
323
|
"audience.status": "AudienceStatus",
|
|
298
324
|
"batch_job.status": "BatchJobStatus",
|
|
299
325
|
"bidding_data_exclusion.advertising_channel_types": "AdvertisingChannelType",
|
|
@@ -375,6 +401,7 @@ var fields;
|
|
|
375
401
|
"campaign_feed.placeholder_types": "PlaceholderType",
|
|
376
402
|
"campaign_feed.status": "FeedLinkStatus",
|
|
377
403
|
"campaign_group.status": "CampaignGroupStatus",
|
|
404
|
+
"campaign_lifecycle_goal.customer_acquisition_goal_settings.optimization_mode": "CustomerAcquisitionOptimizationMode",
|
|
378
405
|
"campaign_shared_set.status": "CampaignSharedSetStatus",
|
|
379
406
|
"campaign_simulation.modification_method": "SimulationModificationMethod",
|
|
380
407
|
"campaign_simulation.type": "SimulationType",
|
|
@@ -476,6 +503,18 @@ var fields;
|
|
|
476
503
|
"keyword_plan_campaign.keyword_plan_network": "KeywordPlanNetwork",
|
|
477
504
|
"keyword_plan_campaign_keyword.match_type": "KeywordMatchType",
|
|
478
505
|
"label.status": "LabelStatus",
|
|
506
|
+
"local_services_employee.status": "LocalServicesEmployeeStatus",
|
|
507
|
+
"local_services_employee.type": "LocalServicesEmployeeType",
|
|
508
|
+
"local_services_lead.lead_status": "LeadStatus",
|
|
509
|
+
"local_services_lead.lead_type": "LeadType",
|
|
510
|
+
"local_services_lead_conversation.conversation_channel": "ConversationType",
|
|
511
|
+
"local_services_lead_conversation.participant_type": "ParticipantType",
|
|
512
|
+
"local_services_verification_artifact.artifact_type": "LocalServicesVerificationArtifactType",
|
|
513
|
+
"local_services_verification_artifact.business_registration_check_verification_artifact.registration_type": "LocalServicesBusinessRegistrationType",
|
|
514
|
+
"local_services_verification_artifact.business_registration_check_verification_artifact.rejection_reason": "LocalServicesBusinessRegistrationCheckRejectionReason",
|
|
515
|
+
"local_services_verification_artifact.insurance_verification_artifact.rejection_reason": "LocalServicesInsuranceRejectionReason",
|
|
516
|
+
"local_services_verification_artifact.license_verification_artifact.rejection_reason": "LocalServicesLicenseRejectionReason",
|
|
517
|
+
"local_services_verification_artifact.status": "LocalServicesVerificationArtifactStatus",
|
|
479
518
|
"media_file.mime_type": "MimeType",
|
|
480
519
|
"media_file.type": "MediaType",
|
|
481
520
|
"metrics.historical_creative_quality_score": "QualityScoreBucket",
|
|
@@ -483,15 +522,21 @@ var fields;
|
|
|
483
522
|
"metrics.historical_search_predicted_ctr": "QualityScoreBucket",
|
|
484
523
|
"metrics.interaction_event_types": "InteractionEventType",
|
|
485
524
|
"mobile_device_constant.type": "MobileDeviceType",
|
|
525
|
+
"offline_conversion_upload_client_summary.client": "OfflineEventUploadClient",
|
|
526
|
+
"offline_conversion_upload_client_summary.status": "OfflineConversionDiagnosticStatus",
|
|
486
527
|
"offline_user_data_job.failure_reason": "OfflineUserDataJobFailureReason",
|
|
487
528
|
"offline_user_data_job.operation_metadata.match_rate_range": "OfflineUserDataJobMatchRateRange",
|
|
488
529
|
"offline_user_data_job.status": "OfflineUserDataJobStatus",
|
|
489
530
|
"offline_user_data_job.type": "OfflineUserDataJobType",
|
|
490
531
|
"operating_system_version_constant.operator_type": "OperatingSystemVersionOperatorType",
|
|
491
|
-
"
|
|
492
|
-
"
|
|
532
|
+
"product_category_constant.level": "ProductCategoryLevel",
|
|
533
|
+
"product_category_constant.state": "ProductCategoryState",
|
|
493
534
|
"product_link.type": "LinkedProductType",
|
|
535
|
+
"product_link_invitation.status": "ProductLinkInvitationStatus",
|
|
536
|
+
"product_link_invitation.type": "LinkedProductType",
|
|
494
537
|
"recommendation.type": "RecommendationType",
|
|
538
|
+
"recommendation_subscription.status": "RecommendationSubscriptionStatus",
|
|
539
|
+
"recommendation_subscription.type": "RecommendationType",
|
|
495
540
|
"search_term_view.status": "SearchTermTargetingStatus",
|
|
496
541
|
"segments.ad_destination_type": "AdDestinationType",
|
|
497
542
|
"segments.ad_network_type": "AdNetworkType",
|
|
@@ -521,6 +566,8 @@ var fields;
|
|
|
521
566
|
"segments.search_term_match_type": "SearchTermMatchType",
|
|
522
567
|
"segments.sk_ad_network_ad_event_type": "SkAdNetworkAdEventType",
|
|
523
568
|
"segments.sk_ad_network_attribution_credit": "SkAdNetworkAttributionCredit",
|
|
569
|
+
"segments.sk_ad_network_coarse_conversion_value": "SkAdNetworkCoarseConversionValue",
|
|
570
|
+
"segments.sk_ad_network_source_type": "SkAdNetworkSourceType",
|
|
524
571
|
"segments.sk_ad_network_user_type": "SkAdNetworkUserType",
|
|
525
572
|
"segments.slot": "Slot",
|
|
526
573
|
"shared_criterion.keyword.match_type": "KeywordMatchType",
|
|
@@ -533,6 +580,7 @@ var fields;
|
|
|
533
580
|
"user_list.closing_reason": "UserListClosingReason",
|
|
534
581
|
"user_list.crm_based_user_list.data_source_type": "UserListCrmDataSourceType",
|
|
535
582
|
"user_list.crm_based_user_list.upload_key_type": "CustomerMatchUploadKeyType",
|
|
583
|
+
"user_list.lookalike_user_list.expansion_level": "LookalikeExpansionLevel",
|
|
536
584
|
"user_list.membership_status": "UserListMembershipStatus",
|
|
537
585
|
"user_list.rule_based_user_list.flexible_rule_user_list.inclusive_rule_operator": "UserListFlexibleRuleOperator",
|
|
538
586
|
"user_list.rule_based_user_list.prepopulation_status": "UserListPrepopulationStatus",
|
|
@@ -243,6 +243,39 @@ export declare type AgeRangeViewResourceName = `customers/${StrNum}/ageRangeView
|
|
|
243
243
|
* @example const ageRangeView: ResourceNames.AgeRangeViewResourceName = ResourceNames.ageRangeView(10987417, 21974834, 43949668)
|
|
244
244
|
*/
|
|
245
245
|
export declare function ageRangeView(customerId: string | number, adGroupId: string | number, criterionId: string | number): AgeRangeViewResourceName;
|
|
246
|
+
export declare type AndroidPrivacySharedKeyGoogleAdGroupResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleAdGroups/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
247
|
+
/**
|
|
248
|
+
* @param {string | number} customerId
|
|
249
|
+
* @param {string | number} campaignId
|
|
250
|
+
* @param {string | number} adGroupId
|
|
251
|
+
* @param {string | number} androidPrivacyInteractionType
|
|
252
|
+
* @param {string | number} androidPrivacyNetworkType
|
|
253
|
+
* @param {string | number} androidPrivacyInteractionDate
|
|
254
|
+
* @returns `AndroidPrivacySharedKeyGoogleAdGroupResourceName`
|
|
255
|
+
* @example const androidPrivacySharedKeyGoogleAdGroup: ResourceNames.AndroidPrivacySharedKeyGoogleAdGroupResourceName = ResourceNames.androidPrivacySharedKeyGoogleAdGroup(10987417, 21974834, 43949668, 87899336, 175798672, 351597344)
|
|
256
|
+
*/
|
|
257
|
+
export declare function androidPrivacySharedKeyGoogleAdGroup(customerId: string | number, campaignId: string | number, adGroupId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyNetworkType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleAdGroupResourceName;
|
|
258
|
+
export declare type AndroidPrivacySharedKeyGoogleCampaignResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleCampaigns/${StrNum}~${StrNum}~${StrNum}`;
|
|
259
|
+
/**
|
|
260
|
+
* @param {string | number} customerId
|
|
261
|
+
* @param {string | number} campaignId
|
|
262
|
+
* @param {string | number} androidPrivacyInteractionType
|
|
263
|
+
* @param {string | number} androidPrivacyInteractionDate
|
|
264
|
+
* @returns `AndroidPrivacySharedKeyGoogleCampaignResourceName`
|
|
265
|
+
* @example const androidPrivacySharedKeyGoogleCampaign: ResourceNames.AndroidPrivacySharedKeyGoogleCampaignResourceName = ResourceNames.androidPrivacySharedKeyGoogleCampaign(10987417, 21974834, 43949668, 87899336)
|
|
266
|
+
*/
|
|
267
|
+
export declare function androidPrivacySharedKeyGoogleCampaign(customerId: string | number, campaignId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleCampaignResourceName;
|
|
268
|
+
export declare type AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleNetworkTypes/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
269
|
+
/**
|
|
270
|
+
* @param {string | number} customerId
|
|
271
|
+
* @param {string | number} campaignId
|
|
272
|
+
* @param {string | number} androidPrivacyInteractionType
|
|
273
|
+
* @param {string | number} androidPrivacyNetworkType
|
|
274
|
+
* @param {string | number} androidPrivacyInteractionDate
|
|
275
|
+
* @returns `AndroidPrivacySharedKeyGoogleNetworkTypeResourceName`
|
|
276
|
+
* @example const androidPrivacySharedKeyGoogleNetworkType: ResourceNames.AndroidPrivacySharedKeyGoogleNetworkTypeResourceName = ResourceNames.androidPrivacySharedKeyGoogleNetworkType(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
277
|
+
*/
|
|
278
|
+
export declare function androidPrivacySharedKeyGoogleNetworkType(customerId: string | number, campaignId: string | number, androidPrivacyInteractionType: string | number, androidPrivacyNetworkType: string | number, androidPrivacyInteractionDate: string | number): AndroidPrivacySharedKeyGoogleNetworkTypeResourceName;
|
|
246
279
|
export declare type AssetResourceName = `customers/${StrNum}/assets/${StrNum}`;
|
|
247
280
|
/**
|
|
248
281
|
* @param {string | number} customerId
|
|
@@ -304,6 +337,15 @@ export declare type AssetGroupSignalResourceName = `customers/${StrNum}/assetGro
|
|
|
304
337
|
* @example const assetGroupSignal: ResourceNames.AssetGroupSignalResourceName = ResourceNames.assetGroupSignal(10987417, 21974834, 43949668)
|
|
305
338
|
*/
|
|
306
339
|
export declare function assetGroupSignal(customerId: string | number, assetGroupId: string | number, criterionId: string | number): AssetGroupSignalResourceName;
|
|
340
|
+
export declare type AssetGroupTopCombinationViewResourceName = `customers/${StrNum}/assetGroupTopCombinationViews/${StrNum}~${StrNum}`;
|
|
341
|
+
/**
|
|
342
|
+
* @param {string | number} customerId
|
|
343
|
+
* @param {string | number} assetGroupId
|
|
344
|
+
* @param {string | number} assetCombinationCategory
|
|
345
|
+
* @returns `AssetGroupTopCombinationViewResourceName`
|
|
346
|
+
* @example const assetGroupTopCombinationView: ResourceNames.AssetGroupTopCombinationViewResourceName = ResourceNames.assetGroupTopCombinationView(10987417, 21974834, 43949668)
|
|
347
|
+
*/
|
|
348
|
+
export declare function assetGroupTopCombinationView(customerId: string | number, assetGroupId: string | number, assetCombinationCategory: string | number): AssetGroupTopCombinationViewResourceName;
|
|
307
349
|
export declare type AssetSetResourceName = `customers/${StrNum}/assetSets/${StrNum}`;
|
|
308
350
|
/**
|
|
309
351
|
* @param {string | number} customerId
|
|
@@ -522,6 +564,14 @@ export declare type CampaignLabelResourceName = `customers/${StrNum}/campaignLab
|
|
|
522
564
|
* @example const campaignLabel: ResourceNames.CampaignLabelResourceName = ResourceNames.campaignLabel(10987417, 21974834, 43949668)
|
|
523
565
|
*/
|
|
524
566
|
export declare function campaignLabel(customerId: string | number, campaignId: string | number, labelId: string | number): CampaignLabelResourceName;
|
|
567
|
+
export declare type CampaignLifecycleGoalResourceName = `customers/${StrNum}/campaignLifecycleGoals/${StrNum}`;
|
|
568
|
+
/**
|
|
569
|
+
* @param {string | number} customerId
|
|
570
|
+
* @param {string | number} campaignId
|
|
571
|
+
* @returns `CampaignLifecycleGoalResourceName`
|
|
572
|
+
* @example const campaignLifecycleGoal: ResourceNames.CampaignLifecycleGoalResourceName = ResourceNames.campaignLifecycleGoal(10987417, 21974834)
|
|
573
|
+
*/
|
|
574
|
+
export declare function campaignLifecycleGoal(customerId: string | number, campaignId: string | number): CampaignLifecycleGoalResourceName;
|
|
525
575
|
export declare type CampaignSearchTermInsightResourceName = `customers/${StrNum}/campaignSearchTermInsights/${StrNum}~${StrNum}`;
|
|
526
576
|
/**
|
|
527
577
|
* @param {string | number} customerId
|
|
@@ -747,6 +797,13 @@ export declare type CustomerLabelResourceName = `customers/${StrNum}/customerLab
|
|
|
747
797
|
* @example const customerLabel: ResourceNames.CustomerLabelResourceName = ResourceNames.customerLabel(10987417, 21974834)
|
|
748
798
|
*/
|
|
749
799
|
export declare function customerLabel(customerId: string | number, labelId: string | number): CustomerLabelResourceName;
|
|
800
|
+
export declare type CustomerLifecycleGoalResourceName = `customers/${StrNum}/customerLifecycleGoals`;
|
|
801
|
+
/**
|
|
802
|
+
* @param {string | number} customerId
|
|
803
|
+
* @returns `CustomerLifecycleGoalResourceName`
|
|
804
|
+
* @example const customerLifecycleGoal: ResourceNames.CustomerLifecycleGoalResourceName = ResourceNames.customerLifecycleGoal(10987417)
|
|
805
|
+
*/
|
|
806
|
+
export declare function customerLifecycleGoal(customerId: string | number): CustomerLifecycleGoalResourceName;
|
|
750
807
|
export declare type CustomerManagerLinkResourceName = `customers/${StrNum}/customerManagerLinks/${StrNum}~${StrNum}`;
|
|
751
808
|
/**
|
|
752
809
|
* @param {string | number} customerId
|
|
@@ -1136,6 +1193,38 @@ export declare type LifeEventResourceName = `customers/${StrNum}/lifeEvents/${St
|
|
|
1136
1193
|
* @example const lifeEvent: ResourceNames.LifeEventResourceName = ResourceNames.lifeEvent(10987417, 21974834)
|
|
1137
1194
|
*/
|
|
1138
1195
|
export declare function lifeEvent(customerId: string | number, lifeEventId: string | number): LifeEventResourceName;
|
|
1196
|
+
export declare type LocalServicesEmployeeResourceName = `customers/${StrNum}/localServicesEmployees/${StrNum}`;
|
|
1197
|
+
/**
|
|
1198
|
+
* @param {string | number} customerId
|
|
1199
|
+
* @param {string | number} glsEmployeeId
|
|
1200
|
+
* @returns `LocalServicesEmployeeResourceName`
|
|
1201
|
+
* @example const localServicesEmployee: ResourceNames.LocalServicesEmployeeResourceName = ResourceNames.localServicesEmployee(10987417, 21974834)
|
|
1202
|
+
*/
|
|
1203
|
+
export declare function localServicesEmployee(customerId: string | number, glsEmployeeId: string | number): LocalServicesEmployeeResourceName;
|
|
1204
|
+
export declare type LocalServicesLeadResourceName = `customers/${StrNum}/localServicesLeads/${StrNum}`;
|
|
1205
|
+
/**
|
|
1206
|
+
* @param {string | number} customerId
|
|
1207
|
+
* @param {string | number} localServicesLeadId
|
|
1208
|
+
* @returns `LocalServicesLeadResourceName`
|
|
1209
|
+
* @example const localServicesLead: ResourceNames.LocalServicesLeadResourceName = ResourceNames.localServicesLead(10987417, 21974834)
|
|
1210
|
+
*/
|
|
1211
|
+
export declare function localServicesLead(customerId: string | number, localServicesLeadId: string | number): LocalServicesLeadResourceName;
|
|
1212
|
+
export declare type LocalServicesLeadConversationResourceName = `customers/${StrNum}/localServicesLeadConversations/${StrNum}`;
|
|
1213
|
+
/**
|
|
1214
|
+
* @param {string | number} customerId
|
|
1215
|
+
* @param {string | number} localServicesLeadConversationId
|
|
1216
|
+
* @returns `LocalServicesLeadConversationResourceName`
|
|
1217
|
+
* @example const localServicesLeadConversation: ResourceNames.LocalServicesLeadConversationResourceName = ResourceNames.localServicesLeadConversation(10987417, 21974834)
|
|
1218
|
+
*/
|
|
1219
|
+
export declare function localServicesLeadConversation(customerId: string | number, localServicesLeadConversationId: string | number): LocalServicesLeadConversationResourceName;
|
|
1220
|
+
export declare type LocalServicesVerificationArtifactResourceName = `customers/${StrNum}/localServicesVerificationArtifacts/${StrNum}`;
|
|
1221
|
+
/**
|
|
1222
|
+
* @param {string | number} customerId
|
|
1223
|
+
* @param {string | number} glsVerificationArtifactId
|
|
1224
|
+
* @returns `LocalServicesVerificationArtifactResourceName`
|
|
1225
|
+
* @example const localServicesVerificationArtifact: ResourceNames.LocalServicesVerificationArtifactResourceName = ResourceNames.localServicesVerificationArtifact(10987417, 21974834)
|
|
1226
|
+
*/
|
|
1227
|
+
export declare function localServicesVerificationArtifact(customerId: string | number, glsVerificationArtifactId: string | number): LocalServicesVerificationArtifactResourceName;
|
|
1139
1228
|
export declare type LocationViewResourceName = `customers/${StrNum}/locationViews/${StrNum}~${StrNum}`;
|
|
1140
1229
|
/**
|
|
1141
1230
|
* @param {string | number} customerId
|
|
@@ -1162,14 +1251,6 @@ export declare type MediaFileResourceName = `customers/${StrNum}/mediaFiles/${St
|
|
|
1162
1251
|
* @example const mediaFile: ResourceNames.MediaFileResourceName = ResourceNames.mediaFile(10987417, 21974834)
|
|
1163
1252
|
*/
|
|
1164
1253
|
export declare function mediaFile(customerId: string | number, mediaFileId: string | number): MediaFileResourceName;
|
|
1165
|
-
export declare type MerchantCenterLinkResourceName = `customers/${StrNum}/merchantCenterLinks/${StrNum}`;
|
|
1166
|
-
/**
|
|
1167
|
-
* @param {string | number} customerId
|
|
1168
|
-
* @param {string | number} merchantCenterId
|
|
1169
|
-
* @returns `MerchantCenterLinkResourceName`
|
|
1170
|
-
* @example const merchantCenterLink: ResourceNames.MerchantCenterLinkResourceName = ResourceNames.merchantCenterLink(10987417, 21974834)
|
|
1171
|
-
*/
|
|
1172
|
-
export declare function merchantCenterLink(customerId: string | number, merchantCenterId: string | number): MerchantCenterLinkResourceName;
|
|
1173
1254
|
export declare type MobileAppCategoryConstantResourceName = `mobileAppCategoryConstants/${StrNum}`;
|
|
1174
1255
|
/**
|
|
1175
1256
|
* @param {string | number} mobileAppCategoryId
|
|
@@ -1184,6 +1265,14 @@ export declare type MobileDeviceConstantResourceName = `mobileDeviceConstants/${
|
|
|
1184
1265
|
* @example const mobileDeviceConstant: ResourceNames.MobileDeviceConstantResourceName = ResourceNames.mobileDeviceConstant(10987417)
|
|
1185
1266
|
*/
|
|
1186
1267
|
export declare function mobileDeviceConstant(criterionId: string | number): MobileDeviceConstantResourceName;
|
|
1268
|
+
export declare type OfflineConversionUploadClientSummaryResourceName = `customers/${StrNum}/offlineConversionUploadClientSummaries/${StrNum}`;
|
|
1269
|
+
/**
|
|
1270
|
+
* @param {string | number} customerId
|
|
1271
|
+
* @param {string | number} client
|
|
1272
|
+
* @returns `OfflineConversionUploadClientSummaryResourceName`
|
|
1273
|
+
* @example const offlineConversionUploadClientSummary: ResourceNames.OfflineConversionUploadClientSummaryResourceName = ResourceNames.offlineConversionUploadClientSummary(10987417, 21974834)
|
|
1274
|
+
*/
|
|
1275
|
+
export declare function offlineConversionUploadClientSummary(customerId: string | number, client: string | number): OfflineConversionUploadClientSummaryResourceName;
|
|
1187
1276
|
export declare type OfflineUserDataJobResourceName = `customers/${StrNum}/offlineUserDataJobs/${StrNum}`;
|
|
1188
1277
|
/**
|
|
1189
1278
|
* @param {string | number} customerId
|
|
@@ -1234,15 +1323,14 @@ export declare type PerStoreViewResourceName = `customers/${StrNum}/perStoreView
|
|
|
1234
1323
|
* @example const perStoreView: ResourceNames.PerStoreViewResourceName = ResourceNames.perStoreView(10987417, 21974834)
|
|
1235
1324
|
*/
|
|
1236
1325
|
export declare function perStoreView(customerId: string | number, placeId: string | number): PerStoreViewResourceName;
|
|
1237
|
-
export declare type
|
|
1326
|
+
export declare type ProductCategoryConstantResourceName = `productCategoryConstants/${StrNum}~${StrNum}`;
|
|
1238
1327
|
/**
|
|
1239
|
-
* @param {string | number} countryCode
|
|
1240
1328
|
* @param {string | number} level
|
|
1241
|
-
* @param {string | number}
|
|
1242
|
-
* @returns `
|
|
1243
|
-
* @example const
|
|
1329
|
+
* @param {string | number} categoryId
|
|
1330
|
+
* @returns `ProductCategoryConstantResourceName`
|
|
1331
|
+
* @example const productCategoryConstant: ResourceNames.ProductCategoryConstantResourceName = ResourceNames.productCategoryConstant(10987417, 21974834)
|
|
1244
1332
|
*/
|
|
1245
|
-
export declare function
|
|
1333
|
+
export declare function productCategoryConstant(level: string | number, categoryId: string | number): ProductCategoryConstantResourceName;
|
|
1246
1334
|
export declare type ProductGroupViewResourceName = `customers/${StrNum}/productGroupViews/${StrNum}~${StrNum}`;
|
|
1247
1335
|
/**
|
|
1248
1336
|
* @param {string | number} customerId
|
|
@@ -1260,6 +1348,14 @@ export declare type ProductLinkResourceName = `customers/${StrNum}/productLinks/
|
|
|
1260
1348
|
* @example const productLink: ResourceNames.ProductLinkResourceName = ResourceNames.productLink(10987417, 21974834)
|
|
1261
1349
|
*/
|
|
1262
1350
|
export declare function productLink(customerId: string | number, productLinkId: string | number): ProductLinkResourceName;
|
|
1351
|
+
export declare type ProductLinkInvitationResourceName = `customers/${StrNum}/productLinkInvitations/${StrNum}`;
|
|
1352
|
+
/**
|
|
1353
|
+
* @param {string | number} customerId
|
|
1354
|
+
* @param {string | number} customerInvitationId
|
|
1355
|
+
* @returns `ProductLinkInvitationResourceName`
|
|
1356
|
+
* @example const productLinkInvitation: ResourceNames.ProductLinkInvitationResourceName = ResourceNames.productLinkInvitation(10987417, 21974834)
|
|
1357
|
+
*/
|
|
1358
|
+
export declare function productLinkInvitation(customerId: string | number, customerInvitationId: string | number): ProductLinkInvitationResourceName;
|
|
1263
1359
|
export declare type QualifyingQuestionResourceName = `qualifyingQuestions/${StrNum}`;
|
|
1264
1360
|
/**
|
|
1265
1361
|
* @param {string | number} qualifyingQuestionId
|
|
@@ -1275,6 +1371,14 @@ export declare type RecommendationResourceName = `customers/${StrNum}/recommenda
|
|
|
1275
1371
|
* @example const recommendation: ResourceNames.RecommendationResourceName = ResourceNames.recommendation(10987417, 21974834)
|
|
1276
1372
|
*/
|
|
1277
1373
|
export declare function recommendation(customerId: string | number, recommendationId: string | number): RecommendationResourceName;
|
|
1374
|
+
export declare type RecommendationSubscriptionResourceName = `customers/${StrNum}/recommendationSubscriptions/${StrNum}`;
|
|
1375
|
+
/**
|
|
1376
|
+
* @param {string | number} customerId
|
|
1377
|
+
* @param {string | number} recommendationType
|
|
1378
|
+
* @returns `RecommendationSubscriptionResourceName`
|
|
1379
|
+
* @example const recommendationSubscription: ResourceNames.RecommendationSubscriptionResourceName = ResourceNames.recommendationSubscription(10987417, 21974834)
|
|
1380
|
+
*/
|
|
1381
|
+
export declare function recommendationSubscription(customerId: string | number, recommendationType: string | number): RecommendationSubscriptionResourceName;
|
|
1278
1382
|
export declare type RemarketingActionResourceName = `customers/${StrNum}/remarketingActions/${StrNum}`;
|
|
1279
1383
|
/**
|
|
1280
1384
|
* @param {string | number} customerId
|