Reports.EntityUsageReports.Get (Admin SDK API reports

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.reports.ReportsRequest<UsageReports>
        
        com.google.api.services.reports.Reports.EntityUsageReports.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Reports.EntityUsageReports
```
public class Reports.EntityUsageReports.Get
extends ReportsRequest<UsageReports>
```

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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Get(String entityType, String entityKey, String date)` Retrieves a report which is a collection of properties and statistics for entities used by users within the account.

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()`
`String`	`getCustomerId()` The unique ID of the customer to retrieve data for.
`String`	`getDate()` Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time).
`String`	`getEntityKey()` Represents the key of the object to filter the data with.
`String`	`getEntityType()` Represents the type of entity for the report.
`String`	`getFilters()` The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator.
`Long`	`getMaxResults()` Determines how many activity records are shown on each response page.
`String`	`getPageToken()` Token to specify next page.
`String`	`getParameters()` The `parameters` query string is a comma-separated list of event parameters that refine a report's results.
`Reports.EntityUsageReports.Get`	`set(String parameterName, Object value)`
`Reports.EntityUsageReports.Get`	`set$Xgafv(String $Xgafv)` V1 error format.
`Reports.EntityUsageReports.Get`	`setAccessToken(String accessToken)` OAuth access token.
`Reports.EntityUsageReports.Get`	`setAlt(String alt)` Data format for response.
`Reports.EntityUsageReports.Get`	`setCallback(String callback)` JSONP
`Reports.EntityUsageReports.Get`	`setCustomerId(String customerId)` The unique ID of the customer to retrieve data for.
`Reports.EntityUsageReports.Get`	`setDate(String date)` Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time).
`Reports.EntityUsageReports.Get`	`setEntityKey(String entityKey)` Represents the key of the object to filter the data with.
`Reports.EntityUsageReports.Get`	`setEntityType(String entityType)` Represents the type of entity for the report.
`Reports.EntityUsageReports.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Reports.EntityUsageReports.Get`	`setFilters(String filters)` The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator.
`Reports.EntityUsageReports.Get`	`setKey(String key)` API key.
`Reports.EntityUsageReports.Get`	`setMaxResults(Long maxResults)` Determines how many activity records are shown on each response page.
`Reports.EntityUsageReports.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Reports.EntityUsageReports.Get`	`setPageToken(String pageToken)` Token to specify next page.
`Reports.EntityUsageReports.Get`	`setParameters(String parameters)` The `parameters` query string is a comma-separated list of event parameters that refine a report's results.
`Reports.EntityUsageReports.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Reports.EntityUsageReports.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Reports.EntityUsageReports.Get`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Reports.EntityUsageReports.Get`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.reports.ReportsRequest
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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - Get
```
protected Get(String entityType,
              String entityKey,
              String date)
```
    Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides. Create a request for the method "entityUsageReports.get". This request holds the parameters needed by the the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Reports.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    entityType - Represents the type of entity for the report.
    
    entityKey - Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.
    
    date - Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
    
    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<UsageReports>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<UsageReports>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Reports.EntityUsageReports.Get set$Xgafv(String $Xgafv)
```
    Description copied from class: ReportsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ReportsRequest<UsageReports>
  - setAccessToken
```
public Reports.EntityUsageReports.Get setAccessToken(String accessToken)
```
    Description copied from class: ReportsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ReportsRequest<UsageReports>
  - setAlt
```
public Reports.EntityUsageReports.Get setAlt(String alt)
```
    Description copied from class: ReportsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ReportsRequest<UsageReports>
  - setCallback
```
public Reports.EntityUsageReports.Get setCallback(String callback)
```
    Description copied from class: ReportsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ReportsRequest<UsageReports>
  - setFields
```
public Reports.EntityUsageReports.Get setFields(String fields)
```
    Description copied from class: ReportsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ReportsRequest<UsageReports>
  - setKey
```
public Reports.EntityUsageReports.Get setKey(String key)
```
    Description copied from class: ReportsRequest
    
    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 ReportsRequest<UsageReports>
  - setOauthToken
```
public Reports.EntityUsageReports.Get setOauthToken(String oauthToken)
```
    Description copied from class: ReportsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ReportsRequest<UsageReports>
  - setPrettyPrint
```
public Reports.EntityUsageReports.Get setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ReportsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ReportsRequest<UsageReports>
  - setQuotaUser
```
public Reports.EntityUsageReports.Get setQuotaUser(String quotaUser)
```
    Description copied from class: ReportsRequest
    
    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 ReportsRequest<UsageReports>
  - setUploadType
```
public Reports.EntityUsageReports.Get setUploadType(String uploadType)
```
    Description copied from class: ReportsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ReportsRequest<UsageReports>
  - setUploadProtocol
```
public Reports.EntityUsageReports.Get setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ReportsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ReportsRequest<UsageReports>
  - getEntityType
```
public String getEntityType()
```
    Represents the type of entity for the report.
  - setEntityType
```
public Reports.EntityUsageReports.Get setEntityType(String entityType)
```
    Represents the type of entity for the report.
  - getEntityKey
```
public String getEntityKey()
```
    Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.
  - setEntityKey
```
public Reports.EntityUsageReports.Get setEntityKey(String entityKey)
```
    Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.
  - getDate
```
public String getDate()
```
    Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.
  - setDate
```
public Reports.EntityUsageReports.Get setDate(String date)
```
    Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm- dd`.
  - getCustomerId
```
public String getCustomerId()
```
    The unique ID of the customer to retrieve data for.
  - setCustomerId
```
public Reports.EntityUsageReports.Get setCustomerId(String customerId)
```
    The unique ID of the customer to retrieve data for.
  - getFilters
```
public String getFilters()
```
    The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.
  - setFilters
```
public Reports.EntityUsageReports.Get setFilters(String filters)
```
    The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL- encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.
  - getMaxResults
```
public Long getMaxResults()
```
    Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. [default: 1000] [minimum: 1] [maximum: 1000]
  - setMaxResults
```
public Reports.EntityUsageReports.Get setMaxResults(Long maxResults)
```
    Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page.
  - getPageToken
```
public String getPageToken()
```
    Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
  - setPageToken
```
public Reports.EntityUsageReports.Get setPageToken(String pageToken)
```
    Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
  - getParameters
```
public String getParameters()
```
    The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.
  - setParameters
```
public Reports.EntityUsageReports.Get setParameters(String parameters)
```
    The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.
  - set
```
public Reports.EntityUsageReports.Get set(String parameterName,
                                          Object value)
```
    Overrides:
    
    set in class ReportsRequest<UsageReports>

Class Reports.EntityUsageReports.Get

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.reports.ReportsRequest

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

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getEntityType

setEntityType

getEntityKey

setEntityKey

getDate

setDate

getCustomerId

setCustomerId

getFilters

setFilters

getMaxResults

setMaxResults

getPageToken

setPageToken

getParameters

setParameters

set