Method: advertisers.invoices.list

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

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

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 प्लैटफ़ॉर्म शुल्क वाले इनवॉइस.

बिल

एक इनवॉइस.

जेएसओएन के काेड में दिखाना 
{
  "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

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

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

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode USD है, तो 1000000 एक डॉलर को दिखाता है.
totalAmountMicros

string (int64 format)

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

उदाहरण के लिए, अगर currencyCode USD है, तो 1000000 एक डॉलर को दिखाता है.