Rede de Display e A API Video 360 v2 foi descontinuada. Use o Display & Video 360 API v3. Para ver as instruções de migração da v2 para a v3, consulte nosso guia de migração.

Esta página foi traduzida pela API Cloud Translation.

Method: advertisers.invoices.list

Solicitação HTTP
Parâmetros de caminho
Parâmetros de consulta
Corpo da solicitação
Corpo da resposta
- Representação JSON
Escopos de autorização
LoiSapinInvoiceType
Fatura
- Representação JSON
InvoiceType
BudgetSummary
- Representação JSON
Faça um teste

Lista as faturas postadas para um anunciante em um determinado mês.

Faturas geradas por perfis de faturamento com um "parceiro" nível da fatura não podem ser recuperados por meio desse método.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros

Parâmetros
`advertiserId`	`string (int64 format)` Obrigatório. O ID do anunciante para o qual as faturas serão listadas.

advertiserId

string (int64 format)

Obrigatório. O ID do anunciante para o qual as faturas serão listadas.

Parâmetros de consulta

Parâmetros
`issueMonth`	`string` O mês para listar as faturas. Se ela não for definida, a solicitação recuperará as faturas do mês anterior. Precisa estar no formato AAAAMM.
`loiSapinInvoiceType`	`enum (LoiSapinInvoiceType)` Selecione o tipo de fatura a ser recuperado para os anunciantes da Lei Sapin. Aplicável somente a anunciantes da Lei Sapin. Caso contrário, será ignorado.
`pageSize`	`integer` Tamanho da página solicitada. O valor precisa estar entre `1` e `200`. Se não for especificado, o padrão será `100`. Retorna o código de erro `INVALID_ARGUMENT` se um valor inválido for especificado.
`pageToken`	`string` Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de `nextPageToken` retornado da chamada anterior para o método `invoices.list`. Se não for especificado, a primeira página de resultados será retornada.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON
{ "invoices": [ { object (`Invoice`) } ], "nextPageToken": string }

Campos

Campos
`invoices[]`	`object (Invoice)` Lista de faturas. Esta lista estará ausente se estiver vazia.
`nextPageToken`	`string` Um token para recuperar a próxima página de resultados. Transmita esse valor no campo `pageToken` na chamada seguinte para o método `invoices.list` para recuperar a próxima página de resultados. Esse token estará ausente se não houver mais `invoices` para retornar.

invoices[]

object (Invoice)

Lista de faturas.

Esta lista estará ausente se estiver vazia.

nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método invoices.list para recuperar a próxima página de resultados.

Esse token estará ausente se não houver mais invoices para retornar.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

LoiSapinInvoiceType

Possíveis tipos de fatura para anunciantes da Lei Sapin.

Enums
`LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED`	O valor não está especificado.
`LOI_SAPIN_INVOICE_TYPE_MEDIA`	Faturas com custo de mídia.
`LOI_SAPIN_INVOICE_TYPE_PLATFORM`	Faturas com taxa de plataforma.

Fatura

Uma única fatura.

Representação JSON

Representação 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 }

{
  "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
}

Campos
`name`	`string` O nome do recurso da fatura.
`invoiceId`	`string` O ID exclusivo da fatura.
`displayName`	`string` O nome de exibição da fatura.
`paymentsProfileId`	`string` O ID do perfil para pagamentos a que a fatura pertence. Aparece no PDF da fatura como `Billing ID`.
`paymentsAccountId`	`string` O ID da conta para pagamentos a que a fatura pertence. Aparece no PDF da fatura como `Billing Account Number`.
`issueDate`	`object (Date)` A data em que a fatura foi emitida.
`dueDate`	`object (Date)` A data de vencimento da fatura.
`serviceDateRange`	`object (DateRange)` As datas de início e término do serviço cobertas por esta fatura.
`currencyCode`	`string` A moeda usada na fatura no formato ISO 4217.
`subtotalAmountMicros`	`string (int64 format)` O valor do subtotal sem tributos, em micros da moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.
`totalTaxAmountMicros`	`string (int64 format)` A soma de todos os impostos na fatura, em micros na moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.
`totalAmountMicros`	`string (int64 format)` O valor total da fatura, em micros na moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.
`purchaseOrderNumber`	`string` Número da ordem de compra associada à fatura.
`budgetInvoiceGroupingId`	`string` O ID do agrupamento de orçamento desta fatura. Esse campo só é definido se o nível da fatura do perfil de faturamento correspondente tiver sido definido como "ID do agrupamento de faturas de orçamento".
`invoiceType`	`enum (InvoiceType)` O tipo de documento de fatura.
`correctedInvoiceId`	`string` O ID da fatura original que está sendo ajustada por esta fatura, se aplicável. Pode aparecer no PDF da fatura como `Reference invoice number`. Se `replacedInvoiceIds` for definido, este campo ficará vazio.
`replacedInvoiceIds[]`	`string` Os IDs de qualquer fatura emitida originalmente que esteja sendo cancelada por esta fatura, se aplicável. Várias faturas poderão ser listadas se elas estiverem sendo consolidadas em uma única fatura. Pode aparecer no PDF da fatura como `Replaced invoice numbers`. Se `correctedInvoiceId` for definido, este campo ficará vazio.
`pdfUrl`	`string` O URL para fazer o download de uma cópia em PDF da fatura. Esse URL é específico ao usuário e requer um token de acesso OAuth 2.0 válido para ser acessado. O token de acesso precisa ser fornecido em um cabeçalho HTTP `Authorization: Bearer` e ser autorizado para um dos seguintes escopos: `https://www.googleapis.com/auth/display-video-mediaplanning` `https://www.googleapis.com/auth/display-video` O URL será válido por sete dias após a recuperação desse objeto de fatura ou até que a fatura seja recuperada novamente.
`budgetSummaries[]`	`object (BudgetSummary)` A lista de informações resumidas para cada orçamento associado a esta fatura. Esse campo só será definido se o nível de detalhes da fatura do perfil de faturamento correspondente tiver sido definido como "Ordem de compra no nível do orçamento".
`nonBudgetMicros`	`string (int64 format)` O valor total dos custos ou ajustes não vinculados a um orçamento específico, em micros da moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.

InvoiceType

Possíveis tipos de faturas.

Enums
`INVOICE_TYPE_UNSPECIFIED`	Não especificado ou desconhecido nesta versão.
`INVOICE_TYPE_CREDIT`	A fatura tem um valor negativo.
`INVOICE_TYPE_INVOICE`	A fatura tem um valor positivo.

BudgetSummary

Informações resumidas do orçamento de uma campanha individual.

Representação JSON
{ "externalBudgetId": string, "prismaCpeCode": { object (`PrismaCpeCode`) }, "preTaxAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string }

Campos
`externalBudgetId`	`string` Corresponde ao `externalBudgetId` do orçamento de uma campanha. Se o valor não for definido no orçamento da campanha, esse campo ficará vazio.
`prismaCpeCode`	`object (PrismaCpeCode)` Códigos relevantes de clientes, produtos e estimativas da ferramenta Mediaocean Prisma. Aplicável somente a orçamentos de campanhas com um `externalBudgetSource` de `EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN`.
`preTaxAmountMicros`	`string (int64 format)` A soma das cobranças feitas nesse orçamento antes dos tributos, em micros na moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.
`taxAmountMicros`	`string (int64 format)` O valor dos tributos aplicados às cobranças desse orçamento, em micros na moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.
`totalAmountMicros`	`string (int64 format)` A soma total das cobranças feitas nesse orçamento, incluindo tributos, em micros na moeda da fatura. Por exemplo, se `currencyCode` for `USD`, 1000000 representará um dólar americano.