Uploads: deleteUploadData

Requires authorization

Delete data associated with a previous upload. 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

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData

Parameters

Parameter name Value Description
Path parameters
accountId string Account Id for the uploads to be deleted.
customDataSourceId string Custom data source Id for the uploads to be deleted.
webPropertyId string Web property Id for the uploads to be deleted.

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

Request body

In the request body, supply data with the following structure:

{
  "customDataImportUids": [
    string
  ]
}
Property name Value Description Notes
customDataImportUids[] list A list of upload UIDs.

Response

If successful, this method returns an empty 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.
 */


// Construct a list of file ids to delete.
List<String> filesToDelete = Arrays.asList("ZYXABC123zyxabc",
    "lmnopEFGXYZ123a", "999AAA888bbb777");

// Construct the body of the Delete Request and set the file ids.
AnalyticsDataimportDeleteUploadDataRequest body = new
    AnalyticsDataimportDeleteUploadDataRequest();
body.setCustomDataImportUids(filesToDelete);

// This request deletes three uploaded files for the authorized user.
try {
  analytics.management().uploads().deleteUploadData("123456",
      "UA-123456-1", "122333444455555", body).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.
 */

// Construct a list of upload ids to delete.
$uploadIds = array('ABBCCCDDDDEEEEE');

// Construct the body of the Delete Request and set the upload ids.
$body = new
    Google_Service_Analytics_AnalyticsDataimportDeleteUploadDataRequest();
$body->setCustomDataImportUids($uploadIds);

// This request deletes the uploads.
try {
  $uploads = $analytics->management_uploads->deleteUploadData('123456',
      'UA-123456-1', '122333444455555', $body);

} 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 deletes a list of uploads.
try:
  analytics.management().uploads().deleteUploadData(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customDataSourceId='ABCDEFG123456abcdefg',
      body={
          'customDataImportUids': ['ZYXABC123zyxabc',
                                   'lmnopEFGXYZ123a',
                                   '999AAA888bbb777']
      }
  ).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 deletes a list of existing uploads.
 */
function deleteUploads() {
  var request = gapi.client.analytics.management.uploads.deleteUploadData({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1',
    'customDataSourceId': 'ABCDEFG123abcDEF123',
    'resource': {
      'customDataImportUids': ['AAABBBCCCDDD111222',
                               'xLh4wXtzQT6uxe-_OWelog']
    }
  });
  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.