Журнал изменений API управления Google Analytics

Мы периодически обновляем API управления Google Analytics, чтобы предоставлять новые функции и устранять дефекты, обнаруженные в предыдущих версиях. В большинстве случаев эти изменения будут прозрачны для разработчиков API. Однако иногда нам необходимо внести изменения, которые требуют от разработчиков модификации существующих приложений.

На этой странице документируются любые изменения, внесенные в API управления Google Analytics, которые могут повлиять на ваше приложение. Мы рекомендуем разработчикам API периодически проверять этот список на наличие новых объявлений. Вы также можете подписаться на изменения через каналы, перечисленные в разделе «Подписка» ниже.

Подпишитесь на соответствующие журналы изменений

Включает все API сбора, настройки и отчетности.

Включает API управления и API обеспечения.

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

Теперь можно программно настроить параметры хранения пользовательских данных, используя новые поля dataRetentionTtl и dataRetentionResetOnNewActivity, добавленные в ресурс WebProperty .

Операции записи в Management API

Операции записи в Management API (например, создание, обновление, удаление, исправление) для ресурсов веб-ресурса, представления (профиля) и цели больше не требуют внесения в белый список. Дневной лимит по умолчанию для всех операций записи в Management API составляет 50 операций записи в день. Дополнительную информацию см. на странице «Лимиты и квоты» .

Аудитория ремаркетинга – поддержка оптимизации

В этом выпуске добавлена ​​поддержка Google Optimize и OPTIMIZE в качестве типа связанного рекламного аккаунта. Подробную информацию см. в справочной документации по Аудитории ремаркетинга и в руководстве разработчика по Аудитории ремаркетинга .

Пользовательские метрики

Это выпуск с исправлением ошибок; он устраняет проблему, из-за которой не удавалось создать специальную метрику типа TIME , если min_value не было установлено. Запросы без min_value теперь создают пользовательскую метрику с min_value по умолчанию, равным 0 .

Валюты

Это выпуск с исправлением ошибок; исправлена ​​проблема, из-за которой подмножество валют поддерживалось в веб-интерфейсе Analytics, но не поддерживалось в API . В этом выпуске добавлена ​​поддержка следующих валют:

  • UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

Для получения дополнительной информации см.: - Справочник по представлениям (профилям) . – Статья Справочного центра «Справочник валют» .

В этом выпуске в Management API добавлены аудитории ремаркетинга.

Аудитории ремаркетинга

API управления позволяет create , get , list , update и patch аудитории ремаркетинга для ресурса Google Analytics. Дополнительную информацию о том, как работают аудитории ремаркетинга, можно найти в статье Справочного центра «Об аудиториях ремаркетинга в Analytics» .

Ограничение частоты ошибок

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

  • 50 неудачных запросов на запись в час.

Полные отчеты

API полных отчетов больше не имеет ограничения в 100 отчетов в день. В API используется та же система токенов по каждому ресурсу и за день, что и при создании полного отчета через веб-интерфейс.

Полные отчеты

Полные отчеты, недоступные текущему пользователю, больше не будут иметь ссылку для скачивания в ответном сообщении Management API. Такое поведение теперь соответствует функциональности информационной панели пользовательского интерфейса, где только владельцы отчетов могут видеть ссылку для скачивания созданного документа.

Просмотры (профили)

В этом выпуске к ресурсу представления (профиля) добавлено свойство botFilteringEnabled . Это свойство указывает, включена ли фильтрация ботов для представления (профиля). Подробности см. в справочной документации по представлениям (профилям) .

Полные отчеты

В этом выпуске к полным отчетам добавлен метод delete . Подробности см. в справочной документации по удалению полных отчетов .

Сегменты

Это релиз с исправлением ошибок. В этом выпуске исправлена ​​проблема, из-за которой сегменты со значениями валют в определении отображались неправильно при вызове метода списка сегментов .

Сегменты

Это релиз с исправлением ошибок. В этом выпуске исправлена ​​проблема, из-за которой пользователи с частными сегментами, прикрепленными к нескольким представлениям (профилям), могли получать ответ об ошибке 500 при вызове метода списка сегментов .

Пакетирование

В этом выпуске, помимо общей поддержки пакетной обработки , мы добавили специальную поддержку User Permissions API . Пакетные запросы разрешений пользователей позволят значительно повысить производительность и сократить использование квот.

Просмотры (профили)

В этом выпуске свойство currency представления (профиля) по умолчанию будет установлено в долларах США , если оно не было установлено во время операции вставки . Также операции get и list будут возвращать доллары США для представлений (профилей), которые ранее были созданы без свойства currency .

Фильтры

В этом выпуске окончательно удалены устаревшие поля фильтра IS_MOBILE и IS_TABLET , которые следует заменить на DEVICE_CATEGORY=mobile и DEVICE_CATEGORY=tablet . Запросы на вставку, обновление и исправление, которые устанавливают в полях фильтра использование IS_MOBILE и IS_TABLET вернут ошибку.

Фильтры

В этом выпуске добавлена ​​поддержка использования специального измерения для поля фильтра путем добавления свойства fieldIndex во все разделы сведений о фильтре. Например, теперь можно установить выражение фильтра с помощью "field": "CUSTOM_DIMENSION" и "fieldIndex": "1" чтобы фильтр работал по первому пользовательскому измерению.

Цели

В этом выпуске также исправлена ​​проблема, из-за которой создание цели со "comparisonValue": "0" не удавалось.

Этот выпуск знаменует собой окончательное отключение и удаление ресурса dailyUpload . Ресурс dailyUpload был официально признан устаревшим 20 июня 2014 г.; весь импорт данных о расходах теперь должен выполняться с использованием ресурса загрузки .

В этом выпуске в Management API добавлены две новые коллекции: специальные измерения и специальные показатели.

Специальные параметры и показатели

Теперь можно создавать, перечислять, получать, исправлять и обновлять специальные параметры и показатели с помощью Management API.

Ответ метода list для всех коллекций теперь включает пустой список для свойства items , если коллекция не содержит ресурсов. Раньше свойство items в ответе опускалось. См. Справочник по API для получения полной информации о запросах и ответах на данные конфигурации Google Analytics.

В этом выпуске представлена ​​новая область применения API управления Google Analytics . analytics.manage.users.readonly — просмотр разрешений пользователей Google Analytics.

Было добавлено новое поле фильтров DEVICE_CATEGORY , а IS_MOBILE и IS_TABLET больше не поддерживаются. Используйте DEVICE_CATEGORY=mobile и DEVICE_CATEGORY=tablet .

Ресурс View (Profile) теперь включает свойство enhancedECommerceTracking , которое указывает, включена ли расширенная электронная торговля ( true ) или отключена ( false ).

Этот выпуск включает новые типы импорта данных и прекращение поддержки ресурса dailyUpload .

Импорт данных

Подробную информацию о том, как использовать Management API для импорта данных в вашу учетную запись Google Analytics, см. в Руководстве разработчика по импорту данных .

Загрузки

  • Ресурс upload теперь поддерживает следующие типы загрузки:
    • Данные кампании
    • Данные контента
    • Данные о затратах
    • Данные продукта
    • Данные о возврате
    • Данные пользователя
  • Ресурс upload имеет новый migrateDataImport для переноса существующих данных о затратах customDataSources .

Прекращение ежедневной загрузки

  • Ресурс dailyUpload устарел! дополнительные сведения о переходе с использованием функции импорта данных см. в Руководстве по миграции .
  • Ресурс dailyUpload будет продолжать работать еще шесть месяцев, после чего все оставшиеся customDataSources со свойством uploadType , имеющим значение analytics#dailyUploads будут автоматически перенесены и работать только с ресурсом upload .
  • Текущим пользователям ресурса dailyUpload следует обновить свой код и перейти на использование ресурса Upload как можно скорее.

В этом выпуске добавлены два новых API конфигурации.

Фильтры

Полные отчеты: API управления

В Management API добавляется новый ресурс под названием Unsampled Reports . Полные отчеты – это отчеты Google Analytics (GA), созданные с использованием полных данных. Полные отчеты в настоящее время доступны только пользователям GA Premium.

Сегменты: Management API v2.4 и v3.0

В коллекцию сегментов были внесены следующие изменения:

  • В API теперь поддерживаются сегменты пользователей и последовательностей.
  • Коллекция сегментов теперь возвращает все встроенные и настраиваемые сегменты уровня сеанса и пользователя .
  • Свойство definition сегментов теперь будет использовать новый синтаксис сегментов. Сюда входят определения для существующих сегментов уровня сеанса , которые изменятся по сравнению с definition: " " definition: " " к definition: "sessions::condition:: " definition: "sessions::condition:: " .
  • К ресурсу Segment было добавлено новое свойство type , указывающее, является ли сегмент CUSTOM (т. е. создан пользователем в веб-интерфейсе) или BUILT_IN (т. е. предоставлен Google Analytics).

Эксперименты

Следующие показатели AdSense теперь можно использовать в качестве целей оптимизации:

  • ga:adsenseAdsClicks — количество кликов по объявлениям AdSense на вашем сайте.
  • ga:adsenseAdsViewed — количество просмотренных объявлений AdSense. В одном рекламном блоке может отображаться несколько объявлений.
  • ga:adsenseRevenue — общий доход от рекламы AdSense.

Новая коллекция сводок по счетам

Следующие изменения были внесены в сегменты по умолчанию в связи с прекращением поддержки измерений ga:isMobile и ga:isTablet :

  • Сегмент gaid::-11 переименован с Мобильный трафик в Мобильный и планшетный трафик . Определение этого сегмента было изменено с ga:isMobile==Yes на ga:deviceCategory==mobile,ga:deviceCategory==tablet . Обратите внимание, что ga:isMobile учитывает трафик планшетов, что отражено в новом определении. Если вам нужен только мобильный трафик, исключая планшеты, переключитесь на новый сегмент «Мобильный трафик» ( gaid::-14 ).
  • Определение сегмента gaid::-13 изменено с ga:isTablet==Yes на ga:deviceCategory==tablet . Это по-прежнему представляет собой трафик планшетов .
  • Добавлен сегмент gaid::-14 . Имя сегмента — «Мобильный трафик» , а определение — ga:deviceCategory==mobile .

Исправление ошибок:

  • Исправлена ​​информация о часовом поясе для представлений (профилей). Подробности : до этого исправления в некоторых случаях при перечислении представлений (профилей) в Management API возвращалась неверная информация о часовом поясе для представления (профиля). Теперь информация о часовом поясе для представлений (профилей) соответствует тому, что установлено в интерфейсе администратора Google Analytics.

В этом выпуске представлены операции записи для ресурсов веб-ресурса, представления (профиля) и цели, а также набор из трех новых ресурсов, которые позволяют управлять разрешениями пользователей.

API настройки и настройки учетной записи

  • Представления (профили) теперь можно создавать, обновлять, исправлять и удалять. Подробные сведения о новых методах см. в справочнике по представлениям (профилям) .
  • Веб-свойства и цели теперь можно создавать, обновлять и исправлять. Подробные сведения о новых методах см. в справочнике по веб-свойствам и справочнике по целям .
  • Теперь с помощью метода get можно запросить отдельный веб-ресурс, представление (профиль) или цель.
  • Эти функции в настоящее время доступны в виде предварительной версии для разработчиков в рамках ограниченной бета-версии. Если вы заинтересованы в регистрации, запросите доступ к бета-версии .

Разрешения пользователя в Management API

В рамках запуска новых сегментов мы внесем следующие изменения в коллекцию сегментов :

  • Все идентификаторы сегментов будут изменены с положительных целых чисел на буквенно-цифровые строки. Если вы сохранили идентификаторы сегментов пользователей, мы рекомендуем обновить их, чтобы использовать новые идентификаторы.
  • Коллекция сегментов вернет только существующие сегменты уровня посещения . Новые сегменты посетителей, когорт и последовательностей в настоящее время не поддерживаются API.
  • Коллекция сегментов продолжит возвращать существующие сегменты по умолчанию с теми же отрицательными числовыми идентификаторами, однако новые сегменты по умолчанию в настоящее время не поддерживаются.

В этом выпуске к ресурсу Webproperty добавлено 2 новых свойства:

  • profileCount — возвращает количество профилей для свойства. Это позволяет фильтровать свойства, у которых нет профилей (т. е. ProfileCount = 0).
  • industryVertical — возвращает отраслевую вертикаль/категорию, выбранную для свойства.

Исправление ошибок:

  • Свойство eCommerceTracking ресурса Profile теперь соответствует настройкам электронной торговли в разделе администрирования веб-интерфейса. Возвращает true , если отслеживание электронной торговли включено, и false , если нет.
  • Ресурс веб-ресурса теперь включает свойство level , указывающее, является ли веб-ресурс PREMIUM или STANDARD .
  • В Management API v3 была добавлена ​​новая конечная точка для доступа к ресурсам экспериментов и их изменения.
  • Ресурс профиля теперь включает свойство type , позволяющее определить, настроен ли профиль для веб-сайта или приложения. Два возможных значения: WEB или APP .

В этом выпуске в Management API добавлены полезные ответы на ошибки.

  • В тело ответов об ошибках API добавлены новые коды ошибок, причины и описания. Все коды документированы для обеих версий — версии 2.4 и версии 3.0 — Management API.

В этом выпуске добавлены данные, изменены существующие функции и исправлена ​​ошибка.

Новые данные

  • Коллекция расширенных сегментов теперь содержит поле segmentId , которое можно использовать в параметре сегмента API экспорта данных.

Изменения

  • Тип данных для max-results был изменен на integer .

  • Значение по умолчанию и максимальное значение для max-results было изменено на 1000.

Исправление ошибок

  • Аккаунты, веб-ресурсы и профили для экспериментов Оптимизатора веб-сайтов Google больше не включаются в соответствующие коллекции.

В этом выпуске добавлены две новые версии API со множеством новых функций, а старая версия признана устаревшей. Изменения повлияют на то, как вы запрашиваете и обрабатываете данные из API.

Версия 3.0

  • Это последняя основная версия нашего API, которая не имеет обратной совместимости. Вся будущая разработка API будет осуществляться на основе этой версии.

  • Новые данные

    • Полное представление целей мероприятия
    • Внутренний идентификатор веб-ресурса, который можно использовать для глубокой ссылки на пользовательский интерфейс Google Analytics.
    • Конфигурации профиля для параметров страницы по умолчанию и поискового запроса по сайту.
  • Изменения

Версия 2.4

  • Это незначительное обновление версии, которое в основном обратно совместимо с существующей версией 2.3.

  • Изменения

    • Новая политика квотирования
    • Интеграция с консолью Google API для управления доступом к API и запроса дополнительных квот.
    • Продолжение поддержки существующих механизмов авторизации и OAuth 2.0.
    • Новый URL-адрес для отправки запросов: https://www.googleapis.com/analytics/v2.4/management/…
    • Ответы только в XML
    • Нет поддержки клиентской библиотеки Google Data JavaScript.
    • Вывод XML соответствует версии 2.3, поэтому другие существующие клиентские библиотеки данных Google продолжат работать.

Устаревание

  • Мы объявляем об прекращении поддержки устаревшей версии 2.3 Management API. Он продолжит работать в течение двух месяцев, после чего все запросы версии 2.3 будут возвращать ответ версии 2.4.

Это бета-версия API управления Google Analytics!

Новые каналы

Обновленные клиентские библиотеки

  • Management API выпускается в той же библиотеке, что и API экспорта данных Google Analytics. Библиотеки Google Data Java и JavaScript были обновлены. Доступ к каждому каналу можно получить, указав соответствующий URI канала для метода библиотеки getManagementFeed() .

Новая документация

  • В документации для разработчиков Google Analytics создан новый раздел, описывающий, как работает новый Management API .