REST Resource: advertisers.lineItems

L'

Ressource : LineItem

Un seul élément de campagne.

Représentation JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean,
  "youtubeAndPartnersSettings": {
    object (YoutubeAndPartnersSettings)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus)
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'élément de campagne.
advertiserId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'annonceur auquel appartient l'élément de campagne.
campaignId

string (int64 format)

Uniquement en sortie. Identifiant unique de la campagne à laquelle appartient l'élément de campagne.
insertionOrderId

string (int64 format)

Obligatoire. Immuable. Identifiant unique de l'ordre d'insertion auquel appartient l'élément de campagne.
lineItemId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'élément de campagne. Attribué par le système.
displayName

string

Obligatoire. Nom à afficher de l'élément de campagne.

Doit être encodé au format UTF-8 et ne pas dépasser 240 octets.
lineItemType

enum (LineItemType)

Obligatoire. Immuable. Type de l'élément de campagne.
entityStatus

enum (EntityStatus)

Obligatoire. Détermine si l'élément de campagne peut dépenser son budget et enchérir sur l'inventaire.

  • Pour la méthode lineItems.create, seul ENTITY_STATUS_DRAFT est autorisé. Pour activer un élément de campagne, utilisez la méthode lineItems.patch et définissez l'état sur ENTITY_STATUS_ACTIVE après la création.
  • Il est impossible de rétablir l'état ENTITY_STATUS_DRAFT d'un élément de campagne.
  • Si l'ordre d'insertion parent de l'élément de campagne n'est pas actif, l'élément de campagne ne peut pas dépenser son budget, même si son propre état est ENTITY_STATUS_ACTIVE.
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'article. Attribué par le système.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
partnerCosts[]

object (PartnerCost)

Coûts partenaires associés à la ligne.

Si elle est absente ou vide dans la méthode lineItems.create, le nouvel élément de campagne hérite des coûts partenaires de son ordre d'insertion parent.
flight

object (LineItemFlight)

Obligatoire. Heures de début et de fin de la diffusion de l'élément de campagne.
budget

object (LineItemBudget)

Obligatoire. Paramètre de répartition du budget de l'élément de campagne.
pacing

object (Pacing)

Obligatoire. Paramètre de vitesse de dépense du budget de l'élément de campagne.
frequencyCap

object (FrequencyCap)

Obligatoire. Paramètres de limite de la fréquence d'impression de l'élément de campagne.

Le champ maxImpressions de cet objet de paramètres doit être utilisé si vous attribuez un plafond limité.
partnerRevenueModel

object (PartnerRevenueModel)

Obligatoire. Paramètre du modèle de revenus du partenaire de l'élément de campagne.
conversionCounting

object (ConversionCountingConfig)

Paramètre de suivi des conversions de l'élément de campagne.
creativeIds[]

string (int64 format)

ID des créations associées à l'élément de campagne.
bidStrategy

object (BiddingStrategy)

Obligatoire. Stratégie d'enchères de l'élément de campagne.
integrationDetails

object (IntegrationDetails)

Détails de l'intégration de l'élément de campagne.
targetingExpansion

object (TargetingExpansionConfig)

Paramètres de ciblage optimisé de l'élément de campagne.

Cette configuration ne s'applique qu'aux éléments de campagne display, vidéo ou audio qui utilisent les enchères automatiques et ciblent de manière positive les listes d'audience éligibles.
warningMessages[]

enum (LineItemWarningMessage)

Uniquement en sortie. Messages d'avertissement générés par l'élément de campagne. Ces avertissements n'empêchent pas l'enregistrement de l'élément de campagne, mais certains peuvent empêcher sa diffusion.
mobileApp

object (MobileApp)

Application mobile promue par l'élément de campagne.

Cela ne s'applique que lorsque lineItemType est LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL ou LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.
reservationType

enum (ReservationType)

Uniquement en sortie. Type de réservation de l'élément de campagne.
excludeNewExchanges

boolean

Indique si les nouvelles places de marché doivent être exclues du ciblage automatique par l'élément de campagne. La valeur par défaut de ce champ est "false".
youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

Uniquement en sortie. Paramètres spécifiques aux éléments de campagne YouTube et partenaires.
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

Indique si cet élément de campagne diffusera des annonces à caractère politique dans l'Union européenne.

Si containsEuPoliticalAds a été défini sur DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING dans l'annonceur parent, ce champ sera défini sur DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING s'il n'est pas spécifié autrement. Vous pourrez ensuite mettre à jour ce champ à l'aide de l'UI, de l'API ou des fichiers de données structurées.

LineItemType

Types possibles d'un élément de campagne.

Le type d'élément de campagne détermine les paramètres et les options applicables, comme le format des annonces ou les options de ciblage.

Enums
LINE_ITEM_TYPE_UNSPECIFIED

La valeur du type n'est pas spécifiée ou est inconnue dans cette version.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_DISPLAY_DEFAULT Annonces illustrées, HTML5, natives ou rich media
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Diffuser des annonces display qui génèrent des installations d'application
LINE_ITEM_TYPE_VIDEO_DEFAULT Annonces vidéo vendues au CPM pour différents environnements.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Annonces vidéo qui génèrent des installations d'application.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Annonces display diffusées sur l'inventaire d'applications mobiles.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

Annonces vidéo diffusées sur l'inventaire d'applications mobiles.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_AUDIO_DEFAULT Annonces audio RTB vendues pour différents environnements.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Annonces de type "Service de distribution par contournement" présentes dans les ordres d'insertion de type "OTT". Ce type ne s'applique qu'aux éléments de campagne dont l'ordre d'insertion est insertionOrderType OVER_THE_TOP.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION

Annonces vidéo YouTube qui favorisent les conversions.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE

Annonces vidéo YouTube (jusqu'à 15 secondes) qui ne peuvent pas être ignorées.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Annonces vidéo YouTube qui racontent une histoire dans un ordre précis à l'aide de différents formats.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO

Annonces audio YouTube

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH

Annonces vidéo YouTube optimisées pour toucher plus d'utilisateurs uniques à moindre coût. Elles peuvent inclure des annonces bumper, des annonces InStream désactivables ou une combinaison des deux.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE

Annonces vidéo YouTube par défaut.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP

Annonces vidéo YouTube pour TV connectée (jusqu'à 15 secondes) qui ne peuvent pas être ignorées.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP

Annonces vidéo YouTube pour TV connectée qui optimisent la couverture d'un plus grand nombre d'utilisateurs uniques à moindre coût. Elles peuvent inclure des annonces bumper, des annonces InStream désactivables ou une combinaison des deux.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP

Annonces vidéo YouTube par défaut sur TV connectée. N'incluez que le format d'annonce InStream.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY

L'objectif de ce type d'élément de campagne est de diffuser les annonces YouTube un certain nombre de fois auprès de la même personne au cours d'une période donnée.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW

Annonces vidéo YouTube visant à générer plus de vues grâce à différents formats d'annonces.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME

Annonces display diffusées dans l'inventaire de publicité extérieure numérique.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.
LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME

Annonces vidéo diffusées dans l'inventaire de publicité extérieure numérique.

Il est impossible de créer ou de modifier les éléments de campagne de ce type et leur ciblage à l'aide de l'API.

LineItemFlight

Paramètres qui contrôlent la durée active d'un élément de campagne.

Représentation JSON 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}
Champs
flightDateType

enum (LineItemFlightDateType)

Obligatoire. Type de période de diffusion de l'élément de campagne.
dateRange

object (DateRange)

Dates de début et de fin de diffusion de l'élément de campagne. Elles sont résolues par rapport au fuseau horaire de l'annonceur parent.

  • Obligatoire lorsque flightDateType est défini sur LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. Sinon, il s'agit d'une sortie uniquement.
  • Lorsque vous créez un vol, startDate et endDate doivent être dans le futur.
  • Un vol existant avec un startDate dans le passé a un endDate modifiable, mais un startDate immuable.
  • endDate doit être startDate ou une version ultérieure, avant l'année 2037.

LineItemFlightDateType

Types possibles de dates de diffusion d'un élément de campagne.

Enums
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED Les dates de diffusion de l'élément de campagne sont héritées de son ordre d'insertion parent.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM L'élément de campagne utilise sa propre période de diffusion personnalisée.

LineItemBudget

Paramètres qui contrôlent la façon dont le budget est alloué.

Représentation JSON 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
Champs
budgetAllocationType

enum (LineItemBudgetAllocationType)

Obligatoire. Type d'allocation du budget.

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC ne s'applique que lorsque la répartition automatique du budget est activée pour l'ordre d'insertion parent.
budgetUnit

enum (BudgetUnit)

Uniquement en sortie. L'unité budgétaire indique si le budget est basé sur une devise ou sur des impressions. Cette valeur est héritée de l'ordre d'insertion parent.
maxAmount

string (int64 format)

Montant maximal du budget que l'élément de campagne dépensera. Doit être supérieur à 0.

Lorsque budgetAllocationType est :

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC : ce champ est immuable et est défini par le système.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, si budgetUnit est :
    • BUDGET_UNIT_CURRENCY, ce champ représente le montant maximal du budget à dépenser, en micro-unités de la devise de l'annonceur. Par exemple, 1500000 représente 1,5 unité standard de la devise.
    • BUDGET_UNIT_IMPRESSIONS : ce champ représente le nombre maximal d'impressions à diffuser.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, ce champ n'est pas applicable et sera ignoré par le système.

LineItemBudgetAllocationType

Types possibles de répartition du budget.

Enums
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC La répartition automatique du budget est activée pour l'élément de campagne.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Un montant de budget maximal fixe est alloué à l'élément de campagne.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED Aucune limite de budget n'est appliquée à l'élément de campagne.

PartnerRevenueModel

Paramètres qui contrôlent le calcul des revenus des partenaires.

Représentation JSON 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
Champs
markupType

enum (PartnerRevenueModelMarkupType)

Obligatoire. Type de majoration du modèle de revenus du partenaire.
markupAmount

string (int64 format)

Obligatoire. Montant de la majoration du modèle de revenus du partenaire. La valeur doit être supérieure ou égale à 0.

  • Lorsque markupType est défini sur PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, ce champ représente la majoration du CPM en micros de la devise de l'annonceur. Par exemple, 1500000 représente 1,5 unité standard de la devise.
  • Lorsque markupType est défini sur PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, ce champ représente le pourcentage de majoration du coût média en millisecondes. Par exemple, 100 représente 0,1 % (décimal 0,001).
  • Lorsque markupType est défini sur PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, ce champ représente la majoration en pourcentage du coût média total en millisecondes. Par exemple, 100 représente 0,1 % (décimal 0,001).

PartnerRevenueModelMarkupType

Types de majoration possibles du modèle de revenus du partenaire.

Enums
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM Calculez les revenus du partenaire en fonction d'un CPM fixe.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

Calculez les revenus du partenaire en fonction d'un pourcentage supplémentaire de ses coûts liés aux médias.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Calculez les revenus du partenaire en fonction d'un pourcentage supplémentaire de son coût média total, qui inclut tous les coûts partenaires et des données.

ConversionCountingConfig

Paramètres qui contrôlent la façon dont les conversions sont comptabilisées.

Toutes les conversions post-clic seront comptabilisées. Vous pouvez définir un pourcentage pour le décompte des conversions après affichage.

Représentation JSON 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
Champs
postViewCountPercentageMillis

string (int64 format)

Pourcentage de conversions après affichage à comptabiliser, en millisecondes (1/1 000 de pourcentage). Doit être compris entre 0 et 100 000 (inclus).

Par exemple, pour suivre 50 % des conversions post-clic, définissez la valeur sur 50000.
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

Configurations d'activité Floodlight utilisées pour suivre les conversions.

Le nombre de conversions comptabilisées correspond à la somme de toutes les conversions comptabilisées par l'ensemble des ID d'activité Floodlight spécifiés dans ce champ.

Ce champ ne peut pas être modifié si un algorithme d'enchères personnalisées est attribué à l'élément de campagne. Si vous définissez ce champ et attribuez un algorithme d'enchères personnalisées dans la même requête, les activités Floodlight doivent correspondre à celles utilisées par l'algorithme d'enchères personnalisées.

TrackingFloodlightActivityConfig

Paramètres qui contrôlent le comportement d'une configuration d'activité Floodlight.

Représentation JSON 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
Champs
floodlightActivityId

string (int64 format)

Obligatoire. Identifiant de l'activité Floodlight.
postClickLookbackWindowDays

integer

Obligatoire. Nombre de jours après un clic sur une annonce pendant lesquels une conversion peut être comptabilisée. Cette valeur doit être comprise entre 0 et 90 (inclus).
postViewLookbackWindowDays

integer

Obligatoire. Nombre de jours après l'affichage d'une annonce pendant lesquels une conversion peut être comptabilisée. Cette valeur doit être comprise entre 0 et 90 (inclus).

LineItemWarningMessage

Messages d'avertissement générés par un élément de campagne. Ces types d'avertissements n'empêchent pas l'enregistrement d'un élément de campagne, mais peuvent empêcher son exécution.

Enums
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Non spécifié ou inconnu.
INVALID_FLIGHT_DATES La période de diffusion de cet élément de campagne n'est pas valide. L'élément de campagne ne sera pas diffusé.
EXPIRED La date de fin de cet élément de campagne est passée.
PENDING_FLIGHT Cet élément de campagne commencera à être diffusé ultérieurement.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED Toutes les places de marché activées pour le partenaire font l'objet d'un ciblage par exclusion. L'élément de campagne ne sera pas diffusé.
INVALID_INVENTORY_SOURCE Aucune source d'inventaire active n'est ciblée. L'élément de campagne ne sera pas diffusé.
APP_INVENTORY_INVALID_SITE_TARGETING Le ciblage par application et par URL associé à cet élément de campagne ne comporte aucune application mobile. Le type de cet élément de campagne vous oblige à inclure des applications mobiles dans votre canal, votre liste de sites ou votre ciblage par application. L'élément de campagne ne sera pas diffusé.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Cet élément de campagne ne cible aucun mobinaute. Le type de cet élément de campagne vous oblige à cibler une liste d'utilisateurs comportant des mobinautes. L'élément de campagne ne sera pas diffusé.
NO_VALID_CREATIVE Cet élément de campagne ne contient aucune création valide. L'élément de campagne ne sera pas diffusé.
PARENT_INSERTION_ORDER_PAUSED L'ordre d'insertion de cet élément de campagne a été mis en pause. L'élément de campagne ne sera pas diffusé.
PARENT_INSERTION_ORDER_EXPIRED La date de fin de l'ordre d'insertion de cet élément de campagne est antérieure à la date du jour. L'élément de campagne ne sera pas diffusé.

MobileApp

Application mobile promue par un élément de campagne incitant à installer une application mobile.

Représentation JSON 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
Champs
appId

string

Obligatoire. ID de l'application fourni par la plate-forme de téléchargement.

Les applications Android sont identifiées par l'ID du bundle utilisé par le Play Store d'Android, tel que com.google.android.gm.

Les applications iOS sont identifiées par un ID d'application à neuf chiffres utilisé par l'App Store d'Apple, par exemple 422689480.
platform

enum (Platform)

Uniquement en sortie. Plate-forme de l'application.
displayName

string

Uniquement en sortie. Nom de l'application
publisher

string

Uniquement en sortie. Éditeur de l'application

Plate-forme

Plates-formes d'applications mobiles possibles.

Enums
PLATFORM_UNSPECIFIED La plate-forme n'est pas spécifiée.
IOS Plate-forme iOS.
ANDROID Plate-forme Android.

YoutubeAndPartnersSettings

Paramètres des éléments de campagne YouTube et partenaires.

Représentation JSON 
{
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  },
  "videoAdInventoryControl": {
    object (VideoAdInventoryControl)
  }
}
Champs
viewFrequencyCap

object (FrequencyCap)

Paramètres de limite de la fréquence d'exposition pour les vues de l'élément de campagne.

Le champ maxViews de cet objet de paramètres doit être utilisé si vous attribuez un plafond limité.
thirdPartyMeasurementConfigs

object (ThirdPartyMeasurementConfigs)

Facultatif. Configurations de mesure tierce de l'élément de campagne.
inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

Paramètres qui contrôlent les inventaires YouTube et partenaires que l'élément de campagne ciblera.
contentCategory

enum (YoutubeAndPartnersContentCategory)

Uniquement en sortie. Type de contenu sur lequel les annonces YouTube et sur les sites partenaires seront diffusées.
effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

Uniquement en sortie. Catégorie de contenu qui prend effet lors de la diffusion de l'élément de campagne. Lorsque la catégorie de contenu est définie à la fois au niveau de l'élément de campagne et de l'annonceur, la plus stricte s'applique lors de la diffusion de l'élément de campagne.

Les nouveaux éléments de campagne n'hériteront que du paramètre au niveau de l'annonceur.
targetFrequency

object (TargetFrequency)

Facultatif. Nombre moyen de fois que vous souhaitez diffuser des annonces de cet élément de campagne auprès de la même personne sur une période donnée.
linkedMerchantId

string (int64 format)

Facultatif. ID du marchand associé à la ligne pour le flux de produits.
relatedVideoIds[]

string

Facultatif. Les ID des vidéos s'affichent sous l'annonce vidéo principale diffusée dans l'application YouTube d'un appareil mobile.
leadFormId

string (int64 format)

Facultatif. ID du formulaire permettant de générer des prospects.
videoAdSequenceSettings

object (VideoAdSequenceSettings)

Facultatif. Paramètres liés à VideoAdSequence.
videoAdInventoryControl

object (VideoAdInventoryControl)

Facultatif. Paramètres permettant de contrôler l'inventaire autorisé pour cet élément de campagne.

ThirdPartyMeasurementConfigs

Paramètres qui contrôlent les fournisseurs tiers qui mesurent les métriques spécifiques aux éléments de campagne.

Représentation JSON 
{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}
Champs
viewabilityVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers qui mesurent la visibilité.

Les fournisseurs tiers suivants s'appliquent :

  • THIRD_PARTY_VENDOR_MOAT
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_TELEMETRY
  • THIRD_PARTY_VENDOR_MEETRICS
brandSafetyVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers qui mesurent la brand safety.

Les fournisseurs tiers suivants s'appliquent :

  • THIRD_PARTY_VENDOR_ZEFR
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers qui mesurent la couverture.

Les fournisseurs tiers suivants s'appliquent :

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers qui mesurent le brand lift.

Les fournisseurs tiers suivants s'appliquent :

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_NIELSEN

ThirdPartyVendorConfig

Paramètres qui contrôlent la configuration des fournisseurs de solutions de mesure tierces.

Représentation JSON 
{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}
Champs
vendor

enum (ThirdPartyVendor)

Fournisseur de mesure tiers.
placementId

string

Identifiant utilisé par la plate-forme du fournisseur tiers pour identifier l'élément de campagne.

ThirdPartyVendor

Fournisseurs qui effectuent des mesures tierces.

Enums
THIRD_PARTY_VENDOR_UNSPECIFIED Fournisseur tiers inconnu.
THIRD_PARTY_VENDOR_MOAT Moat.
THIRD_PARTY_VENDOR_DOUBLE_VERIFY DoubleVerify.
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE Integral Ad Science.
THIRD_PARTY_VENDOR_COMSCORE Comscore.
THIRD_PARTY_VENDOR_TELEMETRY Télémétrie.
THIRD_PARTY_VENDOR_MEETRICS Meetrics
THIRD_PARTY_VENDOR_ZEFR ZEFR.
THIRD_PARTY_VENDOR_NIELSEN Nielsen.
THIRD_PARTY_VENDOR_KANTAR Kantar.
THIRD_PARTY_VENDOR_DYNATA Dynata.
THIRD_PARTY_VENDOR_TRANSUNION Transunion.

YoutubeAndPartnersInventorySourceConfig

Paramètres qui contrôlent les inventaires associés à YouTube que l'élément de campagne YouTube et partenaires ciblera.

Représentation JSON 
{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
Champs
includeYoutube

boolean

Facultatif. Indique s'il faut cibler l'inventaire sur YouTube. Cela inclut la recherche, les chaînes et les vidéos.
includeGoogleTv

boolean

Facultatif. Indique s'il faut cibler l'inventaire dans les applications vidéo disponibles avec Google TV.
includeYoutubeVideoPartners

boolean

Indique si vous souhaitez cibler l'inventaire sur un ensemble de sites et d'applications partenaires qui respectent les mêmes normes de brand safety que YouTube.

YoutubeAndPartnersContentCategory

Catégories de brand safety pour les contenus YouTube et partenaires.

Enums
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED La catégorie de contenu n'est pas spécifiée ou est inconnue dans cette version.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD Catégorie regroupant un large éventail de contenus adaptés à la plupart des marques. Le contenu est basé sur les Consignes relatives aux contenus adaptés aux annonceurs de YouTube.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED Catégorie incluant tous les contenus sur YouTube et les partenaires vidéo qui répondent aux normes de monétisation.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED Catégorie composée d'un éventail réduit de contenus qui répondent à des exigences plus strictes, en particulier en ce qui concerne le langage inapproprié et le contenu suggestif à caractère sexuel.

TargetFrequency

Paramètre qui contrôle le nombre moyen de fois où les annonces seront diffusées auprès de la même personne sur une période donnée.

Représentation JSON 
{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}
Champs
targetCount

string (int64 format)

Nombre cible de fois où les annonces seront diffusées en moyenne auprès de la même personne au cours de la période définie par timeUnit et timeUnitCount.
timeUnit

enum (TimeUnit)

Unité de temps dans laquelle la fréquence cible sera appliquée.

L'unité de temps suivante s'applique :

  • TIME_UNIT_WEEKS
timeUnitCount

integer

Nombre de timeUnit pendant lesquels la fréquence cible sera appliquée.

Les restrictions suivantes s'appliquent en fonction de la valeur de timeUnit :

  • TIME_UNIT_WEEKS : doit être égal à 1

VideoAdSequenceSettings

Paramètres liés à VideoAdSequence.

Représentation JSON 
{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}
Champs
minimumDuration

enum (VideoAdSequenceMinimumDuration)

Intervalle de temps minimal avant que le même utilisateur revoie cette séquence.
steps[]

object (VideoAdSequenceStep)

Étapes dont se compose la séquence.

VideoAdSequenceMinimumDuration

Énumération de la durée minimale de l'intervalle avant que le même utilisateur ne revoie la séquence d'annonces vidéo.

Enums
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED Non spécifié ou inconnu.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 jours.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 jours.

VideoAdSequenceStep

Détails d'une seule étape d'une VideoAdSequence.

Représentation JSON 
{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}
Champs
stepId

string (int64 format)

ID de l'étape.
adGroupId

string (int64 format)

ID du groupe d'annonces correspondant à l'étape.
previousStepId

string (int64 format)

ID de l'étape précédente. La première étape n'a pas d'étape précédente.
interactionType

enum (InteractionType)

L'interaction avec l'étape précédente qui redirigera l'utilisateur vers l'étape présente. La première étape ne comporte pas de champ "interactionType".

InteractionType

Types d'interaction d'une étape.

Enums
INTERACTION_TYPE_UNSPECIFIED Non spécifié ou inconnu
INTERACTION_TYPE_PAID_VIEW Une vue payée.
INTERACTION_TYPE_SKIP L'utilisateur a ignoré l'annonce.
INTERACTION_TYPE_IMPRESSION Impression d'annonce (vue).
INTERACTION_TYPE_ENGAGED_IMPRESSION Impression d'annonce que l'utilisateur n'a pas ignorée immédiatement, mais qui n'a pas non plus atteint l'événement facturable.

VideoAdInventoryControl

Contrôle de l'inventaire d'annonces vidéo utilisé dans certains types d'éléments de campagne YouTube.

Représentation JSON 
{
  "allowInStream": boolean,
  "allowInFeed": boolean,
  "allowShorts": boolean
}
Champs
allowInStream

boolean

Facultatif. Indique si les annonces peuvent être diffusées au format InStream.
allowInFeed

boolean

Facultatif. Indique si les annonces peuvent être diffusées au format In-Feed.
allowShorts

boolean

Facultatif. Indique si les annonces peuvent être diffusées au format Shorts.

Méthodes

bulkEditAssignedTargetingOptions

 Modifie de façon groupée les options de ciblage de plusieurs éléments de campagne.

bulkListAssignedTargetingOptions

 Liste les options de ciblage attribuées à plusieurs éléments de campagne pour différents types de ciblage.

bulkUpdate

 Met à jour plusieurs éléments de campagne.

create

 Crée un élément de campagne.

delete

 Supprime un élément de campagne.

duplicate

 Duplique un élément de campagne.

generateDefault

 Crée un élément de campagne avec des paramètres (y compris le ciblage) hérités de l'ordre d'insertion et un ENTITY_STATUS_DRAFT entity_status.

get

 Permet d'obtenir un élément de campagne.

list

 Liste les éléments de campagne d'un annonceur.

patch

 Met à jour un élément de campagne existant.