توفر واجهة برمجة التطبيقات inline API للمطوّرين عدة مكونات مدمجة لتنفيذ طلبات بحث عن بيانات التقارير وعرضها. يتم بناء جميع المكونات على قاعدة مشتركة وبالتالي تشترك في العديد من نفس الطرق. يقدّم هذا القسم نظرة عامة حول كيفية استخدام هذه الطرق المشترَكة. لمزيد من المعلومات حول المكوّنات الفردية، يُرجى الاطّلاع على مرجع المكوّن.
خيارات المكونات
يتم ضبط خيارات المكوّنات في وقت الإنشاء عبر الدالة الإنشائية من خلال استدعاء طريقة set على المثيل. للحصول على حالة مثيل المكوِّن في أي وقت، يمكنك استدعاء get وسيتم عرض خياراته الحالية.
تفاعل المكون
تنبعث المكونات أحداثًا عندما يحدث شيء ما مهم، مما يسمح للمكونات الأخرى بالاستجابة عند حدوث هذه الأحداث. لتسجيل معالج مع حدث معيّن، ما عليك سوى استدعاء الطريقة on. وبدلاً من ذلك، يمكنك استخدام طريقة once، والتي تشبه on، ولكن سيتم استدعاء المعالج الخاص بها في المرة الأولى فقط ثم تتم إزالته تلقائيًا. لإزالة المعالج، يمكنك استخدام الإجراء off.
ستستمع عادةً إلى الأحداث التلقائية الصادرة من المكوّنات، ولكن إذا أردت إرسال حدث خاص بك، يمكنك إجراء ذلك باستخدام طريقة emit.
مكتبة عملاء "إحصاءات Google"
تُحمِّل واجهة برمجة التطبيقات inline API أيضًا مكتبة برامج "إحصاءات Google"، والتي تتيح لك إمكانية الوصول إلى العديد من واجهات برمجة تطبيقات "إحصاءات Google" الأخرى إذا كنت بحاجة إليها.
تتوفّر واجهات برمجة التطبيقات التالية في مساحات الاسم التالية:
gapi.client.analytics.data.ga gapi.client.analytics.data.mcf gapi.client.analytics.data.realtime gapi.client.analytics.management gapi.client.analytics.metadata