google-ads-api 21.0.0 → 21.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/build/src/protos/autogen/fields.d.ts +219 -171
- package/build/src/protos/autogen/fields.js +20 -2
- package/build/src/protos/autogen/resourceNames.d.ts +57 -0
- package/build/src/protos/autogen/resourceNames.js +69 -0
- package/build/src/protos/autogen/serviceFactory.d.ts +184 -171
- package/build/src/protos/autogen/serviceFactory.js +305 -171
- package/package.json +1 -1
|
@@ -225,6 +225,17 @@ export type AgeRangeViewResourceName = `customers/${StrNum}/ageRangeViews/${StrN
|
|
|
225
225
|
* @example const ageRangeView: ResourceNames.AgeRangeViewResourceName = ResourceNames.ageRangeView(10987417, 21974834, 43949668)
|
|
226
226
|
*/
|
|
227
227
|
export declare function ageRangeView(customerId: string | number, adGroupId: string | number, criterionId: string | number): AgeRangeViewResourceName;
|
|
228
|
+
export type AiMaxSearchTermAdCombinationViewResourceName = `customers/${StrNum}/aiMaxSearchTermAdCombinationViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
229
|
+
/**
|
|
230
|
+
* @param {string | number} customerId
|
|
231
|
+
* @param {string | number} adGroupId
|
|
232
|
+
* @param {string | number} searchTerm
|
|
233
|
+
* @param {string | number} landingPage
|
|
234
|
+
* @param {string | number} headline
|
|
235
|
+
* @returns `AiMaxSearchTermAdCombinationViewResourceName`
|
|
236
|
+
* @example const aiMaxSearchTermAdCombinationView: ResourceNames.AiMaxSearchTermAdCombinationViewResourceName = ResourceNames.aiMaxSearchTermAdCombinationView(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
237
|
+
*/
|
|
238
|
+
export declare function aiMaxSearchTermAdCombinationView(customerId: string | number, adGroupId: string | number, searchTerm: string | number, landingPage: string | number, headline: string | number): AiMaxSearchTermAdCombinationViewResourceName;
|
|
228
239
|
export type AndroidPrivacySharedKeyGoogleAdGroupResourceName = `customers/${StrNum}/androidPrivacySharedKeyGoogleAdGroups/${StrNum}~${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
229
240
|
/**
|
|
230
241
|
* @param {string | number} customerId
|
|
@@ -556,6 +567,15 @@ export type CampaignSearchTermInsightResourceName = `customers/${StrNum}/campaig
|
|
|
556
567
|
* @example const campaignSearchTermInsight: ResourceNames.CampaignSearchTermInsightResourceName = ResourceNames.campaignSearchTermInsight(10987417, 21974834, 43949668)
|
|
557
568
|
*/
|
|
558
569
|
export declare function campaignSearchTermInsight(customerId: string | number, campaignId: string | number, clusterId: string | number): CampaignSearchTermInsightResourceName;
|
|
570
|
+
export type CampaignSearchTermViewResourceName = `customers/${StrNum}/campaignSearchTermViews/${StrNum}~${StrNum}`;
|
|
571
|
+
/**
|
|
572
|
+
* @param {string | number} customerId
|
|
573
|
+
* @param {string | number} campaignId
|
|
574
|
+
* @param {string | number} query
|
|
575
|
+
* @returns `CampaignSearchTermViewResourceName`
|
|
576
|
+
* @example const campaignSearchTermView: ResourceNames.CampaignSearchTermViewResourceName = ResourceNames.campaignSearchTermView(10987417, 21974834, 43949668)
|
|
577
|
+
*/
|
|
578
|
+
export declare function campaignSearchTermView(customerId: string | number, campaignId: string | number, query: string | number): CampaignSearchTermViewResourceName;
|
|
559
579
|
export type CampaignSharedSetResourceName = `customers/${StrNum}/campaignSharedSets/${StrNum}~${StrNum}`;
|
|
560
580
|
/**
|
|
561
581
|
* @param {string | number} customerId
|
|
@@ -849,6 +869,14 @@ export type DataLinkResourceName = `customers/${StrNum}/dataLinks/${StrNum}~${St
|
|
|
849
869
|
* @example const dataLink: ResourceNames.DataLinkResourceName = ResourceNames.dataLink(10987417, 21974834, 43949668)
|
|
850
870
|
*/
|
|
851
871
|
export declare function dataLink(customerId: string | number, productLinkId: string | number, dataLinkId: string | number): DataLinkResourceName;
|
|
872
|
+
export type DetailContentSuitabilityPlacementViewResourceName = `customers/${StrNum}/detailContentSuitabilityPlacementViews/${StrNum}`;
|
|
873
|
+
/**
|
|
874
|
+
* @param {string | number} customerId
|
|
875
|
+
* @param {string | number} placementFingerprint
|
|
876
|
+
* @returns `DetailContentSuitabilityPlacementViewResourceName`
|
|
877
|
+
* @example const detailContentSuitabilityPlacementView: ResourceNames.DetailContentSuitabilityPlacementViewResourceName = ResourceNames.detailContentSuitabilityPlacementView(10987417, 21974834)
|
|
878
|
+
*/
|
|
879
|
+
export declare function detailContentSuitabilityPlacementView(customerId: string | number, placementFingerprint: string | number): DetailContentSuitabilityPlacementViewResourceName;
|
|
852
880
|
export type DetailPlacementViewResourceName = `customers/${StrNum}/detailPlacementViews/${StrNum}~${StrNum}`;
|
|
853
881
|
/**
|
|
854
882
|
* @param {string | number} customerId
|
|
@@ -931,6 +959,17 @@ export type ExperimentArmResourceName = `customers/${StrNum}/experimentArms/${St
|
|
|
931
959
|
* @example const experimentArm: ResourceNames.ExperimentArmResourceName = ResourceNames.experimentArm(10987417, 21974834, 43949668)
|
|
932
960
|
*/
|
|
933
961
|
export declare function experimentArm(customerId: string | number, trialId: string | number, trialArmId: string | number): ExperimentArmResourceName;
|
|
962
|
+
export type FinalUrlExpansionAssetViewResourceName = `customers/${StrNum}/finalUrlExpansionAssetViews/${StrNum}~${StrNum}~${StrNum}~${StrNum}`;
|
|
963
|
+
/**
|
|
964
|
+
* @param {string | number} customerId
|
|
965
|
+
* @param {string | number} campaignId
|
|
966
|
+
* @param {string | number} assetId
|
|
967
|
+
* @param {string | number} fieldType
|
|
968
|
+
* @param {string | number} urlFp
|
|
969
|
+
* @returns `FinalUrlExpansionAssetViewResourceName`
|
|
970
|
+
* @example const finalUrlExpansionAssetView: ResourceNames.FinalUrlExpansionAssetViewResourceName = ResourceNames.finalUrlExpansionAssetView(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
971
|
+
*/
|
|
972
|
+
export declare function finalUrlExpansionAssetView(customerId: string | number, campaignId: string | number, assetId: string | number, fieldType: string | number, urlFp: string | number): FinalUrlExpansionAssetViewResourceName;
|
|
934
973
|
export type GenderViewResourceName = `customers/${StrNum}/genderViews/${StrNum}~${StrNum}`;
|
|
935
974
|
/**
|
|
936
975
|
* @param {string | number} customerId
|
|
@@ -963,6 +1002,14 @@ export type GoogleAdsFieldResourceName = `googleAdsFields/${StrNum}`;
|
|
|
963
1002
|
* @example const googleAdsField: ResourceNames.GoogleAdsFieldResourceName = ResourceNames.googleAdsField(10987417)
|
|
964
1003
|
*/
|
|
965
1004
|
export declare function googleAdsField(googleAdsField: string | number): GoogleAdsFieldResourceName;
|
|
1005
|
+
export type GroupContentSuitabilityPlacementViewResourceName = `customers/${StrNum}/groupContentSuitabilityPlacementViews/${StrNum}`;
|
|
1006
|
+
/**
|
|
1007
|
+
* @param {string | number} customerId
|
|
1008
|
+
* @param {string | number} placementFingerprint
|
|
1009
|
+
* @returns `GroupContentSuitabilityPlacementViewResourceName`
|
|
1010
|
+
* @example const groupContentSuitabilityPlacementView: ResourceNames.GroupContentSuitabilityPlacementViewResourceName = ResourceNames.groupContentSuitabilityPlacementView(10987417, 21974834)
|
|
1011
|
+
*/
|
|
1012
|
+
export declare function groupContentSuitabilityPlacementView(customerId: string | number, placementFingerprint: string | number): GroupContentSuitabilityPlacementViewResourceName;
|
|
966
1013
|
export type GroupPlacementViewResourceName = `customers/${StrNum}/groupPlacementViews/${StrNum}~${StrNum}`;
|
|
967
1014
|
/**
|
|
968
1015
|
* @param {string | number} customerId
|
|
@@ -1141,6 +1188,16 @@ export type LocalServicesVerificationArtifactResourceName = `customers/${StrNum}
|
|
|
1141
1188
|
* @example const localServicesVerificationArtifact: ResourceNames.LocalServicesVerificationArtifactResourceName = ResourceNames.localServicesVerificationArtifact(10987417, 21974834)
|
|
1142
1189
|
*/
|
|
1143
1190
|
export declare function localServicesVerificationArtifact(customerId: string | number, glsVerificationArtifactId: string | number): LocalServicesVerificationArtifactResourceName;
|
|
1191
|
+
export type LocationInterestViewResourceName = `customers/${StrNum}/locationInterestViews/${StrNum}~${StrNum}~${StrNum}`;
|
|
1192
|
+
/**
|
|
1193
|
+
* @param {string | number} customerId
|
|
1194
|
+
* @param {string | number} campaignId
|
|
1195
|
+
* @param {string | number} adGroupId
|
|
1196
|
+
* @param {string | number} criterionId
|
|
1197
|
+
* @returns `LocationInterestViewResourceName`
|
|
1198
|
+
* @example const locationInterestView: ResourceNames.LocationInterestViewResourceName = ResourceNames.locationInterestView(10987417, 21974834, 43949668, 87899336)
|
|
1199
|
+
*/
|
|
1200
|
+
export declare function locationInterestView(customerId: string | number, campaignId: string | number, adGroupId: string | number, criterionId: string | number): LocationInterestViewResourceName;
|
|
1144
1201
|
export type LocationViewResourceName = `customers/${StrNum}/locationViews/${StrNum}~${StrNum}`;
|
|
1145
1202
|
/**
|
|
1146
1203
|
* @param {string | number} customerId
|
|
@@ -25,6 +25,7 @@ exports.adGroupSimulation = adGroupSimulation;
|
|
|
25
25
|
exports.adParameter = adParameter;
|
|
26
26
|
exports.adScheduleView = adScheduleView;
|
|
27
27
|
exports.ageRangeView = ageRangeView;
|
|
28
|
+
exports.aiMaxSearchTermAdCombinationView = aiMaxSearchTermAdCombinationView;
|
|
28
29
|
exports.androidPrivacySharedKeyGoogleAdGroup = androidPrivacySharedKeyGoogleAdGroup;
|
|
29
30
|
exports.androidPrivacySharedKeyGoogleCampaign = androidPrivacySharedKeyGoogleCampaign;
|
|
30
31
|
exports.androidPrivacySharedKeyGoogleNetworkType = androidPrivacySharedKeyGoogleNetworkType;
|
|
@@ -62,6 +63,7 @@ exports.campaignGroup = campaignGroup;
|
|
|
62
63
|
exports.campaignLabel = campaignLabel;
|
|
63
64
|
exports.campaignLifecycleGoal = campaignLifecycleGoal;
|
|
64
65
|
exports.campaignSearchTermInsight = campaignSearchTermInsight;
|
|
66
|
+
exports.campaignSearchTermView = campaignSearchTermView;
|
|
65
67
|
exports.campaignSharedSet = campaignSharedSet;
|
|
66
68
|
exports.campaignSimulation = campaignSimulation;
|
|
67
69
|
exports.carrierConstant = carrierConstant;
|
|
@@ -97,6 +99,7 @@ exports.customerUserAccess = customerUserAccess;
|
|
|
97
99
|
exports.customerUserAccessInvitation = customerUserAccessInvitation;
|
|
98
100
|
exports.customizerAttribute = customizerAttribute;
|
|
99
101
|
exports.dataLink = dataLink;
|
|
102
|
+
exports.detailContentSuitabilityPlacementView = detailContentSuitabilityPlacementView;
|
|
100
103
|
exports.detailPlacementView = detailPlacementView;
|
|
101
104
|
exports.detailedDemographic = detailedDemographic;
|
|
102
105
|
exports.displayKeywordView = displayKeywordView;
|
|
@@ -106,10 +109,12 @@ exports.dynamicSearchAdsSearchTermView = dynamicSearchAdsSearchTermView;
|
|
|
106
109
|
exports.expandedLandingPageView = expandedLandingPageView;
|
|
107
110
|
exports.experiment = experiment;
|
|
108
111
|
exports.experimentArm = experimentArm;
|
|
112
|
+
exports.finalUrlExpansionAssetView = finalUrlExpansionAssetView;
|
|
109
113
|
exports.genderView = genderView;
|
|
110
114
|
exports.geoTargetConstant = geoTargetConstant;
|
|
111
115
|
exports.geographicView = geographicView;
|
|
112
116
|
exports.googleAdsField = googleAdsField;
|
|
117
|
+
exports.groupContentSuitabilityPlacementView = groupContentSuitabilityPlacementView;
|
|
113
118
|
exports.groupPlacementView = groupPlacementView;
|
|
114
119
|
exports.hotelGroupView = hotelGroupView;
|
|
115
120
|
exports.hotelPerformanceView = hotelPerformanceView;
|
|
@@ -132,6 +137,7 @@ exports.localServicesEmployee = localServicesEmployee;
|
|
|
132
137
|
exports.localServicesLead = localServicesLead;
|
|
133
138
|
exports.localServicesLeadConversation = localServicesLeadConversation;
|
|
134
139
|
exports.localServicesVerificationArtifact = localServicesVerificationArtifact;
|
|
140
|
+
exports.locationInterestView = locationInterestView;
|
|
135
141
|
exports.locationView = locationView;
|
|
136
142
|
exports.managedPlacementView = managedPlacementView;
|
|
137
143
|
exports.mediaFile = mediaFile;
|
|
@@ -422,6 +428,18 @@ function adScheduleView(customerId, campaignId, criterionId) {
|
|
|
422
428
|
function ageRangeView(customerId, adGroupId, criterionId) {
|
|
423
429
|
return `customers/${customerId}/ageRangeViews/${adGroupId}~${criterionId}`;
|
|
424
430
|
}
|
|
431
|
+
/**
|
|
432
|
+
* @param {string | number} customerId
|
|
433
|
+
* @param {string | number} adGroupId
|
|
434
|
+
* @param {string | number} searchTerm
|
|
435
|
+
* @param {string | number} landingPage
|
|
436
|
+
* @param {string | number} headline
|
|
437
|
+
* @returns `AiMaxSearchTermAdCombinationViewResourceName`
|
|
438
|
+
* @example const aiMaxSearchTermAdCombinationView: ResourceNames.AiMaxSearchTermAdCombinationViewResourceName = ResourceNames.aiMaxSearchTermAdCombinationView(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
439
|
+
*/
|
|
440
|
+
function aiMaxSearchTermAdCombinationView(customerId, adGroupId, searchTerm, landingPage, headline) {
|
|
441
|
+
return `customers/${customerId}/aiMaxSearchTermAdCombinationViews/${adGroupId}~${searchTerm}~${landingPage}~${headline}`;
|
|
442
|
+
}
|
|
425
443
|
/**
|
|
426
444
|
* @param {string | number} customerId
|
|
427
445
|
* @param {string | number} campaignId
|
|
@@ -790,6 +808,16 @@ function campaignLifecycleGoal(customerId, campaignId) {
|
|
|
790
808
|
function campaignSearchTermInsight(customerId, campaignId, clusterId) {
|
|
791
809
|
return `customers/${customerId}/campaignSearchTermInsights/${campaignId}~${clusterId}`;
|
|
792
810
|
}
|
|
811
|
+
/**
|
|
812
|
+
* @param {string | number} customerId
|
|
813
|
+
* @param {string | number} campaignId
|
|
814
|
+
* @param {string | number} query
|
|
815
|
+
* @returns `CampaignSearchTermViewResourceName`
|
|
816
|
+
* @example const campaignSearchTermView: ResourceNames.CampaignSearchTermViewResourceName = ResourceNames.campaignSearchTermView(10987417, 21974834, 43949668)
|
|
817
|
+
*/
|
|
818
|
+
function campaignSearchTermView(customerId, campaignId, query) {
|
|
819
|
+
return `customers/${customerId}/campaignSearchTermViews/${campaignId}~${query}`;
|
|
820
|
+
}
|
|
793
821
|
/**
|
|
794
822
|
* @param {string | number} customerId
|
|
795
823
|
* @param {string | number} campaignId
|
|
@@ -1118,6 +1146,15 @@ function customizerAttribute(customerId, customizerAttributeId) {
|
|
|
1118
1146
|
function dataLink(customerId, productLinkId, dataLinkId) {
|
|
1119
1147
|
return `customers/${customerId}/dataLinks/${productLinkId}~${dataLinkId}`;
|
|
1120
1148
|
}
|
|
1149
|
+
/**
|
|
1150
|
+
* @param {string | number} customerId
|
|
1151
|
+
* @param {string | number} placementFingerprint
|
|
1152
|
+
* @returns `DetailContentSuitabilityPlacementViewResourceName`
|
|
1153
|
+
* @example const detailContentSuitabilityPlacementView: ResourceNames.DetailContentSuitabilityPlacementViewResourceName = ResourceNames.detailContentSuitabilityPlacementView(10987417, 21974834)
|
|
1154
|
+
*/
|
|
1155
|
+
function detailContentSuitabilityPlacementView(customerId, placementFingerprint) {
|
|
1156
|
+
return `customers/${customerId}/detailContentSuitabilityPlacementViews/${placementFingerprint}`;
|
|
1157
|
+
}
|
|
1121
1158
|
/**
|
|
1122
1159
|
* @param {string | number} customerId
|
|
1123
1160
|
* @param {string | number} adGroupId
|
|
@@ -1209,6 +1246,18 @@ function experiment(customerId, trialId) {
|
|
|
1209
1246
|
function experimentArm(customerId, trialId, trialArmId) {
|
|
1210
1247
|
return `customers/${customerId}/experimentArms/${trialId}~${trialArmId}`;
|
|
1211
1248
|
}
|
|
1249
|
+
/**
|
|
1250
|
+
* @param {string | number} customerId
|
|
1251
|
+
* @param {string | number} campaignId
|
|
1252
|
+
* @param {string | number} assetId
|
|
1253
|
+
* @param {string | number} fieldType
|
|
1254
|
+
* @param {string | number} urlFp
|
|
1255
|
+
* @returns `FinalUrlExpansionAssetViewResourceName`
|
|
1256
|
+
* @example const finalUrlExpansionAssetView: ResourceNames.FinalUrlExpansionAssetViewResourceName = ResourceNames.finalUrlExpansionAssetView(10987417, 21974834, 43949668, 87899336, 175798672)
|
|
1257
|
+
*/
|
|
1258
|
+
function finalUrlExpansionAssetView(customerId, campaignId, assetId, fieldType, urlFp) {
|
|
1259
|
+
return `customers/${customerId}/finalUrlExpansionAssetViews/${campaignId}~${assetId}~${fieldType}~${urlFp}`;
|
|
1260
|
+
}
|
|
1212
1261
|
/**
|
|
1213
1262
|
* @param {string | number} customerId
|
|
1214
1263
|
* @param {string | number} adGroupId
|
|
@@ -1245,6 +1294,15 @@ function geographicView(customerId, countryCriterionId, locationType) {
|
|
|
1245
1294
|
function googleAdsField(googleAdsField) {
|
|
1246
1295
|
return `googleAdsFields/${googleAdsField}`;
|
|
1247
1296
|
}
|
|
1297
|
+
/**
|
|
1298
|
+
* @param {string | number} customerId
|
|
1299
|
+
* @param {string | number} placementFingerprint
|
|
1300
|
+
* @returns `GroupContentSuitabilityPlacementViewResourceName`
|
|
1301
|
+
* @example const groupContentSuitabilityPlacementView: ResourceNames.GroupContentSuitabilityPlacementViewResourceName = ResourceNames.groupContentSuitabilityPlacementView(10987417, 21974834)
|
|
1302
|
+
*/
|
|
1303
|
+
function groupContentSuitabilityPlacementView(customerId, placementFingerprint) {
|
|
1304
|
+
return `customers/${customerId}/groupContentSuitabilityPlacementViews/${placementFingerprint}`;
|
|
1305
|
+
}
|
|
1248
1306
|
/**
|
|
1249
1307
|
* @param {string | number} customerId
|
|
1250
1308
|
* @param {string | number} adGroupId
|
|
@@ -1445,6 +1503,17 @@ function localServicesLeadConversation(customerId, localServicesLeadConversation
|
|
|
1445
1503
|
function localServicesVerificationArtifact(customerId, glsVerificationArtifactId) {
|
|
1446
1504
|
return `customers/${customerId}/localServicesVerificationArtifacts/${glsVerificationArtifactId}`;
|
|
1447
1505
|
}
|
|
1506
|
+
/**
|
|
1507
|
+
* @param {string | number} customerId
|
|
1508
|
+
* @param {string | number} campaignId
|
|
1509
|
+
* @param {string | number} adGroupId
|
|
1510
|
+
* @param {string | number} criterionId
|
|
1511
|
+
* @returns `LocationInterestViewResourceName`
|
|
1512
|
+
* @example const locationInterestView: ResourceNames.LocationInterestViewResourceName = ResourceNames.locationInterestView(10987417, 21974834, 43949668, 87899336)
|
|
1513
|
+
*/
|
|
1514
|
+
function locationInterestView(customerId, campaignId, adGroupId, criterionId) {
|
|
1515
|
+
return `customers/${customerId}/locationInterestViews/${campaignId}~${adGroupId}~${criterionId}`;
|
|
1516
|
+
}
|
|
1448
1517
|
/**
|
|
1449
1518
|
* @param {string | number} customerId
|
|
1450
1519
|
* @param {string | number} campaignId
|