You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
121 lines
5.0 KiB
121 lines
5.0 KiB
// Copyright 2021 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.v7.resources; |
|
|
|
import "google/ads/googleads/v7/enums/campaign_experiment_status.proto"; |
|
import "google/ads/googleads/v7/enums/campaign_experiment_traffic_split_type.proto"; |
|
import "google/api/field_behavior.proto"; |
|
import "google/api/resource.proto"; |
|
import "google/api/annotations.proto"; |
|
|
|
option csharp_namespace = "Google.Ads.GoogleAds.V7.Resources"; |
|
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v7/resources;resources"; |
|
option java_multiple_files = true; |
|
option java_outer_classname = "CampaignExperimentProto"; |
|
option java_package = "com.google.ads.googleads.v7.resources"; |
|
option objc_class_prefix = "GAA"; |
|
option php_namespace = "Google\\Ads\\GoogleAds\\V7\\Resources"; |
|
option ruby_package = "Google::Ads::GoogleAds::V7::Resources"; |
|
|
|
// Proto file describing the Campaign Experiment resource. |
|
|
|
// An A/B experiment that compares the performance of the base campaign |
|
// (the control) and a variation of that campaign (the experiment). |
|
message CampaignExperiment { |
|
option (google.api.resource) = { |
|
type: "googleads.googleapis.com/CampaignExperiment" |
|
pattern: "customers/{customer_id}/campaignExperiments/{campaign_experiment_id}" |
|
}; |
|
|
|
// Immutable. The resource name of the campaign experiment. |
|
// Campaign experiment resource names have the form: |
|
// |
|
// `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}` |
|
string resource_name = 1 [ |
|
(google.api.field_behavior) = IMMUTABLE, |
|
(google.api.resource_reference) = { |
|
type: "googleads.googleapis.com/CampaignExperiment" |
|
} |
|
]; |
|
|
|
// Output only. The ID of the campaign experiment. |
|
// |
|
// This field is read-only. |
|
optional int64 id = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Immutable. The campaign draft with staged changes to the base campaign. |
|
optional string campaign_draft = 14 [ |
|
(google.api.field_behavior) = IMMUTABLE, |
|
(google.api.resource_reference) = { |
|
type: "googleads.googleapis.com/CampaignDraft" |
|
} |
|
]; |
|
|
|
// The name of the campaign experiment. |
|
// |
|
// This field is required when creating new campaign experiments |
|
// and must not conflict with the name of another non-removed |
|
// campaign experiment or campaign. |
|
// |
|
// It must not contain any null (code point 0x0), NL line feed |
|
// (code point 0xA) or carriage return (code point 0xD) characters. |
|
optional string name = 15; |
|
|
|
// The description of the experiment. |
|
optional string description = 16; |
|
|
|
// Immutable. Share of traffic directed to experiment as a percent (must be between 1 and |
|
// 99 inclusive. Base campaign receives the remainder of the traffic |
|
// (100 - traffic_split_percent). Required for create. |
|
optional int64 traffic_split_percent = 17 [(google.api.field_behavior) = IMMUTABLE]; |
|
|
|
// Immutable. Determines the behavior of the traffic split. |
|
google.ads.googleads.v7.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(google.api.field_behavior) = IMMUTABLE]; |
|
|
|
// Output only. The experiment campaign, as opposed to the base campaign. |
|
optional string experiment_campaign = 18 [ |
|
(google.api.field_behavior) = OUTPUT_ONLY, |
|
(google.api.resource_reference) = { |
|
type: "googleads.googleapis.com/Campaign" |
|
} |
|
]; |
|
|
|
// Output only. The status of the campaign experiment. This field is read-only. |
|
google.ads.googleads.v7.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Output only. The resource name of the long-running operation that can be used to poll |
|
// for completion of experiment create or promote. The most recent long |
|
// running operation is returned. |
|
optional string long_running_operation = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Date when the campaign experiment starts. By default, the experiment starts |
|
// now or on the campaign's start date, whichever is later. If this field is |
|
// set, then the experiment starts at the beginning of the specified date in |
|
// the customer's time zone. Cannot be changed once the experiment starts. |
|
// |
|
// Format: YYYY-MM-DD |
|
// Example: 2019-03-14 |
|
optional string start_date = 20; |
|
|
|
// The last day of the campaign experiment. By default, the experiment ends on |
|
// the campaign's end date. If this field is set, then the experiment ends at |
|
// the end of the specified date in the customer's time zone. |
|
// |
|
// Format: YYYY-MM-DD |
|
// Example: 2019-04-18 |
|
optional string end_date = 21; |
|
}
|
|
|