com.google.api.services.youtubeAnalytics.v2.model

Class QueryResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtubeAnalytics.v2.model.QueryResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class QueryResponse
extends GenericJson

Response message for TargetedQueriesService.Query.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the YouTube Analytics API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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>

Constructor Summary

Constructors

Constructor and Description
QueryResponse()

Method Summary

Modifier and Type	Method and Description
QueryResponse	clone()
List<ResultTableColumnHeader>	getColumnHeaders() This value specifies information about the data returned in the `rows` fields.
Errors	getErrors() When set, indicates that the operation failed.
String	getKind() This value specifies the type of data included in the API response.
List<List<Object>>	getRows() The list contains all rows of the result table.
QueryResponse	set(String fieldName, Object value)
QueryResponse	setColumnHeaders(List<ResultTableColumnHeader> columnHeaders) This value specifies information about the data returned in the `rows` fields.
QueryResponse	setErrors(Errors errors) When set, indicates that the operation failed.
QueryResponse	setKind(String kind) This value specifies the type of data included in the API response.
QueryResponse	setRows(List<List<Object>> rows) The list contains all rows of the result table.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

QueryResponse

public QueryResponse()

Method Detail

getColumnHeaders

public List<ResultTableColumnHeader> getColumnHeaders()

This value specifies information about the data returned in the `rows` fields. Each item in the `columnHeaders` list identifies a field returned in the `rows` value, which contains a list of comma-delimited data. The `columnHeaders` list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters `dimensions=ageGroup,gender=viewerPercentage`, the API response will return columns in this order: `ageGroup`, `gender`, `viewerPercentage`.

Returns:

value or null for none

setColumnHeaders

public QueryResponse setColumnHeaders(List<ResultTableColumnHeader> columnHeaders)

This value specifies information about the data returned in the `rows` fields. Each item in the `columnHeaders` list identifies a field returned in the `rows` value, which contains a list of comma-delimited data. The `columnHeaders` list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters `dimensions=ageGroup,gender=viewerPercentage`, the API response will return columns in this order: `ageGroup`, `gender`, `viewerPercentage`.

Parameters:

columnHeaders - columnHeaders or null for none

getErrors

public Errors getErrors()

When set, indicates that the operation failed.

Returns:

value or null for none

setErrors

public QueryResponse setErrors(Errors errors)

When set, indicates that the operation failed.

Parameters:

errors - errors or null for none

getKind

public String getKind()

This value specifies the type of data included in the API response. For the query method, the kind property value will be `youtubeAnalytics#resultTable`.

Returns:

value or null for none

setKind

public QueryResponse setKind(String kind)

This value specifies the type of data included in the API response. For the query method, the kind property value will be `youtubeAnalytics#resultTable`.

Parameters:

kind - kind or null for none

getRows

public List<List<Object>> getRows()

The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the `columnHeaders` field. If no data is available for the given query, the `rows` element will be omitted from the response. The response for a query with the `day` dimension will not contain rows for the most recent days.

Returns:

value or null for none

setRows

public QueryResponse setRows(List<List<Object>> rows)

The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the `columnHeaders` field. If no data is available for the given query, the `rows` element will be omitted from the response. The response for a query with the `day` dimension will not contain rows for the most recent days.

Parameters:

rows - rows or null for none

set

public QueryResponse set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public QueryResponse clone()

Overrides:

clone in class GenericJson