legacy-libs/google-proto-files/google/ads/googleads/v1/common/criterion_category_availability.proto

   1 // Copyright 2019 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v1.common;
  19
  20 import "google/ads/googleads/v1/enums/advertising_channel_sub_type.proto";
  21 import "google/ads/googleads/v1/enums/advertising_channel_type.proto";
  22 import "google/ads/googleads/v1/enums/criterion_category_channel_availability_mode.proto";
  23 import "google/ads/googleads/v1/enums/criterion_category_locale_availability_mode.proto";
  24 import "google/protobuf/wrappers.proto";
  25 import "google/api/annotations.proto";
  26
  27 option csharp_namespace = "Google.Ads.GoogleAds.V1.Common";
  28 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/common;common";
  29 option java_multiple_files = true;
  30 option java_outer_classname = "CriterionCategoryAvailabilityProto";
  31 option java_package = "com.google.ads.googleads.v1.common";
  32 option objc_class_prefix = "GAA";
  33 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Common";
  34 option ruby_package = "Google::Ads::GoogleAds::V1::Common";
  35 // Proto file describing criterion category availability information.
  36
  37 // Information of category availability, per advertising channel.
  38 message CriterionCategoryAvailability {
  39   // Channel types and subtypes that are available to the category.
  40   CriterionCategoryChannelAvailability channel = 1;
  41
  42   // Locales that are available to the category for the channel.
  43   repeated CriterionCategoryLocaleAvailability locale = 2;
  44 }
  45
  46 // Information of advertising channel type and subtypes a category is available
  47 // in.
  48 message CriterionCategoryChannelAvailability {
  49   // Format of the channel availability. Can be ALL_CHANNELS (the rest of the
  50   // fields will not be set), CHANNEL_TYPE (only advertising_channel_type type
  51   // will be set, the category is available to all sub types under it) or
  52   // CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type,
  53   // advertising_channel_sub_type, and include_default_channel_sub_type will all
  54   // be set).
  55   google.ads.googleads.v1.enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1;
  56
  57   // Channel type the category is available to.
  58   google.ads.googleads.v1.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2;
  59
  60   // Channel subtypes under the channel type the category is available to.
  61   repeated google.ads.googleads.v1.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 3;
  62
  63   // Whether default channel sub type is included. For example,
  64   // advertising_channel_type being DISPLAY and include_default_channel_sub_type
  65   // being false means that the default display campaign where channel sub type
  66   // is not set is not included in this availability configuration.
  67   google.protobuf.BoolValue include_default_channel_sub_type = 4;
  68 }
  69
  70 // Information about which locales a category is available in.
  71 message CriterionCategoryLocaleAvailability {
  72   // Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and
  73   // language will be empty), COUNTRY (only country will be set), LANGUAGE (only
  74   // language wil be set), COUNTRY_AND_LANGUAGE (both country and language will
  75   // be set).
  76   google.ads.googleads.v1.enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1;
  77
  78   // Code of the country.
  79   google.protobuf.StringValue country_code = 2;
  80
  81   // Code of the language.
  82   google.protobuf.StringValue language_code = 3;
  83 }