com.google.api.ads.adwords.lib.selectorfields.v201710.cm

Enum TrialField

java.lang.Object

java.lang.Enum<TrialField>

com.google.api.ads.adwords.lib.selectorfields.v201710.cm.TrialField

All Implemented Interfaces:

EntityField, Serializable, Comparable<TrialField>

public enum TrialField
extends Enum<TrialField>
implements EntityField

A Enum to facilitate the selection of fields for Trial.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BaseCampaignId Id of the base campaign, which will be the control arm of this trial.
DraftId Valid id of the draft this trial is based on.
EndDate Date the campaign ends.
Id The id of this trial.
Name The name of this trial.
StartDate Date the trial begins.
Status Status of this trial.
TrafficSplitPercent Traffic share to be directed to the trial arm of this trial, i.e.
TrialCampaignId Id of the trial campaign.

Method Summary

Modifier and Type	Method and Description
boolean	isFilterable() If the field is filterable.
static TrialField	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrialField[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.api.ads.adwords.lib.selectorfields.EntityField

name

Enum Constant Detail

BaseCampaignId

public static final TrialField BaseCampaignId

Id of the base campaign, which will be the control arm of this trial.

DraftId

public static final TrialField DraftId

Valid id of the draft this trial is based on.

EndDate

public static final TrialField EndDate

Date the campaign ends. On add, defaults to the base campaign's end date.

Id

public static final TrialField Id

The id of this trial.

Name

public static final TrialField Name

The name of this trial. Must not conflict with the name of another trial or campaign.

StartDate

public static final TrialField StartDate

Date the trial begins. On add, defaults to the the base campaign's start date or the current day in the parent account's local timezone (whichever is later).

Status

public static final TrialField Status

Status of this trial. Note that a running trial will always be ACTIVE, but not all ACTIVE trials are currently running: they may have ended or been scheduled for the future.

TrafficSplitPercent

public static final TrialField TrafficSplitPercent

Traffic share to be directed to the trial arm of this trial, i.e. the arm containing the trial changes (in percent). The remainder of the traffic (100 - trafficSplitPercent) will be directed to the base campaign.

TrialCampaignId

public static final TrialField TrialCampaignId

Id of the trial campaign. This will be null if the Trial has status CREATING.

Method Detail

values

public static TrialField[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TrialField c : TrialField.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TrialField valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isFilterable

public boolean isFilterable()

Description copied from interface: EntityField

If the field is filterable.

Specified by:

isFilterable in interface EntityField

Returns:

true for a filterable field, false otherwise.