Dfareporting.Campaigns.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<CampaignsListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.Campaigns.List

All Implemented Interfaces:

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

Enclosing class:

Dfareporting.Campaigns
```
public class Dfareporting.Campaigns.List
extends DfareportingRequest<CampaignsListResponse>
```

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.Campaigns.List(java.lang.Long profileId)
Retrieves a list of campaigns, possibly filtered.

Constructors
Modifier	Constructor and Description
`protected`	`Dfareporting.Campaigns.List(java.lang.Long profileId)` Retrieves a list of campaigns, 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.util.List<java.lang.Long>`	`getAdvertiserGroupIds()` Select only campaigns whose advertisers belong to these advertiser groups.
`java.util.List<java.lang.Long>`	`getAdvertiserIds()` Select only campaigns that belong to these advertisers.
`java.lang.Boolean`	`getArchived()` Select only archived campaigns.
`java.lang.Boolean`	`getAtLeastOneOptimizationActivity()` Select only campaigns that have at least one optimization activity.
`java.util.List<java.lang.Long>`	`getExcludedIds()` Exclude campaigns with these IDs.
`java.util.List<java.lang.Long>`	`getIds()` Select only campaigns with these IDs.
`java.lang.Integer`	`getMaxResults()` Maximum number of results to return.
`java.lang.Long`	`getOverriddenEventTagId()` Select only campaigns that have overridden this event tag ID.
`java.lang.String`	`getPageToken()` Value of the nextPageToken from the previous result page.
`java.lang.Long`	`getProfileId()` User profile ID associated with this request.
`java.lang.String`	`getSearchString()` Allows searching for campaigns by name or ID.
`java.lang.String`	`getSortField()` Field by which to sort the list.
`java.lang.String`	`getSortOrder()` Order of sorted results.
`java.lang.Long`	`getSubaccountId()` Select only campaigns that belong to this subaccount.
`Dfareporting.Campaigns.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Dfareporting.Campaigns.List`	`setAdvertiserGroupIds(java.util.List<java.lang.Long> advertiserGroupIds)` Select only campaigns whose advertisers belong to these advertiser groups.
`Dfareporting.Campaigns.List`	`setAdvertiserIds(java.util.List<java.lang.Long> advertiserIds)` Select only campaigns that belong to these advertisers.
`Dfareporting.Campaigns.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Dfareporting.Campaigns.List`	`setArchived(java.lang.Boolean archived)` Select only archived campaigns.
`Dfareporting.Campaigns.List`	`setAtLeastOneOptimizationActivity(java.lang.Boolean atLeastOneOptimizationActivity)` Select only campaigns that have at least one optimization activity.
`Dfareporting.Campaigns.List`	`setExcludedIds(java.util.List<java.lang.Long> excludedIds)` Exclude campaigns with these IDs.
`Dfareporting.Campaigns.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.Campaigns.List`	`setIds(java.util.List<java.lang.Long> ids)` Select only campaigns with these IDs.
`Dfareporting.Campaigns.List`	`setKey(java.lang.String key)` API key.
`Dfareporting.Campaigns.List`	`setMaxResults(java.lang.Integer maxResults)` Maximum number of results to return.
`Dfareporting.Campaigns.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.Campaigns.List`	`setOverriddenEventTagId(java.lang.Long overriddenEventTagId)` Select only campaigns that have overridden this event tag ID.
`Dfareporting.Campaigns.List`	`setPageToken(java.lang.String pageToken)` Value of the nextPageToken from the previous result page.
`Dfareporting.Campaigns.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.Campaigns.List`	`setProfileId(java.lang.Long profileId)` User profile ID associated with this request.
`Dfareporting.Campaigns.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.Campaigns.List`	`setSearchString(java.lang.String searchString)` Allows searching for campaigns by name or ID.
`Dfareporting.Campaigns.List`	`setSortField(java.lang.String sortField)` Field by which to sort the list.
`Dfareporting.Campaigns.List`	`setSortOrder(java.lang.String sortOrder)` Order of sorted results.
`Dfareporting.Campaigns.List`	`setSubaccountId(java.lang.Long subaccountId)` Select only campaigns that belong to this subaccount.
`Dfareporting.Campaigns.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.Campaigns.List
```
protected Dfareporting.Campaigns.List(java.lang.Long profileId)
```
    Retrieves a list of campaigns, possibly filtered. This method supports paging. Create a request for the method "campaigns.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<CampaignsListResponse>
    
    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<CampaignsListResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Dfareporting.Campaigns.List setAlt(java.lang.String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<CampaignsListResponse>
  - setFields
```
public Dfareporting.Campaigns.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<CampaignsListResponse>
  - setKey
```
public Dfareporting.Campaigns.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<CampaignsListResponse>
  - setOauthToken
```
public Dfareporting.Campaigns.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<CampaignsListResponse>
  - setPrettyPrint
```
public Dfareporting.Campaigns.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<CampaignsListResponse>
  - setQuotaUser
```
public Dfareporting.Campaigns.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<CampaignsListResponse>
  - setUserIp
```
public Dfareporting.Campaigns.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<CampaignsListResponse>
  - getProfileId
```
public java.lang.Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.Campaigns.List setProfileId(java.lang.Long profileId)
```
    User profile ID associated with this request.
  - getAdvertiserGroupIds
```
public java.util.List<java.lang.Long> getAdvertiserGroupIds()
```
    Select only campaigns whose advertisers belong to these advertiser groups.
  - setAdvertiserGroupIds
```
public Dfareporting.Campaigns.List setAdvertiserGroupIds(java.util.List<java.lang.Long> advertiserGroupIds)
```
    Select only campaigns whose advertisers belong to these advertiser groups.
  - getAdvertiserIds
```
public java.util.List<java.lang.Long> getAdvertiserIds()
```
    Select only campaigns that belong to these advertisers.
  - setAdvertiserIds
```
public Dfareporting.Campaigns.List setAdvertiserIds(java.util.List<java.lang.Long> advertiserIds)
```
    Select only campaigns that belong to these advertisers.
  - getArchived
```
public java.lang.Boolean getArchived()
```
    Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
  - setArchived
```
public Dfareporting.Campaigns.List setArchived(java.lang.Boolean archived)
```
    Select only archived campaigns. Don't set this field to select both archived and non- archived campaigns.
  - getAtLeastOneOptimizationActivity
```
public java.lang.Boolean getAtLeastOneOptimizationActivity()
```
    Select only campaigns that have at least one optimization activity.
  - setAtLeastOneOptimizationActivity
```
public Dfareporting.Campaigns.List setAtLeastOneOptimizationActivity(java.lang.Boolean atLeastOneOptimizationActivity)
```
    Select only campaigns that have at least one optimization activity.
  - getExcludedIds
```
public java.util.List<java.lang.Long> getExcludedIds()
```
    Exclude campaigns with these IDs.
  - setExcludedIds
```
public Dfareporting.Campaigns.List setExcludedIds(java.util.List<java.lang.Long> excludedIds)
```
    Exclude campaigns with these IDs.
  - getIds
```
public java.util.List<java.lang.Long> getIds()
```
    Select only campaigns with these IDs.
  - setIds
```
public Dfareporting.Campaigns.List setIds(java.util.List<java.lang.Long> ids)
```
    Select only campaigns with these IDs.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    Maximum number of results to return. [default: 1000] [minimum: 0] [maximum: 1000]
  - setMaxResults
```
public Dfareporting.Campaigns.List setMaxResults(java.lang.Integer maxResults)
```
    Maximum number of results to return.
  - getOverriddenEventTagId
```
public java.lang.Long getOverriddenEventTagId()
```
    Select only campaigns that have overridden this event tag ID.
  - setOverriddenEventTagId
```
public Dfareporting.Campaigns.List setOverriddenEventTagId(java.lang.Long overriddenEventTagId)
```
    Select only campaigns that have overridden this event tag ID.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Value of the nextPageToken from the previous result page.
  - setPageToken
```
public Dfareporting.Campaigns.List setPageToken(java.lang.String pageToken)
```
    Value of the nextPageToken from the previous result page.
  - getSearchString
```
public java.lang.String getSearchString()
```
    Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  - setSearchString
```
public Dfareporting.Campaigns.List setSearchString(java.lang.String searchString)
```
    Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  - getSortField
```
public java.lang.String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.Campaigns.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.Campaigns.List setSortOrder(java.lang.String sortOrder)
```
    Order of sorted results.
  - getSubaccountId
```
public java.lang.Long getSubaccountId()
```
    Select only campaigns that belong to this subaccount.
  - setSubaccountId
```
public Dfareporting.Campaigns.List setSubaccountId(java.lang.Long subaccountId)
```
    Select only campaigns that belong to this subaccount.
  - set
```
public Dfareporting.Campaigns.List set(java.lang.String parameterName,
                              java.lang.Object value)
```
    Overrides:
    
    set in class DfareportingRequest<CampaignsListResponse>

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

Class Dfareporting.Campaigns.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.Campaigns.List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProfileId

setProfileId

getAdvertiserGroupIds

setAdvertiserGroupIds

getAdvertiserIds

setAdvertiserIds

getArchived

setArchived

getAtLeastOneOptimizationActivity

setAtLeastOneOptimizationActivity

getExcludedIds

setExcludedIds

getIds

setIds

getMaxResults

setMaxResults

getOverriddenEventTagId

setOverriddenEventTagId

getPageToken

setPageToken

getSearchString

setSearchString

getSortField

setSortField

getSortOrder

setSortOrder

getSubaccountId

setSubaccountId

set