Analytics.Management.Segments.List (Google Analytics API v2.4 (Rev. 134) 1.23.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.analytics.AnalyticsRequest<java.lang.Void>
        
        com.google.api.services.analytics.Analytics.Management.Segments.List

All Implemented Interfaces:

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

Enclosing class:

Analytics.Management.Segments
```
public class Analytics.Management.Segments.List
extends AnalyticsRequest<java.lang.Void>
```

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 List()
Lists advanced segments to which the user has access.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Lists advanced segments to which the user has access.

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.Integer`	`getMaxResults()` The maximum number of advanced segments to include in this response.
`java.lang.Integer`	`getStartIndex()` An index of the first advanced segment to retrieve.
`Analytics.Management.Segments.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Analytics.Management.Segments.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Analytics.Management.Segments.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Analytics.Management.Segments.List`	`setKey(java.lang.String key)` API key.
`Analytics.Management.Segments.List`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of advanced segments to include in this response.
`Analytics.Management.Segments.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Analytics.Management.Segments.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Analytics.Management.Segments.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Analytics.Management.Segments.List`	`setStartIndex(java.lang.Integer startIndex)` An index of the first advanced segment to retrieve.
`Analytics.Management.Segments.List`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.analytics.AnalyticsRequest
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
  - List
```
protected List()
```
    Lists advanced segments to which the user has access. Create a request for the method "segments.list". This request holds the parameters needed by the the analytics server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Analytics.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<java.lang.Void>
    
    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<java.lang.Void>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Analytics.Management.Segments.List setAlt(java.lang.String alt)
```
    Description copied from class: AnalyticsRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class AnalyticsRequest<java.lang.Void>
  - setFields
```
public Analytics.Management.Segments.List setFields(java.lang.String fields)
```
    Description copied from class: AnalyticsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AnalyticsRequest<java.lang.Void>
  - setKey
```
public Analytics.Management.Segments.List setKey(java.lang.String key)
```
    Description copied from class: AnalyticsRequest
    
    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 AnalyticsRequest<java.lang.Void>
  - setOauthToken
```
public Analytics.Management.Segments.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: AnalyticsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AnalyticsRequest<java.lang.Void>
  - setPrettyPrint
```
public Analytics.Management.Segments.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: AnalyticsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AnalyticsRequest<java.lang.Void>
  - setQuotaUser
```
public Analytics.Management.Segments.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: AnalyticsRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class AnalyticsRequest<java.lang.Void>
  - setUserIp
```
public Analytics.Management.Segments.List setUserIp(java.lang.String userIp)
```
    Description copied from class: AnalyticsRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class AnalyticsRequest<java.lang.Void>
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of advanced segments to include in this response.
  - setMaxResults
```
public Analytics.Management.Segments.List setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of advanced segments to include in this response.
  - getStartIndex
```
public java.lang.Integer getStartIndex()
```
    An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. [minimum: 1]
  - setStartIndex
```
public Analytics.Management.Segments.List setStartIndex(java.lang.Integer startIndex)
```
    An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
  - set
```
public Analytics.Management.Segments.List set(java.lang.String parameterName,
                                              java.lang.Object value)
```
    Overrides:
    
    set in class AnalyticsRequest<java.lang.Void>

Google Analytics API v2.4 (revision 134)

Class Analytics.Management.Segments.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.analytics.AnalyticsRequest

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

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getMaxResults

setMaxResults

getStartIndex

setStartIndex

set