- Ресурс: Аудитория
- АудиторияСобытиеТриггер
- Логусловие
- AudienceExclusionDurationMode
- АудиторияФильтрПредложение
- АудиторияПростойФильтр
- AudienceFilterScope
- Выражение AudienceFilterExpression
- Список выражений AudienceFilterExpressionList
- AudienceDimensionOrMetricFilter
- Строковый фильтр
- Тип соответствия
- Инлистфильтр
- ЧисловойФильтр
- Операция
- Числовое значение
- Междуфильтр
- Фильтр событий аудитории
- АудиторияПоследовательностьФильтр
- АудиторияПоследовательностьШаг
- AudienceClauseType
- Методы
Ресурс: Аудитория
Ресурсное сообщение, представляющее аудиторию GA4.
JSON-представление |
---|
{ "name": string, "displayName": string, "description": string, "membershipDurationDays": integer, "adsPersonalizationEnabled": boolean, "eventTrigger": { object ( |
Поля | |
---|---|
name | Только вывод. Имя ресурса для этого ресурса аудитории. Формат: свойства/{propertyId}/audiences/{audienceId} |
displayName | Необходимый. Отображаемое имя аудитории. |
description | Необходимый. Описание аудитории. |
membershipDurationDays | Необходимый. Неизменный. Продолжительность пребывания пользователя в аудитории. Его нельзя установить более чем на 540 дней. |
adsPersonalizationEnabled | Только вывод. GA автоматически устанавливает для него значение false, если это аудитория NPA и она исключена из персонализации рекламы. |
eventTrigger | Необязательный. Указывает событие, которое будет регистрироваться, когда пользователь присоединяется к аудитории. Если этот параметр не установлен, события, когда пользователь присоединяется к аудитории, не регистрируются. |
exclusionDurationMode | Неизменный. Указывает, как долго будет действовать исключение для пользователей, соответствующих фильтру исключений. Он применяется ко всем предложениям фильтра EXCLUDE и игнорируется, если в аудитории нет предложения фильтра EXCLUDE. |
filterClauses[] | Необходимый. Неизменный. Неупорядоченный список. Предложения фильтра, определяющие аудиторию. Все предложения будут объединены оператором AND. |
createTime | Только вывод. Время создания аудитории. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
АудиторияСобытиеТриггер
Указывает событие, которое будет регистрироваться, когда пользователь присоединяется к аудитории.
JSON-представление |
---|
{
"eventName": string,
"logCondition": enum ( |
Поля | |
---|---|
eventName | Необходимый. Имя события, которое будет зарегистрировано. |
logCondition | Необходимый. Когда регистрировать событие. |
Логусловие
Определяет, когда регистрировать событие.
Перечисления | |
---|---|
LOG_CONDITION_UNSPECIFIED | Состояние журнала не указано. |
AUDIENCE_JOINED | Событие должно регистрироваться только при присоединении пользователя. |
AUDIENCE_MEMBERSHIP_RENEWED | Событие должно регистрироваться при каждом выполнении условия аудитории, даже если пользователь уже является участником аудитории. |
AudienceExclusionDurationMode
Указывает, как долго будет действовать исключение для пользователей, соответствующих фильтру исключений.
Перечисления | |
---|---|
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED | Не указан. |
EXCLUDE_TEMPORARILY | Исключайте пользователей из аудитории в периоды, когда они соответствуют условиям фильтра. |
EXCLUDE_PERMANENTLY | Исключите пользователей из аудитории, если они когда-либо выполняли условие фильтра. |
АудиторияФильтрПредложение
Предложение для определения простого фильтра или фильтра последовательности. Фильтр может быть инклюзивным (например, пользователи, удовлетворяющие условию фильтра, включаются в аудиторию) или эксклюзивным (например, пользователи, удовлетворяющие условию фильтра, исключаются из аудитории).
JSON-представление |
---|
{ "clauseType": enum ( |
Поля | |
---|---|
clauseType | Необходимый. Указывает, является ли это предложением фильтра включения или исключения. |
| |
simpleFilter | Простой фильтр, которому должен соответствовать пользователь, чтобы стать членом аудитории. |
sequenceFilter | Фильтры, которые должны выполняться в определенном порядке, чтобы пользователь мог стать членом аудитории. |
АудиторияПростойФильтр
Определяет простой фильтр, которому должен соответствовать пользователь, чтобы стать членом аудитории.
JSON-представление |
---|
{ "scope": enum ( |
Поля | |
---|---|
scope | Необходимый. Неизменный. Указывает область действия этого фильтра. |
filterExpression | Необходимый. Неизменный. Логическое выражение параметров аудитории, показателей или фильтров событий. |
AudienceFilterScope
Указывает, как оценивать пользователей на предмет присоединения к аудитории.
Перечисления | |
---|---|
AUDIENCE_FILTER_SCOPE_UNSPECIFIED | Область применения не указана. |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT | Пользователь присоединяется к Аудитории, если условие фильтра выполнено в рамках одного события. |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION | Пользователь присоединяется к Аудитории, если условие фильтра выполнено в течение одного сеанса. |
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS | Пользователь присоединяется к аудитории, если какое-либо событие в любом сеансе соответствует условию фильтра. |
Выражение AudienceFilterExpression
Логическое выражение параметров аудитории, показателей или фильтров событий.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Выражение, примененное к фильтру. expr может быть только одним из следующих: | |
andGroup | Список выражений, которые должны быть объединены оператором AND. Он может содержать только выражения AudienceFilterExpressions с orGroup. Это должно быть установлено для AudienceFilterExpression верхнего уровня. |
orGroup | Список выражений для объединения OR. Он не может содержать выражения AudienceFilterExpressions с andGroup или orGroup. |
notExpression | Выражение фильтра, которое НЕ должно быть обработано (например, инвертировано, дополнено). Он может включать только DimensionOrMetricFilter. Это невозможно установить на AudienceFilterExpression верхнего уровня. |
dimensionOrMetricFilter | Фильтр по одному параметру или показателю. Это невозможно установить на AudienceFilterExpression верхнего уровня. |
eventFilter | Создает фильтр, соответствующий определенному событию. Это невозможно установить на AudienceFilterExpression верхнего уровня. |
АудиторияФильтрВыражениеСписок
Список выражений фильтра аудитории.
JSON-представление |
---|
{
"filterExpressions": [
{
object ( |
Поля | |
---|---|
filterExpressions[] | Список выражений фильтра аудитории. |
AudienceDimensionOrMetricFilter
Специальный фильтр для одного параметра или показателя.
JSON-представление |
---|
{ "fieldName": string, "atAnyPointInTime": boolean, "inAnyNDayPeriod": integer, // Union field |
Поля | |
---|---|
fieldName | Необходимый. Неизменный. Имя измерения или метрики для фильтрации. Если имя поля относится к специальному параметру или показателю, в начале имени специального параметра или показателя будет добавлен префикс области. Дополнительную информацию о префиксах области действия или специальных параметрах/показателях см. в документации API данных Google Analytics . |
atAnyPointInTime | Необязательный. Указывает, нуждается ли этот фильтр в динамической оценке или нет. Если установлено значение true, пользователи присоединяются к аудитории, если они когда-либо соответствовали условию (статическая оценка). Если значение не установлено или установлено значение false, пользовательская оценка аудитории является динамической; пользователи добавляются в аудиторию, когда они соответствуют условиям, а затем удаляются, когда они больше им не соответствуют. Это значение можно установить только в том случае, если объем аудитории равен ACROSS_ALL_SESSIONS. |
inAnyNDayPeriod | Необязательный. Если установлено, указывает временной интервал, для которого оцениваются данные в количестве дней. Если не установлено, данные об аудитории оцениваются по данным за все время (например, бесконечное временное окно). Например, если установлено значение 1 день, оцениваются только данные текущего дня. Контрольной точкой является текущий день, когда значение atAnyPointInTime не установлено или имеет значение false. Его можно установить только в том случае, если объем аудитории равен ACROSS_ALL_SESSIONS и не может превышать 60 дней. |
Поле объединения one_filter . Один из вышеперечисленных фильтров. one_filter может быть только одним из следующих: | |
stringFilter | Фильтр для измерения строкового типа, соответствующего определенному шаблону. |
inListFilter | Фильтр для измерения строки, соответствующий определенному списку параметров. |
numericFilter | Фильтр для числовых значений или значений даты в измерении или показателе. |
betweenFilter | Фильтр для числовых значений или значений даты между определенными значениями измерения или показателя. |
Строковый фильтр
Фильтр для измерения строкового типа, соответствующего определенному шаблону.
JSON-представление |
---|
{
"matchType": enum ( |
Поля | |
---|---|
matchType | Необходимый. Тип соответствия для строкового фильтра. |
value | Необходимый. Строковое значение, с которым будет сопоставлено. |
caseSensitive | Необязательный. Если это правда, совпадение чувствительно к регистру. Если false, совпадение не учитывает регистр. |
Тип соответствия
Тип соответствия для строкового фильтра.
Перечисления | |
---|---|
MATCH_TYPE_UNSPECIFIED | Неопределенные |
EXACT | Точное совпадение строкового значения. |
BEGINS_WITH | Начинается со строкового значения. |
ENDS_WITH | Заканчивается строковым значением. |
CONTAINS | Содержит строковое значение. |
FULL_REGEXP | Полное регулярное выражение соответствует строковому значению. |
Инлистфильтр
Фильтр для измерения строки, соответствующий определенному списку параметров.
JSON-представление |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Поля | |
---|---|
values[] | Необходимый. Список возможных строковых значений для сопоставления. Должно быть непусто. |
caseSensitive | Необязательный. Если это правда, совпадение чувствительно к регистру. Если false, совпадение не учитывает регистр. |
ЧисловойФильтр
Фильтр для числовых значений или значений даты в измерении или показателе.
JSON-представление |
---|
{ "operation": enum ( |
Поля | |
---|---|
operation | Необходимый. Операция, примененная к числовому фильтру. |
value | Необходимый. Числовое значение или значение даты для сопоставления. |
Операция
Операция, примененная к числовому фильтру.
Перечисления | |
---|---|
OPERATION_UNSPECIFIED | Неопределенные. |
EQUAL | Равный. |
LESS_THAN | Меньше, чем. |
GREATER_THAN | Больше чем. |
Числовое значение
Чтобы представить число.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_value . Одно из числовых значений. one_value может быть только одним из следующих: | |
int64Value | Целочисленное значение. |
doubleValue | Двойная ценность. |
МеждуФильтр
Фильтр для числовых значений или значений даты между определенными значениями измерения или показателя.
JSON-представление |
---|
{ "fromValue": { object ( |
Поля | |
---|---|
fromValue | Необходимый. Начинается с этого номера включительно. |
toValue | Необходимый. Заканчивается этим номером включительно. |
Фильтр событий аудитории
Фильтр, который соответствует событиям с одним именем события. Если указан параметр события, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров.
JSON-представление |
---|
{
"eventName": string,
"eventParameterFilterExpression": {
object ( |
Поля | |
---|---|
eventName | Необходимый. Неизменный. Имя события для сопоставления. |
eventParameterFilterExpression | Необязательный. Если указано, этот фильтр соответствует событиям, которые соответствуют как одному имени события, так и выражениям фильтра параметров. AudienceEventFilter внутри выражения фильтра параметров невозможно установить (например, не поддерживаются вложенные фильтры событий). Это должен быть один элемент andGroup из DimensionOrMetricFilter или notExpression; Операторы AND для OR не поддерживаются. Кроме того, если он включает фильтр «eventCount», будет учитываться только он; все остальные фильтры будут игнорироваться. |
АудиторияПоследовательностьФильтр
Определяет фильтры, которые должны выполняться в определенном порядке, чтобы пользователь мог стать членом аудитории.
JSON-представление |
---|
{ "scope": enum ( |
Поля | |
---|---|
scope | Необходимый. Неизменный. Указывает область действия этого фильтра. |
sequenceMaximumDuration | Необязательный. Определяет период времени, в течение которого должна произойти вся последовательность действий. Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
sequenceSteps[] | Необходимый. Упорядоченная последовательность действий. Пользователь должен выполнить каждый шаг, чтобы присоединиться к фильтру последовательности. |
АудиторияПоследовательностьШаг
Условие, которое должно произойти в указанном порядке шагов, чтобы этот пользователь соответствовал последовательности.
JSON-представление |
---|
{ "scope": enum ( |
Поля | |
---|---|
scope | Необходимый. Неизменный. Указывает область действия этого шага. |
immediatelyFollows | Необязательный. Если это правда, событие, удовлетворяющее этому шагу, должно быть следующим событием после события, удовлетворяющего последнему шагу. Если значение не установлено или имеет значение false, этот шаг косвенно следует за предыдущим шагом; например, между предыдущим шагом и этим шагом могут быть события. На первом этапе он игнорируется. |
constraintDuration | Необязательный. Если этот параметр установлен, этот шаг должен быть выполнен в пределах ограниченияDuration предыдущего шага (например, t[i] — t[i-1] <= ограничениеDuration). Если этот параметр не установлен, требования к продолжительности отсутствуют (продолжительность фактически не ограничена). На первом этапе он игнорируется. Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
filterExpression | Необходимый. Неизменный. Логическое выражение параметров аудитории, показателей или фильтров событий на каждом этапе. |
AudienceClauseType
Указывает, является ли это предложением фильтра включения или исключения.
Перечисления | |
---|---|
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED | Неопределенный тип предложения. |
INCLUDE | Пользователи будут включены в аудиторию, если соблюдено условие фильтра. |
EXCLUDE | Пользователи будут исключены из аудитории, если будет выполнено условие фильтра. |
Методы | |
---|---|
| Архивирует аудиторию на ресурсе. |
| Создает аудиторию. |
| Поиск одной аудитории. |
| Перечисляет аудитории на ресурсе. |
| Обновляет аудиторию на ресурсе. |