Uploads: get

Requires authorization

List uploads to which the user has access. Try it now or see an example.

In addition to the standard parameters, this method supports the parameters listed in the parameters table.

Request

HTTP request

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId

Parameters

Parameter name Value Description
Path parameters
accountId string Account Id for the upload to retrieve.
customDataSourceId string Custom data source Id for upload to retrieve.
uploadId string Upload Id to retrieve.
webPropertyId string Web property Id for the upload to retrieve.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an Uploads resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Data Import Developer Guide for details.
 */


// This request gets an upload for the authorized user.
try {
  analytics.management().uploads().get("123456", "UA-123456-1",
      "122333444455555", "ABBCCCDDDDEEEEE").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Uses the PHP client library.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Data Import Developer Guide for details.
 */

// This request gets an upload for the authorized user.
try {
  $uploads = $analytics->management_uploads->get('123456', 'UA-123456-1',
      '122333444455555', 'ABBCCCDDDDEEEEE');

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.
# See the Data Import Developer Guide for details.

# This request gets an upload object with a particular uploadId.
try:
  upload = analytics.management().uploads().get(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customDataSourceId='abcdefg1234567',
      uploadId='AAABBBCCCDDD111222'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Uses the JavaScript client library.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Data Import Developer Guide for details.
 */

/*
 * This request gets an existing upload.
 */
function getUpload() {
  var request = gapi.client.analytics.management.uploads.get({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1',
    'customDataSourceId': 'ABCDEFG123abcDEF123',
    'uploadId': 'AAABBBCCCDDD111222'
  });
  request.execute(function (response) { // Handle the response. });
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.