REST Resource: floodlightGroups

Ресурс: FloodlightGroup

Одна группа Floodlight.

JSON-представление
{
  "name": string,
  "floodlightGroupId": string,
  "displayName": string,
  "webTagType": enum (WebTagType),
  "lookbackWindow": {
    object (LookbackWindow)
  },
  "customVariables": {
    object
  },
  "activeViewConfig": {
    object (ActiveViewVideoViewabilityMetricConfig)
  }
}
Поля
name

string

Только вывод. Имя ресурса группы Floodlight.

floodlightGroupId

string ( int64 format)

Только вывод. Уникальный идентификатор группы Floodlight. Назначается системой.

displayName

string

Обязательно. Отображаемое имя группы Floodlight.

webTagType

enum ( WebTagType )

Обязательно. Тип веб-тега, включённый для группы Floodlight.

lookbackWindow

object ( LookbackWindow )

Обязательно. Период ретроспективного анализа для группы Floodlight. Необходимо указать оба параметра: clickDays и impressionDays . Допустимые значения для обоих параметров — 0 до 90 включительно.

customVariables

object ( Struct format)

Пользовательские переменные, принадлежащие группе Floodlight. Используйте пользовательские переменные Floodlight для создания отчётных данных, соответствующих уникальным потребностям вашего бизнеса. Пользовательские переменные Floodlight используют ключи U1= , U2= и т. д. и могут принимать любые значения, которые вы им передадите. Вы можете использовать их для отслеживания практически любых данных, которые вы собираете о своих клиентах, например, жанр приобретённого клиентом фильма, страну доставки и т. д.

Пользовательские переменные Floodlight нельзя использовать для передачи каких-либо данных, которые могут быть использованы или распознаны как персональные данные (PII).

Пример: customVariables { fields { "U1": value { numberValue: 123.4 }, "U2": value { stringValue: "MyVariable2" }, "U3": value { stringValue: "MyVariable3" } } }

Допустимые значения ключей: от «U1» до «U100» включительно. Строковые значения должны быть короче 64 символов и не могут содержать следующие символы: "<> .

activeViewConfig

object ( ActiveViewVideoViewabilityMetricConfig )

Конфигурация показателей видимости видео Active View для группы Floodlight.

WebTagType

Возможные типы веб-тегов для группы Floodlight.

Перечисления
WEB_TAG_TYPE_UNSPECIFIED Значение типа не указано или неизвестно в данной версии.
WEB_TAG_TYPE_NONE Тип тега отсутствует.
WEB_TAG_TYPE_IMAGE Тег изображения.
WEB_TAG_TYPE_DYNAMIC Динамический тег.

LookbackWindow

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

JSON-представление
{
  "clickDays": integer,
  "impressionDays": integer
}
Поля
clickDays

integer

Период ретроспективного просмотра (в днях) с момента последнего нажатия пользователем одного из ваших объявлений.

impressionDays

integer

Период ретроспективного просмотра (в днях) с момента последнего просмотра пользователем одного из ваших объявлений.

ActiveViewVideoViewabilityMetricConfig

Конфигурация для пользовательских метрик видимости видео Active View.

JSON-представление
{
  "displayName": string,
  "minimumViewability": enum (VideoViewabilityPercent),
  "minimumVolume": enum (VideoVolumePercent),
  "minimumDuration": enum (VideoDurationSeconds),
  "minimumQuartile": enum (VideoDurationQuartile)
}
Поля
displayName

string

Обязательно. Отображаемое имя пользовательской метрики.

minimumViewability

enum ( VideoViewabilityPercent )

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

minimumVolume

enum ( VideoVolumePercent )

Обязательно. Минимальный процент объёма видеорекламы, необходимый для регистрации показа.

minimumDuration

enum ( VideoDurationSeconds )

Минимальная продолжительность видимого видео (в секундах), необходимая для регистрации показа.

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

minimumQuartile

enum ( VideoDurationQuartile )

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

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

Процент просмотра видео

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

Перечисления
VIEWABILITY_PERCENT_UNSPECIFIED В данной версии значение не указано или неизвестно.
VIEWABILITY_PERCENT_0 0% видимых.
VIEWABILITY_PERCENT_25 25% просматриваемых.
VIEWABILITY_PERCENT_50 50% просматриваемых.
VIEWABILITY_PERCENT_75 75% просматриваемых.
VIEWABILITY_PERCENT_100 100% просматриваемость.

VideoVolumePercent

Возможные процентные значения громкости воспроизведения видеорекламы.

Перечисления
VIDEO_VOLUME_PERCENT_UNSPECIFIED В данной версии значение не указано или неизвестно.
VIDEO_VOLUME_PERCENT_0 0% объема.
VIDEO_VOLUME_PERCENT_10 10% объема.

Длительность видео (секунды)

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

Перечисления
VIDEO_DURATION_UNSPECIFIED В данной версии значение не указано или неизвестно.
VIDEO_DURATION_SECONDS_NONE Длительность не указана.
VIDEO_DURATION_SECONDS_0 0 секунд.
VIDEO_DURATION_SECONDS_1 1 секунда.
VIDEO_DURATION_SECONDS_2 2 секунды.
VIDEO_DURATION_SECONDS_3 3 секунды.
VIDEO_DURATION_SECONDS_4 4 секунды.
VIDEO_DURATION_SECONDS_5 5 секунд.
VIDEO_DURATION_SECONDS_6 6 секунд.
VIDEO_DURATION_SECONDS_7 7 секунд.
VIDEO_DURATION_SECONDS_8 8 секунд.
VIDEO_DURATION_SECONDS_9 9 секунд.
VIDEO_DURATION_SECONDS_10 10 секунд.
VIDEO_DURATION_SECONDS_11 11 секунд.
VIDEO_DURATION_SECONDS_12 12 секунд.
VIDEO_DURATION_SECONDS_13 13 секунд.
VIDEO_DURATION_SECONDS_14 14 секунд.
VIDEO_DURATION_SECONDS_15 15 секунд.
VIDEO_DURATION_SECONDS_30 30 секунд.
VIDEO_DURATION_SECONDS_45 45 секунд.
VIDEO_DURATION_SECONDS_60 60 секунд.

Квартиль длительности видео

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

Перечисления
VIDEO_DURATION_QUARTILE_UNSPECIFIED В данной версии значение не указано или неизвестно.
VIDEO_DURATION_QUARTILE_NONE Квартильное значение отсутствует.
VIDEO_DURATION_QUARTILE_FIRST Первый квартиль.
VIDEO_DURATION_QUARTILE_SECOND Второй квартиль (средняя точка).
VIDEO_DURATION_QUARTILE_THIRD Третий квартиль.
VIDEO_DURATION_QUARTILE_FOURTH Четвертый квартиль (завершение).

Методы

get

Получает группу Floodlight.

patch

Обновляет существующую группу Floodlight.