Custom Data Sources: list

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Memerlukan otorisasi

Mencantumkan sumber data kustom yang aksesnya dimiliki oleh pengguna. Coba sekarang atau lihat contoh.

Selain parameter standar, metode ini mendukung parameter yang tercantum dalam tabel parameter.

Permintaan

Permintaan HTTP

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

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
accountId string ID Akun untuk sumber data kustom yang akan diambil.
webPropertyId string ID properti web untuk sumber data khusus yang akan diambil.
Parameter kueri opsional
max-results integer Jumlah maksimum sumber data kustom untuk disertakan dalam respons ini.
start-index integer Indeks berbasis 1 dari sumber data kustom pertama yang akan diambil. Gunakan parameter ini sebagai mekanisme penomoran halaman bersama dengan parameter hasil maksimal.

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

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

Isi permintaan

Jangan menyediakan isi permintaan dengan metode ini.

Tanggapan

Jika berhasil, metode ini menampilkan isi respons dengan struktur berikut:

{
  "kind": "analytics#customDataSources",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customDataSources Resource
  ]
}
Nama properti Nilai Deskripsi Catatan
kind string Jenis koleksi.
username string ID email pengguna yang diautentikasi
totalResults integer Jumlah total hasil untuk kueri, berapa pun jumlah hasil dalam respons.
startIndex integer Indeks awal resource, yaitu 1 secara default atau ditentukan oleh parameter kueri indeks awal.
itemsPerPage integer Jumlah maksimum resource yang dapat dimuat respons, berapa pun jumlah resource sebenarnya yang ditampilkan. Nilainya berkisar dari 1 hingga 1000 dengan nilai 1000 secara default, atau ditentukan oleh parameter kueri hasil maksimal.
items[] list Kumpulan sumber data kustom.

Contoh

Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).

Java

Menggunakan library klien 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 customDataSources for the authorized user.
 */
try {
  CustomDataSources sources = analytics.management().
      customDataSources().list("123456", "UA-123456-1").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 sources object.
 * The following code shows how to iterate through them.
 */
for (CustomDataSource source : sources.getItems()) {

  System.out.println("Account Id              = " + source.getAccountId());
  System.out.println("Property Id             = " + source.getWebPropertyId());
  System.out.println("Custom Data Source Id   = " + source.getId());
  System.out.println("Custom Data Source Kind = " + source.getKind());
  System.out.println("Custom Data Source Type = " + source.getType());
  System.out.println("Custom Data Source Name = " + source.getName());
  System.out.println("Custom Data Source Description = "
      + source.getDescription());
  System.out.println("Custom Data Source Upload Type = "
      + source.getUploadType());
  System.out.println("\n");
}

PHP

Menggunakan library klien 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 data sets for the authorized user.
 */
try {
  $dataSets = $analytics->management_customDataSources
      ->listManagementCustomDataSources('123456', 'UA-123456-1');

} 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 dataSets object.
 * The following code shows how to iterate through them.
 */
foreach ($dataSets->getItems() as $dataSet) {

  $html = <<<HTML
<pre>
Account id           = {$dataSet->getAccountId()}
Property id          = {$dataSet->getWebPropertyId()}
Data set id          = {$dataSet->getId()}
Data set kind        = {$dataSet->getKind()}
Data set type        = {$dataSet->getType()}
Data set name        = {$dataSet->getName()}
Data set description = {$dataSet->getDescription()}
Data set upload type = {$dataSet->getUploadType()}
</pre>

HTML;
  print $html;
}

Python

Menggunakan library klien Python.

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

# Example #1:
# Requests a list of all customDataSources for the authorized user.
try:
  custom_data_sources = analytics.management().customDataSources().list(
      accountId='123456',
      webPropertyId='UA-123456-1',
  ).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 custom_data_sources object.
# The following code shows how to iterate through them.
for custom_data_source in custom_data_sources.get('items', []):
  print 'Account ID = %s' % custom_data_source.get('accountId')
  print 'Property ID = %s' % custom_data_source.get('webPropertyId')
  print 'Custom Data Source ID = %s' % custom_data_source.get('id')
  print 'Custom Data Source Kind = %s' % custom_data_source.get('kind')
  print 'Custom Data Source Type = %s' % custom_data_source.get('type')
  print 'Custom Data Source Name = %s' % custom_data_source.get('name')
  print 'Custom Data Source Description = %s' % custom_data_source.get('description')
  print 'Custom Data Source uploadType = %s' % custom_data_source.get('uploadType')

  print 'Linked Views (Profiles):'
  for profile in custom_data_source.get('profilesLinked', []):
    print '  View (Profile) ID = %s' % profile

  print 'Created = %s' % custom_data_source.get('created')
  print 'Updated = %s\n' % custom_data_source.get('updated')

JavaScript

Menggunakan library klien 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 data sets for the authorized user.
 */
function listCustomDataSources() {
  var request = gapi.client.analytics.management.customDataSources.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1'
  });
  request.execute(printCustomDataSources);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printCustomDataSources(results) {
  if (results && !results.error) {
    var datasets = results.items;
    for (var i = 0, dataset; dataset = datasets[i]; i++) {
      console.log('Account Id: ' + dataset.accountId);
      console.log('Property Id: ' + dataset.webPropertyId);
      console.log('Dataset Id: ' + dataset.id);
      console.log('Dataset Kind: ' + dataset.kind);
      console.log('Dataset Name: ' + dataset.name);
      console.log('Dataset Description: ' + dataset.description);
      console.log('Dataset uploadType: ' + dataset.uploadType);

      // Iterate through the linked views (profiles).
      var profiles = dataset.profilesLinked;
      if (profiles) {
        for (var j = 0, profile; profile = profiles[j]; j++) {
          console.log('Linked view (profile) Id: ' + profile);
        }
      }
    }
  }
}

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat responsnya. Atau, coba Penjelajah mandiri.