DisplayVideo.Partners.Channels.Sites.List (Display & Video 360 API v4-rev20260505-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.displayvideo.v4.DisplayVideoRequest<ListSitesResponse>
        
        com.google.api.services.displayvideo.v4.DisplayVideo.Partners.Channels.Sites.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Partners.Channels.Sites
```
public class DisplayVideo.Partners.Channels.Sites.List
extends DisplayVideoRequest<ListSitesResponse>
```

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 partnerId, Long channelId)
Lists sites in a channel.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long partnerId, Long channelId)` Lists sites in a channel.

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()`
`Long`	`getAdvertiserId()` The ID of the advertiser that owns the parent channel.
`Long`	`getChannelId()` Required.
`String`	`getFilter()` Allows filtering by site fields.
`String`	`getOrderBy()` Field by which to sort the list.
`Integer`	`getPageSize()` Requested page size.
`String`	`getPageToken()` A token identifying a page of results the server should return.
`Long`	`getPartnerId()` The ID of the partner that owns the parent channel.
`DisplayVideo.Partners.Channels.Sites.List`	`set(String parameterName, Object value)`
`DisplayVideo.Partners.Channels.Sites.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`DisplayVideo.Partners.Channels.Sites.List`	`setAccessToken(String accessToken)` OAuth access token.
`DisplayVideo.Partners.Channels.Sites.List`	`setAdvertiserId(Long advertiserId)` The ID of the advertiser that owns the parent channel.
`DisplayVideo.Partners.Channels.Sites.List`	`setAlt(String alt)` Data format for response.
`DisplayVideo.Partners.Channels.Sites.List`	`setCallback(String callback)` JSONP
`DisplayVideo.Partners.Channels.Sites.List`	`setChannelId(Long channelId)` Required.
`DisplayVideo.Partners.Channels.Sites.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`DisplayVideo.Partners.Channels.Sites.List`	`setFilter(String filter)` Allows filtering by site fields.
`DisplayVideo.Partners.Channels.Sites.List`	`setKey(String key)` API key.
`DisplayVideo.Partners.Channels.Sites.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`DisplayVideo.Partners.Channels.Sites.List`	`setOrderBy(String orderBy)` Field by which to sort the list.
`DisplayVideo.Partners.Channels.Sites.List`	`setPageSize(Integer pageSize)` Requested page size.
`DisplayVideo.Partners.Channels.Sites.List`	`setPageToken(String pageToken)` A token identifying a page of results the server should return.
`DisplayVideo.Partners.Channels.Sites.List`	`setPartnerId(Long partnerId)` The ID of the partner that owns the parent channel.
`DisplayVideo.Partners.Channels.Sites.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`DisplayVideo.Partners.Channels.Sites.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`DisplayVideo.Partners.Channels.Sites.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`DisplayVideo.Partners.Channels.Sites.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v4.DisplayVideoRequest
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 partnerId,
               Long channelId)
```
    Lists sites in a channel. Create a request for the method "sites.list". This request holds the parameters needed by the the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    DisplayVideo.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    partnerId - The ID of the partner that owns the parent channel.
    
    channelId - Required. The ID of the parent channel to which the requested sites belong.
    
    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<ListSitesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListSitesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public DisplayVideo.Partners.Channels.Sites.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DisplayVideoRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DisplayVideoRequest<ListSitesResponse>
  - setAccessToken
```
public DisplayVideo.Partners.Channels.Sites.List setAccessToken(String accessToken)
```
    Description copied from class: DisplayVideoRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DisplayVideoRequest<ListSitesResponse>
  - setAlt
```
public DisplayVideo.Partners.Channels.Sites.List setAlt(String alt)
```
    Description copied from class: DisplayVideoRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DisplayVideoRequest<ListSitesResponse>
  - setCallback
```
public DisplayVideo.Partners.Channels.Sites.List setCallback(String callback)
```
    Description copied from class: DisplayVideoRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DisplayVideoRequest<ListSitesResponse>
  - setFields
```
public DisplayVideo.Partners.Channels.Sites.List setFields(String fields)
```
    Description copied from class: DisplayVideoRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DisplayVideoRequest<ListSitesResponse>
  - setKey
```
public DisplayVideo.Partners.Channels.Sites.List setKey(String key)
```
    Description copied from class: DisplayVideoRequest
    
    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 DisplayVideoRequest<ListSitesResponse>
  - setOauthToken
```
public DisplayVideo.Partners.Channels.Sites.List setOauthToken(String oauthToken)
```
    Description copied from class: DisplayVideoRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DisplayVideoRequest<ListSitesResponse>
  - setPrettyPrint
```
public DisplayVideo.Partners.Channels.Sites.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DisplayVideoRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DisplayVideoRequest<ListSitesResponse>
  - setQuotaUser
```
public DisplayVideo.Partners.Channels.Sites.List setQuotaUser(String quotaUser)
```
    Description copied from class: DisplayVideoRequest
    
    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 DisplayVideoRequest<ListSitesResponse>
  - setUploadType
```
public DisplayVideo.Partners.Channels.Sites.List setUploadType(String uploadType)
```
    Description copied from class: DisplayVideoRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DisplayVideoRequest<ListSitesResponse>
  - setUploadProtocol
```
public DisplayVideo.Partners.Channels.Sites.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DisplayVideoRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DisplayVideoRequest<ListSitesResponse>
  - getPartnerId
```
public Long getPartnerId()
```
    The ID of the partner that owns the parent channel.
  - setPartnerId
```
public DisplayVideo.Partners.Channels.Sites.List setPartnerId(Long partnerId)
```
    The ID of the partner that owns the parent channel.
  - getChannelId
```
public Long getChannelId()
```
    Required. The ID of the parent channel to which the requested sites belong.
  - setChannelId
```
public DisplayVideo.Partners.Channels.Sites.List setChannelId(Long channelId)
```
    Required. The ID of the parent channel to which the requested sites belong.
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    The ID of the advertiser that owns the parent channel.
  - setAdvertiserId
```
public DisplayVideo.Partners.Channels.Sites.List setAdvertiserId(Long advertiserId)
```
    The ID of the advertiser that owns the parent channel.
  - getFilter
```
public String getFilter()
```
    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display- video/api/guides/how-tos/filters) guide for more information.
  - setFilter
```
public DisplayVideo.Partners.Channels.Sites.List setFilter(String filter)
```
    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how- tos/filters) guide for more information.
  - getOrderBy
```
public String getOrderBy()
```
    Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
  - setOrderBy
```
public DisplayVideo.Partners.Channels.Sites.List setOrderBy(String orderBy)
```
    Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
  - getPageSize
```
public Integer getPageSize()
```
    Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
  - setPageSize
```
public DisplayVideo.Partners.Channels.Sites.List setPageSize(Integer pageSize)
```
    Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
  - getPageToken
```
public String getPageToken()
```
    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
  - setPageToken
```
public DisplayVideo.Partners.Channels.Sites.List setPageToken(String pageToken)
```
    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
  - set
```
public DisplayVideo.Partners.Channels.Sites.List set(String parameterName,
                                                     Object value)
```
    Overrides:
    
    set in class DisplayVideoRequest<ListSitesResponse>

Class DisplayVideo.Partners.Channels.Sites.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.displayvideo.v4.DisplayVideoRequest

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

getPartnerId

setPartnerId

getChannelId

setChannelId

getAdvertiserId

setAdvertiserId

getFilter

setFilter

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

set