REST Resource: advertisers.lineItems

Ressource: LineItem

Élément de campagne unique.

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)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'élément de ligne.
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. ID 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 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 définir des enchères 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 son état sur ENTITY_STATUS_ACTIVE après sa création.
  • Impossible de rétablir l'état ENTITY_STATUS_DRAFT d'un élément de campagne à partir d'un autre état.
  • Si l'ordre d'insertion parent de l'élément de campagne n'est pas actif, ce dernier ne peut pas dépenser son budget, même si son é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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

Coûts partenaires associés à l'élément de campagne.

S'ils sont absents ou vides dans la méthode lineItems.create, l'élément de campagne nouvellement créé héritera des coûts partenaires 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 de répartition du budget de l'élément de campagne.
pacing

object (Pacing)

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

object (FrequencyCap)

Obligatoire. Paramètres de limite de la fréquence d'exposition pour les impressions 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 de 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 d'intégration de l'élément de campagne.
inventorySourceIds[]

string (int64 format)

ID des sources d'inventaire privé attribuées à 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 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 n'est applicable 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

Permet d'exclure ou non les nouvelles places de marché du ciblage automatique de l'élément de campagne. Par défaut, la valeur de ce champ est "false".

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, tels que 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 mettre à jour 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 au CPM pour divers 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 des applications mobiles.

Impossible de créer ou de mettre à jour 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 mettre à jour 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 divers environnements.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Annonces de service de distribution par contournement présentes dans les ordres d'insertion de service de distribution par contournement (OTT, over-the-top). Ce type ne s'applique qu'aux éléments de campagne associés à un ordre d'insertion de type OVER_THE_TOP insertionOrderType.

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)
  },
  "triggerId": string
}
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 en fonction du fuseau horaire de l'annonceur parent.

  • Obligatoire lorsque flightDateType est défini sur LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. Sortie uniquement dans le cas contraire.
  • Lorsque vous créez une période de diffusion, les valeurs startDate et endDate doivent toutes les deux se situer dans le futur.
  • Un vol existant ayant un startDate dans le passé présente un endDate modifiable, mais un startDate immuable.
  • endDate doit être la valeur startDate ou une valeur ultérieure, toutes deux antérieures à l'année 2037.
triggerId

string (int64 format)

ID du déclencheur manuel associé à l'élément de campagne.

  • Obligatoire lorsque flightDateType est défini sur LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER. Ne doit pas être défini autrement.
  • Lorsqu'elle est définie, la période de diffusion de l'élément de campagne est héritée de l'ordre d'insertion parent.
  • Les éléments de campagne actifs dépenseront des dépenses lorsque le déclencheur sélectionné sera activé pendant la période de diffusion de l'ordre d'insertion parent.

Avertissement:Les éléments de campagne qui utilisent des déclencheurs manuels ne sont plus diffusés dans les campagnes display et Video 360. Ce champ ne sera plus disponible à partir du 1er août 2023. Pour en savoir plus, consultez notre annonce de l'abandon de fonctionnalités.

LineItemFlightDateType

Types possibles de périodes 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.
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

L'élément de campagne utilise un déclencheur.

Avertissement:Les éléments de campagne qui utilisent des déclencheurs manuels ne sont plus diffusés dans les campagnes display et Video 360. Cette valeur s'arrêtera le 1er août 2023. Pour en savoir plus, consultez notre annonce de l'abandon de fonctionnalités.

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 de répartition 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 un nombre d'impressions. Cette valeur est héritée de l'ordre d'insertion parent.
maxAmount

string (int64 format)

Montant du 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 est défini par le système.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, si budgetUnit est: <ph type="x-smartling-placeholder">
      </ph>
    • BUDGET_UNIT_CURRENCY, ce champ représente le montant maximal du budget à dépenser, en unités 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 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 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 permettant de contrôler le mode de calcul des revenus du partenaire.

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 micro-unités de la devise de l'annonceur. Par exemple, 1 500 000 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 la majoration en pourcentage du coût média en millisecondes. Par exemple, 100 représente 0,1% (0,001 décimal).
  • 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% (0,001 décimal).

PartnerRevenueModelMarkupType

Types de majoration possibles pour le 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

Calculer les revenus du partenaire en fonction d'un pourcentage supplémentaire du coût média.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Calculer les revenus du partenaire sur la base d'un pourcentage supplémentaire du coût média total, qui inclut l'ensemble des coûts partenaires et des coûts liés aux données.

ConversionCountingConfig

Paramètres régissant la comptabilisation des conversions.

Toutes les conversions post-clic seront comptabilisées. Vous pouvez définir un pourcentage pour la comptabilisation 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 %). Doit être compris entre 0 et 100 000 inclus.

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

object (TrackingFloodlightActivityConfig)

Configurations d'activités 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.

TrackingFloodlightActivityConfig

Paramètres contrôlant 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. Il s'agit du nombre de jours au cours desquels une conversion peut être comptabilisée après un clic sur une annonce. Doit être compris entre 0 et 90 inclus.
postViewLookbackWindowDays

integer

Obligatoire. Il s'agit du nombre de jours au cours desquels une conversion peut être comptabilisée après qu'une annonce a été vue. Doit être compris entre 0 et 90 inclus.

TargetingExpansionConfig

Paramètres qui contrôlent les paramètres de ciblage optimisé de l'élément de campagne.

Représentation JSON 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
Champs
targetingExpansionLevel

enum (TargetingExpansionLevel)

Obligatoire. Indique si le ciblage optimisé est activé.

Ce champ accepte les valeurs suivantes:

  • NO_EXPANSION: le ciblage optimisé est désactivé
  • LEAST_EXPANSION: le ciblage optimisé est activé

Si ce champ est défini sur une autre valeur, il sera automatiquement défini sur LEAST_EXPANSION.

NO_EXPANSION sera la valeur par défaut du champ et sera automatiquement attribuée si vous ne le définissez pas.
excludeFirstPartyAudience
(deprecated)

boolean

Permet d'exclure ou non les audiences propriétaires pour l'élargissement du ciblage.

Ce champ a été abandonné avec le lancement du ciblage optimisé.

Ce champ sera défini sur false. Si ce champ est défini sur true lorsqu'il est obsolète, tous les ciblages par type d'audience propriétaire à inclure associés à cet élément de campagne seront remplacés par le ciblage par exclusion des mêmes audiences propriétaires afin que ces audiences continuent d'être exclues.

TargetingExpansionLevel

Paramètre de ciblage optimisé.

Enums
TARGETING_EXPANSION_LEVEL_UNSPECIFIED Le paramètre de ciblage optimisé n'est pas spécifié ou est inconnu dans cette version.
NO_EXPANSION Le ciblage optimisé est désactivé.
LEAST_EXPANSION Le ciblage optimisé est activé.
SOME_EXPANSION

Si vous l'utilisez, il sera automatiquement défini sur LEAST_EXPANSION.
BALANCED_EXPANSION

Si vous l'utilisez, il sera automatiquement défini sur LEAST_EXPANSION.
MORE_EXPANSION

Si vous l'utilisez, il sera automatiquement défini sur LEAST_EXPANSION.
MOST_EXPANSION

Si vous l'utilisez, il sera automatiquement défini sur LEAST_EXPANSION.

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

Enums
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Non spécifié ou inconnu.
INVALID_FLIGHT_DATES La période de diffusion de cette ligne de commande 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 antérieure à la date du jour.
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 Cet élément de campagne Le ciblage par URL n'inclut aucune application mobile. Avec ce type d'élément de campagne, vous devez inclure des applications mobiles à votre canal, votre liste de sites ou votre ciblage par applications. L'élément de campagne ne sera pas diffusé.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Cet élément de campagne ne cible aucun utilisateur mobile. Ce type d'élément de campagne nécessite que vous proposiez une liste d'utilisateurs composée 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 passée. L'élément de campagne ne sera pas diffusé.
NO_POSITIVE_AUDIENCE_LIST_TARGETED Cet élément de campagne ne cible aucune liste d'audience. Par conséquent, votre budget risque d'être dépensé trop rapidement.
APP_INSTALL_NO_CONVERSION_PIXEL Aucun pixel de conversion n'est configuré pour cet élément de campagne d'installation d'applications.
TARGETING_REVOKED_OR_CLOSED_USER_LIST Cet élément de campagne cible une ou plusieurs listes d'utilisateurs qui ne sont plus disponibles. À l'avenir, cela empêchera la diffusion de l'élément de campagne. Nous vous conseillons donc de supprimer ces listes de votre ciblage.
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY La stratégie d'enchères de cet élément de campagne associé à l'installation d'applications n'est pas optimale.
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS Les accords ciblés par cet élément de campagne acceptent les tailles de création qui ne sont pas utilisées. Cela peut limiter la diffusion ou les performances de l'élément de campagne.
NO_CREATIVE_FOR_TARGETED_DEALS Cet élément de campagne ne contient aucune création pour les accords ciblés.
TARGETING_DEPRECATED_GEO_TARGET Cet élément de campagne cible une cible géographique obsolète.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

Cet élément de campagne utilise le paramètre excludeFirstPartyAudience, qui est obsolète et dont l'arrêt est prévu après le 25 mars 2023.

Mettez à jour l'intégration de votre API pour exclure directement les audiences propriétaires utilisant le ciblage d'audience avant le 25 mars 2023 afin de tenir compte de l'arrêt du champ excludeFirstPartyAudience.

MobileApp

Application mobile dont la promotion est assurée par un élément de campagne d'installation d'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 identifiant d'application à neuf chiffres utilisé par l'App Store d'Apple, par exemple 422689480.
platform

enum (Platform)

Uniquement en sortie. La 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.

Méthodes

bulkEditLineItemAssignedTargetingOptions

 Permet de modifier de manière groupée les options de ciblage d'un seul élément de campagne.

bulkListLineItemAssignedTargetingOptions

 Liste les options de ciblage attribuées à un élément de campagne pour plusieurs types de ciblage.

create

 Crée un élément de campagne.

delete

 Supprime un élément de campagne.

generateDefault

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

get

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

list

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

patch

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