• 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 = "AdGroupCriterionSimulationProto";
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 criterion simulation resource.
35
36// An ad group criterion simulation. Supported combinations of advertising
37// channel type, criterion type, simulation type, and simulation modification
38// method are detailed below respectively. Hotel AdGroupCriterion simulation
39// operations starting in V5.
40//
41// 1. DISPLAY - KEYWORD - CPC_BID - UNIFORM
42// 2. SEARCH - KEYWORD - CPC_BID - UNIFORM
43// 3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
44// 4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
45// 5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
46message AdGroupCriterionSimulation {
47  option (google.api.resource) = {
48    type: "googleads.googleapis.com/AdGroupCriterionSimulation"
49    pattern: "customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}"
50  };
51
52  // Output only. The resource name of the ad group criterion simulation.
53  // Ad group criterion simulation resource names have the form:
54  //
55  // `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
56  string resource_name = 1 [
57    (google.api.field_behavior) = OUTPUT_ONLY,
58    (google.api.resource_reference) = {
59      type: "googleads.googleapis.com/AdGroupCriterionSimulation"
60    }
61  ];
62
63  // Output only. AdGroup ID of the simulation.
64  optional int64 ad_group_id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
65
66  // Output only. Criterion ID of the simulation.
67  optional int64 criterion_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
68
69  // Output only. The field that the simulation modifies.
70  google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 4
71      [(google.api.field_behavior) = OUTPUT_ONLY];
72
73  // Output only. How the simulation modifies the field.
74  google.ads.googleads.v14.enums.SimulationModificationMethodEnum
75      .SimulationModificationMethod modification_method = 5
76      [(google.api.field_behavior) = OUTPUT_ONLY];
77
78  // Output only. First day on which the simulation is based, in YYYY-MM-DD
79  // format.
80  optional string start_date = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
81
82  // Output only. Last day on which the simulation is based, in YYYY-MM-DD
83  // format.
84  optional string end_date = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
85
86  // List of simulation points.
87  oneof point_list {
88    // Output only. Simulation points if the simulation type is CPC_BID.
89    google.ads.googleads.v14.common.CpcBidSimulationPointList
90        cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
91
92    // Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
93    google.ads.googleads.v14.common.PercentCpcBidSimulationPointList
94        percent_cpc_bid_point_list = 13
95        [(google.api.field_behavior) = OUTPUT_ONLY];
96  }
97}
98