- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- LoiSapinInvoiceType
- Facture
- InvoiceType
- BudgetSummary
- Essayer
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 |
Obligatoire. ID de l'annonceur pour lequel répertorier les factures. |
Paramètres de requête
Paramètres | |
---|---|
issueMonth |
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 |
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 |
Taille de la page demandée. Doit être compris entre |
pageToken |
Jeton identifiant une page de résultats que le serveur doit renvoyer. Il s'agit généralement de la valeur de |
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 ( |
Champs | |
---|---|
invoices[] |
Liste des factures. Si cette liste est vide, elle sera absente. |
nextPageToken |
Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ Ce jeton sera absent s'il n'y a plus d' |
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 ( |
Champs | |
---|---|
name |
Nom de ressource de la facture. |
invoiceId |
Identifiant unique de la facture. |
displayName |
Nom à afficher pour la facture. |
paymentsProfileId |
ID du profil de paiement auquel la facture appartient. Cet élément apparaît sous la forme |
paymentsAccountId |
ID du compte de paiement auquel la facture appartient. Cet élément apparaît sous la forme |
issueDate |
Date d'émission de la facture. |
dueDate |
Date d'échéance de la facture. |
serviceDateRange |
Dates de début et de fin du service couvertes par cette facture. |
currencyCode |
Devise utilisée sur la facture, au format ISO 4217. |
subtotalAmountMicros |
Montant du sous-total hors taxes, en micro-unités de la devise de la facture. Par exemple, si |
totalTaxAmountMicros |
Somme de toutes les taxes sur la facture, exprimée en micro-unités de la devise de la facture. Par exemple, si |
totalAmountMicros |
Montant total de la facture, en micro-unités de la devise de la facture. Par exemple, si |
purchaseOrderNumber |
Numéro du bon de commande associé à la facture. |
budgetInvoiceGroupingId |
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 |
Type de document de facturation. |
correctedInvoiceId |
Identifiant de la facture d'origine ajustée par cette facture, le cas échéant. Peut apparaître sous la forme Si |
replacedInvoiceIds[] |
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 Si |
pdfUrl |
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
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[] |
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 |
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 |
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 ( |
Champs | |
---|---|
externalBudgetId |
Correspond à la valeur |
prismaCpeCode |
Codes client, produit et d'estimation pertinents de l'outil Mediaocean Prisma. Ne s'applique qu'aux budgets de campagne dont le |
preTaxAmountMicros |
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 |
taxAmountMicros |
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 |
totalAmountMicros |
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 |