Мы периодически обновляем Google Analytics Core Reporting API , чтобы предоставлять новые функции и устранять дефекты, обнаруженные в предыдущих версиях. В большинстве случаев эти изменения будут прозрачны для разработчиков API. Однако иногда нам нужно вносить изменения, требующие от разработчиков модификации своих существующих приложений.
На этой странице документируются любые изменения, внесенные в Google Analytics Core Reporting API, которые могут повлиять на ваше приложение. Мы рекомендуем разработчикам API периодически проверять этот список на наличие новых объявлений. Вы также можете подписаться на изменения через каналы, перечисленные в разделе « Подписка » ниже.
Подпишитесь на соответствующие журналы изменений
Включает все API сбора, настройки и отчетности.
Включает Core Reporting API, Multi-Channel Funnels Reporting API и Real Time Reporting API.
Выпуск 2019-03-19 (19 марта 2019 г.)
Это первоначальный выпуск User Activity API.
- API активности пользователей позволяет получить все данные, связанные с одним идентификатором клиента или идентификатором пользователя за определенный диапазон дат. В первую очередь он предназначен для поддержки владельцев собственности, которые хотят предоставить автоматический доступ к данным пользователя непосредственно этому пользователю. Дополнительные сведения см. в Руководстве по API действий пользователей .
Выпуск 23 января 2018 г. (23 января 2018 г.)
В этом выпуске система квот на основе ресурсов для Google Analytics Reporting API v4 доступна для всех клиентов Analytics 360 (Premium).
Выпуск 29 ноября 2017 г. (29 ноября 2017 г.)
В этом выпуске увеличено максимальное количество строк, возвращаемых в наборе результатов Analytics Reporting API v4.
Максимальное количество строк, возвращаемых в объекте ReportData Analytics Reporting API версии 4 , увеличено с 10 000 до 100 000.
Выпуск 2017-10-31 (31 октября 2017 г.)
В этом выпуске добавлена предварительная версия системы квот на основе ресурсов для Google Analytics Reporting API v4, которая позволяет использовать более высокие пороги выборки для клиентов Analytics 360 (Premium).
Выпуск 2017-06-02 (2 июня 2017 г.)
В этом выпуске функция « Сопутствующие товары » и связанные с ней параметры и показатели устарели. полный список определений см. в Справочнике по параметрам и показателям . Подробные сведения об удалении данных см. в Политике устаревания данных:
Сопутствующие товары
В этом выпуске устарели следующие параметры и показатели:
-
ga:correlationModelId
-
ga:queryProductId
-
ga:queryProductName
-
ga:queryProductVariation
-
ga:relatedProductId
-
ga:relatedProductName
-
ga:relatedProductVariation
-
ga:correlationScore
-
ga:queryProductQuantity
-
ga:relatedProductQuantity
Выпуск от 11 апреля 2017 г. (11 апреля 2017 г.)
В этом выпуске к API добавлено новое измерение; полный список определений см. в Справочнике по параметрам и показателям . В этом выпуске также удалено несколько устаревших параметров и показателей. ознакомьтесь с Политикой устаревания данных для API Google Analytics , чтобы понять весь процесс удаления данных.
Время
- Новое измерение
ga:dateHourMinute
, объединяющееga:date
,ga:hour
иga:minute
.
Удаление данных
В этом выпуске удалены следующие устаревшие параметры и показатели:
-
ga:socialactivities
-
ga:socialactivityaction
-
ga:socialactivitydisplayname
-
ga:socialactivityendorsingurl
-
ga:socialactivitynetworkaction
-
ga:socialactivitypost
-
ga:socialactivitytagssummary
-
ga:socialactivitytimestamp
-
ga:socialactivityuserhandle
-
ga:socialactivityuserphotourl
-
ga:socialactivityuserprofileurl
-
ga:socialinteractionspervisit
Выпуск 2017-03-08 (8 марта 2017 г.)
В этом выпуске обновлены существующие показатели и параметры в API. Полный список определений см. в справочнике по параметрам и показателям .
Метрики пользователя
Расчет показателей « Пользователи » и « Активные пользователи » был обновлен для более эффективного подсчета пользователей. Вы можете увидеть небольшое изменение в ваших показателях. Для получения дополнительной информации см. Как пользователи идентифицируются для показателей пользователей .
Показатели пользователя, затронутые обновлением расчета:
-
ga:users
— общее количество пользователей за запрашиваемый период времени. -
ga:1dayusers
— общее количество однодневных активных пользователей за каждый день в запрошенный период времени. -
ga:7dayusers
— общее количество активных пользователей за 7 дней за каждый день в запрошенный период времени. -
ga:14dayusers
— общее количество 14-дневных активных пользователей за каждый день в запрошенный период времени. -
ga:30dayusers
— общее количество 30-дневных активных пользователей за каждый день в запрошенный период времени.
Уникальные события
Мы приближаемся к концу периода устаревания ga:uniqueEvents
. После 26 марта 2017 года определение ga:uniqueEvents
будет обновлено, а частная метрика ga:uniqueEventsTemporary
будет удалена из API. Дополнительные сведения см. в справочных документах по уникальным событиям .
Выпуск 2017-02-14 (14 февраля 2017 г.)
В этом выпуске в API добавлен новый параметр, улучшены сообщения об ошибках и введены ранее объявленные изменения параметров и показателей AdSense.
Пользовательские параметры
- Измерение —
ga:userBucket
— для любого заданного пользователя измерение сегмента пользователя (значения от 1 до 100) указывает сегмент, которому назначен пользователь. Дополнительные сведения см. в статье Тестирование кампаний ремаркетинга .
Сообщения об ошибках
Если раньше API возвращал ошибочное сообщение об ошибке, Unknown dimension(s):
или Unknown metric(s):
при запросе данных с условиями, которые не были соблюдены, теперь API возвращает сообщение: Restricted metric(s): ... can only be queried under certain conditions.
Параметры и показатели AdSense
Связанным представлениям, не относящимся к AdSense, будет запрещено запрашивать параметры и показатели AdSense. Запрос этих параметров и показателей со связанными представлениями, не относящимися к AdSense, приведет к ошибке.
Выпуск от 11 января 2017 г. (11 января 2017 г.)
Это выпуск с исправлением ошибок, в котором устранена проблема с параметрами и показателями AdSense, а также сообщается о предстоящем изменении этих параметров и показателей.
Параметры и показатели AdSense
В этом выпуске исправлена проблема, возникшая 07.01.2017, из-за которой при запросе параметров и показателей AdSense возвращалась ошибка «Неизвестный показатель» для представлений, не связанных с AdSense.
Грядущие изменения
31 января 2017 года или позже связанные представления, не связанные с AdSense, не смогут запрашивать параметры и показатели AdSense. Запрос этих параметров и показателей со связанными представлениями, не относящимися к AdSense, приведет к ошибке.
Выпуск 2016-10-12 (12 октября 2016 г.)
В этом выпуске в API добавлена следующая новая метрика. Полный список определений см. в справочнике по параметрам и показателям .
Расчетные показатели
В этом выпуске добавлена поддержка вычисляемых метрик .
- Метрика –
ga:calcMetric_
- Значение запрашиваемой расчетной метрики, где относится к определяемому пользователем имени вычисляемой метрики. Обратите внимание, что тип данных ga:calcMetric_
может быть FLOAT, INTEGER, CURRENCY, TIME или PERCENT. Подробнее см. в разделе О вычисляемых показателях .
Выпуск 2016-09-26 (26 сентября 2016 г.)
В этом выпуске в API добавлена новая метрика. Он также отменяет существующую метрику. Полный список определений см. в справочнике по параметрам и показателям .
Отслеживание событий
Определение ga:uniqueEvents
будет изменено, чтобы более точно отражать количество уникальных событий. Чтобы повлиять на это изменение, мы технически прекратим поддержку текущего показателя ga:uniqueEvents
в соответствии с нашей политикой устаревания данных . Если вы хотите попробовать новое определение, вы можете сослаться на частную метрику ga:uniqueEventsTemporary
, которая более точно подсчитывает количество уникальных событий. Мы также представим новую метрику ga:uniqueDimensionCombinations
, которая сохраняет текущее определение ga:uniqueEvents
. По истечении надлежащего периода устаревания (примерно 6 месяцев) частная метрика ga:uniqueEventsTemporary
будет удалена, а исходная метрика ga:uniqueEvents
будет правильно представлять количество уникальных событий. Дополнительные сведения см. в справочных документах по уникальным событиям .
Уникальные события
- Метрика —
ga:uniqueEvents
. Определениеga:uniqueEvents
скоро изменится, чтобы более точно отражать количество уникальных событий. Вместо этого используйтеga:uniqueDimensionCombinations
, если хотите сохранить существующее определение. Дополнительные сведения см. в справочных документах по уникальным событиям . - Метрика —
ga:uniqueDimensionCombinations
— Уникальные комбинации параметров подсчитывает количество уникальных комбинаций параметров и значений для каждого параметра в отчете. Это позволяет создавать комбинированные (объединенные) параметры для постобработки, что обеспечивает более гибкую отчетность без необходимости обновлять реализацию отслеживания или использовать дополнительные слоты для настраиваемых параметров. Дополнительные сведения см. в справочных документах по уникальным событиям .
Переходное тестирование — частное
- Метрика —
ga:uniqueEventsTemporary
— количество уникальных событий; это будет новое определение дляga:uniqueEvents
. Вы можете использовать эту метрику, чтобы понять новое определение до внесения изменений. Обратите внимание, что эта метрика является частной и не будет отображаться в справочнике по параметрам и показателям.
Выпуск 2016-08-09 (9 августа 2016 г.)
В этом выпуске в API добавлены новые параметры и показатели. Полный список определений см. в справочнике по параметрам и показателям .
Менеджер ставок DoubleClick
- Параметр –
ga:dbmClickAdvertiser
– имя рекламодателя DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmClickAdvertiserId
– идентификатор рекламодателя DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmClickCreativeId
– идентификатор объявления DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmClickExchange
— имя обмена DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmClickExchangeId
– идентификатор обмена DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmClickInsertionOrder
— имя заказа на размещение DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmClickInsertionOrderId
— идентификатор заказа на размещение DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmClickLineItem
— название позиции DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmClickLineItemId
— идентификатор позиции DBM для клика DBM, соответствующего сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmClickSite
– название сайта DBM, на котором было показано объявление DBM и на которое был нажат клик DBM, соответствующий сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmClickSiteId
– идентификатор сайта DBM, на котором был показан креатив DBM и на который был нажат клик DBM, соответствующий сеансу Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventAdvertiser
— имя рекламодателя DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventAdvertiserId
— идентификатор рекламодателя DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventCreativeId
— идентификатор объявления DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventExchange
— имя обмена DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventExchangeId
— идентификатор обмена DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmLastEventInsertionOrder
– имя заказа на размещение в DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmLastEventInsertionOrderId
– идентификатор заказа на размещение в DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventLineItem
— название позиции DBM для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventLineItemId
— идентификатор позиции DBM для последнего события DBM (показа или клика в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр –
ga:dbmLastEventSite
– название сайта DBM, на котором было показано объявление DBM и на которое было нажато последнее событие DBM (показ или клик в окне ретроспективного анализа DBM), связанное с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Параметр —
ga:dbmLastEventSiteId
— идентификатор сайта DBM, на котором было показано объявление DBM и на которое было нажато для последнего события DBM (показ или клик в окне ретроспективного анализа DBM), связанного с сеансом Google Analytics (только для Analytics 360, требуется интеграция с DBM). - Метрика –
ga:dbmCPA
– эффективная цена за конверсию от дохода в DBM (только для Аналитики 360, требуется интеграция с DBM). - Метрика –
ga:dbmCPC
– эффективная цена за клик дохода в DBM (только для Analytics 360, требуется интеграция с DBM). - Метрика –
ga:dbmCPM
– доход в DBM (эффективная цена за тысячу показов) (только для Analytics 360, требуется интеграция с DBM). - Метрика –
ga:dbmCTR
– CTR DBM (только для Аналитики 360, требуется интеграция с DBM). - Метрика —
ga:dbmClicks
— общее количество кликов DBM (только для Analytics 360, требуется интеграция с DBM). - Метрика –
ga:dbmConversions
– общее количество конверсий DBM (только для Аналитики 360, требуется интеграция с DBM). - Метрика –
ga:dbmCost
– стоимость DBM (только для Analytics 360, требуется интеграция с DBM). - Метрика —
ga:dbmImpressions
— общее количество показов DBM (только для Analytics 360, требуется интеграция с DBM). - Метрика –
ga:dbmROAS
– рентабельность инвестиций в DBM (только для Analytics 360, требуется интеграция с DBM).
Поиск DoubleClick
- Параметр –
ga:dsAdGroup
– группа объявлений DS (только для Analytics 360, требуется интеграция с DS). - Измерение –
ga:dsAdGroupId
– идентификатор группы объявлений DS (только для Analytics 360, требуется интеграция с DS). - Параметр –
ga:dsAdvertiser
– рекламодатель DS (только для Analytics 360, требуется интеграция с DS). - Параметр –
ga:dsAdvertiserId
– идентификатор рекламодателя DS (только для Analytics 360, требуется интеграция с DS). - Параметр –
ga:dsAgency
– Агентство DS (только для Analytics 360, требуется интеграция с DS). - Измерение –
ga:dsAgencyId
– идентификатор агентства DS (только для Analytics 360, требуется интеграция с DS). - Измерение —
ga:dsCampaign
— DS Campaign (только для Analytics 360, требуется интеграция с DS). - Измерение —
ga:dsCampaignId
— идентификатор кампании DS (только для Analytics 360, требуется интеграция с DS). - Измерение —
ga:dsEngineAccount
— учетная запись DS Engine (только для Analytics 360, требуется интеграция с DS). - Измерение —
ga:dsEngineAccountId
— идентификатор учетной записи DS Engine (только для Analytics 360, требуется интеграция с DS). - Параметр —
ga:dsKeyword
— ключевое слово DS (только для Analytics 360, требуется интеграция с DS). - Измерение —
ga:dsKeywordId
— идентификатор ключевого слова DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsCPC
— стоимость клика рекламодателя в DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsCTR
— рейтинг кликов DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsClicks
— клики DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsCost
— стоимость DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsImpressions
— показы DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsProfit
— DS Profie (только для Analytics 360, требуется интеграция с DS). -
ga:dsReturnOnAdSpend
— рентабельность расходов на рекламу в DS (только для Analytics 360, требуется интеграция с DS). -
ga:dsRevenuePerClick
— доход DS за клик (только для Analytics 360, требуется интеграция с DS).
Выпуск 2016-07-14 (14 июля 2016 г.)
В этом выпуске к API добавлено новое измерение. В этом выпуске также добавлены определенные ограничения на комбинацию измерений, которые можно запрашивать вместе. Полный список определений см. в справочнике по параметрам и показателям .
Гео сеть
- Измерение –
ga:continentId
– идентификатор континента пользователей, полученный из IP-адресов пользователей или географических идентификаторов.
Ограничения
Следующие измерения в следующих группах не могут быть запрошены с измерениями в других группах:
- Посетите группу информации о покупках
-
ga:checkoutOptions
-
ga:shoppingStage
-
- Экспериментальная группа GWO
-
ga:experimentVariant
-
ga:experimentId
-
- Группа по интересам
-
ga:interestOtherCategory
-
- Группа интересов рынка
-
ga:interestInMarketCategory
-
- Группа внутреннего продвижения:
-
ga:internalPromotionCreative
-
ga:internalPromotionId
-
ga:internalPromotionName
-
ga:internalPromotionPosition
-
- Группа интересов брендинга:
-
ga:interestAffinityCategory
-
Выпуск 08.07.2016 (8 июля 2016 г.)
В этом выпуске представлены новые лимиты и квоты. Подробнее см. в документации по лимитам и квотам .
Сообщение об ошибках
В этом выпуске начинают применяться ограничения на количество неудачных ( 5XX
) запросов отчетов .
- 10 неудачных запросов на проект на профиль в час.
- 50 неудачных запросов на проект на профиль в день.
Сводные пределы
В этом выпуске начинают применяться ограничения на сводные запросы:
Выпуск от 17 июня 2016 г. (17 июня 2016 г.)
В этом выпуске в API добавлены новые параметры и показатели. Полный список определений см. в справочнике по параметрам и показателям .
Гео сеть
- Параметр —
ga:metroId
— трехзначный код выделенной рыночной зоны (DMA), откуда поступает трафик, полученный на основе IP-адресов пользователей или географических идентификаторов.
DoubleClick для издателей
- Метрика –
ga:dfpImpressions
– о показе объявления DFP сообщается каждый раз, когда на веб-сайте отображается отдельное объявление. Например, если страница с двумя рекламными блоками просматривается один раз, мы отобразим два показа (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика –
ga:dfpCoverage
Покрытие – это процент запросов объявлений, которые вернули хотя бы одно объявление. Как правило, покрытие может помочь определить сайты, на которых аккаунт DFP не может предоставлять таргетированную рекламу. (Показы объявлений / Общее количество запросов объявлений) * 100 (привязка DFP включена, а скрытие доходов DFP отключено).“ - Метрика –
ga:dfpMonetizedPageviews
– измеряет общее количество просмотров страниц ресурса, которые были показаны с рекламой из связанного аккаунта DFP. Обратите внимание, что на одной странице может быть несколько рекламных блоков (связывание DFP включено, а скрытие доходов DFP отключено). - Метрика –
ga:dfpImpressionsPerSession
– отношение количества показов рекламы в DFP к количеству сеансов Analytics (показы рекламы / сеансы Analytics) (связывание DFP включено, а скрытие доходов DFP отключено). - Метрика —
ga:dfpViewableImpressionsPercent
— процент показов объявлений в видимой области экрана. Показ считается видимым показом, если он появился в браузерах пользователей и может быть просмотрен (связывание DFP включено, а функция "Скрыть доход DFP" не включена).“ - Метрика –
ga:dfpClicks
– количество кликов по объявлениям DFP на сайте (при включенном связывании DFP и выключенном параметре "Скрыть доход DFP"). - Метрика –
ga:dfpCTR
– процент просмотров страниц, которые привели к клику по объявлению DFP (при включенной связи DFP и выключенном скрытии доходов DFP).“ - Метрика –
ga:dfpRevenue
– Доход DFP – это оценка общего дохода от рекламы на основе выполненных показов (связь DFP включена, а функция "Скрыть доход DFP" не включена).“ - Метрика –
ga:dfpRevenuePer1000Sessions
– общий расчетный доход от объявлений DFP на 1 000 сеансов Google Analytics. Обратите внимание, что этот показатель основан на количестве посещений сайта, а не на показах рекламы (привязка DFP включена, а скрытие доходов DFP отключено). - Метрика —
ga:dfpECPM
— эффективная стоимость тысячи просмотров страниц. Это доход DFP на 1000 просмотров страниц (связывание DFP включено, а скрытие дохода DFP не включено)». - Метрика –
ga:backfillImpressions
– количество показов для заполнения – это сумма всех показов объявлений AdSense или Ad Exchance, использованных для заполнения через DFP. О показе объявления сообщается всякий раз, когда на веб-сайте отображается отдельное объявление. Например, если страница с двумя рекламными блоками просматривается один раз, мы отобразим два показа (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика —
ga:backfillCoverage
backfillCoverage. Покрытие для заполнения — это процент запросов объявлений для заполнения, которые вернули хотя бы одно объявление. Как правило, покрытие может помочь определить сайты, на которых учетная запись издателя не может показывать таргетированную рекламу. (Показы объявлений / Общее количество запросов объявлений) * 100. Если и AdSense, и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой средневзвешенное значение двух учетных записей для заполнения (связывание DFP включено, а скрытие дохода DFP отключено)». - Метрика –
ga:backfillMonetizedPageviews
– измеряет общее количество просмотров страниц ресурса, которые были показаны хотя бы с одним объявлением из связанных аккаунтов для заполнения. Обратите внимание, что один монетизированный просмотр страницы может включать в себя несколько показов рекламы (связывание DFP включено, а функция «Скрыть доход DFP» не включена)». - Метрика —
ga:backfillImpressionsPerSession
— отношение показов объявлений для заполнения к сеансам Analytics (показы рекламы / сеансы Analytics). Если и AdSense, и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой сумму двух учетных записей для заполнения (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика —
ga:backfillViewableImpressionsPercent
— процент показов объявлений для заполнения, которые были видны. Показ считается видимым показом, когда он появился в браузерах пользователей и имел возможность быть увиденным. Если AdSense и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой средневзвешенное значение двух учетных записей для заполнения (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика —
ga:backfillClicks
— количество кликов по объявлениям для заполнения на сайте. Если AdSense и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой сумму двух учетных записей для заполнения (связывание DFP включено, а скрытие дохода DFP отключено)». - Метрика —
ga:backfillCTR
— процент показов заполнения, приведших к клику по объявлению. Если AdSense и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой средневзвешенное значение двух учетных записей для заполнения (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика –
ga:backfillRevenue
– общий расчетный доход от объявлений для заполнения. Если AdSense и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой сумму двух учетных записей для заполнения (связывание DFP включено, а скрытие дохода DFP отключено)». - Метрика –
ga:backfillRevenuePer1000Sessions
– общий расчетный доход от объявлений для заполнения на 1 000 сеансов Google Analytics. Обратите внимание, что этот показатель основан на посещениях сайта, а не на показах рекламы. Если и AdSense, и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой сумму двух учетных записей для заполнения (связывание DFP включено, а скрытие доходов DFP отключено)». - Метрика —
ga:backfillECPM
— эффективная стоимость тысячи просмотров страниц. Это доход от заполнения DFP на 1000 просмотров страниц. Если и AdSense, и Ad Exchange предоставляют объявления для заполнения, этот показатель представляет собой сумму двух учетных записей для заполнения (связывание DFP включено, а скрытие доходов DFP отключено)».
Выпуск 2016-05-18 (18 мая 2016 г.)
Это выпуск с исправлением ошибок, который устраняет проблему с сегментами и выборкой.
Сегменты
В этом выпуске исправлена проблема, из-за которой подмножество запросов с сегментом All Users ( gaid::-1
) недооценивалось в Core Reporting API V3 и разделялось на два сегмента в Analytics Reporting API V4 .
Выборка
В этом выпуске исправлена проблема, из-за которой подмножество запросов из пользовательских таблиц возвращало выборочные данные .
Выпуск 29 апреля 2016 г. (29 апреля 2016 г.)
Это выпуск с исправлением ошибок, устраняющий проблему при отправке когортных запросов Analytics Reporting API V4 .
Когортный запрос
Запросы когорт теперь могут запрашивать все параметры когорты ; ранее API возвращал ошибку при запросе измерений ga:acquisition...
Запрос общей ценности LTV
Обратите внимание, что запросы общей ценности могут генерировать отчеты о общей ценности только для просмотров приложения .
Выпуск от 8 апреля 2016 г. (8 апреля 2016 г.)
В этом выпуске представлена новая версия API Analytics Reporting API V4 . Этот новый API — самый передовой программный метод доступа к данным отчетов в Google Analytics.
Ключевая особенность
Google Analytics построен на мощной инфраструктуре отчетности данных. API предоставляет разработчикам доступ к возможностям платформы Google Analytics. Некоторые ключевые функции Analytics Reporting API версии 4 включают следующее:
- Выражения метрик. API позволяет запрашивать не только встроенные метрики, но и математические выражения метрик. Например, число достигнутых целей на количество сеансов может быть выражено в запросе как
ga:goal1completions/ga:sessions
. - Несколько диапазонов дат. Поддержка запроса двух диапазонов дат, что позволяет сравнивать данные за два периода в одном запросе.
- Когорты и жизненная ценность. API имеет богатый словарь для запроса отчетов о когортах и жизненной ценности.
- Несколько сегментов. Теперь вы можете запрашивать несколько сегментов в одном запросе.
Начиная
Подробную информацию о начале работы с API см. в документации для разработчиков .
Политика квот
Analytics Reporting API версии 4 имеет собственные квоты и ограничения ; поскольку это новый API, эти ограничения и квоты могут быть изменены.
Миграция
Наряду с руководством по миграции мы также делаем библиотеку совместимости Python доступной на Github .
Параметры и показатели
В этом выпуске также добавлен набор параметров и показателей специально для Analytics Reporting API V4. Полные определения списков см. в обозревателе параметров и показателей .
Измерение —
ga:cohort
— название группы, к которой принадлежит пользователь, на основе определения группы. В зависимости от того, как определяются когорты, пользователь может принадлежать к нескольким когортам, подобно тому, как пользователь может принадлежать к нескольким сегментам.Измерение —
ga:cohortNthDay
— смещение дня, отсчитываемое от 0, относительно даты определения когорты. Например, если когорта определена с датой первого посещения как 01.09.2015, то для даты 04.09.2015 ga:cohortNthDay будет равно 3.ga:cohortNthMonth
— смещение месяца, отсчитываемое от 0, относительно даты определения когорты.Измерение —
ga:cohortNthWeek
— смещение недели, отсчитываемое от 0, относительно даты определения когорты.Измерение —
ga:acquisitionTrafficChannel
— канал трафика, через который был привлечен пользователь. Он извлекается из первой сессии пользователя. Канал трафика вычисляется на основе правил группировки каналов по умолчанию (на уровне просмотра, если доступно) во время привлечения пользователя.Измерение —
ga:acquisitionSource
— источник, через который пользователь был привлечен. Получено из первого сеанса пользователя.Измерение —
ga:acquisitionMedium
— средство, с помощью которого пользователь был привлечен. Получено из первого сеанса пользователя.Измерение —
ga:acquisitionSourceMedium
— объединенное значение ga:userAcquisitionSource и ga:acquisitionMedium.Измерение -
ga:acquisitionCampaign
Кампания, посредством которой пользователь был привлечен. Получено из первого сеанса пользователя.Метрика —
ga:cohortActiveUsers
— эта метрика актуальна в контексте измерений смещения на основе 0 (ga:cohortNthDay
,ga:cohortNthWeek
илиga:cohortNthMonth
). Он указывает количество пользователей в когорте, которые активны во временном окне, соответствующем n-му дню/неделе/месяцу когорты. Например, дляga:cohortNthWeek = 1
количество пользователей (в когорте), которые были активны на второй неделе. Если в запросе нетga:cohortNthDay
,ga:cohortNthWeek
илиga:cohortNthMonth
, эта метрика будет иметь то же значение, что иga:cohortTotalUsers
.Метрика —
ga:cohortTotalUsers
— количество пользователей, принадлежащих к когорте, также известное как размер когорты.Метрика —
ga:cohortAppviewsPerUser
— количество просмотров приложения на пользователя для когорты.Метрика —
ga:cohortGoalCompletionsPerUser
— количество достигнутых целей на пользователя для когорты.Метрика —
ga:cohortPageviewsPerUser
— количество просмотров страниц на пользователя для когорты.Метрика –
ga:cohortRetentionRate
– коэффициент удержания когорты.Метрика —
ga:cohortRevenuePerUser
— доход на пользователя для когорты.Метрика —
ga:cohortVisitDurationPerUser
— продолжительность сеанса на пользователя для когорты.Метрика —
ga:cohortSessionsPerUser
— количество сеансов на пользователя для когорты.Метрика —
ga:cohortTotalUsersWithLifetimeCriteria
— актуальна в контексте запроса с параметрамиga:acquisitionTrafficChannel
,ga:acquisitionSource
,ga:acquisitionMedium
илиga:acquisitionCampaign
. Он представляет собой количество пользователей в когортах, привлеченных через текущий канал, источник, средство или кампанию. Например, дляga:acquisitionTrafficChannel=Direct
он представляет количество пользователей в когорте, которые были привлечены напрямую. Если ни одно из указанных измерений отсутствует, то его значение равноga:cohortTotalUsers
.Метрика —
ga:cohortAppviewsPerUserWithLifetimeCriteria
— количество просмотров приложения на пользователя для измерения приобретения для когорты.Метрика —
ga:cohortGoalCompletionsPerUserWithLifetimeCriteria
— количество достигнутых целей на пользователя для измерения приобретения для когорты.Метрика —
ga:cohortPageviewsPerUserWithLifetimeCriteria
— количество просмотров страниц на пользователя для измерения приобретения для когорты.Метрика —
ga:cohortRevenuePerUserWithLifetimeCriteria
— доход на пользователя для измерения приобретения для когорты.Метрика —
ga:cohortSessionsPerUserWithLifetimeCriteria
— продолжительность сеанса на пользователя для измерения приобретения для когорты.
Выпуск 2016-03-30 (30 марта 2016 г.)
Параметры и показатели Social Data Hub устарели и будут отображать исторические данные только после 30 апреля 2016 года. после этой даты новые данные появляться не будут. В соответствии с политикой устаревания данных эти параметры и показатели будут удалены после 30 сентября 2016 года .
Полный список определений см. в справочнике по параметрам и показателям .
Культурно-просветительные мероприятия
Эти параметры и показатели устарели и будут удалены после 30 сентября 2016 года . Подробные сведения об удалении данных см. в Политике устаревания данных:
- Измерение —
ga:socialActivityEndorsingUrl
— для действия концентратора социальных данных это URL-адрес социального действия (например, URL-адрес публикации в Google+, URL-адрес комментария в блоге и т. д.). - Измерение —
ga:socialActivityDisplayName
— для действия концентратора социальных данных это название социального действия, опубликованного пользователями социальной сети. - Измерение —
ga:socialActivityPost
— для активности концентратора социальных данных это содержание социальной активности (например, содержание сообщения, опубликованного в Google+), опубликованного пользователями социальной сети. - Измерение —
ga:socialActivityTimestamp
— для действия концентратора социальных данных это время, когда социальная активность произошла в социальной сети. - Измерение —
ga:socialActivityUserHandle
— для активности концентратора социальных данных это дескриптор социальной сети (например, имя или идентификатор) пользователей, которые инициировали социальную активность». - Dimension -
ga:socialActivityUserPhotoUrl
- For a social data hub activity, this is the URL of the photo associated with users' social network profiles.“ - Dimension -
ga:socialActivityUserProfileUrl
- For a social data hub activity, this is the URL of the associated users' social network profiles. - Dimension -
ga:socialActivityTagsSummary
- For a social data hub activity, this is a comma-separated set of tags associated with the social activity.“ - Dimension -
ga:socialActivityAction
- For a social data hub activity, this represents the type of social action (eg, vote, comment, +1, etc.) associated with the activity. - Dimension -
ga:socialActivityNetworkAction
- For a social data hub activity, this is the type of social action and the social network where the activity originated. - Dimension -
ga:socialActivityContentUrl
- For a social data hub activity, this is the URL shared by the associated social network users. - Metric -
ga:socialActivities
- Total number of activities where a content URL was shared or mentioned on a social data hub partner network.
Release 2016-02-03 (February 3, 2016)
This release adds a new dimension to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.
Platform or Device
- Dimension -
ga:browserSize
- The viewport size of the users' browsers. Browser size is a session scoped dimension which captures the initial dimensions of the viewport in pixels and is formatted as width X height. For example, 1920x960.
Release 2015-11-16 (November 16, 2015)
This release adds a new parameter to the API.
Include Empty Rows
- This release adds the new optional parameter
include-empty-rows
, which when set tofalse
rows without data will be omitted from the response. The default value istrue
, which is a non breaking change, and as such should not require a code update. See the Core Reporting API reference documentation for details.
Release 2015-10-06 (October 6, 2015)
This release adds new metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.
User
- Metric -
ga:1dayUsers
- Total number of 1-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 1 day period ending on the given date. - Metric -
ga:7dayUsers
- Total number of 7-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 7 day period ending on the given date. - Metric -
ga:14dayUsers
- Total number of 14-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 14 day period ending on the given date. - Metric -
ga:30dayUsers
- Total number of 30-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 30 day period ending on the given date.
Release 2015-09-11 (September 11, 2015)
This release adds new metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.
DoubleClick Ad Exchange (AdX)
- Metric -
ga:adxCTR
- The percentage of pageviews that resulted in a click on an AdX ad. - Metric -
ga:adxClicks
- The number of times AdX ads were clicked on your site. - Metric -
ga:adxCoverage
- Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help you identify sites where your AdX account isn't able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100 - Metric -
ga:adxECPM
- The effective cost per thousand pageviews. It is your AdX Revenue per 1000 pageviews. - Metric -
ga:adxImpressions
- An AdX ad impression is reported whenever an individual ad is displayed on your website. For example, if a page with two ad units is viewed once, we'll display two impressions. - Metric -
ga:adxImpressionsPerSession
- The ratio of AdX ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions). - Metric -
ga:adxMonetizedPageviews
- Monetized Pageviews measures the total number of pageviews on your property that were shown with an ad from your linked AdX account. Note: A single page can have multiple ad units. - Metric -
ga:adxRevenue
- The total estimated revenue from AdX ads. - Metric -
ga:adxRevenuePer1000Sessions
- The total estimated revenue from AdX ads per 1000 Analytics sessions. Note that this metric is based on sessions to your site and not ad impressions. - Metric -
ga:adxViewableImpressionsPercent
- The percentage of ad impressions that were viewable. An impression is considered a viewable impression when it has appeared within a user's browser and had the opportunity to be seen.
Release 2015-07-23 (July 23, 2015)
This release deprecates existing dimensions or metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.
Deprecated Dimensions
These dimensions have been deprecated. Review the Data Deprecation Policy for details on data removal:
- Dimension -
ga:adSlotPosition
- Usega:adSlot
instead. - Dimension -
ga:nextPagePath
- Usega:pagePath
instead. - Dimension -
ga:nextContentGroupXX
- Usega:contentGroupXX
instead.
Release 2015-05-06 (May 6, 2015)
This release adds a new dimension to the API. Review Dimensions and Metrics Reference for the complete list of dimensions and metrics.
Adwords
- Dimension -
ga:adQueryWordCount
- The number of words in the search query.
Release 2015-02-20 (February 20, 2015)
This release adds new dimensions to the API. Review Dimensions and Metrics Reference for the complete list of dimensions and metrics.
Platform or Device
- Dimension -
ga:dataSource
- The data source of a hit. Hits sent from ga.js and analytics.js are reported as “web”; hits sent from the mobile SDKs are reported as “app”. These values can be overridden.
Internal Search
- Dimension -
ga:searchAfterDestinationPage
- The page that the user visited after performing an internal search on your site.
Release 2015-01-21 (January 21, 2015)
This release adds new dimensions and metrics to the API and deprecates two existing metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.
ECommerce
- Metric -
ga:transactionsPerUser
- The total number of transactions divided by total number of users. - Metric -
ga:revenuePerUser
- The total sale revenue provided in the transaction excluding shipping and tax divided by total number of users.
User
- Metric -
ga:sessionsPerUser
- The total number of sessions divided by the total number of users.
Geo Network
- Dimension -
ga:cityId
- The city IDs of users, derived from IP addresses or Geographical IDs. - Dimension -
ga:countryIsoCode
- The country ISO code of users, derived from IP addresses or Geographical IDs. Values are given as an ISO-3166-1 alpha-2 code. - Dimension -
ga:regionId
- The region ID of users, derived from IP addresses or Geographical IDs. In the US, a region is a state, such as New York. - Dimension -
ga:regionIsoCode
- The region ISO code of users, derived from IP addresses or Geographical IDs. Values are given as an ISO-3166-2 code. - Dimension -
ga:subContinentCode
- The sub-continent code of users, derived from IP addresses or Geographical IDs. For example, Polynesia or Northern Europe. Values are given as a UN M.49 code.
DoubleClick Campaign Manager
- Metric -
ga:dcmROAS
- DCM Return On Ad Spend (ROAS) (premium only).
Deprecated Metrics
These metrics have been deprecated. Review the Data Deprecation Policy for details on data removal: + Metric - ga:dcmROI
- Use ga:dcmROAS
instead. + Metric - ga:dcmMargen
- Use ga:dcmROAS
instead.
Release 2014-10-09 (October 9, 2014)
This release adds a new metric to the API and deprecates two existing metrics. Check the Dimensions and Metrics Reference for the complete list of definitions.
AdWords
- Metric -
ga:ROAS
- Return On Ad Spend (ROAS) is the total transaction revenue and goal value divided by derived advertising cost.
Deprecated Dimensions and Metrics
These dimensions and metrics have been deprecated. Review the Data Deprecation Policy for details on data removal: + Metric - ga:ROI
- Use ga:ROAS
instead. + Metric - ga:margin
- Use ga:ROAS
instead.
Release 2014-10-01 (October 1, 2014)
This release adds new metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.
AdSense
- Metric -
ga:adsenseCoverage
- The percentage of ad requests that returned at least one ad. - Metric -
ga:adsenseViewableImpressionPercent
- The percentage of impressions that were viewable.
Release 2014-08-25 (August 25, 2014)
This release includes the addition of a new session metric, a new traffic sources dimension, and new DoubleClick Campaign Manager dimensions and metrics.
Dimensions and Metrics
Review the Dimensions and Metrics Reference for the complete list of definitions.
Session
- Metric -
ga:hits
- Total number of hits sent to Google Analytics. This metric sums all hit types (eg pageview, event, timing, etc.)
Traffic Sources
- Dimension -
ga:campaignCode
- When using manual campaign tracking, the value of the utm_id campaign tracking parameter.
DoubleClick Campaign Manager
- Dimension -
ga:dcmClickAd
- DCM ad name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickAdId
- DCM ad ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickAdType
- DCM ad type name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickAdTypeId
- DCM ad type ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickAdvertiser
- DCM advertiser name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickAdvertiserId
- DCM advertiser ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCampaign
- DCM campaign name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCampaignId
- DCM campaign ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCreative
- DCM creative name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCreativeId
- DCM creative ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCreativeType
- DCM creative type name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCreativeTypeId
- DCM creative type ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickCreativeVersion
- DCM creative version of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickRenderingId
- DCM rendering ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickSite
- Site name where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickSiteId
- DCM site ID where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickSitePlacement
- DCM site placement name of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickSitePlacementId
- DCM site placement ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmClickSpotId
- DCM Floodlight configuration ID of the DCM click matching the Google Analytics session (premium only). - Dimension -
ga:dcmFloodlightActivity
- DCM Floodlight activity name associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightActivityAndGroup
- DCM Floodlight activity name and group name associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightActivityGroup
- DCM Floodlight activity group name associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightActivityGroupId
- DCM Floodlight activity group ID associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightActivityId
- DCM Floodlight activity ID associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightAdvertiserId
- DCM Floodlight advertiser ID associated with the floodlight conversion (premium only). - Dimension -
ga:dcmFloodlightSpotId
- DCM Floodlight configuration ID associated with the floodlight conversion (premium only). - Dimension -
ga:dcmLastEventAd
- DCM ad name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAdId
- DCM ad ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAdType
- DCM ad type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAdTypeId
- DCM ad type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAdvertiser
- DCM advertiser name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAdvertiserId
- DCM advertiser ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventAttributionType
- There are two possible values (ClickThrough and ViewThrough). If the last DCM event associated with the Google Analytics session was a click, then the value will be ClickThrough. If the last DCM event associated with the Google Analytics session was an ad impression, then the value will be ViewThrough (premium only). - Dimension -
ga:dcmLastEventCampaign
- DCM campaign name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCampaignId
- DCM campaign ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCreative
- DCM creative name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCreativeId
- DCM creative ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCreativeType
- DCM creative type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCreativeTypeId
- DCM creative type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventCreativeVersion
- DCM creative version of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventRenderingId
- DCM rendering ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventSite
- Site name where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventSiteId
- DCM site ID where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventSitePlacement
- DCM site placement name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventSitePlacementId
- DCM site placement ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Dimension -
ga:dcmLastEventSpotId
- DCM Floodlight configuration ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only). - Metric -
ga:dcmFloodlightQuantity
- The number of DCM Floodlight conversions (premium only). - Metric -
dcmFloodlightRevenue
- DCM Floodlight revenue (premium only).
Release 2014-07-14 (July 14, 2014)
This release includes the addition of the new content grouping dimensions and metrics.
Dimensions and Metrics
Review the Dimensions and Metrics Reference for the complete list of definitions.
Content Grouping
- Dimension -
ga:landingContentGroupXX
- The first matching content group in a user's session. - Dimension -
ga:nextContentGroupXX
- Refers to content group that was visited after another content group. - Dimension -
ga:contentGroupXX
- Content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/url regex match, or predefined rules. - Dimension -
ga:previousContentGroupXX
- Refers to content group that was visited before another content group. - Metric -
ga:contentGroupUniqueViewsXX
- The number of different (unique) pages within a session for the specified content group. This takes into account both the pagePath and pageTitle to determine uniqueness.
Release 2014-06-12 (June 12, 2014)
This release includes a new dateOfSession
condition for Segments and the addition of new Enhanced Ecommerce dimensions and metrics.
Segments
Segments now support a new dateOfSession
condition which can restrict a segment to a group of users who have initiated a session within a certain date range. See the Segments Developer Guide for details.
Dimensions and Metrics
Review the Dimensions and Metrics Reference for the complete list of definitions for Enhanced Ecommerce .
Enhanced Ecommerce
- Dimension -
ga:internalPromotionCreative
- The creative content designed for a promotion. - Dimension -
ga:internalPromotionId
- The ID you are using for the promotion. - Dimension -
ga:internalPromotionName
- The name of the promotion. - Dimension -
ga:internalPromotionPosition
- The position of the promotion on the web page or application screen. - Dimension -
ga:orderCouponCode
- Code for the order-level coupon. - Dimension -
ga:productBrand
- The brand name under which the product is sold. - Dimension -
ga:productCategoryHierarchy
- The hierarchical category in which the product is classified (Enhanced Ecommerce). - Dimension -
ga:productCategoryLevelXX
- Level (1-5) in the product category hierarchy, starting from the top. - Dimension -
ga:productCouponCode
- Code for the product-level coupon. - Dimension -
ga:productListName
- The name of the product list in which the product appears. - Dimension -
ga:productListPosition
- The position of the product in the product list. - Dimension -
ga:productVariant
- The specific variation of a product, eg, XS, S, M, L for size or Red, Blue, Green, Black for color. - Dimension -
ga:checkoutOptions
- User options specified during the checkout process, eg, FedEx, DHL, UPS for delivery options or Visa, MasterCard, AmEx for payment options. This dimension should be used along with Shopping Stage. - Dimension -
ga:shoppingStage
- Various stages of the shopping experience that users completed in a session, eg, PRODUCT_VIEW, ADD_TO_CART, CHECKOUT, etc. - Metric -
ga:internalPromotionCTR
- The rate at which users clicked through to view the internal promotion (number of clicks / number of times promotion appeared). - Metric -
ga:internalPromotionClicks
- The number of clicks on an internal promotion. - Metric -
ga:internalPromotionViews
- The number of views of an internal promotion. - Metric -
ga:localProductRefundAmount
- Refund amount for a given product in the local currency. - Metric -
ga:localRefundAmount
- Total refund amount for the transaction in the local currency. - Metric -
ga:productAddsToCart
- Number of times the product was added to the shopping cart. - Metric -
ga:productCheckouts
- Number of times the product was included in the check-out process. - Metric -
ga:productDetailViews
- Number of times users viewed the product-detail page. - Metric -
ga:productListClicks
- Number of times users clicked the product when it appeared in the product list. - Metric -
ga:productListViews
- Number of times the product appeared in a product list. - Metric -
ga:productListCTR
- The rate at which users clicked through on the product in a product list. - Metric -
ga:productRefunds
- Number of times a refund was issued for the product. - Metric -
ga:productRefundAmount
- Total refund amount associated with the product. - Metric -
ga:productRemovesFromCart
- Number of times the product was removed from shopping carts. - Metric -
ga:productRevenuePerPurchase
- Average product revenue per purchase (commonly used with Product Coupon Code). - Metric -
ga:buyToDetailRate
- Unique purchases divided by views of product detail pages. - Metric -
ga:cartToDetailRate
- Product adds divided by views of product details. - Metric -
ga:quantityAddedToCart
- Number of product units added to cart. - Metric -
ga:quantityCheckedOut
- Number of product units included in check out. - Metric -
ga:quantityRefunded
- Number of product units refunded. - Metric -
ga:quantityRemovedFromCart
- Number of product units removed from cart. - Metric -
ga:refundAmount
- Currency amount refunded for a transaction. - Metric -
ga:totalRefunds
- Number of refunds that have been issued.
Release 2014-06-04 (June 4, 2014)
This release includes a bug fix for column header names as well as the addition of new dimensions and metrics.
Dimensions and Metrics
Review the Dimensions and Metrics Reference for the complete list of definitions.
System
- Dimension -
ga:sourcePropertyDisplayName
- Source property display name of roll-up properties. This is valid only for roll-up properties. - Dimension -
ga:sourcePropertyTrackingId
- Source property tracking ID of roll-up properties. This is valid only for roll-up properties
Channel Grouping
- Dimension -
ga:channelGrouping
- The default channel grouping that is shared within the View (Profile).
Related Products
- Dimension -
ga:correlationModelId
- Correlation Model ID for related products. - Dimension -
ga:queryProductId
- ID of the product being queried. - Dimension -
ga:queryProductName
- Name of the product being queried. - Dimension -
ga:queryProductVariation
- Variation of the product being queried. - Dimension -
ga:relatedProductId
- ID of the related product. - Dimension -
ga:relatedProductName
- Name of the related product. - Dimension -
ga:relatedProductVariation
- Variation of the related product. - Metric -
ga:correlationScore
- Correlation Score for related products. - Metric -
ga:queryProductQuantity
- Quantity of the product being queried. - Metric -
ga:relatedProductQuantity
- Quantity of the related product.
Header column name correction
- There was a bug in the 2014-04-16 release; if you queried for a deprecated dimension or metric, the API would return column headers with the replacement dimension or metric. Now it correctly returns the same dimension or metric name used in the request.
Release 2014-04-16 (April 16, 2014)
This release includes the addition and renaming of dimensions and metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.
New Dimensions and Metrics
The following dimensions have been added to the Core Reporting API:
AdWords
- Dimension -
ga:isTrueViewVideoAd
-Yes
orNo
- Indicates whether the ad is an AdWords TrueView video ad.
Time
- Dimension -
ga:nthHour
- Index for each hour in the specified date range. Index for the first hour of first day (ie, start-date) in the date range is 0, 1 for the next hour, and so on.
Renamed Dimensions and Metrics
All visitor and visit based dimensions and metrics have been renamed to instead use user and session respectively.
The following dimensions and metrics have been renamed. Review the Data Deprecation Policy for details on data renaming:
Audience
- Dimension -
ga:visitorAgeBracket
- Usega:userAgeBracket
instead. - Dimension -
ga:visitorGender
- Usega:userGender
instead.
Ecommerce
- Metric -
ga:transactionRevenuePerVisit
- Usega:transactionRevenuePerSession
instead. - Metric -
ga:transactionsPerVisit
- Usega:transactionsPerSession
instead.
Event Tracking
- Metric -
ga:eventsPerVisitWithEvent
- Usega:eventsPerSessionWithEvent
instead. - Metric -
ga:visitsWithEvent
- Usega:sessionsWithEvent
instead.
Goal Conversions
- Metric -
ga:goalValuePerVisit
- Usega:goalValuePerSession
instead.
Internal Search
- Metric -
ga:percentVisitsWithSearch
- Usega:percentSessionsWithSearch
instead. - Metric -
ga:searchVisits
- Usega:searchSessions
instead.
Page Tracking
- Metric -
ga:pageviewsPerVisit
- Usega:pageviewsPerSession
instead.
Session
- Dimension -
ga:visitLength
- Usega:sessionDurationBucket
instead. - Metric -
ga:avgTimeOnSite
- Usega:avgSessionDuration
instead. - Metric -
ga:timeOnSite
- Usega:sessionDuration
instead. - Metric -
ga:visitBounceRate
- Usega:bounceRate
instead. - Metric -
ga:visits
- Usega:sessions
instead.
Social Interactions
- Dimension -
ga:socialInteractionNetworkActionVisit
- Usega:socialInteractionNetworkActionSession
instead. - Metric -
ga:socialInteractionsPerVisit
- Usega:socialInteractionsPerSession
instead.
User
- Dimension -
ga:daysSinceLastVisit
- Usega:daysSinceLastSession
instead. - Dimension -
ga:visitCount
- Usega:sessionCount
instead. - Dimension -
ga:visitorType
- Usega:userType
instead. - Dimension -
ga:visitsToTransaction
- Usega:sessionsToTransaction
instead. - Metric -
ga:newVisits
- Usega:newUsers
instead. - Metric -
ga:percentNewVisits
- Usega:percentNewSessions
instead. - Metric -
ga:visitors
- Usega:users
instead.
Release 2014-04-11 (April 11, 2014)
Segments: Core Reporting API v2.4 & v3.0
New segments support in the Core Reporting API.
- The
segment
parameter now supports user and sequence segments. User level and session level segments created in the web interface can be queried with thesegment
parameter. - A new syntax for dynamic segments is available to use with the
segment
parameter. For details see the Segments Dev Guide - The
dynamic::
prefix has been deprecated. It is recommended that you migrate to the new syntax as soon as possible.
Release 2013-12-12 (December 12, 2013)
This release includes a new Data Table response format and the addition and deprecation of dimensions and metrics (Review the Dimensions and Metrics Reference for the complete list of definitions).
Data Table Output
To make it easier to render your Google Analytics data using Google Charts visualizations, the API can optionally return a Data Table object in the response.
- An optional
output
query parameter has been added to the API. It can be used to select the output format of Analytics data in the response, which is JSON by default. If set todatatable
, adataTable
property that contains a Data Table object is included in the response. This object can be used directly with Google Charts . See the Core Reporting API reference for details.
New Dimensions and Metrics
The following dimensions and metrics have been added to the Core Reporting API:
Time
- Dimension -
ga:minute
- Returns the minute in the hour. The possible values are between00
and59
. - Dimension -
ga:nthMinute
- Index for each minute in the specified date range. Index for the first minute of first day (ie, start-date) in the date range is0
,1
for the next minute, and so on.
Audience
- Dimension -
ga:visitorAgeBracket
- Age bracket of visitor. - Dimension -
ga:visitorGender
- Gender of visitor. - Dimension -
ga:interestAffinityCategory
- Indicates that users are more likely to be interested in learning about the specified category. - Dimension -
ga:interestInMarketCategory
- Indicates that users are more likely to be ready to purchase products or services in the specified category. - Dimension -
ga:interestOtherCategory
- Indicates that users are more likely to be interested in learning about the specified category, and more likely to be ready to purchase.
Dimensions and Metrics Allowed In Segments
These dimensions and metrics can now be used in segments:
- Dimension -
ga:sourceMedium
- Combined values ofga:source
andga:medium
. - Metric -
ga:localItemRevenue
- Product revenue in local currency.
Deprecated Dimensions and Metrics
These dimensions and metrics have been deprecated. Review the Data Deprecation Policy for details on data removal:
- Dimension -
ga:isMobile
- Usega:deviceCategory
instead (eg,ga:deviceCategory==mobile
). - Dimension -
ga:isTablet
- Usega:deviceCategory
instead (eg,ga:deviceCategory==tablet
). - Metric -
ga:entranceBounceRate
- Usega:visitBounceRate
instead.
Release 2013-10-28 (October 28, 2013)
This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.
Adsense
Access to Adsense data has been added:
- Met -
ga:adsenseRevenue
- The total revenue from AdSense ads. - Met -
ga:adsenseAdUnitsViewed
- The number of AdSense ad units viewed. An Ad unit is a set of ads displayed as a result of one piece of the AdSense ad code. Details: https://support.google.com/adsense/answer/32715 . - Met -
ga:adsenseAdsViewed
- The number of AdSense ads viewed. Multiple ads can be displayed within an Ad Unit. - Met -
ga:adsenseAdsClicks
- The number of times AdSense ads on your site were clicked. - Met -
ga:adsensePageImpressions
- The number of pageviews during which an AdSense ad was displayed. A page impression can have multiple Ad Units. - Met -
ga:adsenseCTR
- The percentage of page impressions that resulted in a click on an AdSense ad. (ga:adsenseAdsClicks/ga:adsensePageImpressions
) - Met -
ga:adsenseECPM
- The estimated cost per thousand page impressions. It is your AdSense Revenue per 1000 page impressions. (ga:adsenseRevenue/(ga:adsensePageImpressions/1000). - Met -
ga:adsenseExits
- The number of sessions that ended due to a user clicking on an AdSense ad.
- Met -
Time
- Dim -
ga:isoYear
- The ISO year of the visit. Details: http://en.wikipedia.org/wiki/ISO_week_date .ga:isoYear
should only be used withga:isoWeek
sincega:week
represents gregorian calendar. - Dim -
ga:isoYearIsoWeek
- Combined values ofga:isoYear
andga:isoWeek
.
Adwords
This data is found in Adwords reports:
- Dim -
ga:adKeywordMatchType
- The match types applied to your keywords (Phrase, Exact, Broad). Details: Understanding the Search terms report .
- Dim -
Release 2013-10-14 (October 14, 2013)
New Sample Size Control and Relative Dates Features
Relative Dates
- Support for relative dates has been added to the Core Reporting API.
today
,yesterday
, andNdaysAgo
are now valid values for thestart-date
andend-date
query parameters. - Using these values will automatically determine the date range based on the current date at the time the query is made, and on the timezone of the view (profile) specified in the query. See the API Reference for additional details.
Sampling Level
- A new parameter,
samplingLevel
, has been introduced that allows you to set the sampling level (ie the number of visits used to calculate the result) for a reporting query. Allowed values are:DEFAULT
,FASTER
, andHIGHER_PRECISION
. - 2 new fields have been added to the API Response:
sampleSize
andsampleSpace
. You can use these values to calculate the percentage of visits that were used for a sampled response. - See the API Reference and Sampling for additional details.
Release 2013-07-22 (July 23, 2013)
Bug Fixes
- The
ga:adwordsCustomerID
now correctly returns the 10-digit AdWords Customer ID corresponding to the AdWords API AccountInfo.customerId . This fix makes it possible to join Analytics data with multiple AdWords accounts.
Release 2013-07-15 (July 16, 2013)
As part of the new segments launch , we will be rolling out the following changes to the Core Reporting API.
- The
segment
parameter now supports the new alphanumeric ID for custom advanced segments, which is returned in the Management API Segments collection . - The current numeric IDs for custom segments are now under deprecation. These legacy IDs will continue to be supported for 6 months. We recommend applications that save user segment IDs to switch to the new alphanumeric IDs. Once the deprecation period is over, any queries with the old numeric IDs will return an error.
- Currently, only the visit level segments created in the web interface will be queryable through the
segment
parameter. - The existing default segments with negative numeric IDs will not be affected. However, the new default segments are currently not supported.
Release 2013-07-09 (July 9, 2013)
This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.
App Tracking
- This data is found in App profile reports:
- Dim -
ga:appId
- The id of the application. - Dim -
ga:appInstallerId
- ID of the installer (eg, Google Play Store) from which the app was downloaded. By default, the app installer id is set based on thePackageManager#getInstallerPackageName
method. - Dim -
ga:appName
- The name of the application. - Dim -
ga:appVersion
- The version of the application. - Dim -
ga:exitScreenName
- The name of the screen when the user exited the application. - Dim -
ga:landingScreenName
- The name of the first screen viewed. - Dim -
ga:screenDepth
- The number of screenviews per session reported as a string. Can be useful for historgrams. - Dim -
ga:screenName
- The name of the screen. - Met -
ga:avgScreenviewDuration
- The average amount of time users spent on a screen in seconds. - Met -
ga:timeOnScreen
- The time spent viewing the current screen. - Met -
ga:screenviews
- The total number of screen views. Use this instead ofga:appviews
. - Met -
ga:uniqueScreenviews
- The number of different (unique)ga:screenviews
within a session. Use this instead ofga:uniqueAppviews
. - Met -
ga:screenviewsPerSession
- The average number ofga:screenviews
per session. Use this instead ofga:appviewsPerVisit
.
- Dim -
Deprecated
The following metrics have been deprecated. Use the new metric name instead.
- Met -
ga:appviews
- Usega:screenviews
instead. - Met -
ga:uniqueAppviews
- Usega:uniqueScreenviews
instead. - Met -
ga:appviewsPerVisit
- Usega:screenviewsPerSession
instead.
Custom Variables or Columns
Access to custom dimension and metrics:
- Dim -
ga:dimensionXX
- The name of the requested custom dimension, whereXX
refers the number/index of the custom dimension. - Met -
ga:metricXX
- The name of the requested custom metric, whereXX
refers the number/index of the custom metric.
- Dim -
Documentation Changes
The following Custom Variable dimension and metric have been renamed. This is a documentation change only, it will not require you to update your queries.
-
ga:customVarName(n)
→ga:customVarNameXX
-
ga:customVarValue(n)
→ga:customVarValueXX
Ecommerce
- Dim -
ga:currencyCode
- The local currency code of the transaction based on ISO 4217 standard. - Met -
ga:localItemRevenue
- Product revenue in local currency. - Met -
ga:localTransactionRevenue
- Transaction revenue in local currency. - Met -
ga:localTransactionShipping
- Transaction shipping cost in local currency. - Met -
ga:localTransactionTax
- Transaction tax in local currency.
Exceptions
- This data comes from exception tracking.
- Dim -
ga:exceptionDescription
- The description for the exception. - Met -
ga:exceptionsPerScreenview
- The number of exceptions thrown divided by the number of screenviews. - Met -
ga:fatalExceptionsPerScreenview
- The number of fatal exceptions thrown divided by the number of screenviews.
- Dim -
Goal Conversions
- Dim -
ga:goalCompletionLocation
- The page path or screen name that matched any destination type goal completion. - Dim -
ga:goalPreviousStep1
- The page path or screen name that matched any destination type goal, one step prior to the goal completion location. - Dim -
ga:goalPreviousStep2
- The page path or screen name that matched any destination type goal, two steps prior to the goal completion location. - Dim -
ga:goalPreviousStep3
- The page path or screen name that matched any destination type goal, three steps prior to the goal completion location.
Documentation Changes
The following Goal Conversions dimension and metrics have been renamed. This is a documentation change only, it will not require you to update your queries.
-
ga:goal(n)AbandonRate
→ga:goalXXAbandonRate
-
ga:goal(n)Abandons
→ga:goalXXAbandons
-
ga:goal(n)Completions
→ga:goalXXCompletions
-
ga:goal(n)ConversionRate
→ga:goalXXConversionRate
-
ga:goal(n)Starts
→ga:goalXXStarts
-
ga:goal(n)Value
→ga:goalXXValue
-
ga:searchGoal(n)ConversionRate
→ga:searchGoalXXConversionRate
Internal Search
- Met -
ga:percentSearchRefinements
- The percentage of number of times a refinement (ie, transition) occurs between internal search keywords within a session.
Page Tracking
- Met -
ga:pageValue
- The average value of this page or set of pages. Page Value is ((Transaction Revenue + Total Goal Value) divided by Unique Pageviews for the page or set of pages).
Platform or Device
This data is derived from the HTTP User-Agent string.
- Dim -
ga:deviceCategory
- The type of device: Desktop, Tablet, or Mobile. - Dim -
ga:isTablet
- Indicates tablet visitors. The possible values areYes
orNo
. - Dim -
ga:mobileDeviceMarketingName
- Marketing name used for mobile device.
- Dim -
Social Interactions
This data comes from onsite social interaction tracking.
- Dim -
ga:socialEngagementType
- Engagement type. Possible values areSocially Engaged
orNot Socially Engaged
.
- Dim -
Time
- Dim -
ga:dateHour
- Combined values ofga:date
andga:hour
. - Dim -
ga:dayOfWeekName
- The name of the day of the week (in English). - Dim -
ga:isoWeek
- The ISO week number, where each week starts with a Monday. Details: http://en.wikipedia.org/wiki/ISO_week_date . - Dim -
ga:yearMonth
- Combined values ofga:year
andga:month
. - Dim -
ga:yearWeek
- Combined values ofga:year
andga:week
.
Traffic Sources
- Dim -
ga:fullReferrer
- The full referring URL including the hostname and path. - Dim -
ga:sourceMedium
- The combined values ofga:source
andga:medium
.
Release 2013-04-04 (April 4, 2013)
- This release adds 2 new experiments metrics : -
ga:experimentId
-ga:experimentVariant
Release 2013-01-31 (January 31, 2013)
- This release adds 5 new site speed metrics:
-
ga:domInteractiveTime
-
ga:avgDomInteractiveTime
-
ga:domContentLoadedTime
-
ga:avgDomContentLoadedTime
-
ga:domLatencyMetricsSample
-
Release 2013-01-14 (January 14, 2013)
- This release adds a new default segment for Tablet Traffic,
gaid::-13
.
Release 2012-09 (September 18, 2012)
This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for definitions.
App Tracking
- This data is found in Mobile App tracking SDK reports:
- Met -
ga:uniqueAppviews
- The number of app views per session. - Met -
'ga:appviews
- The total number of app views. - Met -
ga:appviewsPerVisit
- The average number of app views per session.
- Met -
Traffic Sources
- Dim -
ga:socialNetwork
- A string representing the social network name. This can be related to the referring social network for traffic sources, or to the social network for social data hub activities. Eg Google+, Blogger, reddit, etc. - Dim -
ga:hasSocialSourceReferral
- Indicates visits that arrived to the site from a social source (ie A social network such as Google+, Facebook, Twitter, etc.). The possible values are Yes or No, where the first letter must be capitalized.
Social Activities
- This data comes from offsite activity imported from Social Data Hub partners.
- Dim -
ga:socialActivityDisplayName
- For a social data hub activity, this string represents the title of the social activity posted by the social network user. - Dim -
ga:socialActivityEndorsingUrl
- For a social data hub activity, this string represents the URL of the social activity (eg the Google+ post URL, the blog comment URL, etc.) - Dim -
ga:socialActivityPost
- For a social data hub activity, this string represents the content of the social activity posted by the social network user (eg The message content of a Google+ post) - Dim -
ga:socialActivityTimestamp
- For a social data hub activity, this string represents when the social activity occurred on the social network. - Dim -
ga:socialActivityUserPhotoUrl
- For a social data hub activity, this string represents the URL of the photo associated with the user's social network profile. - Dim -
ga:socialActivityUserProfileUrl
- For a social data hub activity, this string represents the URL of the associated user's social network profile. - Dim -
ga:socialActivityContentUrl
- For a social data hub activity, this string represents the URL shared by the associated social network user. - Dim -
ga:socialActivityTagsSummary
- For a social data hub activity, this is a comma-separated set of tags associated with the social activity. - Dim -
ga:socialActivityUserHandle
- For a social data hub activity, this string represents the social network handle (ie name) of the user who initiated the social activity. - Dim -
ga:socialActivityAction
- For a social data hub activity, this string represents the type of social action associated with the activity (eg vote, comment, +1, etc.). - Dim -
ga:socialActivityNetworkAction
- For a social data hub activity, this string represents the type of social action and the social network where the activity originated. - Met -
ga:socialActivities
- The count of activities where a content URL was shared/mentioned on a social data hub partner network.
- Dim -
Social Interactions
- This data comes from onsite social interaction tracking.
- Dim -
ga:socialInteractionAction
- For social interactions, a string representing the social action being tracked (eg +1, like, bookmark) - Dim -
ga:socialInteractionNetwork
- For social interactions, a string representing the social network being tracked (eg Google, Facebook, Twitter, LinkedIn) - Dim -
ga:socialInteractionNetworkAction
- For social interactions, a string representing the concatenation of thega:socialInteractionNetwork
andga:socialInteractionAction
being tracked (eg Google: +1, Facebook: like) - Dim -
ga:socialInteractionTarget
- For social interactions, a string representing the URL (or resource) which receives the social network action. - Met -
ga:socialInteractions
- The total number of social interactions on your site. - Met -
ga:uniqueSocialInteractions
- The total number of unique social interactions on your site. Based on the value pairga:socialInteractionNetwork
andga:socialInteractionAction
- Met -
ga:socialInteractionsPerVisit
-ga:socialInteractions
/ga:uniqueSocialInteractions
. The average number of social interactions per visit to your site.
- Dim -
Geo / Network
- Dim -
ga:metro
- The Designated Market Area (DMA) from where traffic originated.
Page Tracking
- Dim -
ga:pagePathLevel1
- This dimension rolls up all the pagePaths in the first hierarchical level in pagePath. - Dim -
ga:pagePathLevel2
- This dimension rolls up all the pagePaths in the second hierarchical level in pagePath. - Dim -
ga:pagePathLevel3
- This dimension rolls up all the pagePaths in the third hierarchical level in pagePath. - Dim -
ga:pagePathLevel4
- This dimension rolls up all the pagePaths in the fourth hierarchical level in pagePath. All the additional levels in the pagePath hierarchy are also rolled up in this dimension.
Exception Tracking
This data come from exception tracking data.
- Met -
ga:exceptions
- The number of exceptions that were sent to Google Analytics. - Met -
ga:fatalExceptions
- The number of exceptions where isFatal is set to true.
- Met -
User Timings
This data comes from user timing data.
- Dim -
ga:userTimingCategory
- A string for categorizing all user timing variables into logical groups for easier reporting purposes. - Dim -
ga:userTimingLabel
- A string to indicate the name of the action of the resource being tracked. - Dim -
ga:userTimingVariable
- A string that can be used to add flexibility in visualizing user timings in the reports. - Dim -
ga:userTimingValue
The number of milliseconds in elapsed time sent to Google Analytics. - Met -
ga:userTimingSample
- The number of samples that were sent. - Met -
ga:avgUserTimingValue
- The average user timing value.ga:userTimiingValue
/ga:userTimiingSample
.
- Dim -
Device / Platform
- This data comes from the user agent of the collected data.
- Dim -
ga:mobileDeviceBranding
- Mobile manufacturer or branded name (examples: Samsung, HTC, Verizon, T-Mobile). - Dim -
ga:mobileDeviceModel
- Mobile device model (example: Nexus S) - Dim -
ga:mobileInputSelector
- Selector used on the mobile device (examples: touchscreen, joystick, click-wheel, stylus) -
Dim - ga:mobileDeviceInfo
- The branding, model, and marketing name used to identify the mobile device.
- Dim -
Release 2012-05 (May 31, 2012)
Bug Fixes
- The API now correctly handles UTF-8 characters in a filter or dynamic segment.
Release 2012-05 (May 24, 2012)
This release enables Google Analytics premium accounts to access up to 50 custom variables.
Release 2012-02 (February 14, 2012)
This release fixes 2 bugs:
Bug Fixes
Query filters that contain special characters inside regular expressions no longer return server errors.
Combining a metric filter with an advanced segment no longer returns an error.
Release 2012-02 (February 8, 2012)
This release add new site speed metrics to the API.
New Metrics
- The following site speed metrics have been added:
-
ga:speedMetricsSample
-
ga:domainLookupTime
-
ga:pageDownloadTime
-
ga:redirectionTime
-
ga:serverConnectionTime
-
ga:serverResponseTime
-
ga:avgDomainLookupTime
-
ga:avgPageDownloadTime
-
ga:avgRedirectionTime
-
ga:avgServerConnectionTime
-
ga:avgServerResponseTime
-
Check the Dimensions and Metrics Reference for definitions.
API Version 2.3 Deprecation Reminder
Version 2.3 of the Data Export API has been depreacted for 2 months. In roughly 4 more months we will shut down this service and only support the new Core Reporting API version 3.0 and version 2.4 .
We highly recommend you migrate your applications to version 3.0.
In 4 months requests to the legacy version 2.3 XML data feed will be forwarded to version 2.4 and return a version 2.4 XML response. At that point, all version 2.4 quota policies will apply to the version 2.3 requests.
All requests for version 2.3 JSON or the Google Data JavaScript client library that uses version 2.3 JSON output, will return
404
status codes.To get full quota, both version 3.0 and version 2.4 require you to register your application in the Google APIs Console and use an API key (or OAuth 2.0 token) in each request.
Release 2012-01 (January 26, 2012)
We fixed a small bug with ga:visitLength
. This dimension now returns correct data.
Release 2011-12 (December 5, 2011)
This release effects all Google Analytics API developers. It announces two new versions of the API, requires applications to register, introduces a new quota policy, and it changes the API name to the Core Reporting API. Finally it deprecates the existing Data Export API version 2.3.
Version 3.0
The Core Reporting API version 3.0 is the latest major version of our API and is not backwards compatible. All future development of the API will be done on this version.
New Features
- New JSON based output reduces the size of the response ~10x from the previous XML output.
- New Google API client libraries that support Java, JavaScript, Python, PHP, Ruby, and .Net.
- Support for the Google Discovery API .
- Support for OAuth 2.0 as the new, recommended way to authorize users.
Updates
- New URL to make requests:
https://www.googleapis.com/analytics/v3/data/ga…
. - Registration and developers tokens required.
- All requests for configuration data should be done through the Management API .
- New URL to make requests:
Version 2.4
The Core Reporting API version 2.4 is a minor version upgrade that is mostly backwards compatible with the existing Data Export API version 2.3.
Updates
- New URL to make requests:
https://www.googleapis.com/analytics/v2.4/data…
- Registration and developers tokens required.
- XML output consistent with version 2.3, so the other existing Google Data client libraries will continue to work.
- Error code for quota errors have changed from
503
to403
- JSON responses are not supported.
- Google Data JavaScript client library not supported.
- No Account Feed. All requests for configuration data should be done through the Management API .
- New URL to make requests:
Registration
All applications built using the Google Analytics API must be registered as a project through the Google APIs Console .
Each request to the API must include either a API key or for OAuth 2.0, a Client Id and Client Secret.
Quota Policy
The following quota applies to both Anlaytics APIs (Management API and Data Export API)
- 50,000 requests per project per day
- 10 queries per second (QPS) per IP address
The following quota applies to the Data Export API
- 10,000 requests per profile per day
- 10 concurrent requests per profile
For unregistered applications, we provide a very low grace quota to accommodate a small amount of testing.
Deprecations
This release also announces the deprecation of Version 2.3 and the upcoming shut down of the Account Feed in the Data Export API. In 6 months:
Requests to the version 2.3 XML data feed will be forwarded to version 2.4 and return a version 2.4 response. At that point, all version 2.4 quota policies will apply to the version 2.3 requests.
Requests to the version 2.3 JSON output will not be supported by the version 2.4 response and will return
404 Not Found
status codes. If you need a JSON response, upgrade to Version 3.0.Requests to the Account Feed in the Data Export API will return
404 Not Found
status codes. All requests for configuration data should be done through the Management API .
Release 2011-09 (September 7, 2011)
This release adds fresher AdWords data and more combinations for AdWords dimensions and metrics.
AdWords data is now updated within an hour. Before the data was updated daily.
We've relaxed a number valid combinations restrictions with AdWords data.
A few weeks ago we made a change to disallow API queries that asked for ga:adGroup
or ga:adContent
with ga:impressions
, since this combination returned 0. With this change, this combination is now back and has been fixed to return correct data.
Release 2011-08 (August 11, 2011)
This release fixes some invalid combinations of dimensions and metrics
Fixed invalid metrics/dimensions combinations
Last month we announced some upcoming changes to the API to disallow some invalid queries in the data feed that do not return any data. We have now made those changes to the API, and the following combinations are now invalid:
- Product dimensions cannot be combined with transaction metrics.
-
ga:adContent
orga:adGroup
cannot be combined withga:impressions
.
Instead of returning a response with 0 results, the API now returns 400 error code for all queries that ask for these combinations.
Release 2011-07 (July 11, 2011)
This release deprecates the confidence interval value in metrics.
Deprecation of Confidence Interval
If you haven't already done so, please stop using confidence interval values for metrics. With this release, the Data Export API Data Feed returns 0.0 for all the confidence interval values. In a month or so, we will we will completely remove this attribute from all metric elements.
To determine if a response has been sampled, please use the containsSampledData field in the response.
Release 2011-05 (May 31, 2011)
This release adds 3 new metrics and updates the return value of two.
New Data Updates
- We added 3 new metrics dealing with site speed performance to the API:
-
ga:pageLoadSample
-
ga:pageLoadTime
-
ga:avgPageLoadTime
-
Metric Updates
To specify currency values in filters, you must specify the actual value passed in from the tracking code, (eg 1 unit will now be specified as 1).
ga:CTR
now returns the actual percent (eg a value of 2% is returned as 2).
Release 2011-04 (April 19, 2011)
This release improves improves Data Feed performance and adds new data:
Performance Improvement
- This release improves data feed latency by 30 to 35%.
New Data Updates
- We have updated the list of dimensions and metrics that are allowed in Advanced Segments. Please refer to the updated list to make sure that your requests are valid.
Upcoming Changes
Currently, you need to specify a currency filter value as micro units, (eg 1 unit of currency is specified as 1000000). In the near future, you will need to specify the actual value passed in from the tracking code, (eg 1 unit will now be specified as 1).
Currently,
ga:CTR
is apercent
and returns the value 0.02. In the near future this will change to return the actual percent (eg 2).
Release 2011-03 (March 9, 2011)
This release adds more data to the Data Feed:
New Data Updates
The following Time dimension has been added:
ga:dayOfWeek
The following Internal Search metric has been added:
ga:percentVisitsWithSearch
The following Event Tracking metrics have been added:
-
ga:visitsWithEvent
-
ga:eventsPerVisitWithEvent
-
Upcoming Changes
Currently the API returns 401
status codes for for various authorization issues. Within the next couple of weeks, the 401
status will be used exclusively for invalid tokens, giving developers a way to error handle this particular exception.
Release 2011-01 (January 24, 2011)
This release adds significantly more data to the Data Feed:
New Data Updates
The calculation of
ga:visitors
has been changed to return the number of unique visitors across the date range and now supports more dimension and metric combinations.10 new AdWords dimensions have been added:
ga:adDistributionNetwork
,ga:adMatchType
,ga:adMatchedQuery
,ga:adPlacementDomain
,ga:adPlacementUrl
,ga:adFormat
,ga:adTargetingType
,ga:adTargetingOption
,ga:adDisplayUrl
,ga:adDestinationUrl
.The metric
ga:organicSearches
has been added to the campaign group.The metric
ga:searchResultViews
has been added to the internal site search group.3 new time-based dimensions have been added:
ga:nthDay
,ga:nthWeek
,ga:nthMonth
.The groupings of dimensions and metrics have been changed to better reflect the features they represent.
New Calculated Metrics
The following calculated metrics are derived from calculations using the base metrics. Note: Each name with (n)
supports values 1-20.
Goal Based:
ga:costPerConversion
,ga:costPerGoalConversion
,ga:costPerTransaction
,ga:goal(n)AbandonRate
,ga:goal(n)Abandons
,ga:goal(n)ConversionRate
,ga:goalAbandonRateAll
,ga:goalAbandonsAll
,ga:goalConversionRateAll
,ga:goalValueAllPerSearch
,ga:goalValuePerVisit
.Content Based:
ga:entranceBounceRate
,ga:visitBounceRate
,ga:entranceRate
,ga:exitRate
,ga:pageviewsPerVisit
,ga:avgTimeOnPage
,ga:avgTimeOnSite
,ga:avgEventValue
.Internal Site Search Based:
ga:avgSearchDepth
,ga:avgSearchDuration
,ga:avgSearchResultViews
,ga:searchGoalConversionRateAll
,ga:searchGoal(n)ConversionRate
,ga:searchExitRate
.Ecommerce Based:
ga:itemsPerPurchase
,ga:margin
,ga:percentNewVisits
,ga:revenuePerItem
,ga:revenuePerTransaction
,ga:ROI
,ga:RPC
,ga:totalValue
,ga:transactionRevenuePerVisit
,ga:transactionsPerVisit
.
Release 2010-11 (November 1, 2010)
This release adds a new feature to the Data Feed:
New Features
- A new XML element has been added lets users know if the data has been sampled.
true
true
orfalse
. The Java and JavaScript libraries have also been updated with helper methods to access this element.
Release 2010-08 (August 23, 2010)
This release fixes 2 bugs:
Bug Fixes
Previously adding an OR operator to a filter expression with a dimension (ie,
ga:keyword==store,ga:keyword==bar
) could result in different values than if each filter was applied individually across multiple queries. This has been fixed and using the OR operator now returns consistent values.Some of the API error messages for invalid filters have been updated to NOT include whether it was a dimension or metric filter that caused the error (though the actual offending filter expression will continue to be returned).
Release 2010-07 (July 26, 2010)
This release fixes 3 bugs:
Bug Fixes
An encoding issue in the JavaScript Client Library has been fixed. Analytics issue tracker
A bug that prevented the Account Feed to not return when a goal name, goal path, goal comparison value, or goal comparison type had been incorrectly set, has now been fixed.
It is invalid to OR a dimension and metric in the Data Feed query filter parameter. For example:
ga:source==google,ga:visits>5
. The error message for this invalid query has been updated to say:Cannot OR dimension filter(s) with metric filter
.
Release 2010-05 (May 4, 2010)
This release adds new data and fixes a bug:
New Features
The following 5 dimensions have been added in the new category
D8. Adwords
:-
ga:adwordsAdGroupId
: corresponds to the AdWords API AdGroup.id -
ga:adwordsCampaignId
: corresponds to the AdWords API Campaign.id -
ga:adwordsCreativeId
: corresponds to the AdWords API Ad.id -
ga:adwordsCriteriaId
: corresponds to the AdWords API Criterion.id -
ga:adwordsCustomerId
: cooresponds to the AdWords API AccountInfo.customerId
-
Bug Fixes
- We fixed an issue where the Account Feed would not return data if one of the profiles had a misconfigured goal or step.
Release 2010-03 (March 22, 2010)
This release adds a number of new features and fixes a bug:
New Features
The iPhone Default Segment (gaid::-11) has been enhanced to now report on all mobile devices . The ID is the same as before (-11), but the name of the segment is now:
Mobile Traffic
.The sampling rate used by the API is now the same as the web interface. This brings the data for sampled reports inline with the web interface and increases consistency between the two.
The quota policy has been updated in an effort to ensure that all users receive equitable access to resources. Please refer to our quota policy documentation for more details. The new policy is:
- A single web property may make a maximum of 10,000 requests per 24 hours.
- An application can only make 10 requests in any given 1-second period.
- An application can only have 4 pending requests at any given time.
Some restrictions on dimension and metric combinations have been relaxed.
ga:nextPagePath
andga:previousPagePath
are now part of theD3. Content
group. TheD8. Custom Variable
group is now called theD6. Custom Variable
group. Please see the updated reference guide for these new combinations.
Bug Fixes
We fixed a bug on how the API reports the
confidenceInterval
value for metrics. Previously confidence intervals could have a value of eitherINF
or a number from 0 to 1. Now all confidence intervals will have a value of eitherINF
or a number greater than or equal to 0.ga:itemQuantity
andga:uniquePurchases
were previously swapped and returned each other's value. They are now fixed to return the correct data.
Deprecation of Dimensions and Metrics Reminder
- If you haven't done so already, please stop using the previously deprecated dimensions and metrics
Release 2009-12 (December 14, 2009)
This release adds a number of new features:
This release increments the major version number to 2
Some features require the use of the latest client libraries. We officially support: Java & Javascript . 3rd party libraries might not be updated yet.
- Version 2 may be requested by adding the header
GData-Version: 2
to each account or data feed request Read the documentation for more details. - A new XML namespace has been added to both account and data feeds:
xmlns:ga='http://schemas.google.com/ga/2009'
- Version 2 may be requested by adding the header
The API now supports the Google Data protocol version 2 .
Advanced segmentation support
Dynamic segments query parameter:
-
...&segment=dynamic::
expression - allows creation of advanced segments “on the fly.”
- expression can be any dimension or metric and should follow the same syntax as filters.
-
Default and custom segments query parameter:
-
...&segment=gaid::
number - where number is an ID referencing an advanced segment defined in the Google Analytics Web Interface.
- ID can be found in the account feed.
-
The account feed describes segment data through the following XML elements and attributes:
ga:visitorType==Returning Visitor
The data feed also provides an XML element indicating whether a segment was applied in the API request.
More details on advanced segments in our documentation .
New goal data available
Destination and engagement type goals available in the account feed:
48 new goal metrics have been added for goals 5-20 which all follow the convention
goal(n)Completions
, where(n)
is a number between 1 and 20.-
ga:goal(n)Completions
-
ga:goal(n)Starts
-
ga:goal(n)Value
-
GoalCompletionAll
,GoalStartsAll
andGoalValueAll
have been updated to account for the new goal data.
New custom variable data
All custom variables ever collected by each profile have been added as a new XML element to the account feed:
10 new dimensions have been added for custom variables. They follow the convention
customVar(n)
where(n)
can be a number between 1 and 5.-
ga:customVarName(n)
-
ga:customVarValue(n)
-
Deprecated dimensions & metrics to be removed!
If you haven't done so already, please stop using the previously deprecated dimensions and metrics. They will be removed soon and will return errors from our API if requested.
-
ga:countOfVisits
-
ga:countOfVisitsToATransaction
-
ga:sourceMedium
-
ga:percentNewVisits
-
The following dimensions have been renamed:
-
ga:countOfVisits
is nowga:visitCount
-
ga:countOfVisitsToATransaction
is nowga:visitsToTransaction
-
Release 2009-09 (September 18, 2009)
This release adds new features and deprecates some old functionality:
The following dimensions and metrics are now deprecated. We'll be permanently removing them from our API in one month. Please make sure to update your code so your applications don't break:
- ga:countOfVisits
- ga:countOfVisitsToATransaction
- ga:sourceMedium
- ga:percentNewVisits
The following Dimensions have been renamed:
- ga:countOfVisits is now ga:visitCount
- ga:countOfVisitsToATransaction is now ga:visitsToTransaction
All Event Tracking data is now exposed as 2 new groups:
D7. Events (Dimensions) * ga:eventCategory * ga:eventAction * ga:eventLabel
M7. Events (Metrics) * ga:eventValue * ga:totalEvents * ga:uniqueEvents
Overall site navigation data is is now exposed through the following dimensions:
D6. Navigation * ga:previousPagePath * ga:nextPagePath
Landing page navigation is now exposed through the following dimensions:
D3. Content * ga:landingPagePath * ga:secondPagePath
The maximum length of regular expressions in the Data Feed's filter query parameter has been raised from 32 to 128 characters.
The Length of Visit report (found through the UI under Visitors -> Visitor Loyalty) is now exposed through the new dimension:
- ga:visitLength
Release 2009-06 (June 30, 2009)
This release updates the Google Analytics Data Export API as follows:
Some restrictions on dimension and metric combinations have been relaxed. You can now query most content and visitor level dimensions together, for example
ga:pagePath
andga:source
is now a valid combination. Please see the updated reference guide for these new combinations: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceValidCombos.htmlThe total number of rows that can be asked for in one request has been increased to 10,000. The default number of rows returned is still 1,000, but can now be increased by setting the
max-results
query parameter.The Account Feed now returns two new data elements for each Table ID (currency and timezone).
We're now enforcing that data queries must include at least one valid metric.
All previous deprecation changes have taken effect.
Release 2009-05 (May 22, 2009)
This release removes deprecated features from our private beta:
The account feed requests will no longer support a username in them. Instead, it will only accept requests in the following format:
https://www.google.com/analytics/feeds/accounts/default
The following metrics are being removed and will no longer work. Instead, we have provided instructions on how to calculate these values here: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceCommonCalculations.html
- ga:avgPageDuration
- ga:avgPageviews
- ga:avgSessionTime
- ga:bounceRate
- ga:exitRate
- ga:costPerConversion
- ga:costPerGoalConversion
- ga:costPerTransaction
- ga:revenuePerClick
- ga:revenuePerTransaction
- ga:revenuePerVisit
- ga:abandonedFunnels1
- ga:abandonedFunnels2
- ga:abandonedFunnels3
- ga:abandonedFunnels4
- ga:goalConversionRate
- ga:goalConversionRate1
- ga:goalConversionRate2
- ga:goalConversionRate3
- ga:goalConversionRate4
- ga:goalValuePerVisit
The following dimensions and metrics have been renamed. The old names will no longer work. Please verify you are using the official names in our documentation here: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html
Dimensions * ga:subContinentRegion ⇒ ga:subContinent * ga:organization ⇒ ga:networkLocation * ga:domain ⇒ ga:networkDomain * ga:visitNumber ⇒ ga:countOfVisits * ga:platform ⇒ ga:operatingSystem * ga:platformVersion ⇒ ga:operatingSystemVersion * ga:content ⇒ ga:adContent * ga:requestUri ⇒ ga:pagePath * ga:requestUri1 ⇒ ga:landingPagePath * ga:requestUriLast ⇒ ga:exitPagePath * ga:internalSearchNext ⇒ ga:searchKeywordRefinement * ga:internalSearchKeyword ⇒ ga:searchKeyword * ga:internalSearchType ⇒ ga:searchCategory * ga:hasInternalSearch ⇒ ga:searchUsed * ga:requestUriFrom ⇒ ga:searchStartPage * ga:requestUriTo ⇒ ga:searchDestinationPage * ga:productCode ⇒ ga:productSku
Metrics * ga:newVisitors ⇒ ga:newVisits * ga:pageDuration ⇒ ga:timeOnPage * ga:visitDuration ⇒ ga:timeOnSite * ga:cost ⇒ ga:adCost * ga:clicks ⇒ ga:adClicks * ga:clickThroughRate ⇒ ga:CTR * ga:costPerClick ⇒ ga:CPC * ga:costPerMilleImpressions ⇒ ga:CPM * ga:searchTransitions ⇒ ga:searchRefinements * ga:uniqueInternalSearches ⇒ ga:searchUniques * ga:visitsWithSearches ⇒ ga:searchVisits * ga:productPurchases ⇒ ga:itemQuantity * ga:productRevenue ⇒ ga:itemRevenue * ga:products ⇒ ga:uniquePurchases * ga:revenue ⇒ ga:transactionRevenue * ga:shipping ⇒ ga:transactionShipping * ga:tax ⇒ ga:transactionTax * ga:goalCompletions1 ⇒ ga:goal1Completions * ga:goalCompletions2 ⇒ ga:goal2Completions * ga:goalCompletions3 ⇒ ga:goal3Completions * ga:goalCompletions4 ⇒ ga:goal4Completions * ga:goalStarts1 ⇒ ga:goal1Starts * ga:goalStarts2 ⇒ ga:goal2Starts * ga:goalStarts3 ⇒ ga:goal3Starts * ga:goalStarts4 ⇒ ga:goal4Starts * ga:goalValue1 ⇒ ga:goal1Value * ga:goalValue2 ⇒ ga:goal2Value * ga:goalValue3 ⇒ ga:goal3Value * ga:goalValue4 ⇒ ga:goal4Value