com.google.api.services.youtubeAnalytics

Class YouTubeAnalytics.Reports.Query

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

com.google.api.services.youtubeAnalytics.YouTubeAnalytics.Reports.Query

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTubeAnalytics.Reports

public class YouTubeAnalytics.Reports.Query
extends YouTubeAnalyticsRequest<ResultTable>

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	Query(String ids, String startDate, String endDate, String metrics) Retrieve your YouTube Analytics reports.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getCurrency() The currency to which financial metrics should be converted.
String	getDimensions() A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender.
String	getEndDate() The end date for fetching YouTube Analytics data.
String	getFilters() A list of filters that should be applied when retrieving YouTube Analytics data.
String	getIds() Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
Boolean	getIncludeHistoricalChannelData() If set to true historical data (i.e.
Integer	getMaxResults() The maximum number of rows to include in the response.
String	getMetrics() A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes.
String	getSort() A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data.
String	getStartDate() The start date for fetching YouTube Analytics data.
Integer	getStartIndex() An index of the first entity to retrieve.
YouTubeAnalytics.Reports.Query	set(String parameterName, Object value)
YouTubeAnalytics.Reports.Query	setAlt(String alt) Data format for the response.
YouTubeAnalytics.Reports.Query	setCurrency(String currency) The currency to which financial metrics should be converted.
YouTubeAnalytics.Reports.Query	setDimensions(String dimensions) A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender.
YouTubeAnalytics.Reports.Query	setEndDate(String endDate) The end date for fetching YouTube Analytics data.
YouTubeAnalytics.Reports.Query	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTubeAnalytics.Reports.Query	setFilters(String filters) A list of filters that should be applied when retrieving YouTube Analytics data.
YouTubeAnalytics.Reports.Query	setIds(String ids) Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
YouTubeAnalytics.Reports.Query	setIncludeHistoricalChannelData(Boolean includeHistoricalChannelData) If set to true historical data (i.e.
YouTubeAnalytics.Reports.Query	setKey(String key) API key.
YouTubeAnalytics.Reports.Query	setMaxResults(Integer maxResults) The maximum number of rows to include in the response.
YouTubeAnalytics.Reports.Query	setMetrics(String metrics) A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes.
YouTubeAnalytics.Reports.Query	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTubeAnalytics.Reports.Query	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTubeAnalytics.Reports.Query	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTubeAnalytics.Reports.Query	setSort(String sort) A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data.
YouTubeAnalytics.Reports.Query	setStartDate(String startDate) The start date for fetching YouTube Analytics data.
YouTubeAnalytics.Reports.Query	setStartIndex(Integer startIndex) An index of the first entity to retrieve.
YouTubeAnalytics.Reports.Query	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.youtubeAnalytics.YouTubeAnalyticsRequest

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

Query

protected Query(String ids,
                String startDate,
                String endDate,
                String metrics)

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.

Parameters:

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.

startDate - The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

endDate - The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

metrics - A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.

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<ResultTable>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ResultTable>

Throws:

IOException

setAlt

public YouTubeAnalytics.Reports.Query setAlt(String alt)

Description copied from class: YouTubeAnalyticsRequest

Data format for the response.

Overrides:

setAlt in class YouTubeAnalyticsRequest<ResultTable>

setFields

public YouTubeAnalytics.Reports.Query setFields(String fields)

Description copied from class: YouTubeAnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeAnalyticsRequest<ResultTable>

setKey

public YouTubeAnalytics.Reports.Query setKey(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<ResultTable>

setOauthToken

public YouTubeAnalytics.Reports.Query setOauthToken(String oauthToken)

Description copied from class: YouTubeAnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeAnalyticsRequest<ResultTable>

setPrettyPrint

public YouTubeAnalytics.Reports.Query setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeAnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeAnalyticsRequest<ResultTable>

setQuotaUser

public YouTubeAnalytics.Reports.Query setQuotaUser(String quotaUser)

Description copied from class: YouTubeAnalyticsRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeAnalyticsRequest<ResultTable>

setUserIp

public YouTubeAnalytics.Reports.Query setUserIp(String userIp)

Description copied from class: YouTubeAnalyticsRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeAnalyticsRequest<ResultTable>

getIds

public 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.

setIds

public YouTubeAnalytics.Reports.Query setIds(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.

getStartDate

public String getStartDate()

The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

setStartDate

public YouTubeAnalytics.Reports.Query setStartDate(String startDate)

The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

getEndDate

public String getEndDate()

The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

setEndDate

public YouTubeAnalytics.Reports.Query setEndDate(String endDate)

The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

getMetrics

public String getMetrics()

A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.

setMetrics

public YouTubeAnalytics.Reports.Query setMetrics(String metrics)

A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.

getCurrency

public 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.

setCurrency

public YouTubeAnalytics.Reports.Query setCurrency(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.

getDimensions

public String getDimensions()

A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.

setDimensions

public YouTubeAnalytics.Reports.Query setDimensions(String dimensions)

A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.

getFilters

public String getFilters()

A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions 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(String filters)

A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions 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.

getIncludeHistoricalChannelData

public 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(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.

getMaxResults

public Integer getMaxResults()

The maximum number of rows to include in the response. [minimum: 1]

setMaxResults

public YouTubeAnalytics.Reports.Query setMaxResults(Integer maxResults)

The maximum number of rows to include in the response.

getSort

public 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.

setSort

public YouTubeAnalytics.Reports.Query setSort(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.

getStartIndex

public 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). [minimum: 1]

setStartIndex

public YouTubeAnalytics.Reports.Query setStartIndex(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).

set

public YouTubeAnalytics.Reports.Query set(String parameterName,
                                          Object value)

Overrides:

set in class YouTubeAnalyticsRequest<ResultTable>