REST Resource: advertisers.lineItems

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)
  },
  "demandGenSettings": {
    object (DemandGenSettings)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus),
  "optimizeFixedBidding": boolean
}
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 l'élément de campagne appartient.

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é en UTF-8 avec une taille maximale de 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.
  • Un élément de campagne ne peut pas revenir à l'état ENTITY_STATUS_DRAFT à partir d'un autre état.
  • 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'élément de campagne. 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 à l'élément de campagne.

Si ce champ est absent ou vide dans la méthode lineItems.create, l'élément de campagne nouvellement créé héritera des coûts associés au partenaire de son ordre d'insertion parent.

flight

object (LineItemFlight)

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

budget

object (LineItemBudget)

Obligatoire. Paramètre d'allocation 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)

Facultatif. Obligatoire si le type d'élément de campagne n'est pas LINE_ITEM_TYPE_DEMAND_GEN. Paramètres de limite de la fréquence d'exposition de l'élément de campagne.

Le champ maxImpressions de cet objet de paramètres doit être utilisé si vous attribuez une limite.

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)

Les 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 appliquent un ciblage positif à des 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 ne bloquent 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 défini sur 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. Ce champ est défini sur "false" par défaut.

youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

Facultatif. Paramètres spécifiques aux éléments de campagne YouTube et partenaires.

demandGenSettings

object (DemandGenSettings)

Facultatif. Paramètres spécifiques aux éléments de campagne Demand Gen.

S'applique uniquement aux éléments de campagne Demand Gen.

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, sauf indication contraire. Vous pouvez ensuite modifier ce champ à l'aide de l'interface utilisateur, de l'API ou de fichiers de données structurées.

Ce champ doit être renseigné lors de la création d'un élément de campagne. Sinon, la requête advertisers.lineItems.create échouera.

optimizeFixedBidding

boolean

Facultatif. Indique si l'optimisation des enchères de DV360 doit être activée pour les éléments de campagne à enchère fixe.

Par défaut, DV360 optimise votre enchère fixe en diminuant automatiquement les enchères pour les impressions moins susceptibles d'être performantes. Cette optimisation est activée par défaut (valeur définie sur "true").

Lorsque ce champ est défini sur false, cette optimisation est désactivée et l'enchère ne sera pas diminuée, quelle qu'en soit la raison.

Ce paramètre ne s'applique qu'aux éléments de campagne dont le biddingStrategy est de type FIXED_BID.

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.

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 Annonces display qui génèrent des installations d'une application.
LINE_ITEM_TYPE_VIDEO_DEFAULT Annonces vidéo vendues par tranche de mille impressions pour différents environnements.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Annonces vidéo qui génèrent des installations d'une application.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

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

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.

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 service de distribution par contournement (OTT, over-the-top) présentes dans les ordres d'insertion 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.

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.

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 d'une combinaison de formats.

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.

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. Peut inclure des annonces bumper, des annonces InStream désactivables ou une combinaison des deux.

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.

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.

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 sur TV connectée qui optimisent la couverture d'utilisateurs uniques à moindre coût. Peut inclure des annonces bumper, des annonces InStream désactivables ou une combinaison des deux.

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 pour la TV connectée. N'incluez que le format d'annonce InStream.

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 nombre de fois cible auprès de la même personne sur une certaine période.

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.

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 sur l'inventaire de publicité extérieure numérique.

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 sur l'inventaire de publicité extérieure numérique.

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_DEMAND_GEN Annonces Demand Gen.

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 la période 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. Uniquement en sortie dans les autres cas.
  • Lorsque vous créez un vol, les valeurs startDate et endDate doivent être postérieures à la date du jour.
  • Un vol existant dont la date de départ (startDate) est passée possède un champ endDate modifiable, mais un champ startDate immuable.
  • endDate doit être défini sur startDate ou une date 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 La période de diffusion de l'élément de campagne est héritée de l'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 manière dont le budget est alloué.

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

enum (LineItemBudgetAllocationType)

Obligatoire. Type d'allocation budgétaire.

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.

La valeur de ce champ doit être définie sur LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED pour les éléments de campagne Demand Gen.

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)

Budget maximal 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 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 micros de la devise de l'annonceur. Par exemple, 1 500 000 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 d'allocation budgétaire.

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 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.

La valeur de ce champ doit être définie sur PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP pour les éléments de campagne Demand Gen.

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, 1 500 000 représente 1,5 unité standard de la devise.
  • Lorsque le champ 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 millièmes. Par exemple, 100 représente 0,1% (décimale 0,001).
  • Lorsque le champ markupType est défini sur PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, ce champ représente le pourcentage de majoration du coût média total en millièmes. Par exemple, 100 représente 0,1% (décimale 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 son coût média.

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 les coûts liés aux 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 une valeur en pourcentage pour la comptabilisation des conversions après affichage.

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

string (int64 format)

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

Par exemple, pour suivre 50% des conversions post-clic, définissez une valeur de 50 000.

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 tous les 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.

primaryAttributionModelId

string (int64 format)

Facultatif. Modèle d'attribution à utiliser pour mesurer les conversions. Ce modèle d'attribution déterminera la façon dont les conversions sont comptabilisées. Vous pouvez définir le modèle principal pour une configuration ou un groupe Floodlight. En savoir plus

S'applique uniquement aux éléments de campagne Demand Gen.

TrackingFloodlightActivityConfig

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

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

string (int64 format)

Obligatoire. ID de l'activité Floodlight.

postClickLookbackWindowDays

integer

Obligatoire. Nombre de jours pendant lesquels une conversion peut être comptabilisée après un clic sur une annonce. Doit être compris entre 0 et 90 inclus.

postViewLookbackWindowDays

integer

Obligatoire. Nombre de jours après le visionnage d'une annonce pendant lesquels une conversion peut être comptabilisée. Doit être compris entre 0 et 90 inclus.

LineItemWarningMessage

Messages d'avertissement générés par un élément de campagne. Ces types d'avertissements ne bloquent 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 Cet élément de campagne est associé à des périodes de diffusion non valides. L'élément de campagne ne sera pas diffusé.
EXPIRED La date de fin de cet élément de campagne est antérieure à la date du jour.
PENDING_FLIGHT Cet élément de campagne commencera à être diffusé à une date ultérieure.
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 applications et URL de cet élément de campagne n'inclut aucune application mobile. Le type de cet élément de campagne nécessite que vous incluiez des applications mobiles dans votre ciblage par canal, liste de sites ou application. L'élément de campagne ne sera pas diffusé.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Cet élément de campagne ne cible aucun utilisateur mobile. Le type de cet élément de campagne nécessite que vous cibliez une liste d'utilisateurs mobiles. 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 située dans le passé. 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 d'applications.

Les applications Android sont identifiées par l'ID de bundle utilisé par le Play Store d'Android, par exemple 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. L'é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 la 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,
  "relatedVideos": [
    {
      object (RelatedVideo)
    }
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  },
  "videoAdInventoryControl": {
    object (VideoAdInventoryControl)
  }
}
Champs
viewFrequencyCap

object (FrequencyCap)

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

Le champ maxViews de cet objet de paramètres doit être utilisé si vous attribuez une limite.

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 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 dans l'élément de campagne et 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 certaine période.

linkedMerchantId

string (int64 format)

Facultatif. ID du compte Merchant Center utilisé pour fournir un flux de produits.

Ce compte Merchant Center doit déjà être associé à l'annonceur.

relatedVideos[]

object (RelatedVideo)

Facultatif. Vidéos similaires pour l'élément de campagne. Ces vidéos s'afficheront sous l'annonce vidéo principale diffusée dans l'application YouTube d'un appareil mobile.

leadFormId

string (int64 format)

Facultatif. ID du formulaire pour 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 des métriques spécifiques d'é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 mesurant la visibilité.

Les fournisseurs tiers suivants sont concernés :

  • 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 mesurant la brand safety.

Les fournisseurs tiers suivants sont applicables :

  • THIRD_PARTY_VENDOR_ZEFR
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers mesurant la couverture.

Les fournisseurs tiers suivants sont applicables :

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_VIDEO_RESEARCH
  • THIRD_PARTY_VENDOR_MEDIA_SCOPE
  • THIRD_PARTY_VENDOR_AUDIENCE_PROJECT
  • THIRD_PARTY_VENDOR_VIDEO_AMP
  • THIRD_PARTY_VENDOR_ISPOT_TV
  • THIRD_PARTY_VENDOR_GEMIUS
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers mesurant le brand lift.

Les fournisseurs tiers suivants sont concernés :

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_INTAGE
  • THIRD_PARTY_VENDOR_MACROMILL

ThirdPartyVendorConfig

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

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

enum (ThirdPartyVendor)

Fournisseur de solutions de mesure tierce.

placementId

string

ID 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.
THIRD_PARTY_VENDOR_ORIGIN origine.
THIRD_PARTY_VENDOR_GEMIUS Gemius.
THIRD_PARTY_VENDOR_MEDIA_SCOPE MediaScope.
THIRD_PARTY_VENDOR_AUDIENCE_PROJECT Audience Project.
THIRD_PARTY_VENDOR_VIDEO_AMP Video Amp.
THIRD_PARTY_VENDOR_ISPOT_TV iSpot.tv.
THIRD_PARTY_VENDOR_INTAGE Intage.
THIRD_PARTY_VENDOR_MACROMILL Macromill.
THIRD_PARTY_VENDOR_VIDEO_RESEARCH Video Research.
THIRD_PARTY_VENDOR_AQUILA Aquila.

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 si l'inventaire doit être ciblé sur YouTube. Cela inclut les recherches, les chaînes et les vidéos.

includeGoogleTv

boolean

Facultatif. Indique si vous souhaitez 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 de 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 comprenant 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 chez les partenaires vidéo qui respectent les 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 matière de langage inapproprié et de contenu sexuellement suggestif.

TargetFrequency

Paramètre qui contrôle le nombre moyen de fois où les annonces sont 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 moyen de fois que les annonces seront diffusées 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 est applicable :

  • TIME_UNIT_WEEKS
  • TIME_UNIT_MONTHS
timeUnitCount

integer

Nombre de timeUnit pendant lequel 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
  • TIME_UNIT_MONTHS : doit être défini sur 1

RelatedVideo

Représente une entrée de vidéo similaire.

Représentation JSON
{
  "videoId": string,
  "videoAssetId": string
}
Champs
videoId

string

Uniquement en sortie. ID de la vidéo YouTube similaire.

videoAssetId

string (int64 format)

Obligatoire. adAssetId de la ressource AdAsset pour la vidéo YouTube.

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 ne voie à nouveau cette séquence.

steps[]

object (VideoAdSequenceStep)

Étapes qui composent la séquence.

VideoAdSequenceMinimumDuration

Énumération de l'intervalle de temps minimal possible avant que le même utilisateur ne voie à nouveau la VideoAdSequence.

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)

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 sur une étape.

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

VideoAdInventoryControl

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

Représentation JSON
{
  "allowInStream": boolean,
  "allowInFeed": boolean,
  "allowShorts": boolean,
  "allowNonSkippableInStream": 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.

allowNonSkippableInStream

boolean

Facultatif. Indique si les annonces peuvent être diffusées au format InStream non désactivable.

DemandGenSettings

Paramètres des éléments de campagne Demand Gen.

Représentation JSON
{
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "linkedMerchantId": string,
  "geoLanguageTargetingEnabled": boolean
}
Champs
thirdPartyMeasurementConfigs

object (ThirdPartyMeasurementConfigs)

Facultatif. Paramètres de mesure tierce pour l'élément de campagne Demand Gen.

linkedMerchantId

string (int64 format)

Facultatif. ID du compte Merchant Center utilisé pour fournir un flux de produits.

Ce compte Merchant Center doit déjà être associé à l'annonceur.

geoLanguageTargetingEnabled

boolean

Facultatif. Immuable. Indique si le ciblage géographique et linguistique peut être défini au niveau de l'élément de campagne. Sinon, les types de ciblage pertinents doivent être attribués directement aux groupes d'annonces.

Méthodes

bulkEditAssignedTargetingOptions

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

bulkListAssignedTargetingOptions

Répertorie 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.

get

Récupère un élément de campagne.

list

Répertorie les éléments de campagne d'un annonceur.

patch

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