Method: advertisers.reachForecast.generateReachForecast

Erstellt eine Reichweitenprognose für einen bestimmten Werbetreibenden und eine bestimmte Targeting-Konfiguration.

HTTP-Anfrage

POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:generateReachForecast

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, der die geplante Kampagne durchführt.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Felder
targeting

object (Targeting)

Erforderlich. Die Ausrichtungsparameter der geplanten Kampagne.

campaignDuration

object (CampaignDuration)

Erforderlich. Die Dauer der geplanten Kampagne.

currencyCode

string

Erforderlich. Der Währungscode für das Abo im ISO 4217-Format.

plannedProducts[]

object (PlannedProduct)

Erforderlich. Die Liste der Werbebuchungen, die in die Prognose einbezogen werden sollen.

minEffectiveFrequency

integer

Optional. Die effektive Mindesthäufigkeit für die gemeldeten Reichweitenmesswerte. Die Mindestanzahl an Impressionen, die ein Kunde sehen muss, damit die Anzeige als effektiv gilt. Diese Einstellung wirkt sich nur auf Berichte aus.

Muss zwischen 1 und 10 (einschließlich) liegen. Wenn keine Angabe erfolgt, wird der Standardwert 1 verwendet.

Antworttext

Antwortnachricht für ReachForecastService.GenerateReachForecast.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Felder
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Die geschätzten Zielgruppengrößen für die Region mit Targeting.

reachCurve

object (ReachCurve)

Die generierte Prognosekurve.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/display-video

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Targeting

Targeting-Einstellungen für eine geplante Kampagne.

JSON-Darstellung
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Felder
plannableLocationIds[]

string (int64 format)

Erforderlich. IDs der planbaren Standorte für das Targeting.

Planbare Standorte können mit der Methode reachForecast.retrievePlannableLocations abgerufen werden.

ageRange

enum (PlannableAgeRange)

Optional. Die Altersgruppe, auf die Sie das Targeting ausrichten möchten.

genders[]

enum (Gender)

Optional. Die Geschlechtsoptionen für das Targeting.

devices[]

enum (DeviceType)

Optional. Die Geräte, auf die Sie die Anzeigen ausrichten möchten.

CampaignDuration

Die Dauer des Reichweitenplans.

JSON-Darstellung
{

  // Union field duration can be only one of the following:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field duration.
}
Felder
Union-Feld duration. Sie können die Laufzeit der Kampagne selbst bestimmen. Für duration ist nur einer der folgenden Werte zulässig:
durationDays

integer

Erforderlich. Die Anzahl der Tage, die der Plan abdeckt.

dateRange

object (DateRange)

Erforderlich. Der Zeitraum, den der Plan abdeckt.

PlannedProduct

Konfiguration für ein bestimmtes Produkt im Plan.

JSON-Darstellung
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Felder
plannableProductCode

string

Erforderlich. Der Code für das Produkt, z.B. „VIDEO_REACH_CAMPAIGN“.

budgetMicros

string (int64 format)

Erforderlich. Das Budget für dieses Produkt in Mikroeinheiten.

advancedProductTargeting

object (AdvancedProductTargeting)

Optional. Optionale Überschreibungen des Targetings auf Werbebuchungsebene.

AdvancedProductTargeting

Produktspezifische Überschreibungen der Ausrichtung.

JSON-Darstellung
{
  "surfaceTargetingSettings": {
    object (SurfaceTargetingSettings)
  },
  "targetFrequency": {
    object (TargetFrequency)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "userInterestIds": [
    string
  ],
  "userListIds": [
    string
  ],
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  },
  "dateRange": {
    object (DateRange)
  },
  "plannableLocationIds": [
    string
  ],
  "network": enum (PlannableNetwork)
}
Felder
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Optional. Planbare Oberflächen für das Targeting.

targetFrequency

object (TargetFrequency)

Optional. Die durchschnittliche Häufigkeit, mit der Anzeigen einem Nutzer in einem bestimmten Zeitraum präsentiert werden.

frequencyCap

object (FrequencyCap)

Optional. Das Frequency Capping für das jeweilige Produkt.

ageRange

enum (PlannableAgeRange)

Optional. Die Altersgruppe, auf die Sie das Targeting ausrichten möchten.

genders[]

enum (Gender)

Optional. Die Geschlechtsoptionen für das Targeting.

devices[]

enum (DeviceType)

Optional. Die Geräte, auf die Sie die Anzeigen ausrichten möchten.

userInterestIds[]

string

Optional. Die IDs der Nutzerinteressen, auf die ausgerichtet werden soll.

Planbare Nutzerinteressen lassen sich mit der Methode reachForecast.retrievePlannableUserInterests abrufen.

userListIds[]

string

Optional. Die IDs der Nutzerlisten, auf die ausgerichtet werden soll.

Planbare Nutzerlisten lassen sich mit der Methode reachForecast.retrievePlannableUserInterests abrufen.

youtubeSelectSettings

object (YouTubeSelectSettings)

Optional. YouTube Select-Einstellungen.

dateRange

object (DateRange)

Optional. Der Zeitraum, auf den sich das Targeting beziehen soll.

plannableLocationIds[]

string (int64 format)

Optional. Planbare Standort-IDs für die Ausrichtung.

network

enum (PlannableNetwork)

Optional. Das Netzwerk, auf das ausgerichtet werden soll.

SurfaceTargetingSettings

Auswahl der Oberflächenausrichtung.

JSON-Darstellung
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Felder
surfaces[]

enum (PlannableSurface)

Optional. Die Oberflächen, auf die ausgerichtet werden soll.

YouTubeSelectSettings

Einstellungen für YouTube Select-Pakete.

JSON-Darstellung
{
  "lineupId": string
}
Felder
lineupId

string (int64 format)

Optional. Die ID des YouTube Select-Pakets.

OnTargetAudienceMetrics

Geschätzte Zielgruppengrößen für eine bestimmte geografische Einheit.

JSON-Darstellung
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Felder
youtubeAudienceSize

string (int64 format)

Geschätzte Größe der YouTube-Zielgruppe.

censusAudienceSize

string (int64 format)

Größe der Zielgruppe basierend auf den Bevölkerungsstatistiken der Zielregion.

ReachCurve

Die generierte Reichweitenkurve.

JSON-Darstellung
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Felder
reachForecasts[]

object (ReachForecast)

Punkte entlang der Kurve, nach Kosten sortiert.

ReachForecast

Ein einzelner Punkt in der Reichweitenkurve.

JSON-Darstellung
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Felder
costMicros

string (int64 format)

Gesamtkosten für diesen Punkt in Mikros.

plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Aufschlüsselung für einzelne Produkte an diesem Kostenpunkt.

forecast

object (PlannedProductForecast)

Aggregierte Prognose für den gesamten Plan.

PlannedProductReachForecast

Leistungsprognose für ein bestimmtes Produkt.

JSON-Darstellung
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Felder
costMicros

string (int64 format)

Die Kosten für dieses Produkt in Micros.

plannableProductCode

string

Der Code für das Produkt.

plannedProductForecast

object (PlannedProductForecast)

Leistungsmesswerte für das Produkt.

PlannedProductForecast

Leistungsmesswerte für einen Prognosepunkt.

JSON-Darstellung
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Felder
onTargetReach

string (int64 format)

Anzahl der einzelnen Nutzer, die der Definition der Zielgruppe entsprechen und erreicht wurden.

onTargetImpressions

string (int64 format)

Anzahl der Impressionen in der Zielgruppe.

trueviewViews

string (int64 format)

Anzahl der TrueView-Aufrufe.

totalReach

string (int64 format)

Die Gesamtzahl der einzelnen Nutzer, die erreicht wurden.

totalImpressions

string (int64 format)

Gesamtzahl der Impressionen.

viewableImpressions

string (int64 format)

Anzahl der sichtbaren Impressionen

onTargetCoviewReach

string (int64 format)

Anzahl der einzelnen Nutzer, die der Definition für die Zielgruppe entsprechen, einschließlich Co-Viewern.

totalCoviewReach

string (int64 format)

Die Gesamtzahl der erreichten einzelnen Nutzer, einschließlich Co-Viewern.

onTargetCoviewImpressions

string (int64 format)

Anzahl der Impressionen bei der Zielgruppe, einschließlich Co-Viewern.

totalCoviewImpressions

string (int64 format)

Gesamtzahl der Impressionen, einschließlich Co-Viewern.