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/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 listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
issueMonth

string

Faturaların listeleneceği ay. Ayarlanmamışsa istek, önceki aya ait faturaları 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. Belirtilmezse 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ç sayfasını tanımlayan bir jeton. Bu genellikle 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)

Faturaların listesi.

Liste boşsa gösterilmez.
nextPageToken

string

Sonuçların sonraki sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için invoices.list yöntemine yapılan sonraki çağrıda 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

Sapin Yasası'na tabi reklamverenler için olası fatura türleri.

Sıralamalar
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Değer belirtilmemiş.
LOI_SAPIN_INVOICE_TYPE_MEDIA Medya maliyetini 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 son ödeme tarihi.
serviceDateRange

object (DateRange)

Bu faturanın kapsadığı hizmet başlangıç ve bitiş tarihleri.
currencyCode

string

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

string (int64 format)

Faturanın para biriminin mikro cinsinden vergiden önceki alt toplam tutarı.

Örneğin, currencyCode USD ise 1000000 değeri 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 değeri bir ABD dolarını temsil eder.
totalAmountMicros

string (int64 format)

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

Örneğin, currencyCode 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 seviyesi "Bütçe faturası gruplandırma kimliği" olarak ayarlanmışsa belirlenir.
invoiceType

enum (InvoiceType)

Fatura belgesinin türü.
correctedInvoiceId

string

Bu fatura ile düzeltilen 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

Bu fatura ile iptal edilen, başlangıçta 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ı indirme URL'si.

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 üstbilgisinde sağlanmalı ve aşağıdaki kapsamlar 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 sonraki 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 özetlenmiş 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 belirlenir.
nonBudgetMicros

string (int64 format)

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

Örneğin, currencyCode 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 belirtilmemiş veya bilinmiyor.
INVOICE_TYPE_CREDIT Faturada negatif tutar var.
INVOICE_TYPE_INVOICE Faturanın tutarı pozitif olmalıdır.

BudgetSummary

Tek bir kampanya bütçesinin özetlenmiş bilgileri.

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. Değer kampanya bütçesinde ayarlanmamışsa bu alan boş olur.
prismaCpeCode

object (PrismaCpeCode)

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

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

string (int64 format)

Bu bütçe kapsamında vergilerden önce yapılan ödemelerin toplamı, fatura para biriminin mikro cinsinden değeri.

Örneğin, currencyCode 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 USD ise 1000000 değeri bir ABD dolarını temsil eder.
totalAmountMicros

string (int64 format)

Fatura para biriminin mikrosu cinsinden, vergi dahil olmak üzere bu bütçe kapsamında yapılan ödemelerin toplam tutarı.

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