REST Resource: properties.audiences

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

Информационное сообщение, представляющее целевую аудиторию.

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

string

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

displayName

string

Обязательно. Отображаемое имя аудитории.

description

string

Обязательно. Описание целевой аудитории.

membershipDurationDays

integer

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

adsPersonalizationEnabled

boolean

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

eventTrigger

object ( AudienceEventTrigger )

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

exclusionDurationMode

enum ( AudienceExclusionDurationMode )

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

filterClauses[]

object ( AudienceFilterClause )

Обязательный. Неизменяемый. Неупорядоченный список. Фильтрующие условия, определяющие аудиторию. Все условия будут объединены оператором И.

createTime

string ( Timestamp format)

Только вывод. Время создания аудитории.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

AudienceEventTrigger

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

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

string

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

logCondition

enum ( LogCondition )

Обязательно. Когда следует регистрировать событие.

LogCondition

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

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

AudienceExclusionDurationMode

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

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

AudienceFilterClause

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

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 )

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

AudienceSimpleFilter

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

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.
}
Поля
Выражение поля объединения (union field expr . Выражение, применяемое к фильтру. expr может принимать только одно из следующих значений:
andGroup

object ( AudienceFilterExpressionList )

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

orGroup

object ( AudienceFilterExpressionList )

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

notExpression

object ( AudienceFilterExpression )

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

dimensionOrMetricFilter

object ( AudienceDimensionOrMetricFilter )

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

eventFilter

object ( AudienceEventFilter )

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

AudienceFilterExpressionList

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

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

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

atAnyPointInTime

boolean

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

Этот параметр можно установить только в том случае, если область действия Audience установлена ​​на 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 )

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

StringFilter

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

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

enum ( MatchType )

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

value

string

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

caseSensitive

boolean

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

MatchType

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

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

InListFilter

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

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

string

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

caseSensitive

boolean

Необязательный параметр. Если true, поиск чувствителен к регистру. Если 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

Двойное значение.

BetweenFilter

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

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

object ( NumericValue )

Обязательно. Начинается с этого числа включительно.

toValue

object ( NumericValue )

Обязательно. Заканчивается этим числом включительно.

AudienceEventFilter

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

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

string

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

eventParameterFilterExpression

object ( AudienceFilterExpression )

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

AudienceSequenceFilter

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

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

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

constraintDuration

string ( Duration format)

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

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

filterExpression

object ( AudienceFilterExpression )

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

AudienceClauseType

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

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

Методы

archive

 Архивирует запись встречи с аудиторией на объекте недвижимости.

create

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

get

 Поиск по одной целевой аудитории.

list

 Составляет список целевых аудиторий на сайте.

patch

 Обновляет информацию для аудитории о данном объекте недвижимости.