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/v2/advertisers/{advertiserId}/invoices

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Faturaları listelenecek reklamverenin kimliği.

Sorgu parametreleri

Parametreler
issueMonth

string

Faturalarının listeleneceği ay. Ayarlanmazsa istek, önceki ayın faturalarını 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ı 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 kullanılır. Geçersiz bir değer belirtilirse INVALID_ARGUMENT hata kodunu döndürür.
pageToken

string

Sunucunun döndürmesi gereken sonuçların bulunduğu sayfayı tanımlayan 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şsa bu liste yer almayacak.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Bir sonraki sonuç sayfasını almak için bu değeri, bir sonraki invoices.list yöntemi çağrısında 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 belirtilmemiş.
LOI_SAPIN_INVOICE_TYPE_MEDIA Medya maliyeti içeren faturalar.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Platform ücreti içeren 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 kullanılan, ISO 4217 biçimindeki para birimi.
subtotalAmountMicros

string (int64 format)

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

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

string (int64 format)

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

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

string (int64 format)

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

Örneğin, currencyCode değeri USD ise 1000000, 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

Bu faturaya göre düzenlenen orijinal faturanın (varsa) 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 orijinal olarak düzenlenmiş herhangi bir faturanın numaraları. 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şim için geçerli bir OAuth 2.0 erişim jetonu gerektirir. Erişim jetonu, 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 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üzeyinde PO" olarak ayarlanmışsa ayarlanır.
nonBudgetMicros

string (int64 format)

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

Örneğin, currencyCode değeri USD ise 1000000, 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 eksi değer var.
INVOICE_TYPE_INVOICE Fatura tutarı pozitif.

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 ayarlanmamışsa bu alan boş olur.
prismaCpeCode

object (PrismaCpeCode)

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

Yalnızca EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN tutarındaki externalBudgetSource olan kampanya bütçeleri için geçerlidir.
preTaxAmountMicros

string (int64 format)

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

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

string (int64 format)

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

Örneğin, currencyCode değeri USD ise 1000000, 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 fatura para biriminin mikro cinsinden değeri.

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