- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- LoiSapinInvoiceType
- الفاتورة
- InvoiceType
- BudgetSummary
- جرِّبه الآن
يسرد الفواتير التي تمّ نشرها لأحد المعلِنين في شهر معيّن.
باستخدام هذه الطريقة، لا يمكن استرداد الفواتير التي تمّ إنشاؤها بواسطة الملفات الشخصية للفوترة ذات مستوى الفوترة "شريك".
طلب HTTP
GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/invoices
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
advertiserId |
مطلوبة. رقم تعريف المعلِن المطلوب عرض فواتير له. |
معلمات طلب البحث
المَعلمات | |
---|---|
issueMonth |
الشهر الذي سيتم إدراج فواتير له. وإذا لم يتم ضبط السياسة، سيستردّ الطلب الفواتير للشهر السابق. يجب استخدام التنسيق YYYYMM. |
loiSapinInvoiceType |
اختَر نوع الفاتورة المطلوب استردادها للمعلِنين بموجب قانون سابين. لا ينطبق إلا على المعلنين الذين يخضعون لقانون سابين. وسيتم تجاهلها في الحالات الأخرى. |
pageSize |
حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين |
pageToken |
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"invoices": [
{
object ( |
الحقول | |
---|---|
invoices[] |
قائمة الفواتير لن يتم ملء هذه القائمة إذا كانت فارغة. |
nextPageToken |
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل لن يكون هذا الرمز المميز متوفرًا إذا لم يتوفر المزيد من |
نطاقات الأذونات
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
LoiSapinInvoiceType
الأنواع المحتملة من الفواتير لمعلِني قانون سابين.
عمليات التعداد | |
---|---|
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 ( |
الحقول | |
---|---|
name |
اسم مورد الفاتورة |
invoiceId |
المعرّف الفريد للفاتورة. |
displayName |
هو الاسم المعروض للفاتورة. |
paymentsProfileId |
معرّف الملف الشخصي للدفع الذي تنتمي إليه الفاتورة. يظهر في ملف PDF الخاص بالفاتورة بتنسيق |
paymentsAccountId |
معرّف حساب الدفعات الذي تنتمي إليه الفاتورة يظهر في ملف PDF الخاص بالفاتورة بتنسيق |
issueDate |
تاريخ إصدار الفاتورة. |
dueDate |
يشير إلى تاريخ استحقاق استحقاق الفاتورة. |
serviceDateRange |
تاريخ بدء الخدمة وتاريخ انتهائها اللذان تغطيهما هذه الفاتورة. |
currencyCode |
تمثّل هذه السمة العملة المستخدَمة في الفاتورة بتنسيق ISO 4217. |
subtotalAmountMicros |
يشير إلى مبلغ الإجمالي الفرعي قبل احتساب الضريبة بوحدات المايكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
totalTaxAmountMicros |
مجموع كل الضرائب في الفاتورة بالميكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
totalAmountMicros |
إجمالي مبلغ الفاتورة بوحدات المايكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
purchaseOrderNumber |
رقم طلب الشراء المرتبط بالفاتورة. |
budgetInvoiceGroupingId |
رقم تعريف تجميع الميزانية لهذه الفاتورة. لن يتم ضبط هذا الحقل إلا إذا تم ضبط مستوى الفاتورة لملف الفوترة المقابل على "معرّف تجميع فواتير الميزانية". |
invoiceType |
تمثّل هذه السمة نوع مستند الفاتورة. |
correctedInvoiceId |
رقم تعريف الفاتورة الأصلية التي يتم تسويتها في هذه الفاتورة، إذا كان ذلك منطبقًا. قد يظهر في ملف PDF الخاص بالفاتورة بتنسيق وإذا تم ضبط |
replacedInvoiceIds[] |
معرِّفات أي فاتورة تم إصدارها في الأصل وتم إلغاؤها بموجب هذه الفاتورة، في حال توفّرها. قد يتم إدراج عدة فواتير إذا كان يتم دمج هذه الفواتير في فاتورة واحدة. قد تظهر الفاتورة بتنسيق PDF على أنّها وإذا تم ضبط |
pdfUrl |
تمثّل هذه السمة عنوان URL لتنزيل نسخة من الفاتورة بتنسيق PDF. عنوان URL هذا خاص بالمستخدم ويتطلب رمز دخول OAuth 2.0 صالحًا للوصول إليه. يجب توفير رمز الدخول في عنوان HTTP يتضمن السمة
سيكون عنوان URL صالحًا لمدة 7 أيام بعد استرداد عنصر الفاتورة هذا أو حتى يتم استرداد هذه الفاتورة مرة أخرى. |
budgetSummaries[] |
قائمة معلومات موجزة لكل ميزانية مرتبطة بهذه الفاتورة. لن يتم ضبط هذا الحقل إلا إذا تم ضبط مستوى تفاصيل الفاتورة للملف الشخصي للفوترة المقابل على "طلب الشراء على مستوى الميزانية". |
nonBudgetMicros |
المبلغ الإجمالي للتكاليف أو التسويات غير المرتبط بميزانية معيّنة بالمايكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
InvoiceType
أنواع الفواتير المحتملة.
عمليات التعداد | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
غير محدّد أو غير معروف في هذا الإصدار. |
INVOICE_TYPE_CREDIT |
تتضمّن الفاتورة مبلغًا سالبًا. |
INVOICE_TYPE_INVOICE |
تتضمّن الفاتورة مبلغًا موجبًا. |
BudgetSummary
معلومات موجزة عن ميزانية حملة فردية.
تمثيل JSON |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
الحقول | |
---|---|
externalBudgetId |
يتطابق مع |
prismaCpeCode |
رموز العملاء والمنتج والتقديرات ذات الصلة من أداة Mediaocean Prisma لا ينطبق هذا الإجراء إلا على ميزانيات الحملات التي تتضمّن |
preTaxAmountMicros |
مجموع الرسوم التي تم تحصيلها بموجب هذه الميزانية قبل الضرائب، بالميكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
taxAmountMicros |
مبلغ الضريبة المطبَّقة على الرسوم التي يتم تحصيلها بموجب هذه الميزانية بالميكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |
totalAmountMicros |
مجموع الرسوم الإجمالية التي تم تحصيلها بموجب هذه الميزانية، شاملاً الضريبة، بالمايكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |