Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.Trial Class Reference

Interface for campaign trial entities. A trial is an experiment created by an advertiser from changes in a draft. More...

Classes

class  Fields
 List of all supported fields for the Trial class. More...
 
class  FilterableFields
 List of all supported filterable fields for the Trial class. More...
 
class  SelectableFields
 List of all supported selectable fields for the Trial class. More...
 

Properties

long id [get, set]
 The id of this trial. This field can be selected using the value "Id".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. This field is required and should not be More...
 
bool idSpecified [get, set]
 
long baseCampaignId [get, set]
 Id of the base campaign, which will be the control arm of this trial. This field can be selected using the value "BaseCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET. This field is required and should not be More...
 
bool baseCampaignIdSpecified [get, set]
 
long draftId [get, set]
 Valid id of the draft this trial is based on. This field can be selected using the value "DraftId".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET. This field is required and should not be More...
 
bool draftIdSpecified [get, set]
 
long budgetId [get, set]
 Id of the new budget to assign to the trial campaign when graduating a trial. More...
 
bool budgetIdSpecified [get, set]
 
string name [get, set]
 The name of this trial. Must not conflict with the name of another trial or campaign. This field can be selected using the value "Name".This field can be filtered on. This field is required and should not be More...
 
string startDate [get, set]
 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). This field can be selected using the value "StartDate".This field can be filtered on. More...
 
string endDate [get, set]
 Date the campaign ends. On add, defaults to the base campaign's end date. This field can be selected using the value "EndDate".This field can be filtered on. More...
 
int trafficSplitPercent [get, set]
 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 - More...
 
bool trafficSplitPercentSpecified [get, set]
 
CampaignTrialTrafficSplitType trafficSplitType [get, set]
 Determines the behavior of the traffic split. This field can be selected using the value "TrafficSplitType".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET. More...
 
bool trafficSplitTypeSpecified [get, set]
 
TrialStatus status [get, set]
 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. This field can be selected using the value "Status".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. More...
 
bool statusSpecified [get, set]
 
long trialCampaignId [get, set]
 Id of the trial campaign. This will be null if the Trial has status CREATING. This field can be selected using the value "TrialCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool trialCampaignIdSpecified [get, set]
 

Detailed Description

Interface for campaign trial entities. A trial is an experiment created by an advertiser from changes in a draft.

Property Documentation

long Google.Api.Ads.AdWords.v201809.Trial.baseCampaignId
getset

Id of the base campaign, which will be the control arm of this trial. This field can be selected using the value "BaseCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET. This field is required and should not be

null when it is contained within Operators : ADD.

bool Google.Api.Ads.AdWords.v201809.Trial.baseCampaignIdSpecified
getset

true, if a value is specified for baseCampaignId, false otherwise.

long Google.Api.Ads.AdWords.v201809.Trial.budgetId
getset

Id of the new budget to assign to the trial campaign when graduating a trial.

Required for SET operations, when changing the #status to GRADUATED, and read-only otherwise.

When graduating a trial, the same constraints apply to this field as for a budget id passed to CampaignService when creating a new campaign.

GET operations always return a null budget id. This field is read only and will be ignored when sent to the API for the following Operators: ADD.

bool Google.Api.Ads.AdWords.v201809.Trial.budgetIdSpecified
getset

true, if a value is specified for budgetId, false otherwise.

long Google.Api.Ads.AdWords.v201809.Trial.draftId
getset

Valid id of the draft this trial is based on. This field can be selected using the value "DraftId".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET. This field is required and should not be

null when it is contained within Operators : ADD.

bool Google.Api.Ads.AdWords.v201809.Trial.draftIdSpecified
getset

true, if a value is specified for draftId, false otherwise.

string Google.Api.Ads.AdWords.v201809.Trial.endDate
getset

Date the campaign ends. On add, defaults to the base campaign's end date. This field can be selected using the value "EndDate".This field can be filtered on.

long Google.Api.Ads.AdWords.v201809.Trial.id
getset

The id of this trial. This field can be selected using the value "Id".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. This field is required and should not be

null when it is contained within Operators : SET.

bool Google.Api.Ads.AdWords.v201809.Trial.idSpecified
getset

true, if a value is specified for id, false otherwise.

string Google.Api.Ads.AdWords.v201809.Trial.name
getset

The name of this trial. Must not conflict with the name of another trial or campaign. This field can be selected using the value "Name".This field can be filtered on. This field is required and should not be

null when it is contained within Operators : ADD. The length of this string should be between 1 and 1024, inclusive, in UTF-8 bytes, (trimmed).

string Google.Api.Ads.AdWords.v201809.Trial.startDate
getset

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). This field can be selected using the value "StartDate".This field can be filtered on.

TrialStatus Google.Api.Ads.AdWords.v201809.Trial.status
getset

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. This field can be selected using the value "Status".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD.

bool Google.Api.Ads.AdWords.v201809.Trial.statusSpecified
getset

true, if a value is specified for status, false otherwise.

int Google.Api.Ads.AdWords.v201809.Trial.trafficSplitPercent
getset

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. This field can be selected using the value "TrafficSplitPercent".This field can be filtered on. This field must be between 1 and 99, inclusive. This field is read only and will be ignored when sent to the API for the following Operators: SET. This field is required and should not be null when it is contained within Operators : ADD.

bool Google.Api.Ads.AdWords.v201809.Trial.trafficSplitPercentSpecified
getset

true, if a value is specified for trafficSplitPercent, false otherwise.

CampaignTrialTrafficSplitType Google.Api.Ads.AdWords.v201809.Trial.trafficSplitType
getset

Determines the behavior of the traffic split. This field can be selected using the value "TrafficSplitType".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET.

bool Google.Api.Ads.AdWords.v201809.Trial.trafficSplitTypeSpecified
getset

true, if a value is specified for trafficSplitType, false otherwise.

long Google.Api.Ads.AdWords.v201809.Trial.trialCampaignId
getset

Id of the trial campaign. This will be null if the Trial has status CREATING. This field can be selected using the value "TrialCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.Trial.trialCampaignIdSpecified
getset

true, if a value is specified for trialCampaignId, false otherwise.


The documentation for this class was generated from the following file: