target.apidocs.com.google.api.services.analytics.model.CustomDimensions.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-analytics Show documentation

There is a newer version: v3-rev20190807-2.0.0

Show newest version







CustomDimensions (Google Analytics API v3-rev20190604-1.30.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.analytics.model
Class CustomDimensions



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.analytics.model.CustomDimensions













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




public final class CustomDimensions
extends GenericJson
A custom dimension collection lists Analytics custom dimensions to which the user has access.
 Each resource in the collection corresponds to a single Analytics custom dimension.

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


CustomDimensions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CustomDimensions
clone() 


List<CustomDimension>
getItems()
Collection of custom dimensions.



Integer
getItemsPerPage()
The maximum number of resources the response can contain, regardless of the actual number of
 resources returned.



String
getKind()
Collection type.



String
getNextLink()
Link to next page for this custom dimension collection.



String
getPreviousLink()
Link to previous page for this custom dimension collection.



Integer
getStartIndex()
The starting index of the resources, which is 1 by default or otherwise specified by the start-
 index query parameter.



Integer
getTotalResults()
The total number of results for the query, regardless of the number of results in the response.



String
getUsername()
Email ID of the authenticated user



CustomDimensions
set(String fieldName,
   Object value) 


CustomDimensions
setItems(List<CustomDimension> items)
Collection of custom dimensions.



CustomDimensions
setItemsPerPage(Integer itemsPerPage)
The maximum number of resources the response can contain, regardless of the actual number of
 resources returned.



CustomDimensions
setKind(String kind)
Collection type.



CustomDimensions
setNextLink(String nextLink)
Link to next page for this custom dimension collection.



CustomDimensions
setPreviousLink(String previousLink)
Link to previous page for this custom dimension collection.



CustomDimensions
setStartIndex(Integer startIndex)
The starting index of the resources, which is 1 by default or otherwise specified by the start-
 index query parameter.



CustomDimensions
setTotalResults(Integer totalResults)
The total number of results for the query, regardless of the number of results in the response.



CustomDimensions
setUsername(String username)
Email ID of the authenticated user







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





CustomDimensions
public CustomDimensions()









Method Detail





getItems
public List<CustomDimension> getItems()
Collection of custom dimensions.

Returns:
value or null for none








setItems
public CustomDimensions setItems(List<CustomDimension> items)
Collection of custom dimensions.

Parameters:
items - items or null for none








getItemsPerPage
public Integer getItemsPerPage()
The maximum number of resources the response can contain, regardless of the actual number of
 resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or
 otherwise specified by the max-results query parameter.

Returns:
value or null for none








setItemsPerPage
public CustomDimensions setItemsPerPage(Integer itemsPerPage)
The maximum number of resources the response can contain, regardless of the actual number of
 resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or
 otherwise specified by the max-results query parameter.

Parameters:
itemsPerPage - itemsPerPage or null for none








getKind
public String getKind()
Collection type.

Returns:
value or null for none








setKind
public CustomDimensions setKind(String kind)
Collection type.

Parameters:
kind - kind or null for none








getNextLink
public String getNextLink()
Link to next page for this custom dimension collection.

Returns:
value or null for none








setNextLink
public CustomDimensions setNextLink(String nextLink)
Link to next page for this custom dimension collection.

Parameters:
nextLink - nextLink or null for none








getPreviousLink
public String getPreviousLink()
Link to previous page for this custom dimension collection.

Returns:
value or null for none








setPreviousLink
public CustomDimensions setPreviousLink(String previousLink)
Link to previous page for this custom dimension collection.

Parameters:
previousLink - previousLink or null for none








getStartIndex
public Integer getStartIndex()
The starting index of the resources, which is 1 by default or otherwise specified by the start-
 index query parameter.

Returns:
value or null for none








setStartIndex
public CustomDimensions setStartIndex(Integer startIndex)
The starting index of the resources, which is 1 by default or otherwise specified by the start-
 index query parameter.

Parameters:
startIndex - startIndex or null for none








getTotalResults
public Integer getTotalResults()
The total number of results for the query, regardless of the number of results in the response.

Returns:
value or null for none








setTotalResults
public CustomDimensions setTotalResults(Integer totalResults)
The total number of results for the query, regardless of the number of results in the response.

Parameters:
totalResults - totalResults or null for none








getUsername
public String getUsername()
Email ID of the authenticated user

Returns:
value or null for none








setUsername
public CustomDimensions setUsername(String username)
Email ID of the authenticated user

Parameters:
username - username or null for none








set
public CustomDimensions set(String fieldName,
                            Object value)

Overrides:
set in class GenericJson








clone
public CustomDimensions clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2019 Google. All rights reserved.

Modifier and Type	Method and Description
`CustomDimensions`	`clone()`
`List<CustomDimension>`	`getItems()` Collection of custom dimensions.
`Integer`	`getItemsPerPage()` The maximum number of resources the response can contain, regardless of the actual number of resources returned.
`String`	`getKind()` Collection type.
`String`	`getNextLink()` Link to next page for this custom dimension collection.
`String`	`getPreviousLink()` Link to previous page for this custom dimension collection.
`Integer`	`getStartIndex()` The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
`Integer`	`getTotalResults()` The total number of results for the query, regardless of the number of results in the response.
`String`	`getUsername()` Email ID of the authenticated user
`CustomDimensions`	`set(String fieldName, Object value)`
`CustomDimensions`	`setItems(List<CustomDimension> items)` Collection of custom dimensions.
`CustomDimensions`	`setItemsPerPage(Integer itemsPerPage)` The maximum number of resources the response can contain, regardless of the actual number of resources returned.
`CustomDimensions`	`setKind(String kind)` Collection type.
`CustomDimensions`	`setNextLink(String nextLink)` Link to next page for this custom dimension collection.
`CustomDimensions`	`setPreviousLink(String previousLink)` Link to previous page for this custom dimension collection.
`CustomDimensions`	`setStartIndex(Integer startIndex)` The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
`CustomDimensions`	`setTotalResults(Integer totalResults)` The total number of results for the query, regardless of the number of results in the response.
`CustomDimensions`	`setUsername(String username)` Email ID of the authenticated user