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 нельзя использовать для передачи данных, которые могут быть использованы или распознаны как информация, позволяющая идентифицировать личность.

Пример: 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 или оба значения. Если заданы оба критерия, показ будет учитываться в том случае, если он отвечает любому из них (в зависимости от того, что произойдет раньше).

VideoViewabilityPercent

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

Перечисления
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 %.

VideoDurationSeconds

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

Перечисления
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 секунд.

VideoDurationQuartile

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

Перечисления
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.