Method: advertisers.invoices.list

L'

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

Les factures générées par des profils de facturation dont le niveau de facturation est "Partenaire" ne peuvent pas être récupérées par cette méthode.

Requête HTTP

GET https://displayvideo.googleapis.com/v3/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 lister les factures.

Paramètres de requête

Paramètres
issueMonth

string

Mois pour lequel lister les factures. Si elle n'est pas définie, la requête 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 soumis à la loi Sapin.

Uniquement applicable aux annonceurs soumis à la loi Sapin. Il est ignoré dans les autres cas.
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 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 à la méthode invoices.list. Si cette option n'est pas spécifiée, la première page de résultats est renvoyé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.

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 de l'appel suivant à 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 de 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 plus d'informations, consultez la OAuth 2.0 Overview.

LoiSapinInvoiceType

Types de factures possibles pour les annonceurs soumis à 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édia.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Factures avec 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 de la facture.
paymentsProfileId

string

ID du profil de paiement auquel appartient la facture.

Apparaît sur la facture au format PDF sous la forme Billing ID.
paymentsAccountId

string

ID du compte de paiement auquel appartient la facture.

Apparaît sur la facture au format PDF sous la forme Billing Account Number.
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 des services couverts par cette facture.
currencyCode

string

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

string (int64 format)

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

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.
totalTaxAmountMicros

string (int64 format)

Somme de toutes les taxes de la facture, en unités de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.
totalAmountMicros

string (int64 format)

Montant total de la facture, en micros de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.
purchaseOrderNumber

string

Numéro de 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 facture.
correctedInvoiceId

string

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

Peut apparaître sur la facture au format PDF sous la forme Reference invoice number.

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

string

ID de toute facture émise à l'origine et annulée par cette facture, le cas échéant. Plusieurs factures peuvent être listées si elles sont regroupées en une seule facture.

Peut apparaître sur la facture au format PDF sous la forme Replaced invoice numbers.

Si correctedInvoiceId est défini, ce champ est 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 après la récupération de cet objet de facture ou jusqu'à ce que cette facture soit récupérée à nouveau.
budgetSummaries[]

object (BudgetSummary)

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

Ce champ ne sera 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 spécifique, en micros de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 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 Le montant de la facture est positif.

BudgetSummary

Informations récapitulatives sur le budget d'une campagne individuelle.

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

string

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

object (PrismaCpeCode)

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

Ne s'applique qu'aux budgets de campagne avec une externalBudgetSource de EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Somme des frais engagés dans le cadre de ce budget avant taxes, en micros de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.
taxAmountMicros

string (int64 format)

Montant de la taxe appliquée aux frais relevant de ce budget, en micros de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.
totalAmountMicros

string (int64 format)

Somme totale des frais imputés à ce budget, y compris les taxes, en micros de la devise de la facture.

Par exemple, si currencyCode est défini sur USD, 1000000 représente un dollar américain.