1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.ads.googleads.v14.common; 18 19import "google/ads/googleads/v14/common/criteria.proto"; 20import "google/ads/googleads/v14/enums/ad_destination_type.proto"; 21import "google/ads/googleads/v14/enums/ad_network_type.proto"; 22import "google/ads/googleads/v14/enums/budget_campaign_association_status.proto"; 23import "google/ads/googleads/v14/enums/click_type.proto"; 24import "google/ads/googleads/v14/enums/conversion_action_category.proto"; 25import "google/ads/googleads/v14/enums/conversion_attribution_event_type.proto"; 26import "google/ads/googleads/v14/enums/conversion_lag_bucket.proto"; 27import "google/ads/googleads/v14/enums/conversion_or_adjustment_lag_bucket.proto"; 28import "google/ads/googleads/v14/enums/conversion_value_rule_primary_dimension.proto"; 29import "google/ads/googleads/v14/enums/converting_user_prior_engagement_type_and_ltv_bucket.proto"; 30import "google/ads/googleads/v14/enums/day_of_week.proto"; 31import "google/ads/googleads/v14/enums/device.proto"; 32import "google/ads/googleads/v14/enums/external_conversion_source.proto"; 33import "google/ads/googleads/v14/enums/hotel_date_selection_type.proto"; 34import "google/ads/googleads/v14/enums/hotel_price_bucket.proto"; 35import "google/ads/googleads/v14/enums/hotel_rate_type.proto"; 36import "google/ads/googleads/v14/enums/month_of_year.proto"; 37import "google/ads/googleads/v14/enums/placeholder_type.proto"; 38import "google/ads/googleads/v14/enums/product_channel.proto"; 39import "google/ads/googleads/v14/enums/product_channel_exclusivity.proto"; 40import "google/ads/googleads/v14/enums/product_condition.proto"; 41import "google/ads/googleads/v14/enums/recommendation_type.proto"; 42import "google/ads/googleads/v14/enums/search_engine_results_page_type.proto"; 43import "google/ads/googleads/v14/enums/search_term_match_type.proto"; 44import "google/ads/googleads/v14/enums/sk_ad_network_ad_event_type.proto"; 45import "google/ads/googleads/v14/enums/sk_ad_network_attribution_credit.proto"; 46import "google/ads/googleads/v14/enums/sk_ad_network_user_type.proto"; 47import "google/ads/googleads/v14/enums/slot.proto"; 48import "google/api/resource.proto"; 49 50option csharp_namespace = "Google.Ads.GoogleAds.V14.Common"; 51option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/common;common"; 52option java_multiple_files = true; 53option java_outer_classname = "SegmentsProto"; 54option java_package = "com.google.ads.googleads.v14.common"; 55option objc_class_prefix = "GAA"; 56option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Common"; 57option ruby_package = "Google::Ads::GoogleAds::V14::Common"; 58 59// Proto file describing segment only fields. 60 61// Segment only fields. 62message Segments { 63 // Activity account ID. 64 optional int64 activity_account_id = 148; 65 66 // Activity rating. 67 optional int64 activity_rating = 149; 68 69 // Advertiser supplied activity ID. 70 optional string external_activity_id = 150; 71 72 // Ad Destination type. 73 google.ads.googleads.v14.enums.AdDestinationTypeEnum.AdDestinationType 74 ad_destination_type = 136; 75 76 // Ad network type. 77 google.ads.googleads.v14.enums.AdNetworkTypeEnum.AdNetworkType 78 ad_network_type = 3; 79 80 // Resource name of the ad group. 81 optional string ad_group = 158; 82 83 // Resource name of the asset group. 84 optional string asset_group = 159; 85 86 // Domain (visible URL) of a participant in the Auction Insights report. 87 optional string auction_insight_domain = 145; 88 89 // Budget campaign association status. 90 BudgetCampaignAssociationStatus budget_campaign_association_status = 134; 91 92 // Resource name of the campaign. 93 optional string campaign = 157; 94 95 // Click type. 96 google.ads.googleads.v14.enums.ClickTypeEnum.ClickType click_type = 26; 97 98 // Resource name of the conversion action. 99 optional string conversion_action = 113 [(google.api.resource_reference) = { 100 type: "googleads.googleapis.com/ConversionAction" 101 }]; 102 103 // Conversion action category. 104 google.ads.googleads.v14.enums.ConversionActionCategoryEnum 105 .ConversionActionCategory conversion_action_category = 53; 106 107 // Conversion action name. 108 optional string conversion_action_name = 114; 109 110 // This segments your conversion columns by the original conversion and 111 // conversion value versus the delta if conversions were adjusted. False row 112 // has the data as originally stated; While true row has the delta between 113 // data now and the data as originally stated. Summing the two together 114 // results post-adjustment data. 115 optional bool conversion_adjustment = 115; 116 117 // Conversion attribution event type. 118 google.ads.googleads.v14.enums.ConversionAttributionEventTypeEnum 119 .ConversionAttributionEventType conversion_attribution_event_type = 2; 120 121 // An enum value representing the number of days between the impression and 122 // the conversion. 123 google.ads.googleads.v14.enums.ConversionLagBucketEnum.ConversionLagBucket 124 conversion_lag_bucket = 50; 125 126 // An enum value representing the number of days between the impression and 127 // the conversion or between the impression and adjustments to the conversion. 128 google.ads.googleads.v14.enums.ConversionOrAdjustmentLagBucketEnum 129 .ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51; 130 131 // Date to which metrics apply. 132 // yyyy-MM-dd format, for example, 2018-04-17. 133 optional string date = 79; 134 135 // Day of the week, for example, MONDAY. 136 google.ads.googleads.v14.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; 137 138 // Device to which metrics apply. 139 google.ads.googleads.v14.enums.DeviceEnum.Device device = 1; 140 141 // External conversion source. 142 google.ads.googleads.v14.enums.ExternalConversionSourceEnum 143 .ExternalConversionSource external_conversion_source = 55; 144 145 // Resource name of the geo target constant that represents an airport. 146 optional string geo_target_airport = 116; 147 148 // Resource name of the geo target constant that represents a canton. 149 optional string geo_target_canton = 117; 150 151 // Resource name of the geo target constant that represents a city. 152 optional string geo_target_city = 118; 153 154 // Resource name of the geo target constant that represents a country. 155 optional string geo_target_country = 119; 156 157 // Resource name of the geo target constant that represents a county. 158 optional string geo_target_county = 120; 159 160 // Resource name of the geo target constant that represents a district. 161 optional string geo_target_district = 121; 162 163 // Resource name of the geo target constant that represents a metro. 164 optional string geo_target_metro = 122; 165 166 // Resource name of the geo target constant that represents the most 167 // specific location. 168 optional string geo_target_most_specific_location = 123; 169 170 // Resource name of the geo target constant that represents a postal code. 171 optional string geo_target_postal_code = 124; 172 173 // Resource name of the geo target constant that represents a province. 174 optional string geo_target_province = 125; 175 176 // Resource name of the geo target constant that represents a region. 177 optional string geo_target_region = 126; 178 179 // Resource name of the geo target constant that represents a state. 180 optional string geo_target_state = 127; 181 182 // Hotel booking window in days. 183 optional int64 hotel_booking_window_days = 135; 184 185 // Hotel center ID. 186 optional int64 hotel_center_id = 80; 187 188 // Hotel check-in date. Formatted as yyyy-MM-dd. 189 optional string hotel_check_in_date = 81; 190 191 // Hotel check-in day of week. 192 google.ads.googleads.v14.enums.DayOfWeekEnum.DayOfWeek 193 hotel_check_in_day_of_week = 9; 194 195 // Hotel city. 196 optional string hotel_city = 82; 197 198 // Hotel class. 199 optional int32 hotel_class = 83; 200 201 // Hotel country. 202 optional string hotel_country = 84; 203 204 // Hotel date selection type. 205 google.ads.googleads.v14.enums.HotelDateSelectionTypeEnum 206 .HotelDateSelectionType hotel_date_selection_type = 13; 207 208 // Hotel length of stay. 209 optional int32 hotel_length_of_stay = 85; 210 211 // Hotel rate rule ID. 212 optional string hotel_rate_rule_id = 86; 213 214 // Hotel rate type. 215 google.ads.googleads.v14.enums.HotelRateTypeEnum.HotelRateType 216 hotel_rate_type = 74; 217 218 // Hotel price bucket. 219 google.ads.googleads.v14.enums.HotelPriceBucketEnum.HotelPriceBucket 220 hotel_price_bucket = 78; 221 222 // Hotel state. 223 optional string hotel_state = 87; 224 225 // Hour of day as a number between 0 and 23, inclusive. 226 optional int32 hour = 88; 227 228 // Only used with feed item metrics. 229 // Indicates whether the interaction metrics occurred on the feed item itself 230 // or a different extension or ad unit. 231 optional bool interaction_on_this_extension = 89; 232 233 // Keyword criterion. 234 Keyword keyword = 61; 235 236 // Month as represented by the date of the first day of a month. Formatted as 237 // yyyy-MM-dd. 238 optional string month = 90; 239 240 // Month of the year, for example, January. 241 google.ads.googleads.v14.enums.MonthOfYearEnum.MonthOfYear month_of_year = 18; 242 243 // Partner hotel ID. 244 optional string partner_hotel_id = 91; 245 246 // Placeholder type. This is only used with feed item metrics. 247 google.ads.googleads.v14.enums.PlaceholderTypeEnum.PlaceholderType 248 placeholder_type = 20; 249 250 // Aggregator ID of the product. 251 optional int64 product_aggregator_id = 132; 252 253 // Bidding category (level 1) of the product. 254 optional string product_bidding_category_level1 = 92; 255 256 // Bidding category (level 2) of the product. 257 optional string product_bidding_category_level2 = 93; 258 259 // Bidding category (level 3) of the product. 260 optional string product_bidding_category_level3 = 94; 261 262 // Bidding category (level 4) of the product. 263 optional string product_bidding_category_level4 = 95; 264 265 // Bidding category (level 5) of the product. 266 optional string product_bidding_category_level5 = 96; 267 268 // Brand of the product. 269 optional string product_brand = 97; 270 271 // Channel of the product. 272 google.ads.googleads.v14.enums.ProductChannelEnum.ProductChannel 273 product_channel = 30; 274 275 // Channel exclusivity of the product. 276 google.ads.googleads.v14.enums.ProductChannelExclusivityEnum 277 .ProductChannelExclusivity product_channel_exclusivity = 31; 278 279 // Condition of the product. 280 google.ads.googleads.v14.enums.ProductConditionEnum.ProductCondition 281 product_condition = 32; 282 283 // Resource name of the geo target constant for the country of sale of the 284 // product. 285 optional string product_country = 98; 286 287 // Custom attribute 0 of the product. 288 optional string product_custom_attribute0 = 99; 289 290 // Custom attribute 1 of the product. 291 optional string product_custom_attribute1 = 100; 292 293 // Custom attribute 2 of the product. 294 optional string product_custom_attribute2 = 101; 295 296 // Custom attribute 3 of the product. 297 optional string product_custom_attribute3 = 102; 298 299 // Custom attribute 4 of the product. 300 optional string product_custom_attribute4 = 103; 301 302 // Feed label of the product. 303 optional string product_feed_label = 147; 304 305 // Item ID of the product. 306 optional string product_item_id = 104; 307 308 // Resource name of the language constant for the language of the product. 309 optional string product_language = 105; 310 311 // Merchant ID of the product. 312 optional int64 product_merchant_id = 133; 313 314 // Store ID of the product. 315 optional string product_store_id = 106; 316 317 // Title of the product. 318 optional string product_title = 107; 319 320 // Type (level 1) of the product. 321 optional string product_type_l1 = 108; 322 323 // Type (level 2) of the product. 324 optional string product_type_l2 = 109; 325 326 // Type (level 3) of the product. 327 optional string product_type_l3 = 110; 328 329 // Type (level 4) of the product. 330 optional string product_type_l4 = 111; 331 332 // Type (level 5) of the product. 333 optional string product_type_l5 = 112; 334 335 // Quarter as represented by the date of the first day of a quarter. 336 // Uses the calendar year for quarters, for example, the second quarter of 337 // 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd. 338 optional string quarter = 128; 339 340 // Recommendation type. 341 google.ads.googleads.v14.enums.RecommendationTypeEnum.RecommendationType 342 recommendation_type = 140; 343 344 // Type of the search engine results page. 345 google.ads.googleads.v14.enums.SearchEngineResultsPageTypeEnum 346 .SearchEngineResultsPageType search_engine_results_page_type = 70; 347 348 // A search term subcategory. An empty string denotes the catch-all 349 // subcategory for search terms that didn't fit into another subcategory. 350 optional string search_subcategory = 155; 351 352 // A search term. 353 optional string search_term = 156; 354 355 // Match type of the keyword that triggered the ad, including variants. 356 google.ads.googleads.v14.enums.SearchTermMatchTypeEnum.SearchTermMatchType 357 search_term_match_type = 22; 358 359 // Position of the ad. 360 google.ads.googleads.v14.enums.SlotEnum.Slot slot = 23; 361 362 // Primary dimension of applied conversion value rules. 363 // NO_RULE_APPLIED shows the total recorded value of conversions that 364 // do not have a value rule applied. 365 // ORIGINAL shows the original value of conversions to which a value rule 366 // has been applied. 367 // GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value 368 // rules were applied. 369 google.ads.googleads.v14.enums.ConversionValueRulePrimaryDimensionEnum 370 .ConversionValueRulePrimaryDimension 371 conversion_value_rule_primary_dimension = 138; 372 373 // Resource name of the ad group criterion that represents webpage criterion. 374 optional string webpage = 129; 375 376 // Week as defined as Monday through Sunday, and represented by the date of 377 // Monday. Formatted as yyyy-MM-dd. 378 optional string week = 130; 379 380 // Year, formatted as yyyy. 381 optional int32 year = 131; 382 383 // iOS Store Kit Ad Network conversion value. 384 // Null value means this segment is not applicable, for example, non-iOS 385 // campaign. 386 optional int64 sk_ad_network_conversion_value = 137; 387 388 // iOS Store Kit Ad Network user type. 389 google.ads.googleads.v14.enums.SkAdNetworkUserTypeEnum.SkAdNetworkUserType 390 sk_ad_network_user_type = 141; 391 392 // iOS Store Kit Ad Network ad event type. 393 google.ads.googleads.v14.enums.SkAdNetworkAdEventTypeEnum 394 .SkAdNetworkAdEventType sk_ad_network_ad_event_type = 142; 395 396 // App where the ad that drove the iOS Store Kit Ad Network install was 397 // shown. Null value means this segment is not applicable, for example, 398 // non-iOS campaign, or was not present in any postbacks sent by Apple. 399 optional SkAdNetworkSourceApp sk_ad_network_source_app = 143; 400 401 // iOS Store Kit Ad Network attribution credit 402 google.ads.googleads.v14.enums.SkAdNetworkAttributionCreditEnum 403 .SkAdNetworkAttributionCredit sk_ad_network_attribution_credit = 144; 404 405 // Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. 406 // Indicates whether the interaction metrics occurred on the asset itself 407 // or a different asset or ad unit. 408 // Interactions (for example, clicks) are counted across all the parts of the 409 // served ad (for example, Ad itself and other components like Sitelinks) when 410 // they are served together. When interaction_on_this_asset is true, it means 411 // the interactions are on this specific asset and when 412 // interaction_on_this_asset is false, it means the interactions is not on 413 // this specific asset but on other parts of the served ad this asset is 414 // served with. 415 optional AssetInteractionTarget asset_interaction_target = 139; 416 417 // This is for segmenting conversions by whether the user is a new customer 418 // or a returning customer. This segmentation is typically used to measure 419 // the impact of customer acquisition goal. 420 google.ads.googleads.v14.enums 421 .ConvertingUserPriorEngagementTypeAndLtvBucketEnum 422 .ConvertingUserPriorEngagementTypeAndLtvBucket 423 new_versus_returning_customers = 160; 424} 425 426// A Keyword criterion segment. 427message Keyword { 428 // The AdGroupCriterion resource name. 429 optional string ad_group_criterion = 3; 430 431 // Keyword info. 432 KeywordInfo info = 2; 433} 434 435// A BudgetCampaignAssociationStatus segment. 436message BudgetCampaignAssociationStatus { 437 // The campaign resource name. 438 optional string campaign = 1; 439 440 // Budget campaign association status. 441 google.ads.googleads.v14.enums.BudgetCampaignAssociationStatusEnum 442 .BudgetCampaignAssociationStatus status = 2; 443} 444 445// An AssetInteractionTarget segment. 446message AssetInteractionTarget { 447 // The asset resource name. 448 string asset = 1; 449 450 // Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. 451 // Indicates whether the interaction metrics occurred on the asset itself or a 452 // different asset or ad unit. 453 bool interaction_on_this_asset = 2; 454} 455 456// A SkAdNetworkSourceApp segment. 457message SkAdNetworkSourceApp { 458 // App id where the ad that drove the iOS Store Kit Ad Network install was 459 // shown. 460 optional string sk_ad_network_source_app_id = 1; 461} 462