Method: advertisers.invoices.list

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

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

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

GET https://displayvideo.googleapis.com/v5/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 तरीके को किए गए पिछले कॉल से मिलती है. अगर इसे तय नहीं किया जाता है, तो नतीजों का पहला पेज दिखेगा.

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "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 Overview देखें.

LoiSapinInvoiceType

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

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

बिल

एक इनवॉइस.

JSON के काेड में दिखाना 
{
  "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 है, तो 1000000 का मतलब एक डॉलर है.
totalTaxAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode की वैल्यू USD है, तो 1000000 का मतलब एक डॉलर है.
totalAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode की वैल्यू USD है, तो 1000000 का मतलब एक डॉलर है.
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 है, तो 1000000 का मतलब एक डॉलर है.

InvoiceType

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

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

BudgetSummary

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

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

string

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

object (PrismaCpeCode)

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

यह सिर्फ़ उन कैंपेन बजट पर लागू होता है जिनकी externalBudgetSource, EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN है.
preTaxAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode की वैल्यू USD है, तो 1000000 का मतलब एक डॉलर है.
taxAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode की वैल्यू USD है, तो 1000000 का मतलब एक डॉलर है.
totalAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode की वैल्यू USD है, तो 1000000 का मतलब एक डॉलर है.