REST Resource: advertisers.lineItems

{
  "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)
  }
}

string

Uniquement en sortie. Nom de ressource de l'élément de ligne.

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

Doit être encodé au format UTF-8 avec une taille maximale de 240 octets.

enum (LineItemType)

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

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.

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

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.

object (LineItemFlight)

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

object (LineItemBudget)

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

object (Pacing)

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

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

object (PartnerRevenueModel)

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

object (ConversionCountingConfig)

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

string (int64 format)

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

object (BiddingStrategy)

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

object (IntegrationDetails)

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

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.

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.

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.

enum (ReservationType)

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

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

object (YoutubeAndPartnersSettings)

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

{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}

enum (LineItemFlightDateType)

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

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.

{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}

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.

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.

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.

{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}

enum (PartnerRevenueModelMarkupType)

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

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

{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}

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.

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.

{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}

string (int64 format)

Obligatoire. ID de l'activité Floodlight.

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.

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.

{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}

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.

enum (Platform)

Uniquement en sortie. La plate-forme de l'application

string

Uniquement en sortie. Nom de l'application.

string

Uniquement en sortie. Éditeur de l'application.

{
  "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)
  }
}

object (FrequencyCap)

Afficher les 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 un plafond limité.

object (ThirdPartyMeasurementConfigs)

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

object (YoutubeAndPartnersInventorySourceConfig)

Paramètres permettant de contrôler les inventaires YouTube et partenaires que l'élément de campagne va cibler.

enum (YoutubeAndPartnersContentCategory)

Type de contenu sur lequel les annonces YouTube et partenaires seront diffusées.

enum (YoutubeAndPartnersContentCategory)

Uniquement en sortie. Catégorie de contenu appliquée 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 dans l'annonceur, la plus stricte est appliquée lors de la diffusion de l'élément de campagne.

object (TargetFrequency)

Nombre moyen de fois que vous souhaitez que les annonces de cet élément de campagne soient diffusées auprès de la même personne au cours d'une période donnée.

string (int64 format)

Identifiant du marchand associé à la ligne du flux de produits.

string

Les ID des vidéos s'affichent sous l'annonce vidéo principale lorsque celle-ci est diffusée dans l'application YouTube d'un appareil mobile.

string (int64 format)

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

object (VideoAdSequenceSettings)

Paramètres associés à VideoAdSequence.

{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}

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

object (ThirdPartyVendorConfig)

Facultatif. Les fournisseurs tiers qui mesurent la brand safety.

Les fournisseurs tiers suivants sont concernés:

• THIRD_PARTY_VENDOR_ZERF
• THIRD_PARTY_VENDOR_DOUBLE_VERIFY
• THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE

object (ThirdPartyVendorConfig)

Facultatif. Fournisseurs tiers mesurant la couverture.

Les fournisseurs tiers suivants sont concernés:

• THIRD_PARTY_VENDOR_NIELSEN
• THIRD_PARTY_VENDOR_COMSCORE
• THIRD_PARTY_VENDOR_KANTAR

object (ThirdPartyVendorConfig)

Facultatif. Les fournisseurs tiers mesurant le brand lift.

Les fournisseurs tiers suivants sont concernés:

• THIRD_PARTY_VENDOR_DYNATA
• THIRD_PARTY_VENDOR_KANTAR

{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}

enum (ThirdPartyVendor)

Le fournisseur de mesure tiers.

string

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

{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}

boolean

Facultatif. Cibler ou non l'inventaire sur YouTube. Cela inclut à la fois la recherche, les chaînes et les vidéos.

boolean

Facultatif. Cibler ou non l'inventaire dans les applications vidéo disponibles avec Google TV.

boolean

Permet de cibler ou non l'inventaire sur un ensemble de sites et d'applications partenaires qui respectent les mêmes normes de brand safety que YouTube.

{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}

string (int64 format)

Nombre cible de diffusions, en moyenne, des annonces auprès de la même personne au cours de la période définie par timeUnit et timeUnitCount.

enum (TimeUnit)

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

L'unité de temps suivante s'applique:

• TIME_UNIT_WEEKS

integer

Nombre de timeUnit pendant lesquels la fréquence cible durera.

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

• TIME_UNIT_WEEKS - doit être 1

{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}

enum (VideoAdSequenceMinimumDuration)

Intervalle de temps minimal avant que le même utilisateur voie de nouveau cette séquence.

object (VideoAdSequenceStep)

Étapes composant la séquence.

{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}

string (int64 format)

ID de l'étape.

string (int64 format)

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

string (int64 format)

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

enum (InteractionType)

Interaction à l'étape précédente qui mène l'utilisateur à cette étape. La première étape ne comporte pas interactionType.