- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- LoiSapinInvoiceType
- Fatura
- InvoiceType
- BudgetSummary
- Faça um teste
Lista as faturas publicadas para um anunciante em um determinado mês.
As faturas geradas por perfis de faturamento com o nível "Parceiro" não podem ser recuperadas com esse método.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/invoices
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
advertiserId |
Obrigatório. O ID do anunciante para listar as faturas. |
Parâmetros de consulta
Parâmetros | |
---|---|
issueMonth |
O mês para listar as faturas. Se ela não for definida, as faturas do mês anterior serão recuperadas. Precisa estar no formato AAAAMM. |
loiSapinInvoiceType |
Selecione o tipo de fatura a ser recuperada para os anunciantes da Lei Sapin. Aplicável somente a anunciantes da Lei Sapin. Caso contrário, será ignorado. |
pageSize |
Tamanho da página solicitada. O valor precisa estar entre |
pageToken |
Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de |
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 ( |
Campos | |
---|---|
invoices[] |
Lista de faturas. Esta lista não vai aparecer se estiver vazia. |
nextPageToken |
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo Esse token estará ausente se não houver mais |
Escopos de autorização
Requer um dos seguintes escopos de 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 foi 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 |
---|
{ "name": string, "invoiceId": string, "displayName": string, "paymentsProfileId": string, "paymentsAccountId": string, "issueDate": { object ( |
Campos | |
---|---|
name |
O nome do recurso da fatura. |
invoiceId |
O ID exclusivo da fatura. |
displayName |
O nome de exibição da fatura. |
paymentsProfileId |
O ID do perfil para pagamentos a que a fatura pertence. Aparece no PDF da fatura como |
paymentsAccountId |
O ID da conta para pagamentos a que a fatura pertence. Aparece no PDF da fatura como |
issueDate |
A data em que a fatura foi emitida. |
dueDate |
A data de vencimento da fatura. |
serviceDateRange |
As datas de início e término do serviço cobertas por esta fatura. |
currencyCode |
A moeda usada na fatura no formato ISO 4217. |
subtotalAmountMicros |
O valor do subtotal sem tributos, em micros da moeda da fatura. Por exemplo, se |
totalTaxAmountMicros |
A soma de todos os tributos na fatura, em micros da moeda da fatura. Por exemplo, se |
totalAmountMicros |
O valor total da fatura, em micros da moeda da fatura. Por exemplo, se |
purchaseOrderNumber |
Número da ordem de compra associada à fatura. |
budgetInvoiceGroupingId |
É o ID do agrupamento de orçamento desta fatura. Esse campo só será 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 |
O tipo de documento de fatura. |
correctedInvoiceId |
O ID da fatura original que está sendo ajustado por esta fatura, se aplicável. Pode aparecer no PDF da fatura como Se |
replacedInvoiceIds[] |
Os IDs de qualquer fatura emitida originalmente que está sendo cancelada por essa fatura, se aplicável. Várias faturas podem ser listadas se elas estiverem sendo consolidadas em uma única fatura. Pode aparecer no PDF da fatura como Se |
pdfUrl |
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. O token de acesso precisa ser fornecido em um cabeçalho HTTP
O URL será válido por sete dias após a recuperação desse objeto de fatura ou até que esta fatura seja recuperada novamente. |
budgetSummaries[] |
A lista de informações resumidas de 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 com nível de orçamento". |
nonBudgetMicros |
O valor total de custos ou ajustes não vinculados a um orçamento específico, em micros da moeda da fatura. Por exemplo, se |
InvoiceType
Possíveis tipos de faturas.
Enums | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
Não está especificada ou é desconhecida 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 ( |
Campos | |
---|---|
externalBudgetId |
Corresponde ao |
prismaCpeCode |
Códigos de cliente, produto e estimativa relevantes da ferramenta Mediaocean Prisma. Aplicável apenas a orçamentos de campanha com um |
preTaxAmountMicros |
A soma das cobranças feitas nesse orçamento antes dos impostos, em micros da moeda da fatura. Por exemplo, se |
taxAmountMicros |
O valor dos tributos aplicados às cobranças desse orçamento, em micros da moeda da fatura. Por exemplo, se |
totalAmountMicros |
A soma total das cobranças feitas nesse orçamento, incluindo impostos, em micros da moeda da fatura. Por exemplo, se |