Dfareporting.EventTags.List (DCM/DFA Reporting And Trafficking API v3.0 (Rev. 1) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.dfareporting.DfareportingRequest<EventTagsListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.EventTags.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Dfareporting.EventTags
```
public class Dfareporting.EventTags.List
extends DfareportingRequest<EventTagsListResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Dfareporting.EventTags.List(java.lang.Long profileId)
Retrieves a list of event tags, possibly filtered.

Constructors
Modifier	Constructor and Description
`protected`	`Dfareporting.EventTags.List(java.lang.Long profileId)` Retrieves a list of event tags, possibly filtered.

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.Long`	`getAdId()` Select only event tags that belong to this ad.
`java.lang.Long`	`getAdvertiserId()` Select only event tags that belong to this advertiser.
`java.lang.Long`	`getCampaignId()` Select only event tags that belong to this campaign.
`java.lang.Boolean`	`getDefinitionsOnly()` Examine only the specified campaign or advertiser's event tags for matching selector criteria.
`java.lang.Boolean`	`getEnabled()` Select only enabled event tags.
`java.util.List<java.lang.String>`	`getEventTagTypes()` Select only event tags with the specified event tag types.
`java.util.List<java.lang.Long>`	`getIds()` Select only event tags with these IDs.
`java.lang.Long`	`getProfileId()` User profile ID associated with this request.
`java.lang.String`	`getSearchString()` Allows searching for objects by name or ID.
`java.lang.String`	`getSortField()` Field by which to sort the list.
`java.lang.String`	`getSortOrder()` Order of sorted results.
`Dfareporting.EventTags.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Dfareporting.EventTags.List`	`setAdId(java.lang.Long adId)` Select only event tags that belong to this ad.
`Dfareporting.EventTags.List`	`setAdvertiserId(java.lang.Long advertiserId)` Select only event tags that belong to this advertiser.
`Dfareporting.EventTags.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Dfareporting.EventTags.List`	`setCampaignId(java.lang.Long campaignId)` Select only event tags that belong to this campaign.
`Dfareporting.EventTags.List`	`setDefinitionsOnly(java.lang.Boolean definitionsOnly)` Examine only the specified campaign or advertiser's event tags for matching selector criteria.
`Dfareporting.EventTags.List`	`setEnabled(java.lang.Boolean enabled)` Select only enabled event tags.
`Dfareporting.EventTags.List`	`setEventTagTypes(java.util.List<java.lang.String> eventTagTypes)` Select only event tags with the specified event tag types.
`Dfareporting.EventTags.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.EventTags.List`	`setIds(java.util.List<java.lang.Long> ids)` Select only event tags with these IDs.
`Dfareporting.EventTags.List`	`setKey(java.lang.String key)` API key.
`Dfareporting.EventTags.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.EventTags.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.EventTags.List`	`setProfileId(java.lang.Long profileId)` User profile ID associated with this request.
`Dfareporting.EventTags.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.EventTags.List`	`setSearchString(java.lang.String searchString)` Allows searching for objects by name or ID.
`Dfareporting.EventTags.List`	`setSortField(java.lang.String sortField)` Field by which to sort the list.
`Dfareporting.EventTags.List`	`setSortOrder(java.lang.String sortOrder)` Order of sorted results.
`Dfareporting.EventTags.List`	`setUserIp(java.lang.String userIp)` IP address of the site where the request originates.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Dfareporting.EventTags.List
```
protected Dfareporting.EventTags.List(java.lang.Long profileId)
```
    Retrieves a list of event tags, possibly filtered. Create a request for the method "eventTags.list". This request holds the parameters needed by the the dfareporting server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Dfareporting.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    profileId - User profile ID associated with this request.
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<EventTagsListResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<EventTagsListResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Dfareporting.EventTags.List setAlt(java.lang.String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<EventTagsListResponse>
  - setFields
```
public Dfareporting.EventTags.List setFields(java.lang.String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<EventTagsListResponse>
  - setKey
```
public Dfareporting.EventTags.List setKey(java.lang.String key)
```
    Description copied from class: DfareportingRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class DfareportingRequest<EventTagsListResponse>
  - setOauthToken
```
public Dfareporting.EventTags.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<EventTagsListResponse>
  - setPrettyPrint
```
public Dfareporting.EventTags.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<EventTagsListResponse>
  - setQuotaUser
```
public Dfareporting.EventTags.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: DfareportingRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    
    Overrides:
    
    setQuotaUser in class DfareportingRequest<EventTagsListResponse>
  - setUserIp
```
public Dfareporting.EventTags.List setUserIp(java.lang.String userIp)
```
    Description copied from class: DfareportingRequest
    
    IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    
    Overrides:
    
    setUserIp in class DfareportingRequest<EventTagsListResponse>
  - getProfileId
```
public java.lang.Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.EventTags.List setProfileId(java.lang.Long profileId)
```
    User profile ID associated with this request.
  - getAdId
```
public java.lang.Long getAdId()
```
    Select only event tags that belong to this ad.
  - setAdId
```
public Dfareporting.EventTags.List setAdId(java.lang.Long adId)
```
    Select only event tags that belong to this ad.
  - getAdvertiserId
```
public java.lang.Long getAdvertiserId()
```
    Select only event tags that belong to this advertiser.
  - setAdvertiserId
```
public Dfareporting.EventTags.List setAdvertiserId(java.lang.Long advertiserId)
```
    Select only event tags that belong to this advertiser.
  - getCampaignId
```
public java.lang.Long getCampaignId()
```
    Select only event tags that belong to this campaign.
  - setCampaignId
```
public Dfareporting.EventTags.List setCampaignId(java.lang.Long campaignId)
```
    Select only event tags that belong to this campaign.
  - getDefinitionsOnly
```
public java.lang.Boolean getDefinitionsOnly()
```
    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.
  - setDefinitionsOnly
```
public Dfareporting.EventTags.List setDefinitionsOnly(java.lang.Boolean 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.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    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.
  - setEnabled
```
public Dfareporting.EventTags.List setEnabled(java.lang.Boolean 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.
  - getEventTagTypes
```
public java.util.List<java.lang.String> getEventTagTypes()
```
    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.
  - setEventTagTypes
```
public Dfareporting.EventTags.List setEventTagTypes(java.util.List<java.lang.String> 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.
  - getIds
```
public java.util.List<java.lang.Long> getIds()
```
    Select only event tags with these IDs.
  - setIds
```
public Dfareporting.EventTags.List setIds(java.util.List<java.lang.Long> ids)
```
    Select only event tags with these IDs.
  - getSearchString
```
public java.lang.String getSearchString()
```
    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" 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".
  - setSearchString
```
public Dfareporting.EventTags.List setSearchString(java.lang.String searchString)
```
    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" 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".
  - getSortField
```
public java.lang.String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.EventTags.List setSortField(java.lang.String sortField)
```
    Field by which to sort the list.
  - getSortOrder
```
public java.lang.String getSortOrder()
```
    Order of sorted results. [default: ASCENDING]
  - setSortOrder
```
public Dfareporting.EventTags.List setSortOrder(java.lang.String sortOrder)
```
    Order of sorted results.
  - set
```
public Dfareporting.EventTags.List set(java.lang.String parameterName,
                              java.lang.Object value)
```
    Overrides:
    
    set in class DfareportingRequest<EventTagsListResponse>

DCM/DFA Reporting And Trafficking API v3.0 (revision 1)

Class Dfareporting.EventTags.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Dfareporting.EventTags.List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProfileId

setProfileId

getAdId

setAdId

getAdvertiserId

setAdvertiserId

getCampaignId

setCampaignId

getDefinitionsOnly

setDefinitionsOnly

getEnabled

setEnabled

getEventTagTypes

setEventTagTypes

getIds

setIds

getSearchString

setSearchString

getSortField

setSortField

getSortOrder

setSortOrder

set