Method: advertisers.lineItems.list

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

L'ordre est défini par le paramètre orderBy. Si aucune valeur filter par entityStatus n'est spécifiée, les éléments de campagne comportant la valeur ENTITY_STATUS_ARCHIVED ne seront pas inclus dans les résultats.

Requête HTTP

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/lineItems

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
advertiserId

string (int64 format)

Obligatoire. Référence de l'annonceur pour lequel répertorier les éléments de campagne.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. La valeur doit être comprise entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si la valeur spécifiée n'est pas valide.
pageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. En général, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode lineItems.list. Si aucune valeur n'est spécifiée, la première page de résultats est renvoyée.
orderBy

string

Champ selon lequel la liste doit être triée. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)
  • entityStatus
  • updateTime

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, ajoutez un suffixe "desc". doit être ajouté au nom du champ. Exemple : displayName desc
filter

string

Permet de filtrer par champs d'élément de campagne.

Syntaxe compatible:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées à l'aide des opérateurs logiques AND ou OR. Une séquence de restrictions utilise implicitement AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Le champ updateTime doit utiliser les opérateurs GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=).
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés:

  • campaignId
  • displayName
  • entityStatus
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (au format ISO 8601, ou YYYY-MM-DDTHH:MM:SSZ)

Exemples :

  • Tous les éléments de campagne d'un ordre d'insertion: insertionOrderId="1234"
  • Tous les éléments de campagne ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED et LINE_ITEM_TYPE_DISPLAY_DEFAULT d'un annonceur: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Tous les éléments de campagne dont la date de mise à jour est inférieure ou égale à 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tous les éléments de campagne dont la date de mise à jour est supérieure ou égale à 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

La longueur de ce champ ne doit pas dépasser 500 caractères.

Pour en savoir plus, consultez notre guide sur le filtrage des requêtes LIST.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

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

Représentation JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Champs
lineItems[]

object (LineItem)

Liste des éléments de campagne.

Cette liste sera absente si elle est vide.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ pageToken lors de l'appel suivant de la méthode lineItems.list pour récupérer la page de résultats suivante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.