Skip to content

Commit 340ca02

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
feat(searchads360): update the API
#### searchads360:v0 The following keys were added: - schemas.GoogleAdsSearchads360V0Resources__AdGroupAd.properties.effectiveLabels.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAd.properties.effectiveLabels.items.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAd.properties.effectiveLabels.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroupAd.properties.effectiveLabels.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.id - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.adGroupAd.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.adGroupAd.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.label.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.label.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.ownerCustomerId.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.ownerCustomerId.format - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.ownerCustomerId.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.ownerCustomerId.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.resourceName.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.properties.resourceName.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterion.properties.effectiveLabels.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterion.properties.effectiveLabels.items.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterion.properties.effectiveLabels.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterion.properties.effectiveLabels.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.id - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.adGroupCriterion.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.adGroupCriterion.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.label.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.label.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.ownerCustomerId.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.ownerCustomerId.format - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.ownerCustomerId.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.ownerCustomerId.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.resourceName.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.properties.resourceName.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel.type - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.description - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.id - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.countryCriterionId.description - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.countryCriterionId.format - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.countryCriterionId.readOnly - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.countryCriterionId.type - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.resourceName.description - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.resourceName.readOnly - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.resourceName.type - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.targetingLocation.description - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.targetingLocation.readOnly - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.properties.targetingLocation.type - schemas.GoogleAdsSearchads360V0Resources__UserLocationView.type - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupAdEffectiveLabel.$ref - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupAdEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupCriterionEffectiveLabel.$ref - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupCriterionEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.userLocationView.$ref - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.userLocationView.description
1 parent 8c8c86e commit 340ca02

File tree

2 files changed

+181
-1
lines changed

2 files changed

+181
-1
lines changed

‎discovery/searchads360-v0.json

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@
260260
}
261261
}
262262
},
263-
"revision": "20241002",
263+
"revision": "20241108",
264264
"rootUrl": "https://searchads360.googleapis.com/",
265265
"schemas": {
266266
"GoogleAdsSearchads360V0Common__AdScheduleInfo": {
@@ -4225,6 +4225,14 @@
42254225
"readOnly": true,
42264226
"type": "string"
42274227
},
4228+
"effectiveLabels": {
4229+
"description": "Output only. The resource names of effective labels attached to this ad. An effective label is a label inherited or directly assigned to this ad.",
4230+
"items": {
4231+
"type": "string"
4232+
},
4233+
"readOnly": true,
4234+
"type": "array"
4235+
},
42284236
"engineId": {
42294237
"description": "Output only. ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use \"ad_group_ad.ad.id\" instead.",
42304238
"readOnly": true,
@@ -4336,6 +4344,31 @@
43364344
},
43374345
"type": "object"
43384346
},
4347+
"GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel": {
4348+
"description": "A relationship between an ad group ad and an effective label. An effective label is a label inherited or directly assigned to this ad group ad.",
4349+
"id": "GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel",
4350+
"properties": {
4351+
"adGroupAd": {
4352+
"description": "Immutable. The ad group ad to which the effective label is attached.",
4353+
"type": "string"
4354+
},
4355+
"label": {
4356+
"description": "Immutable. The effective label assigned to the ad group ad.",
4357+
"type": "string"
4358+
},
4359+
"ownerCustomerId": {
4360+
"description": "Output only. The ID of the Customer which owns the effective label.",
4361+
"format": "int64",
4362+
"readOnly": true,
4363+
"type": "string"
4364+
},
4365+
"resourceName": {
4366+
"description": "Immutable. The resource name of the ad group ad effective label. Ad group ad effective label resource names have the form: `customers/{customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}`",
4367+
"type": "string"
4368+
}
4369+
},
4370+
"type": "object"
4371+
},
43394372
"GoogleAdsSearchads360V0Resources__AdGroupAdLabel": {
43404373
"description": "A relationship between an ad group ad and a label.",
43414374
"id": "GoogleAdsSearchads360V0Resources__AdGroupAdLabel",
@@ -4505,6 +4538,14 @@
45054538
"readOnly": true,
45064539
"type": "string"
45074540
},
4541+
"effectiveLabels": {
4542+
"description": "Output only. The resource names of effective labels attached to this ad group criterion. An effective label is a label inherited or directly assigned to this ad group criterion.",
4543+
"items": {
4544+
"type": "string"
4545+
},
4546+
"readOnly": true,
4547+
"type": "array"
4548+
},
45084549
"engineId": {
45094550
"description": "Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use \"ad_group_criterion.criterion_id\" instead.",
45104551
"readOnly": true,
@@ -4764,6 +4805,31 @@
47644805
},
47654806
"type": "object"
47664807
},
4808+
"GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel": {
4809+
"description": "A relationship between an ad group criterion and an effective label. An effective label is a label inherited or directly assigned to this ad group criterion.",
4810+
"id": "GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel",
4811+
"properties": {
4812+
"adGroupCriterion": {
4813+
"description": "Immutable. The ad group criterion to which the effective label is attached.",
4814+
"type": "string"
4815+
},
4816+
"label": {
4817+
"description": "Immutable. The effective label assigned to the ad group criterion.",
4818+
"type": "string"
4819+
},
4820+
"ownerCustomerId": {
4821+
"description": "Output only. The ID of the Customer which owns the effective label.",
4822+
"format": "int64",
4823+
"readOnly": true,
4824+
"type": "string"
4825+
},
4826+
"resourceName": {
4827+
"description": "Immutable. The resource name of the ad group criterion effective label. Ad group criterion effective label resource names have the form: `customers/{customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}`",
4828+
"type": "string"
4829+
}
4830+
},
4831+
"type": "object"
4832+
},
47674833
"GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel": {
47684834
"description": "A relationship between an ad group criterion and a label.",
47694835
"id": "GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel",
@@ -8099,6 +8165,29 @@
80998165
},
81008166
"type": "object"
81018167
},
8168+
"GoogleAdsSearchads360V0Resources__UserLocationView": {
8169+
"description": "A user location view. User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.",
8170+
"id": "GoogleAdsSearchads360V0Resources__UserLocationView",
8171+
"properties": {
8172+
"countryCriterionId": {
8173+
"description": "Output only. Criterion Id for the country.",
8174+
"format": "int64",
8175+
"readOnly": true,
8176+
"type": "string"
8177+
},
8178+
"resourceName": {
8179+
"description": "Output only. The resource name of the user location view. UserLocation view resource names have the form: `customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}`",
8180+
"readOnly": true,
8181+
"type": "string"
8182+
},
8183+
"targetingLocation": {
8184+
"description": "Output only. Indicates whether location was targeted or not.",
8185+
"readOnly": true,
8186+
"type": "boolean"
8187+
}
8188+
},
8189+
"type": "object"
8190+
},
81028191
"GoogleAdsSearchads360V0Resources__Visit": {
81038192
"description": "A visit.",
81048193
"id": "GoogleAdsSearchads360V0Resources__Visit",
@@ -8397,6 +8486,10 @@
83978486
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupAd",
83988487
"description": "The ad referenced in the query."
83998488
},
8489+
"adGroupAdEffectiveLabel": {
8490+
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel",
8491+
"description": "The ad group ad effective label referenced in the query."
8492+
},
84008493
"adGroupAdLabel": {
84018494
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupAdLabel",
84028495
"description": "The ad group ad label referenced in the query."
@@ -8421,6 +8514,10 @@
84218514
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupCriterion",
84228515
"description": "The criterion referenced in the query."
84238516
},
8517+
"adGroupCriterionEffectiveLabel": {
8518+
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel",
8519+
"description": "The ad group criterion effective label referenced in the query."
8520+
},
84248521
"adGroupCriterionLabel": {
84258522
"$ref": "GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel",
84268523
"description": "The ad group criterion label referenced in the query."
@@ -8604,6 +8701,10 @@
86048701
"$ref": "GoogleAdsSearchads360V0Resources__UserList",
86058702
"description": "The user list referenced in the query."
86068703
},
8704+
"userLocationView": {
8705+
"$ref": "GoogleAdsSearchads360V0Resources__UserLocationView",
8706+
"description": "The user location view referenced in the query."
8707+
},
86078708
"visit": {
86088709
"$ref": "GoogleAdsSearchads360V0Resources__Visit",
86098710
"description": "The event level visit referenced in the query."

‎src/apis/searchads360/v0.ts

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2204,6 +2204,10 @@ export namespace searchads360_v0 {
22042204
* Output only. The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
22052205
*/
22062206
creationTime?: string | null;
2207+
/**
2208+
* Output only. The resource names of effective labels attached to this ad. An effective label is a label inherited or directly assigned to this ad.
2209+
*/
2210+
effectiveLabels?: string[] | null;
22072211
/**
22082212
* Output only. ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use "ad_group_ad.ad.id" instead.
22092213
*/
@@ -2229,6 +2233,27 @@ export namespace searchads360_v0 {
22292233
*/
22302234
status?: string | null;
22312235
}
2236+
/**
2237+
* A relationship between an ad group ad and an effective label. An effective label is a label inherited or directly assigned to this ad group ad.
2238+
*/
2239+
export interface Schema$GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel {
2240+
/**
2241+
* Immutable. The ad group ad to which the effective label is attached.
2242+
*/
2243+
adGroupAd?: string | null;
2244+
/**
2245+
* Immutable. The effective label assigned to the ad group ad.
2246+
*/
2247+
label?: string | null;
2248+
/**
2249+
* Output only. The ID of the Customer which owns the effective label.
2250+
*/
2251+
ownerCustomerId?: string | null;
2252+
/**
2253+
* Immutable. The resource name of the ad group ad effective label. Ad group ad effective label resource names have the form: `customers/{customer_id\}/adGroupAdEffectiveLabels/{ad_group_id\}~{ad_id\}~{label_id\}`
2254+
*/
2255+
resourceName?: string | null;
2256+
}
22322257
/**
22332258
* A relationship between an ad group ad and a label.
22342259
*/
@@ -2350,6 +2375,10 @@ export namespace searchads360_v0 {
23502375
* Output only. The effective CPC (cost-per-click) bid.
23512376
*/
23522377
effectiveCpcBidMicros?: string | null;
2378+
/**
2379+
* Output only. The resource names of effective labels attached to this ad group criterion. An effective label is a label inherited or directly assigned to this ad group criterion.
2380+
*/
2381+
effectiveLabels?: string[] | null;
23532382
/**
23542383
* Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
23552384
*/
@@ -2427,6 +2456,27 @@ export namespace searchads360_v0 {
24272456
*/
24282457
webpage?: Schema$GoogleAdsSearchads360V0Common__WebpageInfo;
24292458
}
2459+
/**
2460+
* A relationship between an ad group criterion and an effective label. An effective label is a label inherited or directly assigned to this ad group criterion.
2461+
*/
2462+
export interface Schema$GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel {
2463+
/**
2464+
* Immutable. The ad group criterion to which the effective label is attached.
2465+
*/
2466+
adGroupCriterion?: string | null;
2467+
/**
2468+
* Immutable. The effective label assigned to the ad group criterion.
2469+
*/
2470+
label?: string | null;
2471+
/**
2472+
* Output only. The ID of the Customer which owns the effective label.
2473+
*/
2474+
ownerCustomerId?: string | null;
2475+
/**
2476+
* Immutable. The resource name of the ad group criterion effective label. Ad group criterion effective label resource names have the form: `customers/{customer_id\}/adGroupCriterionEffectiveLabels/{ad_group_id\}~{criterion_id\}~{label_id\}`
2477+
*/
2478+
resourceName?: string | null;
2479+
}
24302480
/**
24312481
* A relationship between an ad group criterion and a label.
24322482
*/
@@ -4048,6 +4098,23 @@ export namespace searchads360_v0 {
40484098
*/
40494099
type?: string | null;
40504100
}
4101+
/**
4102+
* A user location view. User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.
4103+
*/
4104+
export interface Schema$GoogleAdsSearchads360V0Resources__UserLocationView {
4105+
/**
4106+
* Output only. Criterion Id for the country.
4107+
*/
4108+
countryCriterionId?: string | null;
4109+
/**
4110+
* Output only. The resource name of the user location view. UserLocation view resource names have the form: `customers/{customer_id\}/userLocationViews/{country_criterion_id\}~{targeting_location\}`
4111+
*/
4112+
resourceName?: string | null;
4113+
/**
4114+
* Output only. Indicates whether location was targeted or not.
4115+
*/
4116+
targetingLocation?: boolean | null;
4117+
}
40514118
/**
40524119
* A visit.
40534120
*/
@@ -4221,6 +4288,10 @@ export namespace searchads360_v0 {
42214288
* The ad referenced in the query.
42224289
*/
42234290
adGroupAd?: Schema$GoogleAdsSearchads360V0Resources__AdGroupAd;
4291+
/**
4292+
* The ad group ad effective label referenced in the query.
4293+
*/
4294+
adGroupAdEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel;
42244295
/**
42254296
* The ad group ad label referenced in the query.
42264297
*/
@@ -4245,6 +4316,10 @@ export namespace searchads360_v0 {
42454316
* The criterion referenced in the query.
42464317
*/
42474318
adGroupCriterion?: Schema$GoogleAdsSearchads360V0Resources__AdGroupCriterion;
4319+
/**
4320+
* The ad group criterion effective label referenced in the query.
4321+
*/
4322+
adGroupCriterionEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel;
42484323
/**
42494324
* The ad group criterion label referenced in the query.
42504325
*/
@@ -4425,6 +4500,10 @@ export namespace searchads360_v0 {
44254500
* The user list referenced in the query.
44264501
*/
44274502
userList?: Schema$GoogleAdsSearchads360V0Resources__UserList;
4503+
/**
4504+
* The user location view referenced in the query.
4505+
*/
4506+
userLocationView?: Schema$GoogleAdsSearchads360V0Resources__UserLocationView;
44284507
/**
44294508
* The event level visit referenced in the query.
44304509
*/

0 commit comments

Comments
 (0)