Аккаунты: метод list

Выводит список всех доступных пользователю аккаунтов. Испытайте его в действии или изучите готовый пример.

Помимо стандартных параметров, этот метод поддерживает перечисленные в таблице ниже.

Запрос

HTTP-запрос

GET https://www.googleapis.com/analytics/v3/management/accounts

Параметры

Название параметра	Значение	Описание
Необязательные параметры запроса
`max-results`	`integer`	Максимальное количество аккаунтов, которые будут включены в ответ.
`start-index`	`integer`	Индекс первого извлекаемого аккаунта. Используется совместно с параметром `max-results` для разбиения результатов на страницы.

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее...

Область доступа
`https://www.googleapis.com/auth/analytics`
`https://www.googleapis.com/auth/analytics.edit`
`https://www.googleapis.com/auth/analytics.readonly`

Тело запроса

При работе с данным методом тело запроса не используется.

Ответ

В случае успеха метод возвращает тело ответа со следующей структурой:

{
  "kind": "analytics#accounts",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.accounts Resource
  ]
}

Название свойства	Значение	Описание
`kind`	`string`	Тип коллекции. Значение: "`analytics#accounts`".
`username`	`string`	Электронный адрес пользователя, прошедшего аутентификацию.
`totalResults`	`integer`	Общее число результатов запроса, не зависящее от числа результатов в ответе.
`startIndex`	`integer`	Индекс первой извлекаемой записи. По умолчанию равен 1 и может задаваться с помощью параметра запроса `start-index`.
`itemsPerPage`	`integer`	Максимальное число записей, включаемых в ответ независимо от числа фактически возвращаемых записей. Задается с помощью параметра `max-results` в диапазоне от 1 до 1000 (значение по умолчанию).
`previousLink`	`string`	Предыдущая ссылка для этой коллекции аккаунта.
`nextLink`	`string`	Следующая ссылка для этой коллекции аккаунта.
`items[]`	`list`	Список аккаунтов.

Примеры

Примечание. Примеры кода для этого метода не охватывают все поддерживаемые языки программирования (их список опубликован на странице, посвященной клиентским библиотекам).

Java

Используется клиентская библиотека Java.

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

/**
 * Example #1:
 * Requests a list of all accounts for the authorized user.
 */
try {
  Accounts accounts = analytics.management.accounts.list().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 accounts object.
 * The following code shows how to iterate through them.
 */
for (Account account : accounts.getItems()) {
  System.out.println("Account ID: " + account.getId());
  System.out.println("Account Name: " + account.getName());
  System.out.println("Account Created: " + account.getCreated());
  System.out.println("Account Updated: " + account.getUpdated());
}

PHP

Используется клиентская библиотека PHP.

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

/**
 * Example #1:
 * Requests a list of all accounts for the authorized user.
 */
try {
  $accounts = $analytics->management_accounts->listManagementAccounts();
} 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 accounts object.
 * The following code shows how to iterate through them.
 */
foreach ($accounts->getItems() as $account) {
  $html = <<<HTML
<pre>
Account id   = {$account->getId()}
Account name = {$account->getName()}
Created      = {$account->getCreated()}
Updated      = {$account->getUpdated()}
</pre>
HTML;
  print $html;
}

Python

Используется клиентская библиотека Python.

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

# Example #1:
# Requests a list of all accounts for the authorized user.
try:
  accounts = analytics.management().accounts().list().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 accounts object.
# The following code shows how to iterate through them.
for account in accounts_response.get('items', []):
  print 'Account ID      = %s' % account.get('id')
  print 'Account Name    = %s' % account.get('name')
  print 'Created         = %s' % account.get('created')
  print 'Updated         = %s' % account.get('updated')

JavaScript

Используется клиентская библиотека JavaScript.

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

/*
 * Example 1:
 * Requests a list of all accounts for the authorized user.
 */
function listAccounts() {
  var request = gapi.client.analytics.management.accounts.list();
  request.execute(printAccounts);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printAccounts(results) {
  if (results && !results.error) {
    var accounts = results.items;
    for (var i = 0, account; account = accounts[i]; i++) {
      console.log('Account Id: ' + account.id);
      console.log('Account Kind: ' + account.kind);
      console.log('Account Name: ' + account.name);
      console.log('Account Created: ' + account.created);
      console.log('Account Updated: ' + account.updated);
    }
  }
}

Практическое занятие

Воспользуйтесь инструментом API Explorer ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает. Также можно перейти на эту страницу.