Method: advertisers.invoices.list

Belirli bir ayda reklamveren için yayınlanan faturaları listeler.

"İş ortağı" ile faturalandırma profilleri tarafından oluşturulan faturalar bu yöntemle fatura düzeyine ulaşılamaz.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Faturalarının listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
issueMonth

string

Faturalarının listeleneceği ay. Politika ayarlanmazsa istek, önceki aya ait faturaları alır.

YYYYAA biçiminde olmalıdır.

loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Sapin Yasası reklamverenleri için alınacak fatura türünü seçin.

Yalnızca Loi Sapin reklamverenleri için geçerlidir. Aksi takdirde yoksayılır.

pageSize

integer

İstenen sayfa boyutu. 1 ile 200 arasında olmalıdır. Belirtilmemişse varsayılan olarak 100 olur. Geçersiz bir değer belirtilirse INVALID_ARGUMENT hata kodunu döndürür.

pageToken

string

Sunucunun döndürmesi gereken sonuçların yer aldığı sayfayı tanımlayan jeton. Genellikle bu, invoices.list yöntemine önceki çağrıdan döndürülen nextPageToken değeridir. Belirtilmezse sonuçların ilk sayfası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Alanlar
invoices[]

object (Invoice)

Faturaların listesi.

Boşsa bu liste bulunmayacak.

nextPageToken

string

Sonuçların sonraki sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, invoices.list yöntemine yapılan bir sonraki çağrıda pageToken alanına iletin.

Döndürülecek başka invoices yoksa bu jeton eksik olur.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview (OAuth 2.0'a Genel Bakış) sayfasına göz atın.

LoiSapinInvoiceType

Loi Sapin reklamverenleri için olası fatura türleri.

Sıralamalar
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Değer belirtilmedi.
LOI_SAPIN_INVOICE_TYPE_MEDIA Medya maliyeti olan faturalar.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Platform ücreti olan faturalar.

Fatura

Tek bir fatura.

JSON gösterimi
{
  "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
}
Alanlar
name

string

Faturanın kaynak adı.

invoiceId

string

Faturanın benzersiz kimliği.

displayName

string

Faturanın görünen adı.

paymentsProfileId

string

Faturanın ait olduğu ödeme profilinin kimliği.

Fatura PDF'sinde Billing ID olarak görünür.

paymentsAccountId

string

Faturanın ait olduğu ödeme hesabının kimliği.

Fatura PDF'sinde Billing Account Number olarak görünür.

issueDate

object (Date)

Faturanın düzenlendiği tarih.

dueDate

object (Date)

Faturanın ödenmesi gereken tarih.

serviceDateRange

object (DateRange)

Bu fatura kapsamındaki hizmet başlangıç ve bitiş tarihleri.

currencyCode

string

Faturada ISO 4217 biçiminde kullanılan para birimi.

subtotalAmountMicros

string (int64 format)

Faturanın para biriminin mikro cinsinden vergi öncesi ara toplam tutarı.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

totalTaxAmountMicros

string (int64 format)

Faturanın para biriminin mikro cinsinden faturadaki tüm vergilerin toplamı.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

totalAmountMicros

string (int64 format)

Faturanın para birimi cinsinden faturanın toplam tutarı.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

purchaseOrderNumber

string

Faturayla ilişkili satın alma siparişi numarası.

budgetInvoiceGroupingId

string

Bu fatura için bütçe gruplandırma kimliği.

Bu alan yalnızca ilgili faturalandırma profilinin fatura düzeyi "Bütçe faturası gruplandırma kimliği" olarak ayarlanmışsa ayarlanır.

invoiceType

enum (InvoiceType)

Fatura belgesinin türü.

correctedInvoiceId

string

Bu fatura tarafından düzenlenen orijinal faturanın kimliği (varsa).

Fatura PDF'sinde Reference invoice number olarak görünebilir.

replacedInvoiceIds ayarlanırsa bu alan boş olur.

replacedInvoiceIds[]

string

Varsa bu faturayla iptal edilen orijinal bir faturanın kimlikleri. Birden fazla fatura, tek bir faturada birleştiriliyorsa listelenebilir.

Fatura PDF'sinde Replaced invoice numbers olarak görünebilir.

correctedInvoiceId ayarlanırsa bu alan boş olur.

pdfUrl

string

Faturanın PDF kopyasını indirebileceğiniz URL.

Bu URL, kullanıcıya özeldir ve erişim için geçerli bir OAuth 2.0 erişim jetonu gerektirir. Erişim jetonu, Authorization: Bearer HTTP başlığında sağlanmalı ve aşağıdaki kapsamlardan biri için yetkilendirilmelidir:

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

URL, bu fatura nesnesi alındıktan sonraki 7 gün boyunca veya bu fatura tekrar alınana kadar geçerli olacaktır.

budgetSummaries[]

object (BudgetSummary)

Bu faturayla ilişkili her bütçeye ait özet bilgilerin listesi.

Bu alan, yalnızca ilgili faturalandırma profilinin fatura ayrıntı düzeyi "Bütçe düzeyi PO" olarak ayarlanmışsa ayarlanır.

nonBudgetMicros

string (int64 format)

Belirli bir bütçeye bağlı olmayan maliyet veya düzenlemelerin faturanın para birimi cinsinden mikro cinsinden toplam tutarı.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

InvoiceType

Olası fatura türleri.

Sıralamalar
INVOICE_TYPE_UNSPECIFIED Bu sürümde belirtilmemiş veya bilinmiyor.
INVOICE_TYPE_CREDIT Faturada negatif bir tutar var.
INVOICE_TYPE_INVOICE Faturada pozitif bir tutar var.

BudgetSummary

Tek bir kampanya bütçesine ait özet bilgiler.

JSON gösterimi
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Alanlar
externalBudgetId

string

Kampanya bütçesinin externalBudgetId değerine karşılık gelir. Kampanya bütçesinde değer belirtilmezse bu alan boş olur.

prismaCpeCode

object (PrismaCpeCode)

Mediaocean Prisma aracından alınan ilgili müşteri, ürün ve tahmin kodları.

Yalnızca externalBudgetSource değeri EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN olan kampanya bütçeleri için geçerlidir.

preTaxAmountMicros

string (int64 format)

Vergiler hariç, bu bütçe kapsamında yapılan masrafların faturanın para biriminin mikro cinsinden toplamıdır.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

taxAmountMicros

string (int64 format)

Bu bütçe altındaki ödemelere uygulanan vergi tutarı, faturanın para biriminin mikro cinsinden değeri.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.

totalAmountMicros

string (int64 format)

Faturanın para birimi cinsinden, vergi dahil, bu bütçe kapsamında yapılan masrafların toplamı.

Örneğin, currencyCode USD ise 1000000 bir ABD dolarını temsil eder.