Method: advertisers.invoices.list

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

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

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

GET https://displayvideo.googleapis.com/v3/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

टोकन, जो नतीजों के उस पेज की पहचान करता है जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह 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 की खास जानकारी देखें.

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

इनवॉइस की 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 एक अमेरिकी डॉलर को दिखाता है.