Специальные параметры: метод list

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Требуется авторизация

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

Запрос

HTTP-запрос

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

Параметры

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

Авторизация

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

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

Тело запроса

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

Ответ

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

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

Примеры

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

Java

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

/**
 * Note: This code assumes you have an authorized Analytics service object.
 */

/**
 * This request lists all custom dimensions for the authorized user.
 */
try {
  CustomDimensions dimensions = analytics.management.customDimensions
      .list("12345", "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/**
 * The results of the list method are stored in the dimensions object.
 * The following code shows how to iterate through them.
 */
for (CustomDimension dimension : dimensions.getItems()) {
  System.out.println("Dimension Kind: " + dimension.getKind());
  System.out.println("Dimension Id: " + dimension.getId());
  System.out.println("Account ID: " + dimension.getAccountId());
  System.out.println("Property ID: " + dimension.getWebPropertyId());
  System.out.println("Dimension Name: " + dimension.getName());
  System.out.println("Dimension Index: " + dimension.getIndex());
  System.out.println("Dimension Scope: " + dimension.getScope());
  System.out.println("Dimension Active: " + dimension.getActive());
  System.out.println("Dimension Created: " + dimension.getCreated());
  System.out.println("Dimension Updated: " + dimension.getUpdated());
}

Python

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

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom dimensions for the authorized user.
try:
  dimensions = analytics.management().customDimensions().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))

# The results of the list method are stored in the dimensions object.
# The following code shows how to iterate through them.
for dimension in dimensions.get('items', []):
  print 'Dimension Kind = %s' % dimension.get('kind')
  print 'Dimension Id = %s' % dimension.get('id')
  print 'Account ID = %s' % dimension.get('accountId')
  print 'Property ID = %s' % dimension.get('webPropertyId')
  print 'Dimension Name = %s' % dimension.get('name')
  print 'Dimension Index = %s' % dimension.get('index')
  print 'Dimension Scope = %s' % dimension.get('scope')
  print 'Dimension Active = %s' % dimension.get('active')
  print 'Dimension Created = %s' % dimension.get('created')
  print 'Dimension Updated = %s' % dimension.get('updated')

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

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