Method: advertisers.invoices.list

यह डायलॉग बॉक्स, किसी महीने में विज्ञापन देने वाले के लिए पोस्ट किए गए इनवॉइस की सूची बनाता है.

इस तरीके का इस्तेमाल करके, "पार्टनर" के इनवॉइस लेवल पर बिलिंग प्रोफ़ाइल से जनरेट किए गए इनवॉइस, वापस नहीं पाए जा सकते.

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. विज्ञापन देने वाले का आईडी, जिसके लिए इनवॉइस लिस्ट करना है.

क्वेरी पैरामीटर

पैरामीटर
issueMonth

string

वह महीना जिसके इनवॉइस की सूची देनी है. अगर यह नीति सेट नहीं की जाती है, तो अनुरोध करने पर पिछले महीने के इनवॉइस जारी हो जाएंगे.

YYYYMM फ़ॉर्मैट में होना चाहिए.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

लुआ सेपा के विज्ञापन देने वालों को वापस पाने के लिए इनवॉइस का टाइप चुनें.

केवल Loi Sapin विज्ञापनदाताओं पर लागू होता है. अगर ऐसा नहीं है, तो इसे अनदेखा कर दिया जाएगा.
pageSize

integer

अनुरोध किए गए पेज का साइज़. यह 1 और 200 के बीच होना चाहिए. अगर कोई भी वैल्यू सेट नहीं की गई है, तो वह डिफ़ॉल्ट रूप से 100 पर सेट हो जाएगी. अमान्य वैल्यू देने पर, गड़बड़ी कोड INVALID_ARGUMENT दिखाता है.
pageToken

string

एक टोकन, जो सर्वर को दिखाए जाने वाले नतीजों के पेज की पहचान करता है. आम तौर पर, यह nextPageToken की वैल्यू होती है, जो पिछली कॉल टू invoices.list तरीके से मिलती है. अगर इसके बारे में नहीं बताया गया है, तो नतीजों का पहला पेज दिखाया जाएगा.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
invoices[]

object (Invoice)

इनवॉइस की सूची.

अगर कोई सूची खाली होगी, तो यह नहीं दिखेगी.
nextPageToken

string

नतीजों का अगला पेज फिर से पाने के लिए टोकन. नतीजों का अगला पेज वापस पाने के लिए, invoices.list को बाद में किए जाने वाले कॉल के pageToken फ़ील्ड में इस वैल्यू को पास करें.

अगर वापस करने के लिए और invoices नहीं हैं, तो यह टोकन मौजूद नहीं रहेगा.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

LoiSapinInvoiceType

लुआ सेपा के विज्ञापन देने वालों के लिए, इनवॉइस के संभावित टाइप.

Enums
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED मान तय नहीं किया गया है.
LOI_SAPIN_INVOICE_TYPE_MEDIA मीडिया लागत वाले इनवॉइस.
LOI_SAPIN_INVOICE_TYPE_PLATFORM प्लैटफ़ॉर्म शुल्क के साथ इनवॉइस.

बिल

सिर्फ़ एक इनवॉइस.

जेएसओएन के काेड में दिखाना 
{
  "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
}
फ़ील्ड
name

string

इनवॉइस के संसाधन का नाम.
invoiceId

string

इनवॉइस का यूनीक आईडी.
displayName

string

इनवॉइस का डिसप्ले नेम.
paymentsProfileId

string

उस पेमेंट्स प्रोफ़ाइल का आईडी जिससे इनवॉइस जुड़ा है.

इनवॉइस के PDF पर Billing ID के तौर पर दिखता है.
paymentsAccountId

string

उस पेमेंट्स खाते का आईडी जिससे इनवॉइस जुड़ा है.

इनवॉइस के PDF पर Billing Account Number के तौर पर दिखता है.
issueDate

object (Date)

इनवॉइस जारी करने की तारीख.
dueDate

object (Date)

इनवॉइस की आखिरी तारीख.
serviceDateRange

object (DateRange)

सेवा के शुरू और खत्म होने की तारीखें, जो इस इनवॉइस में शामिल हैं.
currencyCode

string

इनवॉइस में इस्तेमाल की गई मुद्रा, ISO 4217 फ़ॉर्मैट में.
subtotalAmountMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, टैक्स से पहले की कुल रकम.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.
totalTaxAmountMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, इनवॉइस में मौजूद सभी टैक्स का कुल योग.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.
totalAmountMicros

string (int64 format)

इनवॉइस की कुल रकम, इनवॉइस की मुद्रा के माइक्रो में.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.
purchaseOrderNumber

string

इनवॉइस से जुड़ा परचेज़ ऑर्डर (पीओ) नंबर.
budgetInvoiceGroupingId

string

इस इनवॉइस के लिए, बजट ग्रुप का आईडी.

यह फ़ील्ड सिर्फ़ तब सेट किया जाएगा, जब इससे जुड़ी बिलिंग प्रोफ़ाइल का इनवॉइस लेवल "बजट इनवॉइस ग्रुप आईडी" पर सेट किया गया हो.
invoiceType

enum (InvoiceType)

इनवॉइस के दस्तावेज़ का टाइप.
correctedInvoiceId

string

अगर लागू हो, तो इस इनवॉइस के ज़रिए अडजस्ट किए जा रहे ओरिजनल इनवॉइस का आईडी.

इनवॉइस के PDF पर Reference invoice number के तौर पर दिख सकता है.

अगर replacedInvoiceIds सेट है, तो यह फ़ील्ड खाली रहेगा.
replacedInvoiceIds[]

string

ऐसे किसी भी मूल इनवॉइस के आईडी जिसे इस इनवॉइस से रद्द किया जा रहा है, अगर लागू हो. अगर उन इनवॉइस को मिलाकर एक इनवॉइस बनाया जा रहा है, तो हो सकता है कि कई इनवॉइस शामिल किए जाएं.

इनवॉइस की PDF फ़ाइल पर, Replaced invoice numbers के तौर पर दिख सकता है.

अगर correctedInvoiceId सेट है, तो यह फ़ील्ड खाली रहेगा.
pdfUrl

string

इनवॉइस की PDF कॉपी डाउनलोड करने के लिए यूआरएल.

यह यूआरएल, उपयोगकर्ता के लिए है. इसे ऐक्सेस करने के लिए, मान्य OAuth 2.0 ऐक्सेस टोकन की ज़रूरत होती है. ऐक्सेस टोकन, Authorization: Bearer एचटीटीपी हेडर में दिया जाना चाहिए. साथ ही, उसे इनमें से किसी एक स्कोप के लिए अनुमति दी जानी चाहिए:

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

इस इनवॉइस ऑब्जेक्ट को वापस पाने के बाद, सात दिन तक या इस इनवॉइस को फिर से वापस पाने तक, यह यूआरएल मान्य रहेगा.
budgetSummaries[]

object (BudgetSummary)

इस इनवॉइस से जुड़े हर बजट के लिए, कम शब्दों में दी गई जानकारी की सूची.

यह फ़ील्ड सिर्फ़ तब सेट किया जाएगा, जब इससे जुड़ी बिलिंग प्रोफ़ाइल के इनवॉइस की जानकारी का लेवल "बजट लेवल पीओ" पर सेट किया गया हो.
nonBudgetMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, लागत या अडजस्टमेंट की कुल रकम, जो किसी बजट से जुड़ी नहीं होती.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.

InvoiceType

इनवॉइस के संभावित टाइप.

Enums
INVOICE_TYPE_UNSPECIFIED इस वर्शन में मौजूद नहीं है या अज्ञात है.
INVOICE_TYPE_CREDIT इनवॉइस की रकम नेगेटिव है.
INVOICE_TYPE_INVOICE इनवॉइस में पॉज़िटिव रकम है.

BudgetSummary

किसी कैंपेन के बजट की खास जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
फ़ील्ड
externalBudgetId

string

कैंपेन बजट के externalBudgetId से मेल खाता है. अगर कैंपेन बजट में वैल्यू सेट नहीं है, तो यह फ़ील्ड खाली रहेगा.
prismaCpeCode

object (PrismaCpeCode)

Mediaocean Prisma टूल से लिया गया क्लाइंट, प्रॉडक्ट, और अनुमान कोड.

सिर्फ़ EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN के externalBudgetSource वाले कैंपेन बजट के लिए लागू.
preTaxAmountMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, टैक्स से पहले इस बजट के तहत लगाए गए कुल शुल्क.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.
taxAmountMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, इस बजट के तहत शुल्कों पर लागू टैक्स की रकम.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.
totalAmountMicros

string (int64 format)

इनवॉइस की मुद्रा के माइक्रो में, इस बजट के तहत लगाए गए कुल शुल्कों में टैक्स भी शामिल है.

उदाहरण के लिए, अगर currencyCode USD है, तो 10,00,000 का मतलब एक डॉलर है.