analytics  v3
Public Member Functions | Static Public Attributes | List of all members
google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod Class Reference

#include <analytics_service.h>

Inheritance diagram for google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod:
google_analytics_api::AnalyticsServiceBaseRequest

Public Member Functions

 ManagementResource_UploadsResource_UploadDataMethod (const AnalyticsService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &account_id, const absl::string_view &web_property_id, const absl::string_view &custom_data_source_id, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_)
 
virtual ~ManagementResource_UploadsResource_UploadDataMethod ()
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
util::Status ExecuteAndParseResponse (Upload *data)
 
- Public Member Functions inherited from google_analytics_api::AnalyticsServiceBaseRequest
 AnalyticsServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~AnalyticsServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 

Static Public Attributes

static const client::MediaUploadSpec SIMPLE_MEDIA_UPLOAD
 
static const client::MediaUploadSpec RESUMABLE_MEDIA_UPLOAD
 

Additional Inherited Members

- Protected Member Functions inherited from google_analytics_api::AnalyticsServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the uploadData method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/analytics https://www.googleapis.com/auth/analytics.edit

Constructor & Destructor Documentation

◆ ManagementResource_UploadsResource_UploadDataMethod()

google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::ManagementResource_UploadsResource_UploadDataMethod ( const AnalyticsService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  account_id,
const absl::string_view &  web_property_id,
const absl::string_view &  custom_data_source_id,
const StringPiece &  _media_content_type_,
client::DataReader *  _media_content_reader_ 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]account_idAccount Id associated with the upload.
[in]web_property_idWeb property UA-string associated with the upload.
[in]custom_data_source_idCustom data source Id to which the data being uploaded belongs.
[in]<em>media_content_type</em>The content type of the data in the media_content_reader.
[in]<em>media_content_reader</em>The media content to uploadData. If this is NULL then do not upload any media and ignore media_content_type.

◆ ~ManagementResource_UploadsResource_UploadDataMethod()

google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::~ManagementResource_UploadsResource_UploadDataMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendVariable()

util::Status google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_analytics_api::AnalyticsServiceBaseRequest.

◆ ExecuteAndParseResponse()

util::Status google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::ExecuteAndParseResponse ( Upload data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

Member Data Documentation

◆ RESUMABLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::RESUMABLE_MEDIA_UPLOAD
static

Returns the specification for media upload using the resumable protocol.

◆ SIMPLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_analytics_api::ManagementResource_UploadsResource_UploadDataMethod::SIMPLE_MEDIA_UPLOAD
static

Returns MediaUploader for uploading the content. Returns the specification for media upload using the simple protocol.


The documentation for this class was generated from the following files: