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

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

مقدمة

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

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

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

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

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

لمحة عن المعاملات المكرّرة

في حال مقارنة تقارير معاملات تحقيق الربح ببيانات "إحصاءات Google"، قد تلاحظ عددًا صغيرًا من المعاملات المكرّرة. هذا السلوك متوقّع لأنّ نظام تحقيق الربح يمكنه أن يعالج عدة ملايين من المعاملات يوميًا مع معالجة العديد من المعاملات بشكلٍ متزامن في أي وقت معيّن. في المتوسّط، قد تكون نسبة% 0.1 تقريبًا من المعاملات مكرّرة.

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

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

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

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

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

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

ضبط إعدادات تقرير الفوترة

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

ضبط تقرير الرصيد المدفوع مسبقًا

ضبط تقرير الأرباح

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

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

تتيح لك سياسات تسجيل المعاملات تسجيل بيانات السمات المخصّصة من المعاملات، ويمكنك تضمين هذه السمات المخصّصة في تقارير الأرباح الإجمالية. حدِّد المجموعة التلقائية من السمات المخصّصة المضمّنة في جداول قاعدة بيانات تحقيق الربح من خلال ضبط سمة 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. اطّلِع على خيارات إعداد المعايير.

ضبط تقرير التباين (ميزة متوقّفة نهائيًا)

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

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

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

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

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

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

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

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

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

1. انتقِل إلى صفحة "التقارير".
2. ضع المؤشر فوق التقرير الذي تريد تنزيله.

3. ضمن عمود تم تعديله، انقر على أيّ مما يلي:

   1. رمز أو رمز (لتقرير "ملخّص") يتم حفظ التقرير في ملف 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 وDEVELOPER و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 FIVE لشهر حزيران (يونيو) 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.

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

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

$ 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 إلى أحد موارد البيانات التالية:

عند إصدار الطلب، عليك تحديد تاريخَي البدء والانتهاء للنطاق الزمني كمَعلمات طلب بحث. على سبيل المثال، يعرض الطلب التالي المطوّرين الذين أجروا معاملات خلال شهر آب (أغسطس) 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"
  }, ...
  ]
}

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

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

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

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

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

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