Чтобы переводить контент на ваш предпочитаемый язык, Google использует технологии на основе искусственного интеллекта. Переводы от ИИ могут содержать ошибки.

Примеры использования расширенных функций

В этом документе описаны некоторые продвинутые функции Google Analytics Data API версии 1. Подробную информацию об API можно найти в справочной документации.

Как получить список специальных определений и создать отчеты

Data API позволяет создавать отчеты по зарегистрированным специальным параметрам и специальным показателям. Чтобы получить список названий API для зарегистрированных специальных определений ресурса, можно использовать метод Metadata API. Эти названия API можно использовать в запросах отчетов, например в методе runReport.

В разделах ниже приведены примеры для каждого типа специальных определений. В этих примерах замените GA_PROPERTY_ID на идентификатор ресурса.

Специальные параметры на уровне события

Шаг 1. Отправьте запрос к методу Metadata API, указав идентификатор ресурса.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Шаг 2. Найдите в ответе специальный параметр на уровне события, который вы хотите использовать в отчетах. Если параметр отсутствует, зарегистрируйте его.

"dimensions": [
...
    {
      "apiName": "customEvent:achievement_id",
      "uiName": "Achievement ID",
      "description": "An event scoped custom dimension for your Analytics property."
    },
...
],

Шаг 3. Добавьте специальный параметр в запрос отчета. Ниже приведен пример запроса к методу runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "customEvent:achievement_id" }],
  "metrics": [{ "name": "eventCount" }]
}

Специальные параметры на уровне пользователя

Шаг 1. Отправьте запрос к методу Metadata API, указав идентификатор ресурса.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Шаг 2. Найдите в ответе специальный параметр на уровне пользователя, который вы хотите использовать в отчетах. Если параметр отсутствует, его нужно зарегистрировать.

"dimensions": [
...
    {
      "apiName": "customUser:last_level",
      "uiName": "Last level",
      "description": "A user property for your Analytics property."
    },
...
],

Шаг 3. Добавьте специальный параметр в запрос отчета. Ниже приведен пример запроса к методу runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "entity": { "propertyId": "GA_PROPERTY_ID" },
  "dateRanges": [{ "startDate": "7daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "customUser:last_level" }],
  "metrics": [{ "name": "activeUsers" }]
}

Специальные показатели на уровне события

Шаг 1. Отправьте запрос к методу Metadata API, указав идентификатор ресурса.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Шаг 2. Найдите в ответе специальный показатель на уровне события, который вы хотите использовать в отчетах. Если показателя нет, его нужно зарегистрировать.

"metrics": [
...
    {
      "apiName": "customEvent:credits_spent",
      "uiName": "Credits Spent",
      "description": "An event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

Шаг 3. Включите специальный показатель в запрос отчета. Ниже приведен пример запроса к методу runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "customEvent:credits_spent" }]
}

Показатели доли ключевых событий для одного ключевого события

Шаг 1. Отправьте запрос к Metadata API Method, указав идентификатор ресурса.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Шаг 2. Найдите в ответе показатель "Доля ключевых событий" для нужного ключевого события. Если ключевого события нет, настройте его.

"metrics": [
...
    {
      "apiName": "sessionKeyEventRate:add_to_cart",
      "uiName": "Session key event rate for add_to_cart",
      "description": "The percentage of sessions in which a specific key event was triggered",
    },
...
],

Шаг 3. Включите показатель доли ключевых событий в запрос отчета. Ниже приведен пример запроса к методу runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "sessionKeyEventRate:add_to_cart" }]
}

Средние значения специальных показателей на уровне события

Шаг 1. Отправьте запрос к методу Metadata API, указав идентификатор ресурса.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Шаг 2. Найдите в ответе среднее значение специального показателя на уровне события, по которому вы хотите создать отчет. Если показателя нет, его нужно зарегистрировать.

"metrics": [
...
    {
      "apiName": "averageCustomEvent:credits_spent",
      "uiName": "Average Credits Spent",
      "description": "The average of an event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

Шаг 3. Включите среднее значение специального показателя в запрос отчета. Ниже приведен пример запроса к методу runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-11-01", "endDate": "2020-11-10" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "averageCustomEvent:credits_spent" }]
}

Примеры отчетов о когорте

В отчетах о когортах создается временной ряд удержания пользователей для когорты. Подробную документацию по каждому полю API можно найти в справочнике REST по CohortSpec.

Как создать отчет о когорте

Ниже приведен пример отчета о когорте, в котором:

Когорта – это пользователи, у которых firstSessionDate имеет значение 2020-12-01. Это настраивается с помощью объекта cohorts. Параметры и показатели в ответе на запрос отчета будут основаны только на пользователях когорты.
В отчете о когорте будет три столбца, которые задаются объектами параметров и показателей.
- Параметр cohort – это название когорты.
- Параметр cohortNthDay – это количество дней с 2020-12-01.
- Показатель "cohortActiveUsers" – это количество пользователей, которые остаются активными.
Объект cohortsRange указывает, что отчет должен содержать данные о событиях, начиная с 2020-12-01 и заканчивая 2020-12-06 для этой когорты.
- Если используется детализация DAILY, то для согласованности рекомендуется параметр cohortNthDay.

Запрос отчета для когорты:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" }, { "name": "cohortNthDay" }],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-12-01", "endDate": "2020-12-01" }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "DAILY"
    }
  },
}

Пример ответа на этот запрос:

{
  "dimensionHeaders": [
    { "name": "cohort" }, { "name": "cohortNthDay" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "293" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "143" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "123" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "92" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0005" }],
      "metricValues": [{ "value": "86" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "83" }]
    }
  ],
  "metadata": {},
  "rowCount": 6
}

На основе ответа на запрос отчета создается диаграмма для отчета о когорте. Из этого отчета можно сделать вывод, что самое большое падение числа активных пользователей в этой когорте происходит между первым и вторым днем.

Визуализация пользователей когорты за определенный период времени

Несколько когорт и доля удержанных пользователей

Привлечение и удержание пользователей – это способы развития сайта или приложения. Отчеты о когортах сосредоточены на удержании пользователей. В этом примере отчет показывает, что удержание пользователей в течение 4 дней улучшилось на 10 % за две недели.

Чтобы создать такой отчет, мы указываем три когорты: первая с firstSessionDate 2020-11-02, вторая с firstSessionDate 2020-11-09 и третья с firstSessionDate 2020-11-16. Поскольку количество пользователей на вашем ресурсе в эти три дня будет разным, мы сравниваем долю удержанных пользователей когорты (cohortActiveUsers/cohortTotalUsers), а не используем показатель cohortActiveUsers напрямую.

Запрос отчета для этих когорт выглядит следующим образом:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metrics": [
    {
      "name": "cohortRetentionFraction",
      "expression": "cohortActiveUsers/cohortTotalUsers"
    }
  ],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-02", "endDate": "2020-11-02" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-09", "endDate": "2020-11-09" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-16", "endDate": "2020-11-16" }
      }
    ],
    "cohortsRange": {
      "endOffset": 4,
      "granularity": "DAILY"
    }
  },
}

Пример ответа на этот запрос:

{
  "dimensionHeaders": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metricHeaders": [{
      "name": "cohortRetentionFraction",
      "type": "TYPE_FLOAT"
    }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.308" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.272" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.257" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.248" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.235" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.211" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.198" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.172" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.167" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.155" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.141" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.118" }]
    }
  ],
  "metadata": {},
  "rowCount": 15
}

На основе ответа на запрос отчета создается диаграмма для отчета о когорте. Из этого отчета можно узнать, что удержание пользователей за 4 дня увеличилось на 10 % за две недели. Удержание в более поздней когорте (firstSessionDate из 2020-11-16) превышает удержание в более ранней когорте (firstSessionDate из 2020-11-02).

Диаграмма удержания нескольких когорт

Недельные когорты и использование когорт с другими функциями API

Чтобы исключить ежедневные колебания в поведении пользователей, используйте недельные когорты. В недельных отчетах о когортах все пользователи, у которых firstSessionDate произошло на одной неделе, образуют когорту. Неделя начинается в воскресенье и заканчивается в субботу. Также в этом отчете мы разбиваем когорту, чтобы сравнить пользователей с активностью в России с пользователями с активностью в Мексике. Для этого используется параметр country и dimensionFilter, чтобы учитывать только две страны.

Запрос отчета для этих когорт выглядит следующим образом:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "dimensionFilter": {
    "filter": {
      "fieldName": "country",
      "inListFilter": {
        "values": [ "Russia", "Mexico" ]
      }
    }
  },
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": {
          "startDate": "2020-10-04",
          "endDate": "2020-10-10"
        }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "WEEKLY"
    }
  },
}

Пример ответа на этот запрос:

{
  "dimensionHeaders": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "105" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "98" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "35" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "24" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "23" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "17" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0005" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "3" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    }
  ],
  "metadata": {},
  "rowCount": 11
}

Ниже приведен пример диаграммы из отчета о когорте. Судя по этому отчету, ресурс лучше удерживает пользователей, которые совершают действия в Мексике, чем тех, кто находится в России.

Диаграмма сравнения когорт по странам

Сравнения

Сравнения позволяют сопоставлять разные наборы данных, Чтобы задать сравнения, укажите поле comparisons в определении отчета. Функция сравнения в Data API похожа на сравнения в интерфейсе Google Аналитики.

Подробную документацию по каждому полю API можно найти в справочнике по REST для сравнения цен.

Как создать сравнение

Вы можете создать отдельное сравнение для каждого интересующего вас набора данных. Например, чтобы сравнить статистику сайта и приложения, можно создать одно сравнение для данных Android и iOS, а другое – для данных сайта.

Ниже приведен пример отчета, в котором заданы два сравнения и возвращаются активные пользователи с разбивкой по странам.

Первое сравнение называется "Трафик приложения". В нем используется inListFilter, чтобы сопоставить параметр platform со значениями "iOS" и "Android". Во втором сравнении, которое называется "Трафик сайта", используется stringFilter, чтобы сопоставить параметр platform со значением "web".

  POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
  {
    "comparisons": [
      {
        "name": "App traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "inListFilter": {
              "values": [
                "iOS",
                "Android"
              ]
            }
          }
        }
      },
      {
        "name": "Web traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "stringFilter": {
              "matchType": "EXACT",
              "value": "web"
            }
          }
        }
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ],
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ]
  }

Для всех запросов, в которых используется функция сравнения, в созданный отчет автоматически добавляется поле comparison. Это поле содержит название сравнения, указанное в запросе.

Ниже приведен пример фрагмента ответа, содержащего сравнения.

{
  "dimensionHeaders": [
    {
      "name": "comparison"
    },
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "638572"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "Japan"
        }
      ],
      "metricValues": [
        {
          "value": "376578"
        }
      ]
    },
  {
      "dimensionValues": [
        {
          "value": "App traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "79527"
        }
      ]
    },

    ...

  ],

...

}

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

Как получить список специальных определений и создать отчеты

Специальные параметры на уровне события

Специальные параметры на уровне пользователя

Специальные показатели на уровне события

Показатели доли ключевых событий для одного ключевого события

Средние значения специальных показателей на уровне события

Примеры отчетов о когорте

Как создать отчет о когорте

Несколько когорт и доля удержанных пользователей

Недельные когорты и использование когорт с другими функциями API

Сравнения

Как создать сравнение

Примеры использования расширенных функций