aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v0/resources/ad_group.proto
blob: 9663ed7939b2ebf0d396a015045242a8f4216a6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
// Copyright 2018 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.googleads.v0.resources;

import "google/ads/googleads/v0/common/custom_parameter.proto";
import "google/ads/googleads/v0/common/explorer_auto_optimizer_setting.proto";
import "google/ads/googleads/v0/common/targeting_setting.proto";
import "google/ads/googleads/v0/enums/ad_group_ad_rotation_mode.proto";
import "google/ads/googleads/v0/enums/ad_group_status.proto";
import "google/ads/googleads/v0/enums/ad_group_type.proto";
import "google/ads/googleads/v0/enums/bidding_source.proto";
import "google/ads/googleads/v0/enums/targeting_dimension.proto";
import "google/protobuf/wrappers.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupProto";
option java_package = "com.google.ads.googleads.v0.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V0::Resources";

// Proto file describing the ad group resource.

// An ad group.
message AdGroup {
  // The resource name of the ad group.
  // Ad group resource names have the form:
  //
  // `customers/{customer_id}/adGroups/{ad_group_id}`
  string resource_name = 1;

  // The ID of the ad group.
  google.protobuf.Int64Value id = 3;

  // The name of the ad group.
  //
  // This field is required and should not be empty when creating new ad
  // groups.
  //
  // It must contain fewer than 255 UTF-8 full-width characters.
  //
  // It must not contain any null (code point 0x0), NL line feed
  // (code point 0xA) or carriage return (code point 0xD) characters.
  google.protobuf.StringValue name = 4;

  // The status of the ad group.
  google.ads.googleads.v0.enums.AdGroupStatusEnum.AdGroupStatus status = 5;

  // The type of the ad group.
  google.ads.googleads.v0.enums.AdGroupTypeEnum.AdGroupType type = 12;

  // The ad rotation mode of the ad group.
  google.ads.googleads.v0.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode
      ad_rotation_mode = 22;

  // The URL template for constructing a tracking URL.
  google.protobuf.StringValue tracking_url_template = 13;

  // The list of mappings used to substitute custom parameter tags in a
  // `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
  repeated google.ads.googleads.v0.common.CustomParameter
      url_custom_parameters = 6;

  // The campaign to which the ad group belongs.
  google.protobuf.StringValue campaign = 10;

  // The maximum CPC (cost-per-click) bid.
  google.protobuf.Int64Value cpc_bid_micros = 14;

  // The maximum CPM (cost-per-thousand viewable impressions) bid.
  google.protobuf.Int64Value cpm_bid_micros = 15;

  // The target CPA (cost-per-acquisition).
  google.protobuf.Int64Value target_cpa_micros = 27;

  // The CPV (cost-per-view) bid.
  google.protobuf.Int64Value cpv_bid_micros = 17;

  // Average amount in micros that the advertiser is willing to pay for every
  // thousand times the ad is shown.
  google.protobuf.Int64Value target_cpm_micros = 26;

  // The target ROAS (return-on-ad-spend) override. If the ad group's campaign
  // bidding strategy is a standard Target ROAS strategy, then this field
  // overrides the target ROAS specified in the campaign's bidding strategy.
  // Otherwise, this value is ignored.
  google.protobuf.DoubleValue target_roas = 30;

  // The percent cpc bid amount, expressed as a fraction of the advertised price
  // for some good or service. The valid range for the fraction is [0,1) and the
  // value stored here is 1,000,000 * [fraction].
  google.protobuf.Int64Value percent_cpc_bid_micros = 20;

  // Settings for the Display Campaign Optimizer, initially termed "Explorer".
  google.ads.googleads.v0.common.ExplorerAutoOptimizerSetting
      explorer_auto_optimizer_setting = 21;

  // Allows advertisers to specify a targeting dimension on which to place
  // absolute bids. This is only applicable for campaigns that target only the
  // display network and not search.
  google.ads.googleads.v0.enums.TargetingDimensionEnum.TargetingDimension
      display_custom_bid_dimension = 23;

  // URL template for appending params to Final URL.
  google.protobuf.StringValue final_url_suffix = 24;

  // Setting for targeting related features.
  google.ads.googleads.v0.common.TargetingSetting targeting_setting = 25;

  // The effective target CPA (cost-per-acquisition).
  // This field is read-only.
  google.protobuf.Int64Value effective_target_cpa_micros = 28;

  // Source of the effective target CPA.
  // This field is read-only.
  google.ads.googleads.v0.enums.BiddingSourceEnum.BiddingSource
      effective_target_cpa_source = 29;

  // The effective target ROAS (return-on-ad-spend).
  // This field is read-only.
  google.protobuf.DoubleValue effective_target_roas = 31;

  // Source of the effective target ROAS.
  // This field is read-only.
  google.ads.googleads.v0.enums.BiddingSourceEnum.BiddingSource
      effective_target_roas_source = 32;
}