- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- LoiSapinInvoiceType
- Factura
- InvoiceType
- BudgetSummary
- Pruébala
Muestra una lista de las facturas publicadas para un anunciante en un mes determinado.
Las facturas generadas por perfiles de facturación con un nivel de factura de “Socio” no se recuperan a través de este método.
Solicitud HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
advertiserId |
Obligatorio. El ID del anunciante para el que se enumeran las facturas. |
Parámetros de consulta
Parámetros | |
---|---|
issueMonth |
El mes para el que se enumeran las facturas. Si no se establece, la solicitud recuperará las facturas del mes anterior. Debe tener el formato AAAAMM. |
loiSapinInvoiceType |
Seleccione el tipo de factura que desea obtener para los anunciantes de la Ley Sapin. Solo se aplica a los anunciantes de la Ley Sapin. Se ignorará de lo contrario. |
pageSize |
Indica el tamaño de la página solicitada. Debe ser un valor entre |
pageToken |
Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, es el valor de |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"invoices": [
{
object ( |
Campos | |
---|---|
invoices[] |
Es la lista de facturas. Esta lista no estará disponible si está vacía. |
nextPageToken |
Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo Este token estará ausente si no hay más |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
Para obtener más información, consulta la Descripción general de OAuth 2.0.
LoiSapinInvoiceType
Posibles tipos de facturas para los anunciantes de la Ley Sapin.
Enumeradores | |
---|---|
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED |
No se especificó el valor. |
LOI_SAPIN_INVOICE_TYPE_MEDIA |
Facturas con costo de medios |
LOI_SAPIN_INVOICE_TYPE_PLATFORM |
Facturas con la tarifa de la plataforma. |
Facturas
Una sola factura.
Representación JSON |
---|
{ "name": string, "invoiceId": string, "displayName": string, "paymentsProfileId": string, "paymentsAccountId": string, "issueDate": { object ( |
Campos | |
---|---|
name |
El nombre del recurso de la factura. |
invoiceId |
El ID único de la factura. |
displayName |
El nombre visible de la factura. |
paymentsProfileId |
Es el ID del perfil de pagos al que pertenece la factura. Aparece en la factura en PDF como |
paymentsAccountId |
Es el ID de la cuenta de pagos a la que pertenece la factura. Aparece en la factura en PDF como |
issueDate |
Es la fecha en la que se emitió la factura. |
dueDate |
Es la fecha en la que vence la factura. |
serviceDateRange |
Las fechas de inicio y finalización del servicio que se incluyen en esta factura |
currencyCode |
Es la moneda que se usa en la factura con el formato ISO 4217. |
subtotalAmountMicros |
El importe del subtotal antes de impuestos, en micros de la moneda de la factura Por ejemplo, si |
totalTaxAmountMicros |
Es la suma de todos los impuestos de la factura, en micros de la moneda de la factura. Por ejemplo, si |
totalAmountMicros |
Es el importe total de la factura, en micros de la moneda correspondiente. Por ejemplo, si |
purchaseOrderNumber |
Número de orden de compra asociado con la factura. |
budgetInvoiceGroupingId |
El ID de agrupación de presupuestos de esta factura. Este campo solo se establecerá si el nivel de factura del perfil de facturación correspondiente se estableció en "ID de agrupación de facturas del presupuesto". |
invoiceType |
Es el tipo de documento de la factura. |
correctedInvoiceId |
Es el ID de la factura original que se ajustará con esta factura, si corresponde. Puede aparecer en la factura en PDF como Si se configura |
replacedInvoiceIds[] |
Los ID de las facturas emitidas originalmente que se cancelan con esta factura, si corresponde. Es posible que aparezcan varias facturas si se consolidan en una sola. Puede aparecer en el PDF de la factura como Si se configura |
pdfUrl |
La URL para descargar una copia en formato PDF de la factura. Esta URL es específica del usuario y requiere un token de acceso de OAuth 2.0 válido para acceder. El token de acceso se debe proporcionar en un encabezado HTTP
La URL será válida durante 7 días después de que se recupere este objeto de factura o hasta que esta se recupere de nuevo. |
budgetSummaries[] |
Es la lista de información resumida de cada presupuesto asociado con esta factura. Este campo solo se establecerá si el nivel de detalles de la factura del perfil de facturación correspondiente se estableció en "PO a nivel del presupuesto". |
nonBudgetMicros |
Es el importe total de costos o ajustes no vinculados a un presupuesto determinado, en micros de la moneda de la factura. Por ejemplo, si |
InvoiceType
Posibles tipos de facturas.
Enumeradores | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
No se especifica o se desconoce en esta versión. |
INVOICE_TYPE_CREDIT |
La factura tiene un importe negativo. |
INVOICE_TYPE_INVOICE |
La factura tiene un importe positivo. |
BudgetSummary
Es la información resumida del presupuesto de una campaña individual.
Representación JSON |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
Campos | |
---|---|
externalBudgetId |
Corresponde al |
prismaCpeCode |
Códigos relevantes de clientes, productos y estimaciones de la herramienta Mediaocean Prisma. Solo se aplica a los presupuestos de campañas con un |
preTaxAmountMicros |
Es la suma de los cargos efectuados de conformidad con este presupuesto antes de impuestos, en micros de la moneda de la factura. Por ejemplo, si |
taxAmountMicros |
El importe del impuesto aplicado a los cargos por debajo de este presupuesto, en micros de la moneda de la factura. Por ejemplo, si |
totalAmountMicros |
Es la suma total de los cargos realizados según este presupuesto, incluidos los impuestos, en micros de la moneda de la factura. Por ejemplo, si |