• 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.v14.resources;
18
19import "google/ads/googleads/v14/common/simulation.proto";
20import "google/ads/googleads/v14/enums/simulation_modification_method.proto";
21import "google/ads/googleads/v14/enums/simulation_type.proto";
22import "google/api/field_behavior.proto";
23import "google/api/resource.proto";
24
25option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
26option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
27option java_multiple_files = true;
28option java_outer_classname = "AdGroupSimulationProto";
29option java_package = "com.google.ads.googleads.v14.resources";
30option objc_class_prefix = "GAA";
31option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
32option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
33
34// Proto file describing the ad group simulation resource.
35
36// An ad group simulation. Supported combinations of advertising
37// channel type, simulation type and simulation modification method is
38// detailed below respectively.
39//
40// 1. SEARCH - CPC_BID - DEFAULT
41// 2. SEARCH - CPC_BID - UNIFORM
42// 3. SEARCH - TARGET_CPA - UNIFORM
43// 4. SEARCH - TARGET_ROAS - UNIFORM
44// 5. DISPLAY - CPC_BID - DEFAULT
45// 6. DISPLAY - CPC_BID - UNIFORM
46// 7. DISPLAY - TARGET_CPA - UNIFORM
47message AdGroupSimulation {
48  option (google.api.resource) = {
49    type: "googleads.googleapis.com/AdGroupSimulation"
50    pattern: "customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}"
51  };
52
53  // Output only. The resource name of the ad group simulation.
54  // Ad group simulation resource names have the form:
55  //
56  // `customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}`
57  string resource_name = 1 [
58    (google.api.field_behavior) = OUTPUT_ONLY,
59    (google.api.resource_reference) = {
60      type: "googleads.googleapis.com/AdGroupSimulation"
61    }
62  ];
63
64  // Output only. Ad group id of the simulation.
65  optional int64 ad_group_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
66
67  // Output only. The field that the simulation modifies.
68  google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 3
69      [(google.api.field_behavior) = OUTPUT_ONLY];
70
71  // Output only. How the simulation modifies the field.
72  google.ads.googleads.v14.enums.SimulationModificationMethodEnum
73      .SimulationModificationMethod modification_method = 4
74      [(google.api.field_behavior) = OUTPUT_ONLY];
75
76  // Output only. First day on which the simulation is based, in YYYY-MM-DD
77  // format.
78  optional string start_date = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
79
80  // Output only. Last day on which the simulation is based, in YYYY-MM-DD
81  // format
82  optional string end_date = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
83
84  // List of simulation points.
85  oneof point_list {
86    // Output only. Simulation points if the simulation type is CPC_BID.
87    google.ads.googleads.v14.common.CpcBidSimulationPointList
88        cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
89
90    // Output only. Simulation points if the simulation type is CPV_BID.
91    google.ads.googleads.v14.common.CpvBidSimulationPointList
92        cpv_bid_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
93
94    // Output only. Simulation points if the simulation type is TARGET_CPA.
95    google.ads.googleads.v14.common.TargetCpaSimulationPointList
96        target_cpa_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
97
98    // Output only. Simulation points if the simulation type is TARGET_ROAS.
99    google.ads.googleads.v14.common.TargetRoasSimulationPointList
100        target_roas_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
101  }
102}
103