• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.v16.resources;
18
19import "google/ads/googleads/v16/common/criteria.proto";
20import "google/ads/googleads/v16/enums/bid_modifier_source.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "AdGroupBidModifierProto";
28option java_package = "com.google.ads.googleads.v16.resources";
29option objc_class_prefix = "GAA";
30option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
31option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
32
33// Proto file describing the ad group bid modifier resource.
34
35// Represents an ad group bid modifier.
36message AdGroupBidModifier {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/AdGroupBidModifier"
39    pattern: "customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}"
40  };
41
42  // Immutable. The resource name of the ad group bid modifier.
43  // Ad group bid modifier resource names have the form:
44  //
45  // `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
46  string resource_name = 1 [
47    (google.api.field_behavior) = IMMUTABLE,
48    (google.api.resource_reference) = {
49      type: "googleads.googleapis.com/AdGroupBidModifier"
50    }
51  ];
52
53  // Immutable. The ad group to which this criterion belongs.
54  optional string ad_group = 13 [
55    (google.api.field_behavior) = IMMUTABLE,
56    (google.api.resource_reference) = {
57      type: "googleads.googleapis.com/AdGroup"
58    }
59  ];
60
61  // Output only. The ID of the criterion to bid modify.
62  //
63  // This field is ignored for mutates.
64  optional int64 criterion_id = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
65
66  // The modifier for the bid when the criterion matches. The modifier must be
67  // in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
68  // Use 0 to opt out of a Device type.
69  optional double bid_modifier = 15;
70
71  // Output only. The base ad group from which this draft/trial adgroup bid
72  // modifier was created. If ad_group is a base ad group then this field will
73  // be equal to ad_group. If the ad group was created in the draft or trial and
74  // has no corresponding base ad group, then this field will be null. This
75  // field is readonly.
76  optional string base_ad_group = 16 [
77    (google.api.field_behavior) = OUTPUT_ONLY,
78    (google.api.resource_reference) = {
79      type: "googleads.googleapis.com/AdGroup"
80    }
81  ];
82
83  // Output only. Bid modifier source.
84  google.ads.googleads.v16.enums.BidModifierSourceEnum.BidModifierSource
85      bid_modifier_source = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
86
87  // The criterion of this ad group bid modifier.
88  //
89  // Required in create operations starting in V5.
90  oneof criterion {
91    // Immutable. Criterion for hotel date selection (default dates versus user
92    // selected).
93    google.ads.googleads.v16.common.HotelDateSelectionTypeInfo
94        hotel_date_selection_type = 5 [(google.api.field_behavior) = IMMUTABLE];
95
96    // Immutable. Criterion for number of days prior to the stay the booking is
97    // being made.
98    google.ads.googleads.v16.common.HotelAdvanceBookingWindowInfo
99        hotel_advance_booking_window = 6
100        [(google.api.field_behavior) = IMMUTABLE];
101
102    // Immutable. Criterion for length of hotel stay in nights.
103    google.ads.googleads.v16.common.HotelLengthOfStayInfo hotel_length_of_stay =
104        7 [(google.api.field_behavior) = IMMUTABLE];
105
106    // Immutable. Criterion for day of the week the booking is for.
107    google.ads.googleads.v16.common.HotelCheckInDayInfo hotel_check_in_day = 8
108        [(google.api.field_behavior) = IMMUTABLE];
109
110    // Immutable. A device criterion.
111    google.ads.googleads.v16.common.DeviceInfo device = 11
112        [(google.api.field_behavior) = IMMUTABLE];
113
114    // Immutable. Criterion for a hotel check-in date range.
115    google.ads.googleads.v16.common.HotelCheckInDateRangeInfo
116        hotel_check_in_date_range = 17
117        [(google.api.field_behavior) = IMMUTABLE];
118  }
119}
120