Method: advertisers.invoices.list

فاکتورهای ارسال شده برای یک تبلیغ کننده در یک ماه معین را فهرست می کند.

فاکتورهای تولید شده توسط نمایه‌های صورت‌حساب با سطح فاکتور "شریک" از طریق این روش قابل بازیابی نیستند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
advertiser Id

string ( int64 format)

مورد نیاز. شناسه آگهی‌دهنده برای فهرست فاکتورها.

پارامترهای پرس و جو

پارامترها
issue Month

string

ماه برای لیست فاکتورها. اگر تنظیم نشود، درخواست فاکتورهای ماه قبل را بازیابی می کند.

باید در قالب YYYYMM باشد.

loi Sapin Invoice Type

enum ( LoiSapinInvoiceType )

نوع فاکتور را برای بازیابی برای تبلیغ کنندگان Loi Sapin انتخاب کنید.

فقط برای تبلیغ کنندگان Loi Sapin قابل اجرا است. در غیر این صورت نادیده گرفته می شود.

page Size

integer

اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT برمی‌گرداند.

page Token

string

نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به روش invoices.list بازگردانده می شود. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
فیلدها
invoices[]

object ( Invoice )

لیست فاکتورها

در صورت خالی بودن این لیست وجود نخواهد داشت.

next Page Token

string

نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در روش فراخوانی بعدی به invoices.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید.

اگر 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

نام منبع فاکتور.

invoice Id

string

شناسه منحصر به فرد فاکتور.

display Name

string

نام نمایشی فاکتور

payments Profile Id

string

شناسه نمایه پرداختی که فاکتور به آن تعلق دارد.

در PDF فاکتور به عنوان Billing ID ظاهر می شود.

payments Account Id

string

شناسه حساب پرداختی که فاکتور به آن تعلق دارد.

در PDF فاکتور به عنوان Billing Account Number ظاهر می شود.

issue Date

object ( Date )

تاریخ صدور فاکتور

due Date

object ( Date )

تاریخ سررسید فاکتور

service Date Range

object ( DateRange )

تاریخ شروع و پایان خدمات که تحت پوشش این فاکتور است.

currency Code

string

ارز مورد استفاده در فاکتور در قالب ISO 4217.

subtotal Amount Micros

string ( int64 format)

مبلغ فرعی قبل از مالیات، بر حسب واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

total Tax Amount Micros

string ( int64 format)

مجموع همه مالیات ها در صورتحساب، بر حسب میکرو واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

total Amount Micros

string ( int64 format)

مبلغ کل فاکتور، در میکرو واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

purchase Order Number

string

شماره سفارش خرید مرتبط با فاکتور.

budget Invoice Grouping Id

string

شناسه گروه بندی بودجه برای این فاکتور.

این قسمت تنها در صورتی تنظیم می‌شود که سطح صورت‌حساب نمایه صورت‌حساب مربوطه روی «شناسه گروه‌بندی فاکتور بودجه» تنظیم شده باشد.

invoice Type

enum ( InvoiceType )

نوع سند فاکتور.

corrected Invoice Id

string

شناسه فاکتور اصلی در صورت وجود توسط این فاکتور تنظیم می شود.

ممکن است در PDF فاکتور به عنوان Reference invoice number ظاهر شود.

اگر replacedInvoiceIds تنظیم شود، این فیلد خالی خواهد بود.

replaced Invoice Ids[]

string

شناسه(های) هر فاکتور صادر شده اولیه که توسط این فاکتور لغو می شود، در صورت وجود. اگر این فاکتورها در یک فاکتور ادغام شوند، ممکن است چندین فاکتور فهرست شوند.

ممکن است در PDF فاکتور به عنوان Replaced invoice numbers ظاهر شود.

اگر correctedInvoiceId تنظیم شده باشد، این فیلد خالی خواهد بود.

pdf Url

string

URL برای دانلود یک نسخه PDF از فاکتور.

این URL مختص کاربر است و برای دسترسی به کد دسترسی معتبر OAuth 2.0 نیاز دارد. رمز دسترسی باید در یک هدر Authorization: Bearer HTTP ارائه شود و برای یکی از حوزه های زیر مجاز باشد:

  • https://www.googleapis.com/auth/display-video-mediaplanning
  • https://www.googleapis.com/auth/display-video

URL به مدت 7 روز پس از بازیابی این شیء فاکتور یا تا زمانی که این فاکتور دوباره بازیابی شود معتبر خواهد بود.

budget Summaries[]

object ( BudgetSummary )

فهرستی از اطلاعات خلاصه شده برای هر بودجه مرتبط با این فاکتور.

این فیلد تنها در صورتی تنظیم می‌شود که سطح جزئیات صورت‌حساب نمایه صورت‌حساب مربوطه روی «سطح بودجه PO» تنظیم شده باشد.

non Budget Micros

string ( int64 format)

مجموع هزینه‌ها یا تعدیل‌هایی که به بودجه خاصی وابسته نیستند، بر حسب واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

نوع فاکتور

انواع فاکتورهای احتمالی

Enums
INVOICE_TYPE_UNSPECIFIED در این نسخه مشخص نشده یا ناشناخته است.
INVOICE_TYPE_CREDIT فاکتور دارای مبلغ منفی است.
INVOICE_TYPE_INVOICE فاکتور دارای مبلغ مثبت است.

خلاصه بودجه

اطلاعات خلاصه شده از بودجه کمپین فردی.

نمایندگی JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
فیلدها
external Budget Id

string

مربوط به externalBudgetId یک بودجه کمپین است. اگر مقدار در بودجه کمپین تنظیم نشده باشد، این قسمت خالی خواهد بود.

prisma Cpe Code

object ( PrismaCpeCode )

کدهای مشتری، محصول و تخمین مربوطه از ابزار Mediaocean Prisma.

فقط برای بودجه های کمپین با منبع externalBudgetSource EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN قابل اجرا است.

pre Tax Amount Micros

string ( int64 format)

مجموع هزینه های انجام شده تحت این بودجه قبل از مالیات، بر حسب واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

tax Amount Micros

string ( int64 format)

میزان مالیات اعمال شده برای هزینه‌های تحت این بودجه، بر حسب واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.

total Amount Micros

string ( int64 format)

مجموع هزینه‌های پرداخت شده تحت این بودجه، از جمله مالیات، بر حسب واحد پول فاکتور.

به عنوان مثال، اگر currencyCode USD باشد، 1000000 نشان دهنده یک دلار آمریکا است.