Method: advertisers.invoices.list

Bir reklamveren için belirli bir ayda gönderilen faturaları listeler.

"İş ortağı" fatura düzeyine sahip faturalandırma profilleri tarafından oluşturulan faturalara bu yöntemle erişilemez.

HTTP isteği

GET https://displayvideo.googleapis.com/v1/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 listeleneceği ay. Ayarlanmazsa istek, önceki ayın 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 Sapin Yasası'ndaki reklamverenler 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 bir jeton. Genellikle bu, invoices.list yöntemine yapılan ö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)

Fatura listesi.

Boş bırakılırsa bu liste görünmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, invoices.list yöntemine yapılan sonraki çağrıdaki pageToken alanına geçirin.

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

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'a Genel Bakış başlıklı makaleye bakın.

LoiSapinInvoiceType

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

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

Fatura

Tek 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 kullanılan, ISO 4217 biçimindeki para birimi.
subtotalAmountMicros

string (int64 format)

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

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

string (int64 format)

Faturadaki tüm vergilerin, fatura para biriminin mikro cinsinden toplamı.

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

string (int64 format)

Faturanın para birimi cinsinden mikro cinsinden toplam fatura tutarı.

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

string

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

string

Bu faturanın 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

Varsa, bu faturaya göre düzenlenen orijinal faturanın kimliği.

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

replacedInvoiceIds ayarlanırsa bu alan boş olur.
replacedInvoiceIds[]

string

Varsa, bu fatura ile iptal edilen ilk başta düzenlenen faturaların no'ları. Söz konusu faturalar tek bir faturada birleştiriliyorsa birden fazla fatura 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ı indirme URL'si.

Bu URL kullanıcıya özeldir ve erişmek için geçerli bir OAuth 2.0 erişim jetonu gerektirir. Erişim jetonu bir Authorization: Bearer HTTP üst bilgisinde 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 sonra 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çeyle ilgili ö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 toplam maliyet veya düzenleme tutarı (faturanın para biriminin mikro cinsinden).

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

InvoiceType

Olası fatura türleri.

Sıralamalar
INVOICE_TYPE_UNSPECIFIED Bu sürümde belirtilmedi 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'ına karşılık gelir. Kampanya bütçesinde değer belirtilmezse bu alan boş bırakılır.
prismaCpeCode

object (PrismaCpeCode)

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

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

string (int64 format)

Bu bütçe kapsamında, vergiler hariç olarak yapılan masrafların toplamı (faturanın para birimi cinsinden mikro cinsinden).

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

string (int64 format)

Bu bütçe kapsamındaki ücretlere uygulanan vergi tutarı (faturanın para biriminin mikro cinsinden).

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

string (int64 format)

Vergi dahil, bu bütçe kapsamında yapılan masrafların toplamının faturanın para birimi cinsinden mikro cinsinden ifadesidir.

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