YouTubeAnalytics.Reports.Query (YouTube Analytics API v2 (Rev. 272) 1.25.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.youtubeAnalytics.v2.YouTubeAnalyticsRequest<QueryResponse>
        
        com.google.api.services.youtubeAnalytics.v2.YouTubeAnalytics.Reports.Query

All Implemented Interfaces:

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

Enclosing class:

YouTubeAnalytics.Reports
```
public class YouTubeAnalytics.Reports.Query
extends YouTubeAnalyticsRequest<QueryResponse>
```

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 Query()
Retrieve your YouTube Analytics reports.

Constructors
Modifier	Constructor and Description
`protected`	`Query()` Retrieve your YouTube Analytics reports.

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()`
`java.lang.String`	`getCurrency()` The currency to which financial metrics should be converted.
`java.lang.String`	`getDimensions()` A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`.
`java.lang.String`	`getEndDate()` The end date for fetching YouTube Analytics data.
`java.lang.String`	`getFilters()` A list of filters that should be applied when retrieving YouTube Analytics data.
`java.lang.String`	`getIds()` Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
`java.lang.Boolean`	`getIncludeHistoricalChannelData()` If set to true historical data (i.e.
`java.lang.Integer`	`getMaxResults()` The maximum number of rows to include in the response.", minValue: 1
`java.lang.String`	`getMetrics()` A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`.
`java.lang.String`	`getSort()` A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data.
`java.lang.String`	`getStartDate()` The start date for fetching YouTube Analytics data.
`java.lang.Integer`	`getStartIndex()` An index of the first entity to retrieve.
`YouTubeAnalytics.Reports.Query`	`set(java.lang.String parameterName, java.lang.Object value)`
`YouTubeAnalytics.Reports.Query`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`YouTubeAnalytics.Reports.Query`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`YouTubeAnalytics.Reports.Query`	`setAlt(java.lang.String alt)` Data format for response.
`YouTubeAnalytics.Reports.Query`	`setCallback(java.lang.String callback)` JSONP
`YouTubeAnalytics.Reports.Query`	`setCurrency(java.lang.String currency)` The currency to which financial metrics should be converted.
`YouTubeAnalytics.Reports.Query`	`setDimensions(java.lang.String dimensions)` A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`.
`YouTubeAnalytics.Reports.Query`	`setEndDate(java.lang.String endDate)` The end date for fetching YouTube Analytics data.
`YouTubeAnalytics.Reports.Query`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`YouTubeAnalytics.Reports.Query`	`setFilters(java.lang.String filters)` A list of filters that should be applied when retrieving YouTube Analytics data.
`YouTubeAnalytics.Reports.Query`	`setIds(java.lang.String ids)` Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
`YouTubeAnalytics.Reports.Query`	`setIncludeHistoricalChannelData(java.lang.Boolean includeHistoricalChannelData)` If set to true historical data (i.e.
`YouTubeAnalytics.Reports.Query`	`setKey(java.lang.String key)` API key.
`YouTubeAnalytics.Reports.Query`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of rows to include in the response.", minValue: 1
`YouTubeAnalytics.Reports.Query`	`setMetrics(java.lang.String metrics)` A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`.
`YouTubeAnalytics.Reports.Query`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`YouTubeAnalytics.Reports.Query`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`YouTubeAnalytics.Reports.Query`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`YouTubeAnalytics.Reports.Query`	`setSort(java.lang.String sort)` A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data.
`YouTubeAnalytics.Reports.Query`	`setStartDate(java.lang.String startDate)` The start date for fetching YouTube Analytics data.
`YouTubeAnalytics.Reports.Query`	`setStartIndex(java.lang.Integer startIndex)` An index of the first entity to retrieve.
`YouTubeAnalytics.Reports.Query`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`YouTubeAnalytics.Reports.Query`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.youtubeAnalytics.v2.YouTubeAnalyticsRequest
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, 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
  - Query
```
protected Query()
```
    Retrieve your YouTube Analytics reports. Create a request for the method "reports.query". This request holds the parameters needed by the the youtubeAnalytics server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    YouTubeAnalytics.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    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<QueryResponse>
    
    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<QueryResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public YouTubeAnalytics.Reports.Query set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class YouTubeAnalyticsRequest<QueryResponse>
  - setAccessToken
```
public YouTubeAnalytics.Reports.Query setAccessToken(java.lang.String accessToken)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class YouTubeAnalyticsRequest<QueryResponse>
  - setAlt
```
public YouTubeAnalytics.Reports.Query setAlt(java.lang.String alt)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class YouTubeAnalyticsRequest<QueryResponse>
  - setCallback
```
public YouTubeAnalytics.Reports.Query setCallback(java.lang.String callback)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class YouTubeAnalyticsRequest<QueryResponse>
  - setFields
```
public YouTubeAnalytics.Reports.Query setFields(java.lang.String fields)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class YouTubeAnalyticsRequest<QueryResponse>
  - setKey
```
public YouTubeAnalytics.Reports.Query setKey(java.lang.String key)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    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 YouTubeAnalyticsRequest<QueryResponse>
  - setOauthToken
```
public YouTubeAnalytics.Reports.Query setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class YouTubeAnalyticsRequest<QueryResponse>
  - setPrettyPrint
```
public YouTubeAnalytics.Reports.Query setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class YouTubeAnalyticsRequest<QueryResponse>
  - setQuotaUser
```
public YouTubeAnalytics.Reports.Query setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    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 YouTubeAnalyticsRequest<QueryResponse>
  - setUploadType
```
public YouTubeAnalytics.Reports.Query setUploadType(java.lang.String uploadType)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class YouTubeAnalyticsRequest<QueryResponse>
  - setUploadProtocol
```
public YouTubeAnalytics.Reports.Query setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: YouTubeAnalyticsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class YouTubeAnalyticsRequest<QueryResponse>
  - getSort
```
public java.lang.String getSort()
```
    A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+
  - setSort
```
public YouTubeAnalytics.Reports.Query setSort(java.lang.String sort)
```
    A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+
  - getStartDate
```
public java.lang.String getStartDate()
```
    The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}
  - setStartDate
```
public YouTubeAnalytics.Reports.Query setStartDate(java.lang.String startDate)
```
    The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}
  - getMetrics
```
public java.lang.String getMetrics()
```
    A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+
  - setMetrics
```
public YouTubeAnalytics.Reports.Query setMetrics(java.lang.String metrics)
```
    A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+
  - getIds
```
public java.lang.String getIds()
```
    Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
  - setIds
```
public YouTubeAnalytics.Reports.Query setIds(java.lang.String ids)
```
    Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
  - getIncludeHistoricalChannelData
```
public java.lang.Boolean getIncludeHistoricalChannelData()
```
    If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
  - setIncludeHistoricalChannelData
```
public YouTubeAnalytics.Reports.Query setIncludeHistoricalChannelData(java.lang.Boolean includeHistoricalChannelData)
```
    If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
  - getCurrency
```
public java.lang.String getCurrency()
```
    The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}
  - setCurrency
```
public YouTubeAnalytics.Reports.Query setCurrency(java.lang.String currency)
```
    The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}
  - getStartIndex
```
public java.lang.Integer getStartIndex()
```
    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1
  - setStartIndex
```
public YouTubeAnalytics.Reports.Query setStartIndex(java.lang.Integer startIndex)
```
    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1
  - getDimensions
```
public java.lang.String getDimensions()
```
    A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+
  - setDimensions
```
public YouTubeAnalytics.Reports.Query setDimensions(java.lang.String dimensions)
```
    A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+
  - getEndDate
```
public java.lang.String getEndDate()
```
    The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}
  - setEndDate
```
public YouTubeAnalytics.Reports.Query setEndDate(java.lang.String endDate)
```
    The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of rows to include in the response.", minValue: 1
  - setMaxResults
```
public YouTubeAnalytics.Reports.Query setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of rows to include in the response.", minValue: 1
  - getFilters
```
public java.lang.String getFilters()
```
    A list of filters that should be applied when retrieving YouTube Analytics data. The [Available Reports](/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.",
  - setFilters
```
public YouTubeAnalytics.Reports.Query setFilters(java.lang.String filters)
```
    A list of filters that should be applied when retrieving YouTube Analytics data. The [Available Reports](/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.",
  - set
```
public YouTubeAnalytics.Reports.Query set(java.lang.String parameterName,
                                          java.lang.Object value)
```
    Overrides:
    
    set in class YouTubeAnalyticsRequest<QueryResponse>

YouTube Analytics API v2 (revision 272)

Class YouTubeAnalytics.Reports.Query

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.youtubeAnalytics.v2.YouTubeAnalyticsRequest

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

Query

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSort

setSort

getStartDate

setStartDate

getMetrics

setMetrics

getIds

setIds

getIncludeHistoricalChannelData

setIncludeHistoricalChannelData

getCurrency

setCurrency

getStartIndex

setStartIndex

getDimensions

setDimensions

getEndDate

setEndDate

getMaxResults

setMaxResults

getFilters

setFilters

set