Class EventTagsResource.ListRequest

Retrieves a list of event tags, possibly filtered.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<EventTagsListResponse>
DfareportingBaseServiceRequest<EventTagsListResponse>
EventTagsResource.ListRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dfareporting.v3_5
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class EventTagsResource.ListRequest : DfareportingBaseServiceRequest<EventTagsListResponse>, IClientServiceRequest<EventTagsListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long profileId)
Parameters
Type Name Description
IClientService service
long profileId

Properties

AdId

Select only event tags that belong to this ad.

Declaration
[RequestParameter("adId", RequestParameterType.Query)]
public virtual long? AdId { get; set; }
Property Value
Type Description
long?

AdvertiserId

Select only event tags that belong to this advertiser.

Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }
Property Value
Type Description
long?

CampaignId

Select only event tags that belong to this campaign.

Declaration
[RequestParameter("campaignId", RequestParameterType.Query)]
public virtual long? CampaignId { get; set; }
Property Value
Type Description
long?

DefinitionsOnly

Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

Declaration
[RequestParameter("definitionsOnly", RequestParameterType.Query)]
public virtual bool? DefinitionsOnly { get; set; }
Property Value
Type Description
bool?

Enabled

Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

Declaration
[RequestParameter("enabled", RequestParameterType.Query)]
public virtual bool? Enabled { get; set; }
Property Value
Type Description
bool?

EventTagTypes

Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.

Declaration
[RequestParameter("eventTagTypes", RequestParameterType.Query)]
public virtual EventTagsResource.ListRequest.EventTagTypesEnum? EventTagTypes { get; set; }
Property Value
Type Description
EventTagsResource.ListRequest.EventTagTypesEnum?
Remarks

Use this property to set a single value for the parameter, or EventTagTypesList to set multiple values. Do not set both properties.

EventTagTypesList

Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.

Declaration
[RequestParameter("eventTagTypes", RequestParameterType.Query)]
public virtual Repeatable<EventTagsResource.ListRequest.EventTagTypesEnum> EventTagTypesList { get; set; }
Property Value
Type Description
Repeatable<EventTagsResource.ListRequest.EventTagTypesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and EventTagTypes.

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.EventTagsListResponse>.HttpMethod

Ids

Select only event tags with these IDs.

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type Description
Repeatable<string>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.EventTagsListResponse>.MethodName

ProfileId

User profile ID associated with this request.

Declaration
[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }
Property Value
Type Description
long

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.EventTagsListResponse>.RestPath

SearchString

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "eventtag2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".

Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type Description
string

SortField

Field by which to sort the list.

Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual EventTagsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
EventTagsResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual EventTagsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
EventTagsResource.ListRequest.SortOrderEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_5.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_5.Data.EventTagsListResponse>.InitParameters()

Implements