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

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

مقدمة

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

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

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

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

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

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

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

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

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

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

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

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

اضبط تقريرًا باستخدام واجهة مستخدم Edge أو واجهة المستخدم Classice 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 على التوالي. يجب أن تشير هذه السمة إلى الاسم والموضع في جميع سياسات تسجيل المعاملات الخاصة بالمنتجات التي سيتم تضمينها في التقارير.
  
  

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

إعداد تقرير تباين (متوقّف)

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

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

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

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

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

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

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

  يدعم مستوى التقرير التفصيلي الإنشاء غير المتزامن.

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

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",
    ...
]