legacy-libs/google-proto-files/google/ads/googleads/v1/resources/ad_group_bid_modifier.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.resources;
  19
  20 import "google/ads/googleads/v1/common/criteria.proto";
  21 import "google/ads/googleads/v1/enums/bid_modifier_source.proto";
  22 import "google/protobuf/wrappers.proto";
  23 import "google/api/annotations.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "AdGroupBidModifierProto";
  29 option java_package = "com.google.ads.googleads.v1.resources";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  32 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  33 // Proto file describing the ad group bid modifier resource.
  34
  35 // Represents an ad group bid modifier.
  36 message AdGroupBidModifier {
  37   // The resource name of the ad group bid modifier.
  38   // Ad group bid modifier resource names have the form:
  39   //
  40   // `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
  41   string resource_name = 1;
  42
  43   // The ad group to which this criterion belongs.
  44   google.protobuf.StringValue ad_group = 2;
  45
  46   // The ID of the criterion to bid modify.
  47   //
  48   // This field is ignored for mutates.
  49   google.protobuf.Int64Value criterion_id = 3;
  50
  51   // The modifier for the bid when the criterion matches. The modifier must be
  52   // in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
  53   // Use 0 to opt out of a Device type.
  54   google.protobuf.DoubleValue bid_modifier = 4;
  55
  56   // The base ad group from which this draft/trial adgroup bid modifier was
  57   // created. If ad_group is a base ad group then this field will be equal to
  58   // ad_group. If the ad group was created in the draft or trial and has no
  59   // corresponding base ad group, then this field will be null.
  60   // This field is readonly.
  61   google.protobuf.StringValue base_ad_group = 9;
  62
  63   // Bid modifier source.
  64   google.ads.googleads.v1.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10;
  65
  66   // The criterion of this ad group bid modifier.
  67   oneof criterion {
  68     // Criterion for hotel date selection (default dates vs. user selected).
  69     google.ads.googleads.v1.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5;
  70
  71     // Criterion for number of days prior to the stay the booking is being made.
  72     google.ads.googleads.v1.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6;
  73
  74     // Criterion for length of hotel stay in nights.
  75     google.ads.googleads.v1.common.HotelLengthOfStayInfo hotel_length_of_stay = 7;
  76
  77     // Criterion for day of the week the booking is for.
  78     google.ads.googleads.v1.common.HotelCheckInDayInfo hotel_check_in_day = 8;
  79
  80     // A device criterion.
  81     google.ads.googleads.v1.common.DeviceInfo device = 11;
  82
  83     // A preferred content criterion.
  84     google.ads.googleads.v1.common.PreferredContentInfo preferred_content = 12;
  85   }
  86 }