Google Analytics API v3 (revision 41)

com.google.api.services.analytics
Class Analytics.Management.DailyUploads.Upload

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.analytics.AnalyticsRequest<DailyUploadAppend>
                      com.google.api.services.analytics.Analytics.Management.DailyUploads.Upload

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Management.DailyUploads

public class Analytics.Management.DailyUploads.Upload
extends AnalyticsRequest<DailyUploadAppend>

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

protected	Analytics.Management.DailyUploads.Upload(String accountId, String webPropertyId, String customDataSourceId, String date, Integer appendNumber, String type) Update/Overwrite data for a custom data source.
protected	Analytics.Management.DailyUploads.Upload(String accountId, String webPropertyId, String customDataSourceId, String date, Integer appendNumber, String type, AbstractInputStreamContent mediaContent) Update/Overwrite data for a custom data source.

Method Summary

String	getAccountId() Account Id associated with daily upload.
Integer	getAppendNumber() Append number for this upload indexed from 1.
String	getCustomDataSourceId() Custom data source Id to which the data being uploaded belongs.
String	getDate() Date for which data is uploaded.
Boolean	getReset() Reset/Overwrite all previous appends for this date and start over with this file as the first upload.
String	getType() Type of data for this upload.
String	getWebPropertyId() Web property Id associated with daily upload.
boolean	isReset() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Analytics.Management.DailyUploads.Upload	set(String parameterName, Object value)
Analytics.Management.DailyUploads.Upload	setAccountId(String accountId) Account Id associated with daily upload.
Analytics.Management.DailyUploads.Upload	setAlt(String alt) Data format for the response.
Analytics.Management.DailyUploads.Upload	setAppendNumber(Integer appendNumber) Append number for this upload indexed from 1.
Analytics.Management.DailyUploads.Upload	setCustomDataSourceId(String customDataSourceId) Custom data source Id to which the data being uploaded belongs.
Analytics.Management.DailyUploads.Upload	setDate(String date) Date for which data is uploaded.
Analytics.Management.DailyUploads.Upload	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.DailyUploads.Upload	setKey(String key) API key.
Analytics.Management.DailyUploads.Upload	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.DailyUploads.Upload	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.DailyUploads.Upload	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Management.DailyUploads.Upload	setReset(Boolean reset) Reset/Overwrite all previous appends for this date and start over with this file as the first upload.
Analytics.Management.DailyUploads.Upload	setType(String type) Type of data for this upload.
Analytics.Management.DailyUploads.Upload	setUserIp(String userIp) IP address of the site where the request originates.
Analytics.Management.DailyUploads.Upload	setWebPropertyId(String webPropertyId) Web property Id associated with daily upload.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Constructor Detail

Analytics.Management.DailyUploads.Upload

protected Analytics.Management.DailyUploads.Upload(String accountId,
                                                   String webPropertyId,
                                                   String customDataSourceId,
                                                   String date,
                                                   Integer appendNumber,
                                                   String type)

Update/Overwrite data for a custom data source. Create a request for the method "dailyUploads.upload". 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.

Parameters:

accountId - Account Id associated with daily upload.

webPropertyId - Web property Id associated with daily upload.

customDataSourceId - Custom data source Id to which the data being uploaded belongs.

date - Date for which data is uploaded. Date should be formatted as YYYY-MM-DD.

appendNumber - Append number for this upload indexed from 1. [minimum: 1] [maximum: 20]

type - Type of data for this upload.

Since:

1.13

Analytics.Management.DailyUploads.Upload

protected Analytics.Management.DailyUploads.Upload(String accountId,
                                                   String webPropertyId,
                                                   String customDataSourceId,
                                                   String date,
                                                   Integer appendNumber,
                                                   String type,
                                                   AbstractInputStreamContent mediaContent)

Update/Overwrite data for a custom data source. Create a request for the method "dailyUploads.upload". 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.

This constructor should be used for uploading media content.

Parameters:

accountId - Account Id associated with daily upload.@param webPropertyId Web property Id associated with daily upload.@param customDataSourceId Custom data source Id to which the data being uploaded belongs.@param date Date for which data is uploaded. Date should be formatted as YYYY-MM-DD.@param appendNumber Append number for this upload indexed from 1. [minimum: 1] [maximum: 20]@param type Type of data for this upload.

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public Analytics.Management.DailyUploads.Upload setAlt(String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<DailyUploadAppend>

setFields

public Analytics.Management.DailyUploads.Upload setFields(String fields)

Description copied from class: AnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsRequest<DailyUploadAppend>

setKey

public Analytics.Management.DailyUploads.Upload setKey(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<DailyUploadAppend>

setOauthToken

public Analytics.Management.DailyUploads.Upload setOauthToken(String oauthToken)

Description copied from class: AnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsRequest<DailyUploadAppend>

setPrettyPrint

public Analytics.Management.DailyUploads.Upload setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<DailyUploadAppend>

setQuotaUser

public Analytics.Management.DailyUploads.Upload setQuotaUser(String quotaUser)

Description copied from class: AnalyticsRequest

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 userIp if both are provided.

Overrides:

setQuotaUser in class AnalyticsRequest<DailyUploadAppend>

setUserIp

public Analytics.Management.DailyUploads.Upload setUserIp(String userIp)

Description copied from class: AnalyticsRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class AnalyticsRequest<DailyUploadAppend>

getAccountId

public String getAccountId()

Account Id associated with daily upload.

setAccountId

public Analytics.Management.DailyUploads.Upload setAccountId(String accountId)

Account Id associated with daily upload.

getWebPropertyId

public String getWebPropertyId()

Web property Id associated with daily upload.

setWebPropertyId

public Analytics.Management.DailyUploads.Upload setWebPropertyId(String webPropertyId)

Web property Id associated with daily upload.

getCustomDataSourceId

public String getCustomDataSourceId()

Custom data source Id to which the data being uploaded belongs.

setCustomDataSourceId

public Analytics.Management.DailyUploads.Upload setCustomDataSourceId(String customDataSourceId)

Custom data source Id to which the data being uploaded belongs.

getDate

public String getDate()

Date for which data is uploaded. Date should be formatted as YYYY-MM-DD.

setDate

public Analytics.Management.DailyUploads.Upload setDate(String date)

Date for which data is uploaded. Date should be formatted as YYYY-MM-DD.

getAppendNumber

public Integer getAppendNumber()

Append number for this upload indexed from 1. [minimum: 1] [maximum: 20]

setAppendNumber

public Analytics.Management.DailyUploads.Upload setAppendNumber(Integer appendNumber)

Append number for this upload indexed from 1.

getType

public String getType()

Type of data for this upload.

setType

public Analytics.Management.DailyUploads.Upload setType(String type)

Type of data for this upload.

getReset

public Boolean getReset()

Reset/Overwrite all previous appends for this date and start over with this file as the first upload. [default: false]

setReset

public Analytics.Management.DailyUploads.Upload setReset(Boolean reset)

Reset/Overwrite all previous appends for this date and start over with this file as the first upload.

isReset

public boolean isReset()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Reset/Overwrite all previous appends for this date and start over with this file as the first upload.

set

public Analytics.Management.DailyUploads.Upload set(String parameterName,
                                                    Object value)

Overrides:

set in class AnalyticsRequest<DailyUploadAppend>