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/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21 22option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources"; 23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources"; 24option java_multiple_files = true; 25option java_outer_classname = "ExperimentArmProto"; 26option java_package = "com.google.ads.googleads.v14.resources"; 27option objc_class_prefix = "GAA"; 28option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources"; 29option ruby_package = "Google::Ads::GoogleAds::V14::Resources"; 30 31// Proto file describing the Experiment arm resource. 32 33// A Google ads experiment for users to experiment changes on multiple 34// campaigns, compare the performance, and apply the effective changes. 35message ExperimentArm { 36 option (google.api.resource) = { 37 type: "googleads.googleapis.com/ExperimentArm" 38 pattern: "customers/{customer_id}/experimentArms/{trial_id}~{trial_arm_id}" 39 }; 40 41 // Immutable. The resource name of the experiment arm. 42 // Experiment arm resource names have the form: 43 // 44 // `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}` 45 string resource_name = 1 [ 46 (google.api.field_behavior) = IMMUTABLE, 47 (google.api.resource_reference) = { 48 type: "googleads.googleapis.com/ExperimentArm" 49 } 50 ]; 51 52 // Immutable. The experiment to which the ExperimentArm belongs. 53 string experiment = 8 [ 54 (google.api.field_behavior) = IMMUTABLE, 55 (google.api.resource_reference) = { 56 type: "googleads.googleapis.com/Experiment" 57 } 58 ]; 59 60 // Required. The name of the experiment arm. It must have a minimum length of 61 // 1 and maximum length of 1024. It must be unique under an experiment. 62 string name = 3 [(google.api.field_behavior) = REQUIRED]; 63 64 // Whether this arm is a control arm. A control arm is the arm against 65 // which the other arms are compared. 66 bool control = 4; 67 68 // Traffic split of the trial arm. The value should be between 1 and 100 69 // and must total 100 between the two trial arms. 70 int64 traffic_split = 5; 71 72 // List of campaigns in the trial arm. The max length is one. 73 repeated string campaigns = 6 [(google.api.resource_reference) = { 74 type: "googleads.googleapis.com/Campaign" 75 }]; 76 77 // Output only. The in design campaigns in the treatment experiment arm. 78 repeated string in_design_campaigns = 7 [ 79 (google.api.field_behavior) = OUTPUT_ONLY, 80 (google.api.resource_reference) = { 81 type: "googleads.googleapis.com/Campaign" 82 } 83 ]; 84} 85