Method: advertisers.reachForecast.generateReachForecast

Genera una previsione della copertura per un determinato inserzionista e una determinata configurazione di targeting.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista che pubblicherà la campagna pianificata.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

object (Targeting)

Obbligatorio. I parametri di targeting della campagna pianificata.
campaignDuration

object (CampaignDuration)

Obbligatorio. La durata della campagna pianificata.
currencyCode

string

Obbligatorio. Il codice valuta del piano nel formato ISO 4217.
plannedProducts[]

object (PlannedProduct)

Obbligatorio. L'elenco degli elementi pubblicitari da includere nella previsione.
minEffectiveFrequency

integer

Facoltativo. La frequenza effettiva minima per le metriche di copertura registrate. Questo è il numero minimo di volte in cui un cliente deve essere esposto all'annuncio affinché questo sia considerato efficace. Questa impostazione influisce solo sui report.

Deve essere compreso tra 1 e 10 inclusi. Se non specificato, viene applicato il valore predefinito 1.

Corpo della risposta

Messaggio di risposta per ReachForecastService.GenerateReachForecast.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Campi
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Le dimensioni stimate dei segmenti di pubblico per l'area geografica target.
reachCurve

object (ReachCurve)

La curva di previsione generata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

Targeting

Impostazioni di targeting per una campagna pianificata.

Rappresentazione JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Campi
plannableLocationIds[]

string (int64 format)

Obbligatorio. ID delle località pianificabili da scegliere come target.

Le località pianificabili possono essere recuperate utilizzando il metodo reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

Facoltativo. La fascia d'età da scegliere come target.
genders[]

enum (Gender)

Facoltativo. Le opzioni relative al genere da scegliere come target.
devices[]

enum (DeviceType)

Facoltativo. I dispositivi da scegliere come target.

CampaignDuration

La durata del piano di copertura.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of mutually exclusive fields.
}
Campi
Scelta della durata della campagna. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
durationDays

integer

Obbligatorio. Il numero di giorni coperti dal piano.
dateRange

object (DateRange)

Obbligatorio. L'intervallo di date coperto dal piano.
Fine dei campi che si escludono a vicenda.

PlannedProduct

Configurazione di un prodotto specifico nel piano.

Rappresentazione JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Campi
plannableProductCode

string

Obbligatorio. Il codice del prodotto, ad esempio "VIDEO_REACH_CAMPAIGN".
budgetMicros

string (int64 format)

Obbligatorio. Il budget per questo prodotto in micro.
advancedProductTargeting

object (AdvancedProductTargeting)

Facoltativo. Override facoltativi del targeting a livello di elemento pubblicitario.

AdvancedProductTargeting

Override del targeting specifico per il prodotto.

Rappresentazione JSON 
{
  "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)
}
Campi
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Facoltativo. Piattaforme pianificabili da scegliere come target.
targetFrequency

object (TargetFrequency)

Facoltativo. Il numero medio di volte in cui gli annunci verranno mostrati alla stessa persona in un determinato periodo di tempo.
frequencyCap

object (FrequencyCap)

Facoltativo. La quota limite per il prodotto specifico.
ageRange

enum (PlannableAgeRange)

Facoltativo. La fascia d'età da scegliere come target.
genders[]

enum (Gender)

Facoltativo. Le opzioni relative al genere da scegliere come target.
devices[]

enum (DeviceType)

Facoltativo. I dispositivi da scegliere come target.
userInterestIds[]

string

Facoltativo. Gli ID degli interessi degli utenti da scegliere come target.

Gli interessi degli utenti pianificabili possono essere recuperati utilizzando il metodo reachForecast.retrievePlannableUserInterests.
userListIds[]

string

Facoltativo. Gli ID degli elenchi di utenti da scegliere come target.

Gli elenchi di utenti pianificabili possono essere recuperati utilizzando il metodo reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

Facoltativo. Impostazioni di YouTube Select.
dateRange

object (DateRange)

Facoltativo. L'intervallo di date da scegliere come target.
plannableLocationIds[]

string (int64 format)

Facoltativo. ID località pianificabili da scegliere come target.
network

enum (PlannableNetwork)

Facoltativo. La rete target.

SurfaceTargetingSettings

Selezione del targeting per le piattaforme.

Rappresentazione JSON 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Campi
surfaces[]

enum (PlannableSurface)

Facoltativo. Le piattaforme da scegliere come target.

YouTubeSelectSettings

Impostazioni per le selezioni YouTube Select.

Rappresentazione JSON 
{
  "lineupId": string
}
Campi
lineupId

string (int64 format)

Facoltativo. L'ID della selezione YouTube Select.

OnTargetAudienceMetrics

Dimensioni dei segmenti di pubblico stimati per un'area geografica target.

Rappresentazione JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Campi
youtubeAudienceSize

string (int64 format)

Dimensione stimata del segmento di pubblico di YouTube.
censusAudienceSize

string (int64 format)

Dimensioni del segmento di pubblico in base ai dati del censimento dell'area geografica target.

ReachCurve

La curva di copertura generata.

Rappresentazione JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Campi
reachForecasts[]

object (ReachForecast)

Punti lungo la curva, ordinati per costo.

ReachForecast

Un singolo punto nella curva di copertura.

Rappresentazione JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Campi
costMicros

string (int64 format)

Costo totale per questo punto in micro.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Suddivisione per i singoli prodotti con questo costo.
forecast

object (PlannedProductForecast)

Previsione aggregata per l'intero piano.

PlannedProductReachForecast

Previsione del rendimento per un prodotto specifico.

Rappresentazione JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Campi
costMicros

string (int64 format)

Il costo in micro di questo prodotto.
plannableProductCode

string

Il codice del prodotto.
plannedProductForecast

object (PlannedProductForecast)

Metriche sul rendimento del prodotto.

PlannedProductForecast

Metriche sul rendimento per un punto di previsione.

Rappresentazione JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Campi
onTargetReach

string (int64 format)

Numero di utenti unici raggiunti che corrispondono alla definizione in linea con il target.
onTargetImpressions

string (int64 format)

Numero di impressioni in linea con il target.
trueviewViews

string (int64 format)

Numero di visualizzazioni TrueView.
totalReach

string (int64 format)

Numero totale di utenti unici raggiunti.
totalImpressions

string (int64 format)

Numero totale di impressioni.
viewableImpressions

string (int64 format)

Numero di impressioni visualizzabili.
onTargetCoviewReach

string (int64 format)

Numero di utenti unici raggiunti che corrispondono alla definizione in linea con il target, inclusi i co-spettatori.
totalCoviewReach

string (int64 format)

Numero totale di persone uniche raggiunte, inclusi i co-spettatori.
onTargetCoviewImpressions

string (int64 format)

Numero di impressioni in linea con il target, inclusi i co-spettatori.
totalCoviewImpressions

string (int64 format)

Numero totale di impressioni, inclusi i co-spettatori.