Dfareporting.DirectorySites.List (DCM/DFA Reporting And Trafficking API v3.3-rev20190124-1.26.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<DirectorySitesListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.DirectorySites.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Dfareporting.DirectorySites

public class Dfareporting.DirectorySites.List
extends DfareportingRequest<DirectorySitesListResponse>

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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`List(Long profileId)` Retrieves a list of directory sites, 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`	`getAcceptsInStreamVideoPlacements()` This search filter is no longer supported and will have no effect on the results returned.
`Boolean`	`getAcceptsInterstitialPlacements()` This search filter is no longer supported and will have no effect on the results returned.
`Boolean`	`getAcceptsPublisherPaidPlacements()` Select only directory sites that accept publisher paid placements.
`Boolean`	`getActive()` Select only active directory sites.
`String`	`getDfpNetworkCode()` Select only directory sites with this Ad Manager network code.
`List<Long>`	`getIds()` Select only directory sites with these IDs.
`Integer`	`getMaxResults()` Maximum number of results to return.
`String`	`getPageToken()` Value of the nextPageToken from the previous result page.
`Long`	`getProfileId()` User profile ID associated with this request.
`String`	`getSearchString()` Allows searching for objects by name, ID or URL.
`String`	`getSortField()` Field by which to sort the list.
`String`	`getSortOrder()` Order of sorted results.
`Dfareporting.DirectorySites.List`	`set(String parameterName, Object value)`
`Dfareporting.DirectorySites.List`	`setAcceptsInStreamVideoPlacements(Boolean acceptsInStreamVideoPlacements)` This search filter is no longer supported and will have no effect on the results returned.
`Dfareporting.DirectorySites.List`	`setAcceptsInterstitialPlacements(Boolean acceptsInterstitialPlacements)` This search filter is no longer supported and will have no effect on the results returned.
`Dfareporting.DirectorySites.List`	`setAcceptsPublisherPaidPlacements(Boolean acceptsPublisherPaidPlacements)` Select only directory sites that accept publisher paid placements.
`Dfareporting.DirectorySites.List`	`setActive(Boolean active)` Select only active directory sites.
`Dfareporting.DirectorySites.List`	`setAlt(String alt)` Data format for the response.
`Dfareporting.DirectorySites.List`	`setDfpNetworkCode(String dfpNetworkCode)` Select only directory sites with this Ad Manager network code.
`Dfareporting.DirectorySites.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.DirectorySites.List`	`setIds(List<Long> ids)` Select only directory sites with these IDs.
`Dfareporting.DirectorySites.List`	`setKey(String key)` API key.
`Dfareporting.DirectorySites.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Dfareporting.DirectorySites.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.DirectorySites.List`	`setPageToken(String pageToken)` Value of the nextPageToken from the previous result page.
`Dfareporting.DirectorySites.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.DirectorySites.List`	`setProfileId(Long profileId)` User profile ID associated with this request.
`Dfareporting.DirectorySites.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Dfareporting.DirectorySites.List`	`setSearchString(String searchString)` Allows searching for objects by name, ID or URL.
`Dfareporting.DirectorySites.List`	`setSortField(String sortField)` Field by which to sort the list.
`Dfareporting.DirectorySites.List`	`setSortOrder(String sortOrder)` Order of sorted results.
`Dfareporting.DirectorySites.List`	`setUserIp(String userIp)` Deprecated.

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

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 directory sites, possibly filtered. This method supports paging. Create a request for the method "directorySites.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<DirectorySitesListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<DirectorySitesListResponse>
    
    Throws:
    
    IOException
  - setAlt
```
public Dfareporting.DirectorySites.List setAlt(String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<DirectorySitesListResponse>
  - setFields
```
public Dfareporting.DirectorySites.List setFields(String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<DirectorySitesListResponse>
  - setKey
```
public Dfareporting.DirectorySites.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<DirectorySitesListResponse>
  - setOauthToken
```
public Dfareporting.DirectorySites.List setOauthToken(String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<DirectorySitesListResponse>
  - setPrettyPrint
```
public Dfareporting.DirectorySites.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<DirectorySitesListResponse>
  - setQuotaUser
```
public Dfareporting.DirectorySites.List setQuotaUser(String quotaUser)
```
    Description copied from class: DfareportingRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DfareportingRequest<DirectorySitesListResponse>
  - setUserIp
```
public Dfareporting.DirectorySites.List setUserIp(String userIp)
```
    Description copied from class: DfareportingRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class DfareportingRequest<DirectorySitesListResponse>
  - getProfileId
```
public Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.DirectorySites.List setProfileId(Long profileId)
```
    User profile ID associated with this request.
  - getAcceptsInStreamVideoPlacements
```
public Boolean getAcceptsInStreamVideoPlacements()
```
    This search filter is no longer supported and will have no effect on the results returned.
  - setAcceptsInStreamVideoPlacements
```
public Dfareporting.DirectorySites.List setAcceptsInStreamVideoPlacements(Boolean acceptsInStreamVideoPlacements)
```
    This search filter is no longer supported and will have no effect on the results returned.
  - getAcceptsInterstitialPlacements
```
public Boolean getAcceptsInterstitialPlacements()
```
    This search filter is no longer supported and will have no effect on the results returned.
  - setAcceptsInterstitialPlacements
```
public Dfareporting.DirectorySites.List setAcceptsInterstitialPlacements(Boolean acceptsInterstitialPlacements)
```
    This search filter is no longer supported and will have no effect on the results returned.
  - getAcceptsPublisherPaidPlacements
```
public Boolean getAcceptsPublisherPaidPlacements()
```
    Select only directory sites that accept publisher paid placements. This field can be left blank.
  - setAcceptsPublisherPaidPlacements
```
public Dfareporting.DirectorySites.List setAcceptsPublisherPaidPlacements(Boolean acceptsPublisherPaidPlacements)
```
    Select only directory sites that accept publisher paid placements. This field can be left blank.
  - getActive
```
public Boolean getActive()
```
    Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  - setActive
```
public Dfareporting.DirectorySites.List setActive(Boolean active)
```
    Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  - getDfpNetworkCode
```
public String getDfpNetworkCode()
```
    Select only directory sites with this Ad Manager network code.
  - setDfpNetworkCode
```
public Dfareporting.DirectorySites.List setDfpNetworkCode(String dfpNetworkCode)
```
    Select only directory sites with this Ad Manager network code.
  - getIds
```
public List<Long> getIds()
```
    Select only directory sites with these IDs.
  - setIds
```
public Dfareporting.DirectorySites.List setIds(List<Long> ids)
```
    Select only directory sites with these IDs.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 1000] [minimum: 0] [maximum: 1000]
  - setMaxResults
```
public Dfareporting.DirectorySites.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return.
  - getPageToken
```
public String getPageToken()
```
    Value of the nextPageToken from the previous result page.
  - setPageToken
```
public Dfareporting.DirectorySites.List setPageToken(String pageToken)
```
    Value of the nextPageToken from the previous result page.
  - getSearchString
```
public String getSearchString()
```
    Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  - setSearchString
```
public Dfareporting.DirectorySites.List setSearchString(String searchString)
```
    Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  - getSortField
```
public String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.DirectorySites.List setSortField(String sortField)
```
    Field by which to sort the list.
  - getSortOrder
```
public String getSortOrder()
```
    Order of sorted results. [default: ASCENDING]
  - setSortOrder
```
public Dfareporting.DirectorySites.List setSortOrder(String sortOrder)
```
    Order of sorted results.
  - set
```
public Dfareporting.DirectorySites.List set(String parameterName,
                                            Object value)
```
    Overrides:
    
    set in class DfareportingRequest<DirectorySitesListResponse>

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

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProfileId

setProfileId

getAcceptsInStreamVideoPlacements

setAcceptsInStreamVideoPlacements

getAcceptsInterstitialPlacements

setAcceptsInterstitialPlacements

getAcceptsPublisherPaidPlacements

setAcceptsPublisherPaidPlacements

getActive

setActive

getDfpNetworkCode

setDfpNetworkCode

getIds

setIds

getMaxResults

setMaxResults

getPageToken

setPageToken

getSearchString

setSearchString

getSortField

setSortField

getSortOrder

setSortOrder

set