- HTTP-запрос
- Тело запроса
- Тело ответа
- Области авторизации
- Пользователь
- Юсеридтипе
- Тип активности
- UserActivitySession
- Активность
- CustomDimension
- Данные о просмотре страницы
- ScreenviewData
- Данные электронной коммерции
- Электронная коммерцияДействие
- Данные транзакции
- Данные продукта
- Тип электронной коммерции
- Данные набора целей
- Данные цели
- EventData
- Попробуй это!
Возвращает данные об активности пользователей.
HTTP-запрос
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление | |
---|---|
{ "dateRange": { object( |
Поля | |
---|---|
dateRange | Диапазон дат, за который можно получить данные об активности пользователя. Если диапазон дат не указан, используется диапазон дат по умолчанию (startDate: текущая дата — 7 дней, endDate: текущая дата — 1 день). |
viewId | Необходимый. Идентификатор представления Analytics, из которого можно получить данные. Каждый SearchUserActivityRequest должен содержать |
user | Необходимый. Уникальный идентификатор пользователя для запроса. Каждый SearchUserActivityRequest должен содержать это поле. |
activityTypes[] | Набор всех запрашиваемых типов действий. В ответе будут возвращены только действия, соответствующие этим типам. Если пусто, будут возвращены все действия. |
pageSize | Размер страницы предназначен для разбиения на страницы и определяет максимальное количество возвращаемых строк. Размер страницы должен быть > 0. Если значение равно 0 или поле не указано, запрос возвращает значение по умолчанию — 1000 строк на страницу. |
pageToken | Токен продолжения для получения следующей страницы результатов. Добавление этого к запросу вернет строки после pageToken. PageToken должно быть значением, возвращаемым в параметре nextPageToken в ответе на запрос SearchUserActivityRequest . |
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Ответ от userActivity:get
call.
JSON-представление | |
---|---|
{
"sessions": [
{
object( |
Поля | |
---|---|
sessions[] | Каждая запись представляет сеанс (сведения об устройстве, продолжительность и т. д.). |
totalRows | Общее количество строк, возвращенных этим запросом (на разных страницах). |
nextPageToken | Этот токен следует передать в SearchUserActivityRequest для получения следующей страницы. |
sampleRate | Это поле представляет частоту дискретизации для данного запроса и представляет собой число от 0,0 до 1,0. Подробности смотрите в руководстве разработчика . |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics
Пользователь
Содержит информацию, позволяющую однозначно идентифицировать конкретного пользователя.
JSON-представление | |
---|---|
{
"type": enum( |
Поля | |
---|---|
type | Тип пользователя в запросе. Поле |
userId | Уникальный идентификатор пользователя, для которого запрашиваются данные. |
Юсеридтипе
Представляет различные доступные типы идентификации пользователя.
Перечисления | |
---|---|
USER_ID_TYPE_UNSPECIFIED | Если тип идентификатора пользователя не указан, типом по умолчанию будет CLIENT_ID. |
USER_ID | Один пользователь, например вошедшая в систему учетная запись пользователя, который может взаимодействовать с контентом на одном или нескольких устройствах и/или экземплярах браузера. |
CLIENT_ID | Аналитике присвоен идентификатор клиента. |
Тип активности
Перечисления | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED | ActivityType никогда не будет иметь это значение в ответе. Использование этого типа в запросе приведет к ошибке. |
PAGEVIEW | Используется, когда действие вызвано просмотром страницы посетителем. |
SCREENVIEW | Используется, когда действие вызвано использованием посетителем приложения на мобильном устройстве. |
GOAL | Используется для обозначения действия типа цели. |
ECOMMERCE | Посетитель на странице совершил транзакцию электронной коммерции. |
EVENT | Используется, когда действие является событием. |
UserActivitySession
Это представляет собой сеанс пользователя, выполненный на определенном устройстве в определенное время в течение определенного периода времени.
JSON-представление | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
Поля | |
---|---|
sessionId | Уникальный идентификатор сеанса. |
deviceCategory | Тип используемого устройства: «мобильное», «планшет» и т. д. |
platform | Платформа, на которой происходило действие: «android», «ios» и т. д. |
dataSource | Источник данных обращения. По умолчанию обращения, отправленные из Analytics.js, обозначаются как «Интернет», а обращения, отправленные из мобильных SDK, — как «Приложения». Эти значения можно переопределить в протоколе измерений. |
activities[] | Представляет подробный обзор каждого действия в этом сеансе. |
sessionDate | Дата этой сессии в формате ISO-8601. |
Активность
Activity представляет данные о деятельности пользователя. Обратите внимание, что действие отличается от попадания. Попадание может привести к нескольким действиям. Например, если обращение включает в себя транзакцию и достижение цели, для этого обращения будет два прототипа действий: один для ЭКОКОММЕРЦИИ и один для ЦЕЛИ. И наоборот, несколько обращений также могут создать одно действие. В классической электронной коммерции данные для одной транзакции могут отправляться посредством нескольких обращений. Эти хиты будут объединены в одно мероприятие ЭКОКОММЕРЦИИ.
JSON-представление | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
Поля | ||
---|---|---|
activityTime | Временная метка действия. Временная метка в формате RFC3339 UTC «Зулу» с точностью до наносекунд. Пример: | |
source | Источник рефералов. При отслеживании кампании вручную это значение параметра отслеживания кампании utm_source. Для автоматической пометки AdWords это Google. Если вы не используете ни один из них, это домен источника (например, document.referrer), ссылающийся на пользователей. Он также может содержать адрес порта. Если пользователи пришли без реферера, его значение равно (прямому). | |
medium | Тип рефералов. При отслеживании кампании вручную это значение параметра отслеживания кампании utm_medium. Для автоматической пометки AdWords это цена за клик. Если пользователи пришли из поисковой системы, обнаруженной Google Analytics, это органично. Если реферер не является поисковой системой, то это реферал. Если пользователи пришли непосредственно к свойству и document.referrer пуст, его значение равно (none). | |
channelGrouping | Группа каналов, связанная с сеансом конечного пользователя для этого представления (определяется группами каналов представления). | |
campaign | При отслеживании кампании вручную это значение параметра отслеживания кампании utm_campaign. При автоматической пометке AdWords это названия рекламных интернет-кампаний, которые вы используете для ресурса. Если вы не используете ни один из них, его значение равно (не установлено). | |
keyword | Для отслеживания кампании вручную это значение параметра отслеживания кампании utm_term. Для трафика AdWords он содержит наиболее соответствующие критерии таргетинга. Для контекстно-медийной сети, где несколько критериев таргетинга могли привести к показу объявления, возвращается наиболее соответствующий критерий таргетинга, выбранный Ads. Это может быть display_keyword, размещение на сайте, Boomuserlist, user_interest, возраст или пол. В противном случае его значение равно (не установлено). | |
hostname | Имя хоста, с которого был сделан запрос на отслеживание. | |
landingPagePath | Первая страница сеансов пользователей или целевая страница. | |
activityType | Вид этой деятельности. | |
customDimension[] | Список всех специальных параметров, связанных с этим действием. | |
Поле объединения activity_details . В зависимости от activity_type будет установлено ровно одно из следующих полей. activity_details может быть только одним из следующих: | ||
pageview | Это будет установлено, если | |
appview | Это будет установлено, если | |
ecommerce | Это будет установлено, если | |
goals | Это поле содержит список всех целей, которые были достигнуты в этом действии, когда | |
event | Это поле содержит все сведения, относящиеся к событию, и будет установлено, если |
CustomDimension
Пользовательский размер.
JSON-представление | |
---|---|
{ "index": number, "value": string } |
Поля | |
---|---|
index | Номер слота специального размера. |
value | Значение специального параметра. Значение по умолчанию (т. е. пустая строка) указывает на очистку значения специального параметра области сеанса/посетителя. |
Данные просмотра страницы
Представляет сведения, собираемые при просмотре страницы посетителем.
JSON-представление | |
---|---|
{ "pagePath": string, "pageTitle": string } |
Поля | |
---|---|
pagePath | URL-адрес страницы, которую просмотрел посетитель. |
pageTitle | Название страницы, которую просмотрел посетитель. |
ScreenviewData
JSON-представление | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
Поля | |
---|---|
screenName | Имя экрана. |
mobileDeviceBranding | Производитель мобильного телефона или торговая марка. Например: «Google», «Apple» и т. д. |
mobileDeviceModel | Модель мобильного устройства. Например: «Пиксель», «iPhone» и т. д. |
appName | Имя приложения. |
Данные электронной коммерции
Детали электронной коммерции, связанные с активностью пользователя.
JSON-представление | |
---|---|
{ "actionType": enum( |
Поля | |
---|---|
actionType | Действие, связанное с этим действием электронной торговли. |
transaction | Сведения о транзакции этого действия электронной торговли. |
products[] | Подробная информация о продуктах в этой транзакции. |
ecommerceType | Тип этой деятельности электронной коммерции. |
Электронная коммерцияДействие
Набор всех действий, связанных с действием электронной торговли.
Перечисления | |
---|---|
UNKNOWN | Тип действия неизвестен. |
CLICK | Пролистывайте списки продуктов. |
DETAILS_VIEW | Детальный просмотр продукта. |
ADD_TO_CART | Добавьте товар(ы) в корзину. |
REMOVE_FROM_CART | Удалить товар(ы) из корзины. |
CHECKOUT | Проверить. |
PAYMENT | Завершена покупка. |
REFUND | Возврат покупки. |
CHECKOUT_OPTION | Варианты оформления заказа. |
Данные транзакции
Представляет сведения, собираемые, когда посетитель выполняет транзакцию на странице.
JSON-представление | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
Поля | |
---|---|
transactionId | Идентификатор транзакции, предоставленный методом отслеживания электронной торговли для покупки в корзине. |
transactionRevenue | Общий доход от продажи (без учета доставки и налогов) от транзакции. |
transactionTax | Общий налог за транзакцию. |
transactionShipping | Общая стоимость доставки. |
Данные продукта
Подробная информация о продуктах в транзакции электронной коммерции.
JSON-представление | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
Поля | |
---|---|
productSku | Уникальный код, представляющий продукт. |
productName | Название продукта, предоставленное приложением отслеживания электронной торговли для приобретенных товаров. |
itemRevenue | Общий доход от приобретенных товаров. |
productQuantity | Общее количество единиц этого продукта в транзакции. |
Тип электронной коммерции
Это представляет тип возвращаемых данных электронной коммерции.
Перечисления | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED | Используется, когда тип деятельности электронной коммерции не указан. |
CLASSIC | Используется, когда действие содержит классическую (нерасширенную) информацию об электронной торговле. |
ENHANCED | Используется, когда активность расширяет информацию об электронной торговле. |
Данные набора целей
Представляет собой набор целей, которые были достигнуты в ходе действия.
JSON-представление | |
---|---|
{
"goals": [
{
object( |
Поля | |
---|---|
goals[] | Все цели, которые были достигнуты в текущей деятельности. |
Данные цели
Представляет все детали, относящиеся к цели.
JSON-представление | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
Поля | |
---|---|
goalIndex | Это идентифицирует цель, настроенную для профиля. |
goalCompletions | Общее количество достигнутых целей в этом действии. |
goalValue | Ценность в этой цели. |
goalCompletionLocation | URL страницы, на которой была достигнута эта цель. |
goalPreviousStep1 | URL страницы за шаг до достижения цели. |
goalPreviousStep2 | URL страницы за два шага до достижения цели. |
goalPreviousStep3 | URL страницы за три шага до достижения цели. |
goalName | Название цели. |
EventData
Представляет все детали, относящиеся к событию.
JSON-представление | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
Поля | |
---|---|
eventCategory | Объект на странице, с которым произошло взаимодействие. Например: «Видео». |
eventAction | Тип взаимодействия с объектом. Например: «играть». |
eventLabel | Ярлык, прикрепленный к событию. |
eventValue | Числовое значение, связанное с событием. |
eventCount | Количество таких событий в этом действии. |