REST Resource: floodlightGroups

Ressource: FloodlightGroup

Eine einzelne Floodlight-Gruppe.

JSON-Darstellung
{
  "name": string,
  "floodlightGroupId": string,
  "displayName": string,
  "webTagType": enum (WebTagType),
  "lookbackWindow": {
    object (LookbackWindow)
  },
  "customVariables": {
    object
  },
  "activeViewConfig": {
    object (ActiveViewVideoViewabilityMetricConfig)
  }
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Floodlight-Gruppe.

floodlightGroupId

string (int64 format)

Nur Ausgabe. Die eindeutige ID der Floodlight-Gruppe. Wird vom System zugewiesen.

displayName

string

Erforderlich. Der Anzeigename der Floodlight-Gruppe.

webTagType

enum (WebTagType)

Erforderlich. Der für die Floodlight-Gruppe aktivierte Web-Tag-Typ.

lookbackWindow

object (LookbackWindow)

Erforderlich. Das Lookback-Window für die Floodlight-Gruppe. Sowohl clickDays als auch impressionDays sind erforderlich. Zulässige Werte für beide sind 0 bis 90 (einschließlich).

customVariables

object (Struct format)

Benutzerdefinierte Variablen, die der Floodlight-Gruppe gehören. Mithilfe von benutzerdefinierten Floodlight-Variablen können Sie Berichtsdaten erstellen, die genau auf Ihre konkreten Geschäftsanforderungen zugeschnitten sind. Benutzerdefinierte Floodlight-Variablen enthalten Schlüssel wie U1= oder U2=. Sie können alle Werte annehmen, die Sie ihnen zuweisen. Sie können damit praktisch jede Art von Daten erfassen, die Sie über Ihre Kunden erheben, z. B. das Genre eines gekauften Films oder das Land, in das ein Artikel versendet wird.

Benutzerdefinierte Floodlight-Variablen dürfen nicht verwendet werden, um Daten zu übergeben, die als personenidentifizierbare Informationen verwendet oder erkannt werden könnten.

Beispiel: customVariables { fields { "U1": value { numberValue: 123.4 }, "U2": value { stringValue: "MyVariable2" }, "U3": value { stringValue: "MyVariable3" } } }

Zulässige Werte für Schlüssel sind „U1“ bis „U100“. Stringwerte müssen weniger als 64 Zeichen lang sein und dürfen die folgenden Zeichen nicht enthalten: "<>.

activeViewConfig

object (ActiveViewVideoViewabilityMetricConfig)

Die Konfiguration des Active View-Messwerts für die Sichtbarkeit von Videos für die Floodlight-Gruppe.

WebTagType

Die möglichen Typen von Web-Tags für eine Floodlight-Gruppe.

Enums
WEB_TAG_TYPE_UNSPECIFIED Der Typwert ist nicht angegeben oder in dieser Version unbekannt.
WEB_TAG_TYPE_NONE Kein Tag-Typ.
WEB_TAG_TYPE_IMAGE Bild-Tag.
WEB_TAG_TYPE_DYNAMIC Dynamisches Tag.

LookbackWindow

Hiermit wird angegeben, welcher Zeitraum in der Vergangenheit beim Erfassen einer Conversion berücksichtigt werden soll.

JSON-Darstellung
{
  "clickDays": integer,
  "impressionDays": integer
}
Felder
clickDays

integer

Lookback-Window in Tagen, seit ein bestimmter Nutzer zuletzt auf eine Ihrer Anzeigen geklickt hat.

impressionDays

integer

Lookback-Window in Tagen, seit ein bestimmter Nutzer zuletzt eine Ihrer Anzeigen gesehen hat.

ActiveViewVideoViewabilityMetricConfig

Konfiguration für benutzerdefinierte Active View-Sichtbarkeitsmesswerte für Videos.

JSON-Darstellung
{
  "displayName": string,
  "minimumViewability": enum (VideoViewabilityPercent),
  "minimumVolume": enum (VideoVolumePercent),
  "minimumDuration": enum (VideoDurationSeconds),
  "minimumQuartile": enum (VideoDurationQuartile)
}
Felder
displayName

string

Erforderlich. Der Anzeigename des benutzerdefinierten Messwerts.

minimumViewability

enum (VideoViewabilityPercent)

Erforderlich. Der minimale Prozentsatz der Pixel der Videoanzeige, die auf dem Bildschirm sichtbar sein müssen, damit eine Impression erfasst wird.

minimumVolume

enum (VideoVolumePercent)

Erforderlich. Der Mindestprozentsatz der Lautstärke der Videoanzeige, der erforderlich ist, damit eine Impression erfasst wird.

minimumDuration

enum (VideoDurationSeconds)

Die erforderliche minimale Sichtbarkeitsdauer des Videos (in Sekunden), damit eine Impression erfasst wird.

Sie müssen minimumDuration, minimumQuartile oder beides angeben. Wenn beide angegeben sind, erfüllt eine Impression die Messwertkriterien, wenn eine der beiden Anforderungen erfüllt ist (je nachdem, welche zuerst eintritt).

minimumQuartile

enum (VideoDurationQuartile)

Die minimale Sichtbarkeitsdauer, die basierend auf den Videoquartilen erforderlich ist, damit eine Impression erfasst wird.

Sie müssen minimumDuration, minimumQuartile oder beides angeben. Wenn beide angegeben sind, erfüllt eine Impression die Messwertkriterien, wenn eine der beiden Anforderungen erfüllt ist (je nachdem, welche zuerst eintritt).

VideoViewabilityPercent

Mögliche Prozentwerte der sichtbaren Pixel einer Videoanzeige.

Enums
VIEWABILITY_PERCENT_UNSPECIFIED Der Wert ist nicht angegeben oder in dieser Version unbekannt.
VIEWABILITY_PERCENT_0 0% sichtbar.
VIEWABILITY_PERCENT_25 Zu 25% sichtbar.
VIEWABILITY_PERCENT_50 Zu 50% sichtbar.
VIEWABILITY_PERCENT_75 Zu 75% sichtbar.
VIEWABILITY_PERCENT_100 Zu 100% sichtbar.

VideoVolumePercent

Mögliche Prozentwerte für die Wiedergabelautstärke einer Videoanzeige.

Enums
VIDEO_VOLUME_PERCENT_UNSPECIFIED Der Wert ist nicht angegeben oder in dieser Version unbekannt.
VIDEO_VOLUME_PERCENT_0 0% Lautstärke.
VIDEO_VOLUME_PERCENT_10 Lautstärke 10.

VideoDurationSeconds

Mögliche Werte für die Sichtbarkeitsdauer einer Videoanzeige in Sekunden.

Enums
VIDEO_DURATION_UNSPECIFIED Der Wert ist nicht angegeben oder in dieser Version unbekannt.
VIDEO_DURATION_SECONDS_NONE Kein Wert für die Dauer.
VIDEO_DURATION_SECONDS_0 0 Sekunden.
VIDEO_DURATION_SECONDS_1 1 Sekunde.
VIDEO_DURATION_SECONDS_2 2 Sekunden.
VIDEO_DURATION_SECONDS_3 3 Sekunden.
VIDEO_DURATION_SECONDS_4 4 Sekunden.
VIDEO_DURATION_SECONDS_5 5 Sekunden.
VIDEO_DURATION_SECONDS_6 6 Sekunden.
VIDEO_DURATION_SECONDS_7 7 Sekunden.
VIDEO_DURATION_SECONDS_8 8 Sekunden
VIDEO_DURATION_SECONDS_9 9 Sekunden
VIDEO_DURATION_SECONDS_10 10 Sekunden.
VIDEO_DURATION_SECONDS_11 11 Sekunden
VIDEO_DURATION_SECONDS_12 12 Sekunden.
VIDEO_DURATION_SECONDS_13 13 Sekunden.
VIDEO_DURATION_SECONDS_14 14 Sekunden
VIDEO_DURATION_SECONDS_15 15 Sekunden
VIDEO_DURATION_SECONDS_30 30 Sekunden
VIDEO_DURATION_SECONDS_45 45 Sekunden
VIDEO_DURATION_SECONDS_60 60 Sekunden

VideoDurationQuartile

Mögliche Quartilwerte für die Sichtbarkeitsdauer einer Videoanzeige.

Enums
VIDEO_DURATION_QUARTILE_UNSPECIFIED Der Wert ist nicht angegeben oder in dieser Version unbekannt.
VIDEO_DURATION_QUARTILE_NONE Kein Quartilwert.
VIDEO_DURATION_QUARTILE_FIRST Erstes Quartil.
VIDEO_DURATION_QUARTILE_SECOND Zweites Quartil (Mittelpunkt).
VIDEO_DURATION_QUARTILE_THIRD Drittes Quartil.
VIDEO_DURATION_QUARTILE_FOURTH Viertes Quartil (Abschluss).

Methoden

get

Ruft eine Floodlight-Gruppe ab.

patch

Aktualisiert eine vorhandene Floodlight-Gruppe.