Method: advertisers.invoices.list

Liste les factures publiées pour un annonceur au cours d'un mois donné.

Cette méthode ne permet pas de récupérer les factures générées par les profils de facturation associés au niveau de facturation "Partenaire".

Requête HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/invoices

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
advertiserId

string (int64 format)

Obligatoire. ID de l'annonceur pour lequel répertorier les factures.

Paramètres de requête

Paramètres
issueMonth

string

Mois pour lequel répertorier les factures. Si cette règle n'est pas configurée, la demande récupère les factures du mois précédent.

Doit être au format AAAAMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Sélectionnez le type de facture à récupérer pour les annonceurs conformes à la loi Sapin.

Elle ne s'applique qu'aux annonceurs respectant la loi Sapin. Il sera ignoré dans les autres cas.
pageSize

integer

Taille de la page demandée. Doit être compris 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 une valeur non valide est spécifiée.
pageToken

string

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

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 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Champs
invoices[]

object (Invoice)

Liste des factures.

Si cette liste est vide, elle sera absente.
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 invoices.list pour récupérer la page de résultats suivante.

Ce jeton sera absent s'il n'y a plus d'invoices à renvoyer.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

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

LoiSapinInvoiceType

Types de factures possibles pour les annonceurs respectant la loi Sapin.

Enums
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED La valeur n'est pas spécifiée.
LOI_SAPIN_INVOICE_TYPE_MEDIA Factures avec coût médias.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Factures avec des frais de plate-forme.

Facture

Une seule facture.

Représentation JSON 
{
  "name": string,
  "invoiceId": string,
  "displayName": string,
  "paymentsProfileId": string,
  "paymentsAccountId": string,
  "issueDate": {
    object (Date)
  },
  "dueDate": {
    object (Date)
  },
  "serviceDateRange": {
    object (DateRange)
  },
  "currencyCode": string,
  "subtotalAmountMicros": string,
  "totalTaxAmountMicros": string,
  "totalAmountMicros": string,
  "purchaseOrderNumber": string,
  "budgetInvoiceGroupingId": string,
  "invoiceType": enum (InvoiceType),
  "correctedInvoiceId": string,
  "replacedInvoiceIds": [
    string
  ],
  "pdfUrl": string,
  "budgetSummaries": [
    {
      object (BudgetSummary)
    }
  ],
  "nonBudgetMicros": string
}
Champs
name

string

Nom de ressource de la facture.
invoiceId

string

Identifiant unique de la facture.
displayName

string

Nom à afficher pour la facture.
paymentsProfileId

string

ID du profil de paiement auquel la facture appartient.

Cet élément apparaît sous la forme Billing ID sur le fichier PDF de la facture.
paymentsAccountId

string

ID du compte de paiement auquel la facture appartient.

Cet élément apparaît sous la forme Billing Account Number sur le fichier PDF de la facture.
issueDate

object (Date)

Date d'émission de la facture.
dueDate

object (Date)

Date d'échéance de la facture.
serviceDateRange

object (DateRange)

Dates de début et de fin du service couvertes par cette facture.
currencyCode

string

Devise utilisée sur la facture, au format ISO 4217.
subtotalAmountMicros

string (int64 format)

Montant du sous-total hors taxes, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.
totalTaxAmountMicros

string (int64 format)

Somme de toutes les taxes sur la facture, exprimée en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.
totalAmountMicros

string (int64 format)

Montant total de la facture, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.
purchaseOrderNumber

string

Numéro du bon de commande associé à la facture.
budgetInvoiceGroupingId

string

ID du groupe de budgets pour cette facture.

Ce champ n'est défini que si le niveau de facturation du profil de facturation correspondant a été défini sur "ID du groupe de factures liées au budget".
invoiceType

enum (InvoiceType)

Type de document de facturation.
correctedInvoiceId

string

Identifiant de la facture d'origine ajustée par cette facture, le cas échéant.

Peut apparaître sous la forme Reference invoice number sur le fichier PDF de la facture.

Si replacedInvoiceIds est défini, ce champ sera vide.
replacedInvoiceIds[]

string

Le ou les ID de toute facture initialement émise et annulée par cette facture, le cas échéant. Il est possible que plusieurs factures soient listées si elles sont regroupées en une seule facture.

Peuvent apparaître sur les factures PDF sous la forme Replaced invoice numbers.

Si correctedInvoiceId est défini, ce champ sera vide.
pdfUrl

string

URL permettant de télécharger une copie de la facture au format PDF.

Cette URL est spécifique à l'utilisateur et nécessite un jeton d'accès OAuth 2.0 valide pour y accéder. Le jeton d'accès doit être fourni dans un en-tête HTTP Authorization: Bearer et être autorisé pour l'un des champs d'application suivants:

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

L'URL sera valide pendant sept jours à compter de la récupération de cet objet de facture ou jusqu'à ce que la facture soit de nouveau récupérée.
budgetSummaries[]

object (BudgetSummary)

Liste des informations récapitulatives pour chaque budget associé à cette facture.

Ce champ n'est défini que si le niveau de détail de la facture du profil de facturation correspondant a été défini sur "Bon de commande au niveau du budget".
nonBudgetMicros

string (int64 format)

Montant total des coûts ou des ajustements non liés à un budget donné, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.

InvoiceType

Types de factures possibles.

Enums
INVOICE_TYPE_UNSPECIFIED Non spécifié ou inconnu dans cette version.
INVOICE_TYPE_CREDIT Le montant de la facture est négatif.
INVOICE_TYPE_INVOICE La facture contient un montant positif.

BudgetSummary

Résumé des informations concernant le budget d'une campagne spécifique.

Représentation JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Champs
externalBudgetId

string

Correspond à la valeur externalBudgetId du budget d'une campagne. Si la valeur n'est pas définie dans le budget de la campagne, ce champ est vide.
prismaCpeCode

object (PrismaCpeCode)

Codes client, produit et d'estimation pertinents de l'outil Mediaocean Prisma.

Ne s'applique qu'aux budgets de campagne dont le externalBudgetSource est de EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Somme des frais générés pour ce budget hors taxes, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.
taxAmountMicros

string (int64 format)

Montant des taxes appliquées aux frais au-delà de ce budget, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.
totalAmountMicros

string (int64 format)

Somme totale des frais générés pour ce budget, taxes comprises, en micro-unités de la devise de la facture.

Par exemple, si currencyCode correspond à USD, 1 000 000 représente un dollar américain.