Method: advertisers.invoices.list

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. विज्ञापन देने वाले उस व्यक्ति या कंपनी का आईडी जिसके लिए इनवॉइस की सूची बनानी है.

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

पैरामीटर
issueMonth

string

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

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

enum (LoiSapinInvoiceType)

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

यह सिर्फ़ सैपिन कानून के तहत आने वाले विज्ञापन देने वाले लोगों या कंपनियों के लिए उपलब्ध है. ऐसा न करने पर, इसे अनदेखा कर दिया जाएगा.
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

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

यह यूआरएल, उपयोगकर्ता के हिसाब से होता है. इसे ऐक्सेस करने के लिए, 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 का मतलब एक डॉलर है.