Dfareporting.Ads.List (Campaign Manager 360 API v5-rev20250902-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,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<AdsListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.Ads.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Ads
```
public class Dfareporting.Ads.List
extends DfareportingRequest<AdsListResponse>
```

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
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(Long profileId)
Retrieves a list of ads, possibly filtered.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long profileId)` Retrieves a list of ads, possibly filtered.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Boolean`	`getActive()` Select only active ads.
`Long`	`getAdvertiserId()` Select only ads with this advertiser ID.
`Boolean`	`getArchived()` Select only archived ads.
`List<Long>`	`getAudienceSegmentIds()` Select only ads with these audience segment IDs.
`List<Long>`	`getCampaignIds()` Select only ads with these campaign IDs.
`String`	`getCompatibility()` Select default ads with the specified compatibility.
`List<Long>`	`getCreativeIds()` Select only ads with these creative IDs assigned.
`List<Long>`	`getCreativeOptimizationConfigurationIds()` Select only ads with these creative optimization configuration IDs.
`Boolean`	`getDynamicClickTracker()` Select only dynamic click trackers.
`List<Long>`	`getIds()` Select only ads with these IDs.
`List<Long>`	`getLandingPageIds()` Select only ads with these landing page IDs.
`Integer`	`getMaxResults()` Maximum number of results to return.
`Long`	`getOverriddenEventTagId()` Select only ads with this event tag override ID.
`String`	`getPageToken()` Value of the nextPageToken from the previous result page.
`List<Long>`	`getPlacementIds()` Select only ads with these placement IDs assigned.
`Long`	`getProfileId()` User profile ID associated with this request.
`List<Long>`	`getRemarketingListIds()` Select only ads whose list targeting expression use these remarketing list IDs.
`String`	`getSearchString()` Allows searching for objects by name or ID.
`List<Long>`	`getSizeIds()` Select only ads with these size IDs.
`String`	`getSortField()` Field by which to sort the list.
`String`	`getSortOrder()` Order of sorted results.
`Boolean`	`getSslCompliant()` Select only ads that are SSL-compliant.
`Boolean`	`getSslRequired()` Select only ads that require SSL.
`List<String>`	`getType()` Select only ads with these types.
`Dfareporting.Ads.List`	`set(String parameterName, Object value)`
`Dfareporting.Ads.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dfareporting.Ads.List`	`setAccessToken(String accessToken)` OAuth access token.
`Dfareporting.Ads.List`	`setActive(Boolean active)` Select only active ads.
`Dfareporting.Ads.List`	`setAdvertiserId(Long advertiserId)` Select only ads with this advertiser ID.
`Dfareporting.Ads.List`	`setAlt(String alt)` Data format for response.
`Dfareporting.Ads.List`	`setArchived(Boolean archived)` Select only archived ads.
`Dfareporting.Ads.List`	`setAudienceSegmentIds(List<Long> audienceSegmentIds)` Select only ads with these audience segment IDs.
`Dfareporting.Ads.List`	`setCallback(String callback)` JSONP
`Dfareporting.Ads.List`	`setCampaignIds(List<Long> campaignIds)` Select only ads with these campaign IDs.
`Dfareporting.Ads.List`	`setCompatibility(String compatibility)` Select default ads with the specified compatibility.
`Dfareporting.Ads.List`	`setCreativeIds(List<Long> creativeIds)` Select only ads with these creative IDs assigned.
`Dfareporting.Ads.List`	`setCreativeOptimizationConfigurationIds(List<Long> creativeOptimizationConfigurationIds)` Select only ads with these creative optimization configuration IDs.
`Dfareporting.Ads.List`	`setDynamicClickTracker(Boolean dynamicClickTracker)` Select only dynamic click trackers.
`Dfareporting.Ads.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.Ads.List`	`setIds(List<Long> ids)` Select only ads with these IDs.
`Dfareporting.Ads.List`	`setKey(String key)` API key.
`Dfareporting.Ads.List`	`setLandingPageIds(List<Long> landingPageIds)` Select only ads with these landing page IDs.
`Dfareporting.Ads.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Dfareporting.Ads.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.Ads.List`	`setOverriddenEventTagId(Long overriddenEventTagId)` Select only ads with this event tag override ID.
`Dfareporting.Ads.List`	`setPageToken(String pageToken)` Value of the nextPageToken from the previous result page.
`Dfareporting.Ads.List`	`setPlacementIds(List<Long> placementIds)` Select only ads with these placement IDs assigned.
`Dfareporting.Ads.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.Ads.List`	`setProfileId(Long profileId)` User profile ID associated with this request.
`Dfareporting.Ads.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.Ads.List`	`setRemarketingListIds(List<Long> remarketingListIds)` Select only ads whose list targeting expression use these remarketing list IDs.
`Dfareporting.Ads.List`	`setSearchString(String searchString)` Allows searching for objects by name or ID.
`Dfareporting.Ads.List`	`setSizeIds(List<Long> sizeIds)` Select only ads with these size IDs.
`Dfareporting.Ads.List`	`setSortField(String sortField)` Field by which to sort the list.
`Dfareporting.Ads.List`	`setSortOrder(String sortOrder)` Order of sorted results.
`Dfareporting.Ads.List`	`setSslCompliant(Boolean sslCompliant)` Select only ads that are SSL-compliant.
`Dfareporting.Ads.List`	`setSslRequired(Boolean sslRequired)` Select only ads that require SSL.
`Dfareporting.Ads.List`	`setType(List<String> type)` Select only ads with these types.
`Dfareporting.Ads.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dfareporting.Ads.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(Long profileId)
```
    Retrieves a list of ads, possibly filtered. This method supports paging. Create a request for the method "ads.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 IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<AdsListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<AdsListResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Dfareporting.Ads.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DfareportingRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DfareportingRequest<AdsListResponse>
  - setAccessToken
```
public Dfareporting.Ads.List setAccessToken(String accessToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DfareportingRequest<AdsListResponse>
  - setAlt
```
public Dfareporting.Ads.List setAlt(String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<AdsListResponse>
  - setCallback
```
public Dfareporting.Ads.List setCallback(String callback)
```
    Description copied from class: DfareportingRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DfareportingRequest<AdsListResponse>
  - setFields
```
public Dfareporting.Ads.List setFields(String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<AdsListResponse>
  - setKey
```
public Dfareporting.Ads.List setKey(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<AdsListResponse>
  - setOauthToken
```
public Dfareporting.Ads.List setOauthToken(String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<AdsListResponse>
  - setPrettyPrint
```
public Dfareporting.Ads.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<AdsListResponse>
  - setQuotaUser
```
public Dfareporting.Ads.List setQuotaUser(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:
    
    setQuotaUser in class DfareportingRequest<AdsListResponse>
  - setUploadType
```
public Dfareporting.Ads.List setUploadType(String uploadType)
```
    Description copied from class: DfareportingRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DfareportingRequest<AdsListResponse>
  - setUploadProtocol
```
public Dfareporting.Ads.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DfareportingRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DfareportingRequest<AdsListResponse>
  - getProfileId
```
public Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.Ads.List setProfileId(Long profileId)
```
    User profile ID associated with this request.
  - getActive
```
public Boolean getActive()
```
    Select only active ads.
  - setActive
```
public Dfareporting.Ads.List setActive(Boolean active)
```
    Select only active ads.
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Select only ads with this advertiser ID.
  - setAdvertiserId
```
public Dfareporting.Ads.List setAdvertiserId(Long advertiserId)
```
    Select only ads with this advertiser ID.
  - getArchived
```
public Boolean getArchived()
```
    Select only archived ads.
  - setArchived
```
public Dfareporting.Ads.List setArchived(Boolean archived)
```
    Select only archived ads.
  - getAudienceSegmentIds
```
public List<Long> getAudienceSegmentIds()
```
    Select only ads with these audience segment IDs.
  - setAudienceSegmentIds
```
public Dfareporting.Ads.List setAudienceSegmentIds(List<Long> audienceSegmentIds)
```
    Select only ads with these audience segment IDs.
  - getCampaignIds
```
public List<Long> getCampaignIds()
```
    Select only ads with these campaign IDs.
  - setCampaignIds
```
public Dfareporting.Ads.List setCampaignIds(List<Long> campaignIds)
```
    Select only ads with these campaign IDs.
  - getCompatibility
```
public String getCompatibility()
```
    Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
  - setCompatibility
```
public Dfareporting.Ads.List setCompatibility(String compatibility)
```
    Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
  - getCreativeIds
```
public List<Long> getCreativeIds()
```
    Select only ads with these creative IDs assigned.
  - setCreativeIds
```
public Dfareporting.Ads.List setCreativeIds(List<Long> creativeIds)
```
    Select only ads with these creative IDs assigned.
  - getCreativeOptimizationConfigurationIds
```
public List<Long> getCreativeOptimizationConfigurationIds()
```
    Select only ads with these creative optimization configuration IDs.
  - setCreativeOptimizationConfigurationIds
```
public Dfareporting.Ads.List setCreativeOptimizationConfigurationIds(List<Long> creativeOptimizationConfigurationIds)
```
    Select only ads with these creative optimization configuration IDs.
  - getDynamicClickTracker
```
public Boolean getDynamicClickTracker()
```
    Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
  - setDynamicClickTracker
```
public Dfareporting.Ads.List setDynamicClickTracker(Boolean dynamicClickTracker)
```
    Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
  - getIds
```
public List<Long> getIds()
```
    Select only ads with these IDs.
  - setIds
```
public Dfareporting.Ads.List setIds(List<Long> ids)
```
    Select only ads with these IDs.
  - getLandingPageIds
```
public List<Long> getLandingPageIds()
```
    Select only ads with these landing page IDs.
  - setLandingPageIds
```
public Dfareporting.Ads.List setLandingPageIds(List<Long> landingPageIds)
```
    Select only ads with these landing page IDs.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 1000]
  - setMaxResults
```
public Dfareporting.Ads.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return.
  - getOverriddenEventTagId
```
public Long getOverriddenEventTagId()
```
    Select only ads with this event tag override ID.
  - setOverriddenEventTagId
```
public Dfareporting.Ads.List setOverriddenEventTagId(Long overriddenEventTagId)
```
    Select only ads with this event tag override ID.
  - getPageToken
```
public String getPageToken()
```
    Value of the nextPageToken from the previous result page.
  - setPageToken
```
public Dfareporting.Ads.List setPageToken(String pageToken)
```
    Value of the nextPageToken from the previous result page.
  - getPlacementIds
```
public List<Long> getPlacementIds()
```
    Select only ads with these placement IDs assigned.
  - setPlacementIds
```
public Dfareporting.Ads.List setPlacementIds(List<Long> placementIds)
```
    Select only ads with these placement IDs assigned.
  - getRemarketingListIds
```
public List<Long> getRemarketingListIds()
```
    Select only ads whose list targeting expression use these remarketing list IDs.
  - setRemarketingListIds
```
public Dfareporting.Ads.List setRemarketingListIds(List<Long> remarketingListIds)
```
    Select only ads whose list targeting expression use these remarketing list IDs.
  - getSearchString
```
public String getSearchString()
```
    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  - setSearchString
```
public Dfareporting.Ads.List setSearchString(String searchString)
```
    Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  - getSizeIds
```
public List<Long> getSizeIds()
```
    Select only ads with these size IDs.
  - setSizeIds
```
public Dfareporting.Ads.List setSizeIds(List<Long> sizeIds)
```
    Select only ads with these size IDs.
  - getSortField
```
public String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.Ads.List setSortField(String sortField)
```
    Field by which to sort the list.
  - getSortOrder
```
public String getSortOrder()
```
    Order of sorted results. [default: ASCENDING]
  - setSortOrder
```
public Dfareporting.Ads.List setSortOrder(String sortOrder)
```
    Order of sorted results.
  - getSslCompliant
```
public Boolean getSslCompliant()
```
    Select only ads that are SSL-compliant.
  - setSslCompliant
```
public Dfareporting.Ads.List setSslCompliant(Boolean sslCompliant)
```
    Select only ads that are SSL-compliant.
  - getSslRequired
```
public Boolean getSslRequired()
```
    Select only ads that require SSL.
  - setSslRequired
```
public Dfareporting.Ads.List setSslRequired(Boolean sslRequired)
```
    Select only ads that require SSL.
  - getType
```
public List<String> getType()
```
    Select only ads with these types.
  - setType
```
public Dfareporting.Ads.List setType(List<String> type)
```
    Select only ads with these types.
  - set
```
public Dfareporting.Ads.List set(String parameterName,
                                 Object value)
```
    Overrides:
    
    set in class DfareportingRequest<AdsListResponse>

Class Dfareporting.Ads.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

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProfileId

setProfileId

getActive

setActive

getAdvertiserId

setAdvertiserId

getArchived

setArchived

getAudienceSegmentIds

setAudienceSegmentIds

getCampaignIds

setCampaignIds

getCompatibility

setCompatibility

getCreativeIds

setCreativeIds

getCreativeOptimizationConfigurationIds

setCreativeOptimizationConfigurationIds

getDynamicClickTracker

setDynamicClickTracker

getIds

setIds

getLandingPageIds

setLandingPageIds

getMaxResults

setMaxResults

getOverriddenEventTagId

setOverriddenEventTagId

getPageToken

setPageToken

getPlacementIds

setPlacementIds

getRemarketingListIds

setRemarketingListIds

getSearchString

setSearchString

getSizeIds

setSizeIds

getSortField

setSortField

getSortOrder

setSortOrder

getSslCompliant

setSslCompliant

getSslRequired

setSslRequired

getType

setType