Method: advertisers.invoices.list

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

"İş ortağı" fatura düzeyine sahip faturalandırma profilleri tarafından oluşturulan faturalar bu yöntemle alınamaz.

HTTP isteği

GET https://displayvideo.googleapis.com/v4/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. Ayarlanmamışsa istek, önceki ayın faturalarını alır.

YYYYAA biçiminde olmalıdır.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Loi Sapin 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 bir sonuç sayfasını tanımlayan jeton. Genellikle bu, invoices.list yöntemine yapılan önceki çağrıdan döndürülen nextPageToken değerini ifade eder. Belirtilmemişse 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 bulunmaz.
nextPageToken

string

Sonuçların bir sonraki sayfasını almak için kullanılan jeton. Sonuçların bir sonraki sayfasını almak için invoices.list yönteminin sonraki çağrısında bu değeri pageToken alanına iletin.

İade edilecek 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 Overview sayfasına bakın.

LoiSapinInvoiceType

Loi Sapin 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

Faturada 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 faturanın kapsamındaki hizmetin başlangıç ve bitiş tarihleri.
currencyCode

string

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

string (int64 format)

Vergi öncesi alt toplam tutarı (faturanın para biriminde mikro cinsinden).

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

string (int64 format)

Faturadaki tüm vergilerin toplamı, 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 biriminde mikro cinsinden fatura toplam tutarı.

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

string

Faturaya 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 seviyesi "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üzenlenmekte olan asıl faturanın kimliği (varsa).

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

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

string

Bu fatura tarafından iptal edilen, daha önce düzenlenmiş faturaların kimlikleri(varsa). Bu 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ı indirmek için kullanılacak URL.

Bu URL kullanıcıya özeldir ve erişmek için geçerli bir OAuth 2.0 erişim jetonu gerekir. Erişim jetonu bir Authorization: Bearer HTTP üst bilgisinde sağlanmalı ve aşağıdaki kapsamlardan biri için yetkilendirilmiş olmalıdır:

  • 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 olur.
budgetSummaries[]

object (BudgetSummary)

Bu faturayla ilişkili her bütçenin özet bilgilerinin listesi.

Bu alan yalnızca ilgili faturalandırma profilinin fatura ayrıntı seviyesi "Bütçe seviyesi satın alma siparişi" olarak ayarlanmışsa ayarlanır.
nonBudgetMicros

string (int64 format)

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

Ö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 Faturanın tutarı negatif.
INVOICE_TYPE_INVOICE Faturanın tutarı pozitif olmalıdır.

BudgetSummary

Tek bir kampanya bütçesiyle ilgili özet bilgiler.

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

string

Bir kampanya bütçesinin externalBudgetId değerine karşılık gelir. Değer kampanya bütçesinde ayarlanmamışsa bu alan boş olur.
prismaCpeCode

object (PrismaCpeCode)

Mediaocean Prisma aracındaki alakalı 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)

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

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

string (int64 format)

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

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

string (int64 format)

Bu bütçe kapsamında yapılan ödemelerin toplam tutarı (vergi dahil) faturanın para biriminde mikro olarak.

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