Google Analytics API . management . uploads

Instance Methods

deleteUploadData(accountId=*, webPropertyId=*, customDataSourceId=*, body=None)

Delete data associated with a previous upload.

get(accountId=*, webPropertyId=*, customDataSourceId=*, uploadId=*)

List uploads to which the user has access.

list(accountId=*, webPropertyId=*, customDataSourceId=*, max_results=None, start_index=None)

List uploads to which the user has access.

uploadData(accountId=*, webPropertyId=*, customDataSourceId=*, media_body=None, media_mime_type=None)

Upload data for a custom data source.

Method Details

deleteUploadData(accountId=*, webPropertyId=*, customDataSourceId=*, body=None)
Delete data associated with a previous upload.

Args:
  accountId: string, Account Id for the uploads to be deleted. (required)
  webPropertyId: string, Web property Id for the uploads to be deleted. (required)
  customDataSourceId: string, Custom data source Id for the uploads to be deleted. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request template for the delete upload data request.
    "customDataImportUids": [ # A list of upload UIDs.
      "A String",
    ],
  }

get(accountId=*, webPropertyId=*, customDataSourceId=*, uploadId=*)
List uploads to which the user has access.

Args:
  accountId: string, Account Id for the upload to retrieve. (required)
  webPropertyId: string, Web property Id for the upload to retrieve. (required)
  customDataSourceId: string, Custom data source Id for upload to retrieve. (required)
  uploadId: string, Upload Id to retrieve. (required)

Returns:
  An object of the form:

    { # Metadata returned for an upload operation.
    "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
    "uploadTime": "A String", # Time this file is uploaded.
    "errors": [ # Data import errors collection.
      "A String",
    ],
    "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
    "kind": "analytics#upload", # Resource type for Analytics upload.
    "id": "A String", # A unique ID for this upload.
    "accountId": "A String", # Account Id to which this upload belongs.
  }
list(accountId=*, webPropertyId=*, customDataSourceId=*, max_results=None, start_index=None)
List uploads to which the user has access.

Args:
  accountId: string, Account Id for the uploads to retrieve. (required)
  webPropertyId: string, Web property Id for the uploads to retrieve. (required)
  customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
  max_results: integer, The maximum number of uploads to include in this response.
  start_index: integer, A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.
    "kind": "analytics#uploads", # Collection type.
    "items": [ # A list of uploads.
      { # Metadata returned for an upload operation.
        "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
        "uploadTime": "A String", # Time this file is uploaded.
        "errors": [ # Data import errors collection.
          "A String",
        ],
        "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
        "kind": "analytics#upload", # Resource type for Analytics upload.
        "id": "A String", # A unique ID for this upload.
        "accountId": "A String", # Account Id to which this upload belongs.
      },
    ],
    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
    "previousLink": "A String", # Link to previous page for this upload collection.
    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
    "nextLink": "A String", # Link to next page for this upload collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
  }
uploadData(accountId=*, webPropertyId=*, customDataSourceId=*, media_body=None, media_mime_type=None)
Upload data for a custom data source.

Args:
  accountId: string, Account Id associated with the upload. (required)
  webPropertyId: string, Web property UA-string associated with the upload. (required)
  customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # Metadata returned for an upload operation.
    "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
    "uploadTime": "A String", # Time this file is uploaded.
    "errors": [ # Data import errors collection.
      "A String",
    ],
    "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
    "kind": "analytics#upload", # Resource type for Analytics upload.
    "id": "A String", # A unique ID for this upload.
    "accountId": "A String", # Account Id to which this upload belongs.
  }