إدارة التقارير

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

مقدمة

تتيح لك تقارير تحقيق الربح الوصول إلى معلومات الاستخدام التي تركّز على نشاط المعاملات. على سبيل المثال، يمكنك تحديد التطبيقات أو مطوّري البرامج أو حِزم المنتجات من واجهة برمجة التطبيقات أو منتجات واجهة برمجة التطبيقات التي تضمّنت نشاطًا متعلقًا بالمعاملات لنطاق زمني معيّن. باستخدام ميزة تحقيق الربح، يمكنك إنشاء تقارير ملخّص أو تقارير مفصّلة يتم من خلالها تتبُّع استخدام واجهة برمجة التطبيقات.

أنواع تقارير تحقيق الربح

يمكنك إنشاء الأنواع التالية من تقارير تحقيق الربح:

التقرير الوصف
الإذن بالوصول إلى الفوترة اطّلِع على نشاط المطوّرين لشهر فوترة واحد وتأكّد من أنّ خطط الأسعار قد تم تطبيقها بشكل صحيح.
الرصيد المدفوع مسبقًا يمكنك عرض عمليات إعادة تعبئة الرصيد التي أجراها مطوّر برامج الدفع المسبق في أحد أشهر الفواتير أو في شهر مفتوح حاليًا، وذلك لتتمكن من تسويتها مع الدفعات التي تم استلامها من الجهة المسؤولة عن معالجة المعاملات.
الأرباح يمكنك الاطّلاع على الأنشطة والأرباح التي يحقّقها المطوّرون ضمن نطاق زمني معيّن حتى تتمكّن من تحليل أداء حِزم المنتجات والمنتجات في واجهة برمجة التطبيقات على مستوى المطوّرين (وتطبيقاتهم).
التباين

يمكنك مقارنة الأنشطة والأرباح الناتجة عن المطوّرين في نطاقَين زمنيَين لتتمكّن من تحليل المؤشرات من الأعلى أو الأسفل في أداء حِزم واجهة برمجة التطبيقات ومنتجاتها على مستوى المطوّرين (وتطبيقاتهم).

لمحة عن الاحتفاظ بالبيانات

في السحابة الإلكترونية المتاحة للجميع Apigee Edge، يمثّل الاحتفاظ ببيانات تحقيق الربح استحقاقات للخطة. يمكنك الاطّلاع على استحقاقات تحقيق الربح على الرابط https://cloud.google.com/apigee/specsheets. يُرجى التواصل مع فريق مبيعات Apigee إذا أردت الاحتفاظ ببيانات تحقيق الربح بعد فترة الاستحقاق. يتم تفعيل ميزة الاحتفاظ الممتد بالبيانات في وقت تقديم الطلب ولا يمكن تفعيله بأثر رجعي لتضمين البيانات قبل فترة الاحتفاظ بالبيانات الأصلية.

استكشاف صفحة تقارير تحقيق الربح

انتقِل إلى صفحة "تقارير تحقيق الربح" كما هو موضّح أدناه.

Edge

للوصول إلى صفحة "التقارير" باستخدام واجهة مستخدم Edge:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. اختَر نشر > تحقيق الربح المادي > التقارير في شريط التنقّل الأيمن.

يتم عرض صفحة "التقارير".

كما هو موضّح في الشكل، تتيح لك صفحة "التقارير" تنفيذ ما يلي:

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة "التقارير" باستخدام واجهة مستخدم Edge الكلاسيكية:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. اختَر تحقيق الربح > تقارير تحقيق الربح في شريط التنقّل العلوي.

يتم عرض صفحة "التقارير".

ضبط إعدادات تقرير

يمكنك إعداد تقرير باستخدام واجهة المستخدم، كما هو موضّح في الأقسام التالية.

خطوات إعداد تقرير

يمكنك إعداد تقرير باستخدام واجهة مستخدم Edge أو واجهة مستخدم Classice Edge.

Edge

لإعداد تقرير باستخدام واجهة مستخدم Edge:

  1. اختَر نشر > تحقيق الربح المادي > التقارير في شريط التنقّل الأيمن.
  2. انقر على + تقرير.
  3. اضبط تفاصيل التقرير المحدّدة في الجدول التالي.
    الحقل الوصف
    الاسم الاسم الفريد للتقرير
    الوصف وصف التقرير
    نوع التقرير يُرجى الاطّلاع على أنواع تقارير تحقيق الربح.
  4. اضبط تفاصيل التقرير المتبقية استنادًا إلى نوع التقرير المحدّد، كما هو موضّح في الأقسام التالية:
  5. بعد إدخال المعلومات في نافذة التقرير، يمكنك إجراء ما يلي:
    • انقر على حفظ التقرير لحفظ إعدادات التقرير.
    • للحصول على تقرير تفصيلي فقط، انقر على إرسال المهمة لتشغيل التقرير بشكل غير متزامن واسترداد النتائج في وقت لاحق. يُرجى الاطّلاع على إنشاء تقرير وتنزيله لمزيد من المعلومات.

    • انقر على حفظ بتنسيق CSV أو حفظ بتنسيق Zip لتنزيل التقرير الذي تم إنشاؤه على جهازك المحلي على هيئة قيم مفصولة بفواصل (ملف CSV) أو ملف ZIP مضغوط يحتوي على ملف CSV. يُنصح باستخدام ملفات ZIP للتقارير الكبيرة الحجم، إذ سيتم تنزيلها بفعالية أكبر.

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

لإنشاء تقرير باستخدام واجهة مستخدم الإصدار الكلاسيكي من Edge:

  1. اختَر تحقيق الربح > تقارير تحقيق الربح في شريط التنقّل العلوي.
  2. في القائمة المنسدلة، اختَر نوع التقرير الذي تريد إنشاءه. يُرجى الاطّلاع على أنواع تقارير تحقيق الربح.
  3. انقر على + تقرير.
  4. اضبط تفاصيل التقرير استنادًا إلى نوع الفوترة المحدّد، كما هو موضّح في الأقسام التالية:
  5. بعد إدخال المعلومات في نافذة التقرير، يمكنك إجراء ما يلي:
    • انقر على حفظ باسم ... لحفظ إعداد التقرير وتنزيل التقرير لاحقًا.
    • للحصول على تقرير تفصيلي فقط، انقر على إرسال المهمة لتشغيل التقرير بشكل عشوائي واسترداد النتائج في وقت لاحق. يُرجى الاطّلاع على إنشاء تقرير وتنزيله لمزيد من المعلومات.

    • انقر على تنزيل ملف CSV لإنشاء التقرير وتنزيله على جهازك المحلي كملف قيم مفصولة بفواصل (CSV) لعرضه.

إعداد تقرير فوترة

اتّبِع خطوات إعداد تقرير وأدخِل المعلومات التالية في صفحة التقرير:

الحقل الوصف
شهر الفوترة

شهر الفوترة للتقرير.

مستوى إعداد التقارير

مستوى إعداد التقارير وتشمل القيم الصالحة ما يلي:

  • التفاصيل: تعرض كل معاملة في سطر منفصل وتسمح لك بالتحقق من تطبيق خطط الأسعار بشكل صحيح. ولا يتوفر أي ملخّص.
  • الملخّص: يلخّص إجمالي الأرباح لكل منتج ومطوّر في واجهة برمجة التطبيقات.
حِزم المنتجات

ملاحظة: في واجهة مستخدم Edge الكلاسيكية، يُشار إلى حِزم منتجات واجهة برمجة التطبيقات باسم "حِزم واجهة برمجة التطبيقات".

اختَر حِزم منتجات واجهة برمجة التطبيقات التي تريد تضمينها في التقرير. وفي حال عدم اختيار أي خيار، يتم تضمين جميع حِزم المنتجات في واجهة برمجة التطبيقات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل حزم منتجات محدّدة في واجهة برمجة التطبيقات.

بالنسبة إلى تقرير الملخّص، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في خيارات عرض "الملخّص". في هذه الحالة، يجمع التقرير المعلومات على مستوى جميع حِزم منتجات واجهة برمجة التطبيقات (أو المحدّدة) (ولا يدرج معلومات لكل حِزم منتجات واجهة برمجة التطبيقات بشكل منفصل).

المنتجات

اختر منتجات واجهة برمجة التطبيقات التي تريد تضمينها في التقرير. وفي حال عدم تحديد أي خيار، يتم تضمين جميع منتجات واجهة برمجة التطبيقات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل منتج محدد من منتجات واجهة برمجة التطبيقات.

بالنسبة إلى تقرير الملخّص، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في خيارات عرض "الملخّص". في هذه الحالة، يجمع التقرير المعلومات على مستوى جميع المطوّرين (أو الذين تم اختيارهم) (ولا يعرض معلومات لكل مطوّر تم اختياره على حدة).

شركات

اختَر الشركات التي تريد تضمينها في التقرير. وفي حال عدم اختيار أي شركات، يتم تضمين جميع الشركات في التقرير.

خطة الأسعار

خطط الأسعار التي سيتم تضمينها في التقرير. عليك اختيار أيّ ممّا يلي:

  • جميع خطط الأسعار: أدرِج جميع خطط الأسعار في التقرير.
  • خطط الأسعار العادية: يمكنك تضمين خطط الأسعار العادية فقط في التقرير.
  • خطط الأسعار الخاصة بالمطوّرين: يمكنك تضمين خطط المطوّرين فقط في التقرير.

إعداد تقرير رصيد الدفع المسبق

اتّبِع خطوات إعداد تقرير وأدخِل المعلومات التالية في صفحة التقرير:

الحقل الوصف
شهر الفوترة

شهر الفوترة للتقرير.

مستوى إعداد التقارير

مستوى إعداد التقارير وتشمل القيم الصالحة ما يلي:

  • التفاصيل: تعرض كل عملية إعادة تعبئة رصيد بشكل منفصل، وتتيح لك تسوية الدفعات التي تلقيتها من الجهة المسؤولة عن معالجة المعاملات.
  • ملخّص: يلخّص إجمالي عمليات إعادة تعبئة الرصيد لكلّ مطوّر.
شركات

اختَر الشركات التي تريد تضمينها في التقرير. وفي حال عدم اختيار أي شركات، يتم تضمين جميع الشركات في التقرير.

إعداد تقرير الأرباح

اتّبِع خطوات إعداد تقرير وأدخِل المعلومات التالية في صفحة التقرير:

الحقل الوصف
نطاق التواريخ

النطاق الزمني للتقرير عليك اختيار أيّ ممّا يلي:

  • الإعداد المسبق: اختَر أحد النطاقات الزمنية العادية (مثل آخر شهر في التقويم) من القائمة المنسدلة.
  • مخصّص: اختَر تاريخ بدء وتاريخ انتهاء للنطاق الزمني من نافذة التقويم المنبثقة.
اختيار العملة

عملة التقرير وتشمل القيم الصالحة ما يلي:

  • العملة المحلية: يتم عرض كل سطر من التقرير باستخدام خطة الأسعار السارية. وهذا يعني أنّه قد تتوفّر عملات متعدّدة في التقرير نفسه إذا كان مطوّرو البرامج لديهم خطط تستخدم عملات مختلفة.
  • اليورو: يتم تحويل المعاملات بالعملة المحلية في التقرير وعرضها باليورو.
  • الجنيه الإسترليني: يتم تحويل معاملات العملة المحلية في التقرير وعرضها بالجنيه الإسترليني.
  • الدولار الأمريكي: يتم تحويل المعاملات بالعملة المحلية في التقرير وعرضها بالدولار الأمريكي.
مستوى إعداد التقارير

مستوى إعداد التقارير وتشمل القيم الصالحة ما يلي:

  • تفصيلي: يعرض كل معاملة في سطر منفصل. ولا يوجد ملخص.
  • الملخّص: يلخّص إجمالي الأرباح لكل منتج ومطوّر في واجهة برمجة التطبيقات، وفقًا للمعلَمات التي تختارها.
حِزم المنتجات

ملاحظة: في واجهة مستخدم Edge الكلاسيكية، يُشار إلى حِزم منتجات واجهة برمجة التطبيقات باسم "حِزم واجهة برمجة التطبيقات".

اختَر حِزم منتجات واجهة برمجة التطبيقات التي تريد تضمينها في التقرير. وفي حال عدم اختيار أي خيار، يتم تضمين جميع حِزم المنتجات في واجهة برمجة التطبيقات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل حزم منتجات محدّدة في واجهة برمجة التطبيقات.

بالنسبة إلى تقرير الملخّص، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في خيارات عرض "الملخّص". في هذه الحالة، يجمع التقرير المعلومات على مستوى جميع حِزم منتجات واجهة برمجة التطبيقات (أو المحدّدة) (ولا يدرج معلومات لكل حِزم منتجات واجهة برمجة التطبيقات بشكل منفصل).

المنتجات

اختر منتجات واجهة برمجة التطبيقات التي تريد تضمينها في التقرير. وفي حال عدم تحديد أي خيار، يتم تضمين جميع منتجات واجهة برمجة التطبيقات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل منتج محدد من منتجات واجهة برمجة التطبيقات.

بالنسبة إلى تقرير الملخّص، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في خيارات عرض "الملخّص". في هذه الحالة، يجمع التقرير المعلومات على مستوى جميع المطوّرين (أو الذين تم اختيارهم) (ولا يعرض معلومات لكل مطوّر تم اختياره على حدة).

شركات

اختَر الشركات التي تريد تضمينها في التقرير. وفي حال عدم اختيار أي شركات، يتم تضمين جميع الشركات في التقرير.

للحصول على تقرير موجز، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في القسم "خيارات عرض الملخّص". في هذه الحالة، يجمع التقرير المعلومات بين جميع الشركات (أو التي يتم اختيارها) (ولا يعرض معلومات لكل شركة تم اختيارها على حدة).

التطبيقات

اختَر التطبيقات المطلوب تضمينها في التقرير. وفي حال عدم تحديد أي خيار، يتم تضمين جميع الطلبات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل تطبيق محدد.

للحصول على تقرير موجز، يمكنك اختياريًا وضع علامة في المربّع عدم العرض في القسم "خيارات عرض الملخّص". في هذه الحالة، يجمع التقرير المعلومات بين جميع التطبيقات (أو تلك المحدَّدة) (ولا يعرض معلومات لكل تطبيق تم اختياره على حدة).

خيارات عرض الملخّص

ترتيب تجميع الأعمدة وعرضها في التقرير اختَر رقمًا يشير إلى الترتيب النسبي لذلك القسم في المجموعة (1 هو المجموعة الأولى). على سبيل المثال، تجمِّع المجموعات التالية التقرير حسب الحِزم أولاً، ثم حسب المنتجات، ثم حسب المطوّرين، ثم حسب التطبيقات.

إذا كنت لا تريد عرض قسم، اختَر عدم العرض، ثم اختَر الحقول المتبقية بالترتيب. يتم تعديل الترتيب تلقائيًا عند تغيير الترتيب النسبي لأحد الأقسام أو عند اختيار عدم عرض قسم في التقرير.

تضمين سمات المعاملات المخصّصة في تقارير ملخّص الأرباح

تتيح لك سياسات تسجيل المعاملات جمع بيانات السمات المخصّصة من المعاملات، ويمكنك تضمين هذه السمات المخصّصة في ملخّص تقارير الأرباح. يمكنك تحديد المجموعة التلقائية من السمات المخصّصة المضمّنة في جداول قاعدة بيانات تحقيق الربح من خلال ضبط السمة MINT.SUMMARY_CUSTOM_ATTRIBUTES لمؤسستك.

يتطلب استخدام هذه الميزة بعض التفكير والتخطيط، لذا راجع الاعتبارات أدناه.

إذا كنت أحد عملاء السحابة الإلكترونية، يُرجى التواصل مع فريق دعم Apigee Edge لإعداد السمة. إذا كنت أحد عملاء Apigee Edge for Private Cloud، يمكنك ضبط العلامة باستخدام طلب PUT على واجهة برمجة التطبيقات التالية باستخدام بيانات اعتماد مشرف النظام.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

في هذا المثال، يتم تفعيل الميزة من خلال طلب البيانات من واجهة برمجة التطبيقات وإضافة عمودَي partner_id وtax_source إلى قاعدة بيانات تحقيق الربح. يُرجى العِلم أنّ مصفوفة السمات المخصّصة في طلب البيانات من واجهة برمجة التطبيقات تكون بترميز عنوان URL.

اعتبارات لتضمين سمات المعاملات المخصّصة في التقارير

  • تأكّد من أسماء السمات التي تريد استخدامها قبل إنشائها باستخدام واجهة برمجة التطبيقات. هذه هي أسماء الأعمدة في قاعدة البيانات، ويتم دائمًا تخزين بيانات السمات المخصصة هناك.
  • تتوفر 10 خانات سمات مخصّصة في كل سياسة لتسجيل المعاملات، كما هو موضّح في الصورة التالية. استخدِم أسماء السمات ومواضعها نفسها للسمات نفسها في جميع المنتجات التي سيتم تضمينها في التقارير. على سبيل المثال، في سياسة تسجيل المعاملات التالية، يتم وضع السمتَين المخصّصتَين partner_id وtax_source في المربّعَين 4 و5 على التوالي. ويجب أن يكون اسمها وموضعها في كل سياسات تسجيل المعاملات للمنتجات التي يتم تضمينها في التقارير.

لتضمين سمات مخصّصة في تقرير ملخّص الأرباح بعد تفعيل الميزة، استخدِم report API من خلال إضافة transactionCustomAttributes إلى MintCriteria. راجِع خيارات ضبط المعايير.

ضبط تقرير تباين (تم إيقافه)

اتّبِع خطوات إعداد تقرير وأدخِل المعلومات التالية في صفحة التقرير:

الحقل الوصف
نطاق التواريخ

النطاق الزمني للتقرير عليك اختيار أيّ ممّا يلي:

  • الإعداد المسبق: اختَر أحد النطاقات الزمنية العادية (مثل آخر شهر في التقويم) من القائمة المنسدلة.
  • مخصّص: اختَر تاريخ بدء وتاريخ انتهاء للنطاق الزمني من نافذة التقويم المنبثقة.
الطرود

حِزم واجهة برمجة التطبيقات التي سيتم تضمينها في التقرير. عليك اختيار أيّ ممّا يلي:

  • الكل: يتضمّن جميع حِزم واجهة برمجة التطبيقات في التقرير.
  • محدّدة: يتم عرض قائمة يمكنك من خلالها اختيار حِزم واجهة برمجة التطبيقات لتضمينها في التقرير. في حال عدم اختيار أي حزم، يتم تضمين جميع الحزم في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل حزمة محددة من واجهة برمجة التطبيقات.

للحصول على تقرير ملخّص، يمكنك اختياريًا وضع علامة في المربّع "عدم عرضها (الحزم)" في القسم "خيارات عرض الملخص". في هذه الحالة، يجمع التقرير المعلومات على مستوى جميع حزم واجهة برمجة التطبيقات (أو التي تم اختيارها) (ولا يدرج معلومات عن كل حزمة واجهة برمجة تطبيقات بشكل منفصل).

المنتجات

منتجات واجهة برمجة التطبيقات التي سيتم تضمينها في التقرير عليك اختيار أيّ ممّا يلي:

  • الكل: يشمل جميع المنتجات المتوافقة مع واجهة برمجة التطبيقات في التقرير.
  • محدّدة: تعرض قائمة يمكنك من خلالها اختيار المنتجات المطلوب تضمينها في التقرير. وإذا لم يتم اختيار أي منتجات، يتم تضمين جميع المنتجات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل منتج محدد من منتجات واجهة برمجة التطبيقات.

للاطّلاع على تقرير ملخّص، يمكنك اختياريًا وضع علامة في المربّع بجانب عدم عرضها (المنتجات) في قسم "خيارات عرض الملخص". في هذه الحالة، يجمع التقرير المعلومات في جميع منتجات واجهة برمجة التطبيقات (أو تلك المحدّدة) (ولا يدرج معلومات حول كل منتج من منتجات واجهة برمجة التطبيقات بشكل منفصل).

شركات

الشركات التي سيتم تضمينها في التقرير. عليك اختيار أيّ ممّا يلي:

  • الكل: يتضمن جميع الشركات في التقرير.
  • محدّد: يتم عرض قائمة يمكنك من خلالها اختيار الشركات التي سيتم تضمينها في التقرير. في حال عدم اختيار أي شركات، يتم تضمين جميع الشركات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل شركة تم اختيارها.

للاطّلاع على تقرير ملخّص، يمكنك اختياريًا وضع علامة في المربّع "عدم عرض (الشركات)" في القسم "خيارات العرض الملخّص". في هذه الحالة، يجمع التقرير المعلومات بين جميع الشركات (أو التي يتم اختيارها) (ولا يدرج معلومات لكل شركة تم اختيارها على حدة).

التطبيقات

التطبيقات التي سيتم تضمينها في التقرير. عليك اختيار أيّ ممّا يلي:

  • الكل: يتضمّن جميع التطبيقات الواردة في التقرير.
  • محدّدة: تعرض قائمة يمكنك من خلالها اختيار التطبيقات المطلوب تضمينها في التقرير. وإذا لم تختَر أي طلبات، يتم تضمين جميع الطلبات في التقرير.

يتضمن التقرير سطرًا منفصلاً لكل تطبيق محدد.

للحصول على تقرير ملخّص، يمكنك اختياريًا وضع علامة في المربّع "عدم عرضها (التطبيقات)" في القسم "خيارات عرض الملخص". في هذه الحالة، يجمع التقرير المعلومات بين جميع التطبيقات (أو تلك المحدَّدة) (ولا يعرض معلومات لكل تطبيق تم اختياره على حدة).

العملة

عملة التقرير وتشمل القيم الصالحة ما يلي:

  • العملة المحلية: يتم عرض كل سطر من التقرير باستخدام خطة الأسعار السارية. وهذا يعني أنّه قد تتوفّر عملات متعدّدة في التقرير نفسه إذا كان مطوّرو البرامج لديهم خطط تستخدم عملات مختلفة.
  • اليورو: يتم تحويل المعاملات بالعملة المحلية في التقرير وعرضها باليورو.
  • GPB: يتم تحويل المعاملات بالعملة المحلية في التقرير وعرضها بالجنيه الإسترليني.
  • الدولار الأمريكي: يتم تحويل المعاملات بالعملة المحلية في التقرير وعرضها بالدولار الأمريكي.
خيارات عرض الملخّص

ترتيب تجميع الأعمدة وعرضها في التقرير اختَر رقمًا يشير إلى الترتيب النسبي لذلك القسم في المجموعة (1 هو المجموعة الأولى). على سبيل المثال، تجمِّع المجموعات التالية التقرير حسب الحِزم أولاً، ثم حسب المنتجات، ثم حسب المطوّرين، ثم حسب التطبيقات.

إذا كنت لا تريد عرض قسم، اختَر عدم العرض، ثم اختَر الحقول المتبقية بالترتيب. يتم تعديل الترتيب تلقائيًا عند تغيير الترتيب النسبي لأحد الأقسام أو عند اختيار عدم عرض قسم في التقرير.

إنشاء تقرير وتنزيله

بعد إنشاء تقرير، يمكنك تنزيل نتائج التقرير بتنسيق CSV أو ملف ZIP. يمكنك إنشاء ملف CSV أو ملف ZIP متزامنًا أو بشكل غير متزامن.

  • بالنسبة إلى التقرير المتزامن، يمكنك تنفيذ طلب التقرير وحظره إلى أن يقدّم خادم الإحصاءات ردًا. ومع ذلك، قد يتعذّر إنشاء تقرير متزامن بسبب انتهاء المهلة، لأنّه قد يحتاج إلى معالجة كمية كبيرة من البيانات (على سبيل المثال، 100 غيغابايت).

    لا يتيح مستوى تقرير الملخص سوى الإنشاء المتزامن فقط.

  • بالنسبة إلى التقرير غير المتزامن، يمكنك تشغيل طلب التقرير واسترداد النتائج في وقت لاحق. في ما يلي بعض الحالات التي تكون فيها معالجة طلبات البحث غير المتزامنة بديلاً جيدًا:

    • تحليل وإنشاء التقارير التي تغطي فترات زمنية طويلة.
    • تحليل البيانات باستخدام مجموعة متنوعة من أبعاد التجميع والقيود الأخرى التي تضيف تعقيدًا إلى طلب البحث.
    • إدارة طلبات البحث عندما تجد أن أحجام البيانات قد ازدادت بشكلٍ كبير لبعض المستخدمين أو المؤسسات.

    يتيح مستوى التقرير التفصيلي إمكانية الإنشاء غير المتزامن.

لإنشاء تقرير وتنزيله بتنسيق CSV أو ملف ZIP، نفِّذ إحدى المهام التالية:

  1. الوصول إلى صفحة "التقارير"
  2. ضَع مؤشر الماوس فوق التقرير الذي تريد تنزيله.
  3. ضمن العمود تاريخ التعديل، انقر على أيٍّ مما يلي:

    1. رمز رمز ملف CSV أو رمز رمز ملف ZIP (لتقرير "الملخّص"). يتم حفظ التقرير في ملف CSV أو ملف ZIP بشكلٍ متزامن.
    2. إرسال المهمة (للحصول على تقرير تفصيلي). تبدأ المهمة غير المتزامنة.
      1. راقب حالة الوظيفة في العمود معدَّلة.

        يظهر رمز القرص عندما يكون التقرير جاهزًا للتنزيل:

        تظهر صورة القرص عندما يكون التقرير جاهزًا للتنزيل.
      2. بعد اكتمال المهمة، انقر على رمز القرص لتنزيل التقرير.

في ما يلي مثال على ملف CSV لتقرير ملخّص الفوترة.

تعديل تقرير

لتعديل أحد التقارير:

  1. الوصول إلى صفحة "التقارير".
  2. ضع مؤشر الماوس فوق التقرير الذي تريد تعديله وانقر على في قائمة الإجراءات.
  3. عدِّل إعدادات التقرير، على النحو المطلوب.
  4. انقر على تحديث التقرير لحفظ إعدادات التقرير المحدَّثة.

حذف تقرير

لحذف تقرير:

  1. الوصول إلى صفحة "التقارير".
  2. ضع مؤشر الماوس فوق التقرير الذي تريد حذفه.
  3. انقر على في قائمة الإجراءات.

إدارة تقارير تحقيق الربح باستخدام واجهة برمجة التطبيقات

توضّح الأقسام التالية كيفية إدارة تقارير تحقيق الربح باستخدام واجهة برمجة التطبيقات.

ضبط إعداد تقرير باستخدام واجهة برمجة التطبيقات

لإعداد تقرير لمؤسسة بأكملها، يمكنك إصدار طلب POST إلى /organizations/{org_name}/report-definitions.

لإعداد تقرير لمطوّر محدّد، يمكنك إصدار طلب POST إلى /organizations/{org_name}/developers/{dev_id}/report-definitions، حيث يشير {dev_id} إلى هوية المطوّر.

عند تقديم الطلب، يجب تحديد اسم التقرير ونوعه. وهذا النوع من الأنواع التالية: BILLING أو REVENUE أو VARIANCE (متوقّف نهائيًا) أو PREPAID_BALANCE. بالإضافة إلى ذلك، يمكنك تحديد المعايير في السمة mintCriteria التي تضبط التقرير بشكل أكبر. وتتوفّر مجموعة كبيرة من المعايير التي يمكنك تحديدها. ويمنحك هذا قدرًا كبيرًا من المرونة في ضبط التقرير. وفي ما يلي بعض الأشياء التي يمكنك تحديدها كمعايير:

  • بالنسبة إلى تقرير الفوترة أو الرصيد المدفوع مسبقًا، يكون شهر الفوترة للتقرير.
  • بالنسبة إلى تقرير الأرباح، تشير هذه السمة إلى نوع المعاملات التي يشملها التقرير، مثل معاملات الشراء ومعاملات تحصيل الرسوم وعمليات ردّ الأموال.
  • بالنسبة إلى تقرير رصيد الدفع المسبق، المطوّر الذي ينطبق عليه التقرير
  • بالنسبة إلى تقرير الأرباح، وحِزم المنتجات في واجهة برمجة التطبيقات (أو حِزم واجهة برمجة التطبيقات) والمنتجات وخطط الأسعار والتطبيقات التي ينطبق عليها التقرير.
  • العملة السارية للتقرير في تقرير الأرباح أو التباين
  • بالنسبة إلى تقارير الفوترة أو الرصيد المدفوع مسبقًا أو الأرباح، سواء كان التقرير عبارة عن تقرير ملخّص أو تقريرًا تفصيليًا
  • للاطّلاع على تقرير ملخّص الأرباح، يجب تضمين سمات المعاملات المخصّصة في التقرير.

يمكنك الاطّلاع على خيارات ضبط التقرير للحصول على قائمة كاملة بمعايير التقارير.

على سبيل المثال، يتم في ما يلي إنشاء تقرير الأرباح يلخّص نشاط المعاملات لشهر تموز (يوليو) 2015. يتضمن التقرير مجموعة متنوعة من أنواع المعاملات المحدّدة في السمة transactionTypes، وينطبق ذلك بشكل خاص على حزمة منتجات Payment API ومنتج واجهة برمجة التطبيقات Payment API. بما أنه لم يتم تحديد مطوّر برامج أو تطبيق محدّد في تعريف التقرير، ينطبق التقرير على جميع المطوّرين والتطبيقات. وبما أنّه تم ضبط السمة currencyOption على LOCAL، سيتم عرض كل سطر من التقرير باستخدام عملة خطة السعر السارية. وإضافةً إلى ذلك، تحدّد السمة groupBy أنّه سيتم تجميع الأعمدة في التقرير بالترتيب التالي: PACKAGE وPRODUCT ومطوّرو البرامج وAPPLICATION وRATEPLAN (بما في ذلك اسم خطة السعر ورقم تعريفها في التقرير).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

في ما يلي تقرير تفصيلي عن الفوترة يعرض نشاط أحد المطوّرين DEV في شهر حزيران (يونيو) 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

عرض تكوينات التقارير باستخدام واجهة برمجة التطبيقات

يمكنك عرض إعداد تقرير معيّن أو جميع إعدادات التقارير لمؤسسة. ويمكنك أيضًا عرض عمليات إعداد التقارير لمطوّر فردي.

لعرض إعدادات تقرير محدّد لمؤسسة، يمكنك إصدار طلب GET إلى /organizations/{org_name}/report-definitions/{report_definition_id}، حيث يشير {report_definition_id} إلى إعداد تقرير محدّد (يتم عرض المعرّف في الاستجابة عند إنشاء إعدادات التقرير). مثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

للاطّلاع على جميع إعدادات التقارير الخاصة بالمؤسسة، عليك إصدار طلب GET إلى /organizations/{org_name}/report-definitions.

يمكنك تمرير مَعلمات طلبات البحث التالية لفلترة النتائج وترتيبها:

تفاصيل دخول طلب البحث الوصف
all علامة تحدّد ما إذا كان يجب عرض جميع حِزم المنتجات في واجهة برمجة التطبيقات في حال ضبط هذه السياسة على false، يتمّ تحديد عدد حِزم منتجات واجهة برمجة التطبيقات التي يتم عرضها لكل صفحة من خلال مَعلمة طلب البحث size. تكون القيمة التلقائية false.
size عدد حِزم منتجات واجهة برمجة التطبيقات التي يتم عرضها لكل صفحة. يكون الإعداد التلقائي بالقيمة 20. في حال ضبط معلَمة طلب البحث all على true، سيتم تجاهل هذه المعلَمة.
page رقم الصفحة التي تريد عرضها (إذا كان المحتوى مقسّمًا على صفحات). في حال ضبط معلَمة طلب البحث all على true، يتم تجاهل هذه المعلَمة.
sort الحقل الذي سيتم ترتيب المعلومات وفقًا له. في حال ضبط معلَمة طلب البحث all على true، سيتم تجاهل هذه المعلَمة. وتكون الإعدادات التلقائية على UPDATED:DESC.

على سبيل المثال، في ما يلي عمليات ضبط تقارير المرتجعات للمؤسسة وتحصر إمكانية استرداد البيانات بخمسة إعدادات ضبط بحدّ أقصى للتقارير:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

يجب أن يبدو الرد على النحو التالي (يتم عرض جزء فقط من الرد):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

لعرض إعدادات التقرير لمطوِّر معيّن، يمكنك إصدار طلب GET إلى /organizations/{org_name}/developers/{dev_id}/report-definitions، حيث يشير {dev_id} إلى تعريف المطوّر. عند تقديم الطلب، يمكنك تحديد معلَمات طلب البحث الموضّحة أعلاه لفلترة البيانات وترتيبها.

على سبيل المثال، في ما يلي إعدادات تقارير الإرجاع لمطوّر محدّد وترتيب الرد حسب اسم التقرير:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

تعديل ضبط التقرير باستخدام واجهة برمجة التطبيقات

لتعديل إعدادات تقرير، يمكنك إصدار طلب PUT إلى /organizations/{org_name}/report-definitions/{report_definition_id}، حيث يشير {report_definition_id} إلى معرّف الإعداد المحدّد للتقرير. عند إجراء التعديل، عليك أن تحدّد في نص الطلب قيم الإعدادات المعدَّلة ورقم تعريف إعدادات التقرير. على سبيل المثال، يؤدي الطلب التالي إلى تعديل التقرير ليصبح تقرير ملخّص (يتم تمييز السمات المعدّلة):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

يجب أن يبدو الرد على النحو التالي (يتم عرض جزء فقط من الرد):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

حذف إعداد تقرير باستخدام واجهة برمجة التطبيقات

لحذف إعداد تقرير، يمكنك إصدار طلب "حذف" إلى /organizations/{org_namer}/report-definitions/{report_definition_id}، حيث يشير {report_definition_id} إلى معرّف إعداد التقرير المطلوب حذفه. مثال:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

إنشاء تقرير باستخدام واجهة برمجة التطبيقات

بعد إعداد تقرير، يمكنك إنشاؤه بتنسيق ملف يتضمّن قيمًا مفصولة بفواصل (ملف CSV) لعرضه.

لإنشاء تقرير، عليك إرسال طلب POST إلى organizations/{org_id}/{report_type}، حيث يحدّد {report_type} نوع التقرير الذي تريد إنشاءه. الأنواع هي:

  • billing-reports
  • revenue-reports
  • prepaid-balance-reports
  • variance-reports
بالإضافة إلى ذلك، يمكنك إنشاء تقرير أرباح لمطوِّر معيّن، كما هو موضّح في إنشاء تقرير أرباح لمطوّر برامج.

على سبيل المثال، لإنشاء تقرير فوترة، يمكنك إصدار طلب POST إلى organizations/{org_name}/billing-reports.

حدِّد معايير البحث الخاصة بالتقرير في نص الطلب (لأي نوع من التقارير). استخدِم السمات mintCriteria لتحديد معايير البحث. راجع خيارات ضبط المعايير للحصول على مزيد من التفاصيل.

على سبيل المثال، يبحث الطلب التالي عن تقرير الأرباح استنادًا إلى معايير مختلفة، مثل تاريخَي بدء التقرير وانتهائه وأنواع المعاملات.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

وفي حال العثور عليه، يتم إنشاء تقرير الأرباح بتنسيق ملف CSV. في ما يلي مثال على ناتج التقرير:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

تضمين السمات المخصّصة للمطوّرين في تقارير الأرباح باستخدام واجهة برمجة التطبيقات

بالنسبة إلى تقارير الأرباح فقط، يمكنك تضمين السمات المخصّصة في التقرير إذا تم تحديد السمة المخصّصة لمطوِّر البرامج. عليك تحديد السمات المخصّصة عند إضافة مطوّرين إلى مؤسستك، كما هو موضّح في المقالة إدارة مطوّري التطبيقات.

لتضمين سمات مخصّصة في تقرير الأرباح، عليك إصدار طلب POST إلى organizations/{org_name}/revenue-reports وتضمين مصفوفة devCustomAttributes في نص الطلب:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

ملاحظة: لا تحدِّد السمتَين MINT_* وADMIN_* المحدّدتَين مسبقًا في المصفوفة devCustomAttributes.

على سبيل المثال، يتضمّن المثال التالي ثلاث سمات مخصّصة، BILLING_TYPE وSFID وORG_EXT، في التقرير (إذا تم تحديدها للمطوّر):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

في ما يلي مثال على مخرجات التقرير التي تتضمّن قيمًا للسمتَين المخصّصتَين:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

الإبلاغ عن نشاط المعاملات باستخدام واجهة برمجة التطبيقات

يمكنك الاطّلاع على نشاط المعاملات لإحدى المؤسسات من خلال إصدار طلب POST إلى /organizations/{org_name}/transaction-search. وعند تقديم الطلب، عليك تحديد معايير الاسترجاع. وفي ما يلي بعض الأشياء التي يمكنك تحديدها كمعايير:

  • معرّف منتج واحد أو أكثر من منتجات واجهة برمجة التطبيقات التي تمّ إصدار معاملات لها
  • شهر وسنة الفوترة للمعاملات.
  • المطوّرون الذين أصدروا المعاملة
  • نوع المعاملة، مثل رسوم الشراء والإعداد
  • حالة المعاملة، مثل "تمت العملية بنجاح" وتعذّر إكمالها

راجِع خيارات ضبط المعايير للحصول على قائمة كاملة بالمعايير.

على سبيل المثال، تُرجع المعاملات التالية المعاملات التي أصدرها مطوّر برامج معيّن لشهر الفوترة في حزيران (يونيو) 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

يمكنك أيضًا تحديد التطبيقات أو المطوّرين أو حِزم المنتجات من واجهة برمجة التطبيقات أو منتجات واجهة برمجة التطبيقات التي تضمّنت نشاط معاملات خلال نطاق زمني معيّن. يمكنك الاطّلاع على هذه المعلومات بشكل منفصل لكل نوع من الكائنات. على سبيل المثال، يمكنك عرض معلومات عن التطبيقات التي يمكنها الوصول إلى واجهات برمجة التطبيقات في حِزم منتجات واجهة برمجة التطبيقات التي يتم تحقيق الربح منها ضمن تاريخَي بدء وانتهاء محدّدَين.

لعرض معلومات حول نشاط المعاملات، يمكنك إصدار طلب GET لأحد الموارد التالية:

المورد المرتجعات
/organizations/{org_name}/applications-with-transactions

التطبيقات التي تتضمّن معاملات

/organizations/{org_name}/developers-with-transactions

المطوّرون الذين أجروا معاملات

/organizations/{org_name}/products-with-transactions

المنتجات التي لها معاملات

/organizations/{org_name}/packages-with-transactions

حِزم منتجات واجهة برمجة التطبيقات (أو حِزم واجهة برمجة التطبيقات) مع المعاملات

عند إصدار الطلب، عليك تحديد تاريخ بدء وتاريخ انتهاء للنطاق الزمني كمَعلمات طلب البحث. على سبيل المثال، يعرض الطلب التالي مطوّري البرامج الذين أجروا معاملات خلال شهر آب (أغسطس) 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

يجب أن يبدو الرد على النحو التالي (يتم عرض جزء فقط من الرد):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

خيارات إعداد التقارير لواجهة برمجة التطبيقات

تتوفّر خيارات ضبط التقارير التالية لواجهة برمجة التطبيقات:

الاسم الوصف تلقائي مطلوب؟
name

اسم التقرير

لا ينطبق نعم
description

وصف للتقرير.

لا ينطبق لا
mintCriteria

معايير ضبط التقرير راجِع خيارات ضبط المعايير للحصول على مزيد من التفاصيل.

لا ينطبق لا
type

نوع التقرير يمكن أن تكون القيمة واحدة مما يلي:

  • BILLING
  • REVENUE
  • VARIANCE
  • PREPAID_BALANCE
لا ينطبق نعم

خيارات ضبط المعايير

تتوفّر خيارات الضبط التالية للتقارير من خلال السمة mintCriteria:

الاسم الوصف تلقائي مطلوب؟
appCriteria

رقم التعريف والمؤسسة لتطبيق معيّن لتضمينهما في التقرير. في حال عدم تحديد هذه السمة، يتم تضمين جميع التطبيقات في التقرير.

لا ينطبق لا
billingMonth

ملاحظة: هذا الموقع غير صالح لتقارير الأرباح.

شهر الفوترة للتقرير، مثل تموز (يوليو).

لا ينطبق نعم
billingYear

ملاحظة: هذا الموقع غير صالح لتقارير الأرباح.

سنة الفوترة للتقرير، مثل 2015.

لا ينطبق نعم
currCriteria

رقم التعريف والمؤسسة لعملة معيّنة سيتم تضمينها في التقرير. في حال عدم تحديد هذه السمة، يتم تضمين جميع العملات المتوافقة في التقرير.

لا ينطبق لا
currencyOption

عملة التقرير وتشمل القيم الصالحة ما يلي:

  • LOCAL. يتم عرض كل سطر من التقرير باستخدام خطة السعر السارية. وهذا يعني أنّه قد تتوفّر عملات متعدّدة في التقرير نفسه إذا كان مطوّرو البرامج لديهم خطط تستخدم عملات مختلفة.
  • EUR. يتم تحويل المعاملات بالعملة المحلية وعرضها باليورو.
  • GPB. يتم تحويل المعاملات بالعملة المحلية وعرضها بالجنيه الإسترليني في المملكة المتحدة.
  • USD. يتم تحويل المعاملات بالعملة المحلية وعرضها بالدولار الأمريكي.
لا ينطبق لا
devCriteria

رقم تعريف مطوّر البرامج (عنوان البريد الإلكتروني) واسم المؤسسة لمطوّر معيّن يتم تضمينهما في التقرير. في حال عدم تحديد هذه السمة، يتم تضمين جميع المطوّرين في التقرير. مثال:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                
لا ينطبق لا
devCustomAttributes

ملاحظة: ينطبق هذا السمة على تقارير الأرباح فقط.

سمات مخصّصة لتضمينها في التقرير، إذا تم تحديدها لمطوِّر برامج على سبيل المثال:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

ملاحظة: لا تحدِّد السمتَين MINT_* وADMIN_* المحدّدتَين مسبقًا في المصفوفة devCustomAttributes.

لا ينطبق لا
fromDate

ملاحظة: لا ينطبق هذا الموقع إلّا على تقارير الأرباح والتباين ونشاط المعاملات.

تاريخ بدء التقرير بالتوقيت العالمي المنسّق (UTC).

لا ينطبق مطلوب لتقارير الأرباح، وهي غير مطلوبة لأنواع التقارير الأخرى.
groupBy

ترتيب الأعمدة التي يتم تجميعها في التقرير. وتشمل القيم الصالحة ما يلي:

  • APPLICATION
  • BALANCE
  • DEVELOPER
  • ORG
  • PACKAGE
  • PRODUCT
  • RATEPLAN
لا ينطبق لا
monetizationPackageId

معرّف حزمة منتجات واحدة أو أكثر في واجهة برمجة التطبيقات لتضمينها في التقرير وإذا لم يتم تحديد هذه السمة، يتم تضمين جميع حِزم منتجات واجهة برمجة التطبيقات في التقرير.

ملاحظة: هذه السمة غير صالحة عند عرض نشاط المعاملات (/transaction-search).

لا ينطبق لا
pkgCriteria

المعرّف والمؤسسة لحزمة منتجات معيّنة في واجهة برمجة التطبيقات التي سيتم تضمينها في التقرير. في حال عدم تحديد هذه السمة، يتم تضمين جميع حِزم منتجات واجهة برمجة التطبيقات في التقرير. يمكن تحديد هذه السمة بدلاً من السمة monetizationpackageIds.

ملاحظة: هذه السمة غير صالحة عند عرض نشاط المعاملات (/transaction-search).

لا ينطبق لا
prevFromDate

ملاحظة: لا تنطبق هذه السمة إلا على تقارير التباين.

تاريخ البدء لفترة سابقة بالتوقيت العالمي المنسَّق (UTC). تُستخدَم لإنشاء تقرير عن فترة سابقة للمقارنة بتقرير حالي.

لا ينطبق لا
prevToDate

ملاحظة: لا تنطبق هذه السمة إلا على تقارير التباين.

تاريخ الانتهاء لفترة سابقة بالتوقيت العالمي المنسَّق. يتم استخدامه لإنشاء تقرير لفترة سابقة للمقارنة بتقرير حالي.

لا ينطبق لا
prodCriteria

المعرّف والمؤسسة لمنتج محدّد في واجهة برمجة التطبيقات سيتم تضمينه في التقرير. في حال عدم تحديد هذه السمة، يتم تضمين جميع منتجات واجهة برمجة التطبيقات في التقرير. يمكن تحديد هذه السمة بدلاً من السمة productIds.

ملاحظة: هذه السمة غير صالحة عند عرض نشاط المعاملات (/transaction-search).

لا ينطبق لا
productIds

معرّف منتج واحد أو أكثر من منتجات واجهة برمجة التطبيقات لتضمينها في التقرير في حال عدم تحديد هذه السمة، سيتم تضمين جميع منتجات واجهة برمجة التطبيقات في التقرير.

يجب أن تكون معرّفات المنتجات في واجهة برمجة التطبيقات هي org-name@@@product-name. مثال: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

لا ينطبق لا
pricingTypes

نوع التسعير لخطة الأسعار التي سيتم تضمينها في التقرير. وتشمل القيم الصالحة ما يلي:

  • REVSHARE. خطة مشاركة الأرباح.
  • REVSHARE_RATECARD. خطة مشاركة الأرباح وسعر بطاقة السعر.
  • RATECARD. خطة بطاقة الأسعار

في حال عدم تحديد هذه السمة، يتم تضمين خطط الأسعار بجميع أنواع الأسعار في التقرير.

لا ينطبق لا
ratePlanLevels

نوع خطة الأسعار التي سيتم تضمينها في التقرير. وتشمل القيم الصالحة ما يلي:

  • DEVELOPER. خطة سعر مخصّصة للمطوّرين
  • STANDARD. خطة السعر العادي

في حال عدم تحديد هذه السمة، يتم تضمين خطط الأسعار الخاصة بالمطوّرين وخطط الأسعار العادية في التقرير.

لا ينطبق لا
showRevSharePct

علامة تحدّد ما إذا كان التقرير يعرِض النِسب المئوية لحصة الأرباح وتشمل القيم الصالحة ما يلي:

  • true. عرض النسب المئوية لحصة الأرباح.
  • false. عدم عرض النسب المئوية لحصة الأرباح.
لا ينطبق لا
showSummary

علامة تحدد ما إذا كان التقرير ملخّصًا وتشمل القيم الصالحة ما يلي:

  • true. التقرير عبارة عن ملخّص.
  • false. التقرير لا يمثّل ملخّصًا.
لا ينطبق لا
showTxDetail

ملاحظة: ينطبق هذا السمة على تقارير الأرباح فقط.

علامة تحدد ما إذا كان التقرير يعرض تفاصيل على مستوى المعاملة وتشمل القيم الصالحة ما يلي:

  • true. عرض التفاصيل على مستوى المعاملة
  • false. عدم عرض التفاصيل على مستوى المعاملة
لا ينطبق لا
showTxType

علامة تحدد ما إذا كان التقرير يعرض نوع كل معاملة وتشمل القيم الصالحة ما يلي:

  • true. يمكنك عرض نوع كل معاملة.
  • false. لا تعرض نوع كل معاملة.
لا ينطبق لا
toDate

ملاحظة: لا ينطبق هذا الموقع إلّا على تقارير الأرباح والتباين ونشاط المعاملات.

تاريخ انتهاء التقرير بالتوقيت العالمي المنسّق (UTC).

ويتضمّن التقرير البيانات التي تم جمعها حتى نهاية اليوم الذي يسبق التاريخ المحدّد. وسيتم استبعاد بيانات التقارير التي تم جمعها في تاريخ الانتهاء المحدّد من التقرير. إذا كنت تريد إنهاء خطة السعر في 31 كانون الأول (ديسمبر) 2016 مثلاً، يجب ضبط قيمة toDate على 2017-01-01. في هذه الحالة، سيتضمّن التقرير بيانات التقرير حتى نهاية يوم 31 كانون الأول (ديسمبر) 2016، بينما سيتم استبعاد بيانات التقارير الواردة في 1 كانون الثاني (يناير) 2017.

لا ينطبق مطلوب لتقارير الأرباح، وهي غير مطلوبة لأنواع التقارير الأخرى.
transactionStatus

حالة المعاملات المطلوب تضمينها في التقرير. وتشمل القيم الصالحة ما يلي:

  • SUCCESS. معاملة ناجحة.
  • DUPLICATE: معاملة مكرّرة. ويمكن تجاهل هذه المعاملات. في بعض الأحيان، قد ينشئ مسار البيانات من وقت تشغيل Apigee إلى خادم التقييم معاملات مكرّرة للتساهل مع الأخطاء، وتحدّد ميزة تحقيق الربح هذه المعاملات ويصنّفها على أنّها مكرّرة.
  • FAILED. تعذّر إكمال المعاملة. تظهر هذه الحالة عند تعذُّر التحقُّق من شرط مُسبق. على سبيل المثال:
    • تمت محاولة التقييم على الرغم من أنّ المطوّر لم يشترِ خطة السعر. ويمكن أن يحدث ذلك في حال عدم ضبط سياسة التحقّق من حدود تحقيق الربح.
    • تم تجاوز الحصة المخصصة، ولكن ما زالت المكالمات جارية. ويمكن أن يحدث ذلك في حال عدم ضبط سياسة التحقّق من حدود تحقيق الربح.
    • تم إرسال قيمة السمة المخصّصة السلبية للخطة المستندة إلى السمات.
  • INVALID_TSC. المعاملة غير صالحة. يتم عرض هذه الحالة عندما لا تتطابق معايير وقت تشغيل "txProviderStatus" مع معايير النجاح المحدّدة على مستوى حزمة المنتجات في واجهة برمجة التطبيقات.
  • REVIEW. المعاملات التي تتطلب المراجعة. يتم عرض هذه الحالة لخطط معدّلات حصة الأرباح المرنة إذا كانت القيمة تقع ضمن نطاق أرباح لم يتم ضبطه.
لا ينطبق لا
transactionCustomAttributes

سمات المعاملات المخصّصة المراد تضمينها في تقارير ملخّص الأرباح يجب تفعيل هذه الميزة في مؤسستك. يُرجى الاطّلاع على تضمين سمات المعاملات المخصّصة في تقارير "ملخّص الأرباح".

لا ينطبق لا
transactionTypes

نوع المعاملات التي سيتم تضمينها في التقرير. وتشمل القيم الصالحة ما يلي:

في حال عدم تحديد هذه السمة، يتم تضمين جميع أنواع المعاملات في التقرير.

لا ينطبق لا