Uploads: list

需要授權

列出使用者有權存取的上傳內容。立即試用或參閱範例。

除了標準參數以外，這個方法也支援參數表格中列出的參數。

要求

HTTP 要求

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

參數

參數名稱 值 說明
路徑參數
accountId string 要擷取的上傳項目帳戶 ID。
customDataSourceId string 要擷取的上傳項目自訂資料來源 ID。
webPropertyId string 要擷取的上傳檔案網站資源 ID。
選用查詢參數
max-results integer 要納入此回應的上傳項目數量上限。
start-index integer 要擷取的第一個上傳內容的 1 索引。請將這個參數當做分頁機制，並搭配 max-results 參數。

授權

這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。

範圍
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

要求主體

請勿使用這個方法提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "analytics#uploads",
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.uploads Resource
  ]
}
屬性名稱 值 說明 附註
kind string 集合類型。
totalResults integer 查詢的結果總數，不考慮結果中的資源數量。
startIndex integer 資源的起始索引，預設索引為 1，或透過 start-index 查詢參數指定。
itemsPerPage integer 回應可包含的資源數量上限，不受實際傳回的資源數量影響。這個函式的值範圍從 1 到 1000，且預設值為 1000，或者是由 max-results 查詢參數指定。
items[] list 上傳項目清單。

示例

注意：這個方法適用的程式語言眾多，我們只在此提供部分程式碼範例，完整的支援語言清單請參閱用戶端程式庫頁面。

Java

使用 Java 用戶端程式庫。

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

/*
 * Example #1:
 * Requests a list of all uploads for the authorized user.
 */
try {
  Uploads uploads = analytics.management().uploads().list("123456",
      "UA-123456-1", "122333444455555").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * Example #2:
 * The results of the list method are stored in the uploads object.
 * The following code shows how to iterate through them.
 */
for (Upload upload : uploads.getItems()) {
  System.out.println("Uploads Id            = " + upload.getId());
  System.out.println("Upload Kind           = " + upload.getKind());
  System.out.println("Account Id            = " + upload.getAccountId());
  System.out.println("Custom Data Source Id = " + upload.getCustomDataSourceId());
  System.out.println("Upload Status         = " + upload.getStatus() + "\n");
}

PHP

使用 PHP 用戶端程式庫。

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

/**
 * Example #1:
 * Requests a list of all uploads for the authorized user.
 */
try {
  $uploads = $analytics->management_uploads->listManagementuploads('123456',
      'UA-123456-1', '122333444455555');

} 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();
}


/**
 * Example #2:
 * The results of the list method are stored in the uploads object.
 * The following code shows how to iterate through them.
 */
foreach ($uploads->getItems() as $upload) {

  $html = <<<HTML
<pre>
Upload id     = {$upload->getId()}
Upload kind   = {$upload->getKind()}
Account id    = {$upload->getAccountId()}
Data set id   = {$upload->getCustomDataSourceId()}
Upload status = {$upload->getStatus()}
</pre>

HTML;
  print $html;
}

Python

使用 Python 用戶端程式庫。

# Note: This code assumes you have an authorized Analytics service object.
# See the Uploads Dev Guide for details.

# Example #1:
# Requests a list of all uploads for the authorized user.
try:
  uploads = analytics.management().uploads().list(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customDataSourceId='ABCDEFG123abcDEF123'
  ).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))


# Example #2:
# The results of the list method are stored in the uploads object.
# The following code shows how to iterate through them.
for upload in uploads.get('items', []):
  print 'Upload Id             = %s' % upload.get('id')
  print 'Upload Kind           = %s' % upload.get('kind')
  print 'Account Id            = %s' % upload.get('accountId')
  print 'Custom Data Source Id = %s' % upload.get('customDataSourceId')
  print 'Upload Status         = %s\n' % upload.get('status')

JavaScript

使用 JavaScript 用戶端程式庫。

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

/*
 * Example 1:
 * Requests a list of all Uploads for the authorized user.
 */
function listUploads() {
  var request = gapi.client.analytics.management.uploads.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1',
    'customDataSourceId': 'ABCDEFG123abcDEF123',
  });
  request.execute(printUploads);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printUploads(results) {
  if (results && !results.error) {
    var uploads = results.items;
    for (var i = 0, upload; upload = uploads[i]; i++) {
      console.log('Upload Id: ' + upload.id);
      console.log('Upload Kind: ' + upload.kind);
      console.log('Account Id: ' + upload.accountId);
      console.log('Data Set Id: ' + upload.customDataSourceId);
      console.log('Upload Status: ' + upload.status);
    }
  }
}

試試看！

使用下方的 APIs Explorer，針對有效資料呼叫這個方法，然後查看回應。 或者，您也可以試試獨立的 Explorer。