REST Resource: properties.audiences

Ресурс: Аудитория

Ресурсное сообщение, представляющее аудиторию GA4.

JSON-представление
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ]
}
Поля
name

string

Только вывод. Имя ресурса для этого ресурса аудитории. Формат: свойства/{propertyId}/audiences/{audienceId}

displayName

string

Необходимый. Отображаемое имя аудитории.

description

string

Необходимый. Описание аудитории.

membershipDurationDays

integer

Необходимый. Неизменный. Продолжительность пребывания пользователя в аудитории. Его нельзя установить более чем на 540 дней.

adsPersonalizationEnabled

boolean

Только вывод. GA автоматически устанавливает для него значение false, если это аудитория NPA и она исключена из персонализации рекламы.

eventTrigger

object ( AudienceEventTrigger )

Необязательный. Указывает событие, которое будет регистрироваться, когда пользователь присоединяется к аудитории. Если этот параметр не установлен, событие, когда пользователь присоединяется к аудитории, не регистрируется.

exclusionDurationMode

enum ( AudienceExclusionDurationMode )

Неизменный. Указывает, как долго будет действовать исключение для пользователей, соответствующих фильтру исключений. Он применяется ко всем предложениям фильтра EXCLUDE и игнорируется, если в аудитории нет предложения фильтра EXCLUDE.

filterClauses[]

object ( AudienceFilterClause )

Необходимый. Неизменный. Неупорядоченный список. Предложения фильтра, определяющие аудиторию. Все предложения будут объединены оператором AND.

АудиторияСобытиеТриггер

Указывает событие, которое будет регистрироваться, когда пользователь присоединяется к аудитории.

JSON-представление
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Поля
eventName

string

Необходимый. Имя события, которое будет зарегистрировано.

logCondition

enum ( LogCondition )

Необходимый. Когда регистрировать событие.

Логусловие

Определяет, когда регистрировать событие.

Перечисления
LOG_CONDITION_UNSPECIFIED Состояние журнала не указано.
AUDIENCE_JOINED Событие должно регистрироваться только при присоединении пользователя.
AUDIENCE_MEMBERSHIP_RENEWED Событие должно регистрироваться при каждом выполнении условия аудитории, даже если пользователь уже является участником аудитории.

AudienceExclusionDurationMode

Указывает, как долго будет действовать исключение для пользователей, соответствующих фильтру исключений.

Перечисления
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Не указан.
EXCLUDE_TEMPORARILY Исключайте пользователей из аудитории в периоды, когда они соответствуют условиям фильтра.
EXCLUDE_PERMANENTLY Исключите пользователей из аудитории, если они когда-либо выполняли условие фильтра.

АудиторияФильтрПредложение

Предложение для определения простого фильтра или фильтра последовательности. Фильтр может быть инклюзивным (например, пользователи, удовлетворяющие условию фильтра, включаются в аудиторию) или эксклюзивным (например, пользователи, удовлетворяющие условию фильтра, исключаются из аудитории).

JSON-представление
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
Поля
clauseType

enum ( AudienceClauseType )

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

filter полей объединения.

filter может быть только одним из следующих:

simpleFilter

object ( AudienceSimpleFilter )

Простой фильтр, которому должен соответствовать пользователь, чтобы стать членом аудитории.

sequenceFilter

object ( AudienceSequenceFilter )

Фильтры, которые должны выполняться в определенном порядке, чтобы пользователь мог стать членом аудитории.

АудиторияПростойФильтр

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

JSON-представление
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Поля
scope

enum ( AudienceFilterScope )

Необходимый. Неизменный. Указывает область действия этого фильтра.

filterExpression

object ( AudienceFilterExpression )

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

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 can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Выражение, примененное к фильтру. expr может быть только одним из следующих:
andGroup

object ( AudienceFilterExpressionList )

Список выражений, которые должны быть объединены оператором AND. Он может содержать только выражения AudienceFilterExpressions с orGroup. Это должно быть установлено для AudienceFilterExpression верхнего уровня.

orGroup

object ( AudienceFilterExpressionList )

Список выражений для объединения OR. Он не может содержать выражения AudienceFilterExpressions с andGroup или orGroup.

notExpression

object ( AudienceFilterExpression )

Выражение фильтра, которое НЕ должно быть обработано (например, инвертировано, дополнено). Он может включать только DimensionOrMetricFilter. Это невозможно установить на AudienceFilterExpression верхнего уровня.

dimensionOrMetricFilter

object ( AudienceDimensionOrMetricFilter )

Фильтр по одному параметру или показателю. Это невозможно установить на AudienceFilterExpression верхнего уровня.

eventFilter

object ( AudienceEventFilter )

Создает фильтр, соответствующий определенному событию. Это невозможно установить на AudienceFilterExpression верхнего уровня.

АудиторияФильтрВыражениеСписок

Список выражений фильтра аудитории.

JSON-представление
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Поля
filterExpressions[]

object ( AudienceFilterExpression )

Список выражений фильтра аудитории.

AudienceDimensionOrMetricFilter

Специальный фильтр для одного параметра или показателя.

JSON-представление
{
  "fieldName": string,
  "atAnyPointInTime": boolean,
  "inAnyNDayPeriod": integer,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
fieldName

string

Необходимый. Неизменный. Имя измерения или метрики для фильтрации. Если имя поля относится к специальному параметру или показателю, в начале имени специального параметра или показателя будет добавлен префикс области. Дополнительную информацию о префиксах области действия или специальных параметрах/показателях можно найти в документации API данных Google Analytics .

atAnyPointInTime

boolean

Необязательный. Указывает, нуждается ли этот фильтр в динамической оценке или нет. Если установлено значение true, пользователи присоединяются к аудитории, если они когда-либо соответствовали условию (статическая оценка). Если значение не установлено или установлено значение false, пользовательская оценка аудитории является динамической; пользователи добавляются в аудиторию, когда они соответствуют условиям, а затем удаляются, когда они больше им не соответствуют.

Это можно установить только в том случае, если объем аудитории равен ACROSS_ALL_SESSIONS.

inAnyNDayPeriod

integer

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

Например, если установлено значение 1 день, оцениваются только данные текущего дня. Контрольной точкой является текущий день, когда значение atAnyPointInTime не установлено или имеет значение false.

Его можно установить только в том случае, если объем аудитории равен ACROSS_ALL_SESSIONS и не может превышать 60 дней.

Поле объединения one_filter . Один из вышеперечисленных фильтров. one_filter может быть только одним из следующих:
stringFilter

object ( StringFilter )

Фильтр для измерения строкового типа, соответствующего определенному шаблону.

inListFilter

object ( InListFilter )

Фильтр для измерения строки, соответствующий определенному списку параметров.

numericFilter

object ( NumericFilter )

Фильтр для числовых значений или значений даты в измерении или показателе.

betweenFilter

object ( BetweenFilter )

Фильтр для числовых значений или значений даты между определенными значениями измерения или показателя.

Строковый фильтр

Фильтр для измерения строкового типа, соответствующего определенному шаблону.

JSON-представление
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Поля
matchType

enum ( MatchType )

Необходимый. Тип соответствия для строкового фильтра.

value

string

Необходимый. Строковое значение, с которым будет сопоставлено.

caseSensitive

boolean

Необязательный. Если это правда, совпадение чувствительно к регистру. Если false, совпадение не учитывает регистр.

Тип соответствия

Тип соответствия для строкового фильтра.

Перечисления
MATCH_TYPE_UNSPECIFIED Неопределенные
EXACT Точное совпадение строкового значения.
BEGINS_WITH Начинается со строкового значения.
ENDS_WITH Заканчивается строковым значением.
CONTAINS Содержит строковое значение.
FULL_REGEXP Полное регулярное выражение соответствует строковому значению.

Инлистфильтр

Фильтр для измерения строки, соответствующий определенному списку параметров.

JSON-представление
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Поля
values[]

string

Необходимый. Список возможных строковых значений для сопоставления. Должно быть непусто.

caseSensitive

boolean

Необязательный. Если это правда, совпадение чувствительно к регистру. Если false, совпадение не учитывает регистр.

ЧисловойФильтр

Фильтр для числовых значений или значений даты в измерении или показателе.

JSON-представление
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Поля
operation

enum ( Operation )

Необходимый. Операция, примененная к числовому фильтру.

value

object ( NumericValue )

Необходимый. Числовое значение или значение даты для сопоставления.

Операция

Операция, примененная к числовому фильтру.

Перечисления
OPERATION_UNSPECIFIED Неопределенные.
EQUAL Равный.
LESS_THAN Меньше, чем.
GREATER_THAN Больше чем.

Числовое значение

Чтобы представить число.

JSON-представление
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Поля
Поле объединения one_value . Одно из числовых значений. one_value может быть только одним из следующих:
int64Value

string ( int64 format)

Целочисленное значение.

doubleValue

number

Двойная ценность.

МеждуФильтр

Фильтр для числовых значений или значений даты между определенными значениями измерения или показателя.

JSON-представление
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Поля
fromValue

object ( NumericValue )

Необходимый. Начинается с этого номера включительно.

toValue

object ( NumericValue )

Необходимый. Заканчивается этим номером включительно.

Фильтр событий аудитории

Фильтр, который соответствует событиям с одним именем события. Если указан параметр события, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров.

JSON-представление
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Поля
eventName

string

Необходимый. Неизменный. Имя события для сопоставления.

eventParameterFilterExpression

object ( AudienceFilterExpression )

Необязательный. Если указано, этот фильтр соответствует событиям, которые соответствуют как одному имени события, так и выражениям фильтра параметров. AudienceEventFilter внутри выражения фильтра параметров невозможно установить (например, не поддерживаются вложенные фильтры событий). Это должен быть одиночный элемент andGroup из DimensionOrMetricFilter или notExpression; Операторы AND для OR не поддерживаются. Кроме того, если он включает фильтр «eventCount», будет учитываться только он; все остальные фильтры будут игнорироваться.

АудиторияПоследовательностьФильтр

Определяет фильтры, которые должны выполняться в определенном порядке, чтобы пользователь мог стать членом аудитории.

JSON-представление
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Поля
scope

enum ( AudienceFilterScope )

Необходимый. Неизменный. Указывает область действия этого фильтра.

sequenceMaximumDuration

string ( Duration format)

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

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

sequenceSteps[]

object ( AudienceSequenceStep )

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

АудиторияПоследовательностьШаг

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

JSON-представление
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Поля
scope

enum ( AudienceFilterScope )

Необходимый. Неизменный. Указывает область действия этого шага.

immediatelyFollows

boolean

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

constraintDuration

string ( Duration format)

Необязательный. Если этот параметр установлен, этот шаг должен быть выполнен в пределах ограниченияDuration предыдущего шага (например, t[i] — t[i-1] <= ограничениеDuration). Если этот параметр не установлен, требования к продолжительности отсутствуют (продолжительность фактически не ограничена). На первом этапе он игнорируется.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

filterExpression

object ( AudienceFilterExpression )

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

AudienceClauseType

Указывает, является ли это предложением фильтра включения или исключения.

Перечисления
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Неопределенный тип предложения.
INCLUDE Пользователи будут включены в аудиторию, если соблюдено условие фильтра.
EXCLUDE Пользователи будут исключены из аудитории, если будет выполнено условие фильтра.

Методы

archive

 Архивирует аудиторию на ресурсе.

create

 Создает аудиторию.

get

 Поиск одной аудитории.

list

 Перечисляет аудитории на ресурсе.

patch

 Обновляет аудиторию на ресурсе.