Method: advertisers.invoices.list

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

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

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

पैरामीटर
issueMonth

string

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

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

enum (LoiSapinInvoiceType)

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

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

integer

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

string

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

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

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

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

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

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

Loi Sapin के तहत विज्ञापन देने वाले लोगों या कंपनियों के लिए, इनवॉइस के संभावित टाइप.

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 का मतलब एक डॉलर है.