Script.Projects.GetMetrics (Apps Script API v1 (Rev. 214) 1.21.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.script.ScriptRequest<Metrics>
        
        com.google.api.services.script.Script.Projects.GetMetrics

All Implemented Interfaces:

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

Enclosing class:

Script.Projects
```
public class Script.Projects.GetMetrics
extends ScriptRequest<Metrics>
```

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 GetMetrics(java.lang.String scriptId)
Get metrics data for scripts, such as number of executions and active users.

Constructors
Modifier	Constructor and Description
`protected`	`GetMetrics(java.lang.String scriptId)` Get metrics data for scripts, such as number of executions and active users.

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.String`	`getMetricsFilterDeploymentId()` Optional field indicating a specific deployment to retrieve metrics from.
`java.lang.String`	`getMetricsGranularity()` Required field indicating what granularity of metrics are returned.
`java.lang.String`	`getScriptId()` Required field indicating the script to get metrics for.
`Script.Projects.GetMetrics`	`set(java.lang.String parameterName, java.lang.Object value)`
`Script.Projects.GetMetrics`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Script.Projects.GetMetrics`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Script.Projects.GetMetrics`	`setAlt(java.lang.String alt)` Data format for response.
`Script.Projects.GetMetrics`	`setCallback(java.lang.String callback)` JSONP
`Script.Projects.GetMetrics`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Script.Projects.GetMetrics`	`setKey(java.lang.String key)` API key.
`Script.Projects.GetMetrics`	`setMetricsFilterDeploymentId(java.lang.String metricsFilterDeploymentId)` Optional field indicating a specific deployment to retrieve metrics from.
`Script.Projects.GetMetrics`	`setMetricsGranularity(java.lang.String metricsGranularity)` Required field indicating what granularity of metrics are returned.
`Script.Projects.GetMetrics`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Script.Projects.GetMetrics`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Script.Projects.GetMetrics`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Script.Projects.GetMetrics`	`setScriptId(java.lang.String scriptId)` Required field indicating the script to get metrics for.
`Script.Projects.GetMetrics`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Script.Projects.GetMetrics`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.script.ScriptRequest
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, 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
  - GetMetrics
```
protected GetMetrics(java.lang.String scriptId)
```
    Get metrics data for scripts, such as number of executions and active users. Create a request for the method "projects.getMetrics". This request holds the parameters needed by the the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Script.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    scriptId - Required field indicating the script to get metrics for.
    
    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<Metrics>
    
    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<Metrics>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public Script.Projects.GetMetrics set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: ScriptRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ScriptRequest<Metrics>
  - setAccessToken
```
public Script.Projects.GetMetrics setAccessToken(java.lang.String accessToken)
```
    Description copied from class: ScriptRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ScriptRequest<Metrics>
  - setAlt
```
public Script.Projects.GetMetrics setAlt(java.lang.String alt)
```
    Description copied from class: ScriptRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ScriptRequest<Metrics>
  - setCallback
```
public Script.Projects.GetMetrics setCallback(java.lang.String callback)
```
    Description copied from class: ScriptRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ScriptRequest<Metrics>
  - setFields
```
public Script.Projects.GetMetrics setFields(java.lang.String fields)
```
    Description copied from class: ScriptRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ScriptRequest<Metrics>
  - setKey
```
public Script.Projects.GetMetrics setKey(java.lang.String key)
```
    Description copied from class: ScriptRequest
    
    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 ScriptRequest<Metrics>
  - setOauthToken
```
public Script.Projects.GetMetrics setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: ScriptRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ScriptRequest<Metrics>
  - setPrettyPrint
```
public Script.Projects.GetMetrics setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: ScriptRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ScriptRequest<Metrics>
  - setQuotaUser
```
public Script.Projects.GetMetrics setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: ScriptRequest
    
    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 ScriptRequest<Metrics>
  - setUploadType
```
public Script.Projects.GetMetrics setUploadType(java.lang.String uploadType)
```
    Description copied from class: ScriptRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ScriptRequest<Metrics>
  - setUploadProtocol
```
public Script.Projects.GetMetrics setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: ScriptRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ScriptRequest<Metrics>
  - getScriptId
```
public java.lang.String getScriptId()
```
    Required field indicating the script to get metrics for.
  - setScriptId
```
public Script.Projects.GetMetrics setScriptId(java.lang.String scriptId)
```
    Required field indicating the script to get metrics for.
  - getMetricsGranularity
```
public java.lang.String getMetricsGranularity()
```
    Required field indicating what granularity of metrics are returned.
  - setMetricsGranularity
```
public Script.Projects.GetMetrics setMetricsGranularity(java.lang.String metricsGranularity)
```
    Required field indicating what granularity of metrics are returned.
  - getMetricsFilterDeploymentId
```
public java.lang.String getMetricsFilterDeploymentId()
```
    Optional field indicating a specific deployment to retrieve metrics from.
  - setMetricsFilterDeploymentId
```
public Script.Projects.GetMetrics setMetricsFilterDeploymentId(java.lang.String metricsFilterDeploymentId)
```
    Optional field indicating a specific deployment to retrieve metrics from.
  - set
```
public Script.Projects.GetMetrics set(java.lang.String parameterName,
                                      java.lang.Object value)
```
    Overrides:
    
    set in class ScriptRequest<Metrics>

Apps Script API v1 (revision 214)

Class Script.Projects.GetMetrics

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.script.ScriptRequest

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

GetMetrics

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getScriptId

setScriptId

getMetricsGranularity

setMetricsGranularity

getMetricsFilterDeploymentId

setMetricsFilterDeploymentId

set