Struct google_api_proto::google::ads::googleads::v16::resources::Experiment

pub struct Experiment {

    pub resource_name: String,
    pub experiment_id: Option<i64>,
    pub name: String,
    pub description: String,
    pub suffix: String,
    pub type: i32,
    pub status: i32,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub goals: Vec<MetricGoal>,
    pub long_running_operation: Option<String>,
    pub promote_status: i32,
    pub sync_enabled: Option<bool>,
}

A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.

Fields

resource_name: String

Immutable. The resource name of the experiment. Experiment resource names have the form:

customers/{customer_id}/experiments/{experiment_id}

experiment_id: Option<i64>

Output only. The ID of the experiment. Read only.

name: String

Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer.

description: String

The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.

suffix: String

For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.

type: i32

Required. The product/feature that uses this experiment.

status: i32

The Advertiser-chosen status of this experiment.

start_date: Option<String>

Date when the 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.

Format: YYYY-MM-DD Example: 2019-03-14

end_date: Option<String>

Date when the experiment ends. 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

goals: Vec<MetricGoal>

The goals of this experiment.

long_running_operation: Option<String>

Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.

promote_status: i32

Output only. The status of the experiment promotion process.

sync_enabled: Option<bool>

Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.

Implementations

impl Experiment

pub fn experiment_id(&self) -> i64

Returns the value of experiment_id, or the default value if experiment_id is unset.

pub fn type(&self) -> ExperimentType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: ExperimentType)

Sets type to the provided enum value.

pub fn status(&self) -> ExperimentStatus

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: ExperimentStatus)

Sets status to the provided enum value.

pub fn start_date(&self) -> &str

Returns the value of start_date, or the default value if start_date is unset.

pub fn end_date(&self) -> &str

Returns the value of end_date, or the default value if end_date is unset.

pub fn long_running_operation(&self) -> &str

Returns the value of long_running_operation, or the default value if long_running_operation is unset.

pub fn promote_status(&self) -> AsyncActionStatus

Returns the enum value of promote_status, or the default if the field is set to an invalid enum value.

pub fn set_promote_status(&mut self, value: AsyncActionStatus)

Sets promote_status to the provided enum value.

pub fn sync_enabled(&self) -> bool

Returns the value of sync_enabled, or the default value if sync_enabled is unset.

Trait Implementations

impl Clone for Experiment

fn clone(&self) -> Experiment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Experiment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Experiment

fn default() -> Self

Returns the “default value” for a type.

impl Message for Experiment

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Experiment

fn eq(&self, other: &Experiment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Experiment