Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Analytics_ManagementUploads_Resource Class Reference

The "uploads" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementUploads_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 deleteUploadData ($accountId, $webPropertyId, $customDataSourceId, Google_Service_Analytics_AnalyticsDataimportDeleteUploadDataRequest $postBody, $optParams=array())
 Delete data associated with a previous upload.
 
 get ($accountId, $webPropertyId, $customDataSourceId, $uploadId, $optParams=array())
 List uploads to which the user has access.
 
 listManagementUploads ($accountId, $webPropertyId, $customDataSourceId, $optParams=array())
 List uploads to which the user has access.
 
 uploadData ($accountId, $webPropertyId, $customDataSourceId, $optParams=array())
 Upload data for a custom data source.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "uploads" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $uploads = $analyticsService->uploads;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ deleteUploadData()

Google_Service_Analytics_ManagementUploads_Resource::deleteUploadData ( $accountId,
$webPropertyId,
$customDataSourceId,
Google_Service_Analytics_AnalyticsDataimportDeleteUploadDataRequest $postBody,
$optParams = array() )

Delete data associated with a previous upload.

(uploads.deleteUploadData)

Parameters
string$accountIdAccount Id for the uploads to be deleted.
string$webPropertyIdWeb property Id for the uploads to be deleted.
string$customDataSourceIdCustom data source Id for the uploads to be deleted.
Google_AnalyticsDataimportDeleteUploadDataRequest$postBody
array$optParamsOptional parameters.

◆ get()

Google_Service_Analytics_ManagementUploads_Resource::get ( $accountId,
$webPropertyId,
$customDataSourceId,
$uploadId,
$optParams = array() )

List uploads to which the user has access.

(uploads.get)

Parameters
string$accountIdAccount Id for the upload to retrieve.
string$webPropertyIdWeb property Id for the upload to retrieve.
string$customDataSourceIdCustom data source Id for upload to retrieve.
string$uploadIdUpload Id to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Upload

◆ listManagementUploads()

Google_Service_Analytics_ManagementUploads_Resource::listManagementUploads ( $accountId,
$webPropertyId,
$customDataSourceId,
$optParams = array() )

List uploads to which the user has access.

(uploads.listManagementUploads)

Parameters
string$accountIdAccount Id for the uploads to retrieve.
string$webPropertyIdWeb property Id for the uploads to retrieve.
string$customDataSourceIdCustom data source Id for uploads to retrieve.
array$optParamsOptional parameters.

@opt_param int max-results The maximum number of uploads to include in this response. @opt_param int start-index A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Return values
Google_Service_Analytics_Uploads

◆ uploadData()

Google_Service_Analytics_ManagementUploads_Resource::uploadData ( $accountId,
$webPropertyId,
$customDataSourceId,
$optParams = array() )

Upload data for a custom data source.

(uploads.uploadData)

Parameters
string$accountIdAccount Id associated with the upload.
string$webPropertyIdWeb property UA-string associated with the upload.
string$customDataSourceIdCustom data source Id to which the data being uploaded belongs.
array$optParamsOptional parameters.
Return values
Google_Service_Analytics_Upload

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