Struct googapis::google::ads::googleads::v9::resources::CampaignExperiment

pub struct CampaignExperiment {
    pub resource_name: String,
    pub id: Option<i64>,
    pub campaign_draft: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub traffic_split_percent: Option<i64>,
    pub traffic_split_type: i32,
    pub experiment_campaign: Option<String>,
    pub status: i32,
    pub long_running_operation: Option<String>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
}

An A/B experiment that compares the performance of the base campaign (the control) and a variation of that campaign (the experiment).

Fields

resource_name: String

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

customers/{customer_id}/campaignExperiments/{campaign_experiment_id}

id: Option<i64>

Output only. The ID of the campaign experiment.

This field is read-only.

campaign_draft: Option<String>

Immutable. The campaign draft with staged changes to the base campaign.

name: Option<String>

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.

description: Option<String>

The description of the experiment.

traffic_split_percent: Option<i64>

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.

traffic_split_type: i32

Immutable. Determines the behavior of the traffic split.

experiment_campaign: Option<String>

Output only. The experiment campaign, as opposed to the base campaign.

status: i32

Output only. The status of the campaign experiment. This field is read-only.

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 create or promote. The most recent long running operation is returned.

start_date: Option<String>

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

end_date: Option<String>

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

Implementations

impl CampaignExperiment

pub fn traffic_split_type(&self) -> CampaignExperimentTrafficSplitType

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

pub fn set_traffic_split_type(
    &mut self,
    value: CampaignExperimentTrafficSplitType
)

Sets traffic_split_type to the provided enum value.

pub fn status(&self) -> CampaignExperimentStatus

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: CampaignExperimentStatus)

Sets status to the provided enum value.

pub fn id(&self) -> i64

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

pub fn campaign_draft(&self) -> &str

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

pub fn name(&self) -> &str

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

pub fn description(&self) -> &str

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

pub fn traffic_split_percent(&self) -> i64

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

pub fn experiment_campaign(&self) -> &str

Returns the value of experiment_campaign, or the default value if experiment_campaign 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 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.

Trait Implementations

impl Clone for CampaignExperiment

fn clone(&self) -> CampaignExperiment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignExperiment

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

Formats the value using the given formatter.

impl Default for CampaignExperiment

fn default() -> Self

Returns the “default value” for a type.

impl Message for CampaignExperiment

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<CampaignExperiment> for CampaignExperiment

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

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

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

This method tests for !=.

impl StructuralPartialEq for CampaignExperiment