Method: advertisers.reachForecast.generateReachForecast

Génère une prévision de couverture pour un annonceur et une configuration de ciblage donnés.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
advertiserId

string (int64 format)

Obligatoire. ID de l'annonceur qui diffusera la campagne planifiée.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Champs
targeting

object (Targeting)

Obligatoire. Paramètres de ciblage de la campagne planifiée.
campaignDuration

object (CampaignDuration)

Obligatoire. Durée de la campagne prévue.
currencyCode

string

Obligatoire. Code de la devise du forfait au format ISO 4217.
plannedProducts[]

object (PlannedProduct)

Obligatoire. Liste des éléments de campagne à inclure dans la prévision.
minEffectiveFrequency

integer

Facultatif. Fréquence effective minimale pour les métriques de couverture indiquées. Il s'agit du nombre minimal de fois qu'un client doit être exposé à l'annonce pour qu'elle soit considérée comme efficace. Ce paramètre n'a d'incidence que sur les rapports.

Doit être compris entre 1 et 10 (inclus). Si aucune valeur n'est spécifiée, la valeur par défaut 1 est appliquée.

Corps de la réponse

Message de réponse pour ReachForecastService.GenerateReachForecast.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Champs
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Taille estimée de l'audience pour la zone géographique ciblée.
reachCurve

object (ReachCurve)

Courbe de prévision générée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

Ciblage

Paramètres de ciblage d'une campagne planifiée.

Représentation JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Champs
plannableLocationIds[]

string (int64 format)

Obligatoire. ID des zones géographiques planifiables à cibler.

Vous pouvez récupérer les emplacements planifiables à l'aide de la méthode reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

Facultatif. Tranche d'âge à cibler.
genders[]

enum (Gender)

Facultatif. Options de genre à cibler.
devices[]

enum (DeviceType)

Facultatif. Appareils à cibler.

CampaignDuration

Durée du forfait couverture.

Représentation JSON 
{

  // 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.
}
Champs
Champ d'union duration. Vous pouvez choisir la durée de la campagne. duration ne peut être qu'un des éléments suivants :
durationDays

integer

Obligatoire. Nombre de jours couverts par le forfait.
dateRange

object (DateRange)

Obligatoire. Période couverte par le plan.

PlannedProduct

Configuration d'un produit spécifique du forfait.

Représentation JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Champs
plannableProductCode

string

Obligatoire. Code du produit, par exemple "VIDEO_REACH_CAMPAIGN".
budgetMicros

string (int64 format)

Obligatoire. Budget de ce produit en micros.
advancedProductTargeting

object (AdvancedProductTargeting)

Facultatif. Remplacements facultatifs du ciblage au niveau de l'élément de campagne.

AdvancedProductTargeting

Remplacements du ciblage spécifiques aux produits.

Représentation 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)
}
Champs
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Facultatif. Surfaces planifiables à cibler.
targetFrequency

object (TargetFrequency)

Facultatif. Nombre moyen de fois où les annonces seront diffusées auprès d'une même personne au cours d'une période donnée.
frequencyCap

object (FrequencyCap)

Facultatif. Limite de la fréquence d'exposition pour le produit spécifique.
ageRange

enum (PlannableAgeRange)

Facultatif. Tranche d'âge à cibler.
genders[]

enum (Gender)

Facultatif. Options de genre à cibler.
devices[]

enum (DeviceType)

Facultatif. Appareils à cibler.
userInterestIds[]

string

Facultatif. ID des centres d'intérêt des utilisateurs à cibler.

Vous pouvez récupérer les centres d'intérêt des utilisateurs planifiables à l'aide de la méthode reachForecast.retrievePlannableUserInterests.
userListIds[]

string

Facultatif. ID des listes d'utilisateurs à cibler.

Vous pouvez récupérer les listes d'utilisateurs planifiables à l'aide de la méthode reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

Facultatif. Paramètres YouTube Select.
dateRange

object (DateRange)

Facultatif. Plage de dates à cibler.
plannableLocationIds[]

string (int64 format)

Facultatif. ID de zones géographiques planifiables à cibler.
network

enum (PlannableNetwork)

Facultatif. Réseau à cibler.

SurfaceTargetingSettings

Sélection du ciblage par surface.

Représentation JSON 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Champs
surfaces[]

enum (PlannableSurface)

Facultatif. Surfaces à cibler.

YouTubeSelectSettings

Paramètres pour les lineups YouTube Select.

Représentation JSON 
{
  "lineupId": string
}
Champs
lineupId

string (int64 format)

Facultatif. ID du lineup YouTube Select.

OnTargetAudienceMetrics

Taille d'audience estimée pour une zone géographique ciblée.

Représentation JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Champs
youtubeAudienceSize

string (int64 format)

Taille estimée de l'audience YouTube.
censusAudienceSize

string (int64 format)

Taille de l'audience basée sur les données de recensement de la zone géographique ciblée.

ReachCurve

Courbe de couverture générée.

Représentation JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Champs
reachForecasts[]

object (ReachForecast)

Points le long de la courbe, classés par coût.

ReachForecast

Point unique de la courbe de couverture.

Représentation JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Champs
costMicros

string (int64 format)

Coût total de ce point en micro-unités.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Répartition des produits individuels à ce niveau de coût.
forecast

object (PlannedProductForecast)

Prévision agrégée pour l'ensemble du plan.

PlannedProductReachForecast

Prévisions de performances pour un produit spécifique.

Représentation JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Champs
costMicros

string (int64 format)

Coût en micro-unités pour ce produit.
plannableProductCode

string

Code du produit.
plannedProductForecast

object (PlannedProductForecast)

Métriques de performances du produit.

PlannedProductForecast

Métriques de performances pour un point de prévision.

Représentation JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Champs
onTargetReach

string (int64 format)

Nombre de personnes uniques touchées correspondant à la définition de la cible.
onTargetImpressions

string (int64 format)

Nombre d'impressions dans la cible.
trueviewViews

string (int64 format)

Nombre de vues TrueView.
totalReach

string (int64 format)

Nombre total de personnes uniques touchées.
totalImpressions

string (int64 format)

Nombre total d'impressions.
viewableImpressions

string (int64 format)

Nombre d'impressions visibles
onTargetCoviewReach

string (int64 format)

Nombre de personnes uniques touchées correspondant à la définition de la couverture dans la cible, y compris les co-spectateurs.
totalCoviewReach

string (int64 format)

Nombre total de personnes uniques touchées, y compris les co-spectateurs.
onTargetCoviewImpressions

string (int64 format)

Nombre d'impressions dans la cible, y compris les co-spectateurs.
totalCoviewImpressions

string (int64 format)

Nombre total d'impressions, y compris les co-spectateurs.