diff --git a/google/ads/searchads360/v0/resources/ad_group_ad.proto b/google/ads/searchads360/v0/resources/ad_group_ad.proto index bc0d83d84e..b67282dc09 100644 --- a/google/ads/searchads360/v0/resources/ad_group_ad.proto +++ b/google/ads/searchads360/v0/resources/ad_group_ad.proto @@ -70,6 +70,15 @@ message AdGroupAd { } ]; + // 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. + repeated string effective_labels = 19 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupAdEffectiveLabel" + } + ]; + // 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. diff --git a/google/ads/searchads360/v0/resources/ad_group_ad_effective_label.proto b/google/ads/searchads360/v0/resources/ad_group_ad_effective_label.proto new file mode 100644 index 0000000000..3ceebe6153 --- /dev/null +++ b/google/ads/searchads360/v0/resources/ad_group_ad_effective_label.proto @@ -0,0 +1,73 @@ +// Copyright 2024 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.ads.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupAdEffectiveLabelProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ad group ad effective label resource. + +// 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. +message AdGroupAdEffectiveLabel { + option (google.api.resource) = { + type: "searchads360.googleapis.com/AdGroupAdEffectiveLabel" + pattern: "customers/{customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}" + plural: "adGroupAdEffectiveLabels" + singular: "adGroupAdEffectiveLabel" + }; + + // 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}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupAdEffectiveLabel" + } + ]; + + // Immutable. The ad group ad to which the effective label is attached. + optional string ad_group_ad = 2 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupAd" + } + ]; + + // Immutable. The effective label assigned to the ad group ad. + optional string label = 3 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Label" + } + ]; + + // Output only. The ID of the Customer which owns the effective label. + optional int64 owner_customer_id = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/ad_group_criterion.proto b/google/ads/searchads360/v0/resources/ad_group_criterion.proto index d360d589d1..deeeebf04f 100644 --- a/google/ads/searchads360/v0/resources/ad_group_criterion.proto +++ b/google/ads/searchads360/v0/resources/ad_group_criterion.proto @@ -123,6 +123,16 @@ message AdGroupCriterion { } ]; + // 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. + repeated string effective_labels = 87 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupCriterionEffectiveLabel" + } + ]; + // The modifier for the bid when the criterion matches. The modifier must be // in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. optional double bid_modifier = 61; diff --git a/google/ads/searchads360/v0/resources/ad_group_criterion_effective_label.proto b/google/ads/searchads360/v0/resources/ad_group_criterion_effective_label.proto new file mode 100644 index 0000000000..1c7ba520c9 --- /dev/null +++ b/google/ads/searchads360/v0/resources/ad_group_criterion_effective_label.proto @@ -0,0 +1,73 @@ +// Copyright 2024 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.ads.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupCriterionEffectiveLabelProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ad group criterion effective label resource. + +// 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. +message AdGroupCriterionEffectiveLabel { + option (google.api.resource) = { + type: "searchads360.googleapis.com/AdGroupCriterionEffectiveLabel" + pattern: "customers/{customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}" + plural: "adGroupCriterionEffectiveLabels" + singular: "adGroupCriterionEffectiveLabel" + }; + + // 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}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupCriterionEffectiveLabel" + } + ]; + + // Immutable. The ad group criterion to which the effective label is attached. + optional string ad_group_criterion = 2 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupCriterion" + } + ]; + + // Immutable. The effective label assigned to the ad group criterion. + optional string label = 3 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Label" + } + ]; + + // Output only. The ID of the Customer which owns the effective label. + optional int64 owner_customer_id = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/user_location_view.proto b/google/ads/searchads360/v0/resources/user_location_view.proto new file mode 100644 index 0000000000..6047bc19cb --- /dev/null +++ b/google/ads/searchads360/v0/resources/user_location_view.proto @@ -0,0 +1,63 @@ +// Copyright 2024 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.ads.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "UserLocationViewProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the user location view resource. + +// 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. +message UserLocationView { + option (google.api.resource) = { + type: "searchads360.googleapis.com/UserLocationView" + pattern: "customers/{customer_id}/userLocationViews/{country_criterion_id}~{is_targeting_location}" + }; + + // 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}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/UserLocationView" + } + ]; + + // Output only. Criterion Id for the country. + optional int64 country_criterion_id = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Indicates whether location was targeted or not. + optional bool targeting_location = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/services/search_ads360_service.proto b/google/ads/searchads360/v0/services/search_ads360_service.proto index 7505c2799e..be5dcf6fcb 100644 --- a/google/ads/searchads360/v0/services/search_ads360_service.proto +++ b/google/ads/searchads360/v0/services/search_ads360_service.proto @@ -23,12 +23,14 @@ import "google/ads/searchads360/v0/enums/summary_row_setting.proto"; import "google/ads/searchads360/v0/resources/accessible_bidding_strategy.proto"; import "google/ads/searchads360/v0/resources/ad_group.proto"; import "google/ads/searchads360/v0/resources/ad_group_ad.proto"; +import "google/ads/searchads360/v0/resources/ad_group_ad_effective_label.proto"; import "google/ads/searchads360/v0/resources/ad_group_ad_label.proto"; import "google/ads/searchads360/v0/resources/ad_group_asset.proto"; import "google/ads/searchads360/v0/resources/ad_group_asset_set.proto"; import "google/ads/searchads360/v0/resources/ad_group_audience_view.proto"; import "google/ads/searchads360/v0/resources/ad_group_bid_modifier.proto"; import "google/ads/searchads360/v0/resources/ad_group_criterion.proto"; +import "google/ads/searchads360/v0/resources/ad_group_criterion_effective_label.proto"; import "google/ads/searchads360/v0/resources/ad_group_criterion_label.proto"; import "google/ads/searchads360/v0/resources/ad_group_effective_label.proto"; import "google/ads/searchads360/v0/resources/ad_group_label.proto"; @@ -71,6 +73,7 @@ import "google/ads/searchads360/v0/resources/product_bidding_category_constant.p import "google/ads/searchads360/v0/resources/product_group_view.proto"; import "google/ads/searchads360/v0/resources/shopping_performance_view.proto"; import "google/ads/searchads360/v0/resources/user_list.proto"; +import "google/ads/searchads360/v0/resources/user_location_view.proto"; import "google/ads/searchads360/v0/resources/visit.proto"; import "google/ads/searchads360/v0/resources/webpage_view.proto"; import "google/api/annotations.proto"; @@ -276,6 +279,10 @@ message SearchAds360Row { // The ad referenced in the query. google.ads.searchads360.v0.resources.AdGroupAd ad_group_ad = 16; + // The ad group ad effective label referenced in the query. + google.ads.searchads360.v0.resources.AdGroupAdEffectiveLabel + ad_group_ad_effective_label = 234; + // The ad group ad label referenced in the query. google.ads.searchads360.v0.resources.AdGroupAdLabel ad_group_ad_label = 120; @@ -296,6 +303,10 @@ message SearchAds360Row { // The criterion referenced in the query. google.ads.searchads360.v0.resources.AdGroupCriterion ad_group_criterion = 17; + // The ad group criterion effective label referenced in the query. + google.ads.searchads360.v0.resources.AdGroupCriterionEffectiveLabel + ad_group_criterion_effective_label = 235; + // The ad group criterion label referenced in the query. google.ads.searchads360.v0.resources.AdGroupCriterionLabel ad_group_criterion_label = 121; @@ -440,6 +451,10 @@ message SearchAds360Row { // The user list referenced in the query. google.ads.searchads360.v0.resources.UserList user_list = 38; + // The user location view referenced in the query. + google.ads.searchads360.v0.resources.UserLocationView user_location_view = + 135; + // The webpage view referenced in the query. google.ads.searchads360.v0.resources.WebpageView webpage_view = 162;