- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- LoiSapinInvoiceType
- الفاتورة
- InvoiceType
- BudgetSummary
- جرِّبه الآن
يسرد الفواتير التي تمّ نشرها لأحد المعلِنين في شهر معيّن.
لا يمكن استرداد الفواتير التي تم إنشاؤها من خلال الملفات الشخصية للفوترة على مستوى فاتورة "شريك" من خلال هذه الطريقة.
طلب HTTP
GET https://displayvideo.googleapis.com/v2/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 |
مجموع الرسوم المحصّلة بموجب هذه الميزانية، بما في ذلك الضريبة، بالمايكرو من عملة الفاتورة. على سبيل المثال، إذا كانت قيمة |