يقدم هذا المستند مرجعًا لطرق واجهة برمجة التطبيقات الأساسية للتضمين، بالإضافة إلى نظرة عامة على كيفية تفاعل تلك الطرق مع مكونات وواجهة برمجة التطبيقات للتضمين ومكتبة عميل "إحصاءات Google".
الطُرق الأساسية
الطرق الأساسية لتضمين واجهة برمجة التطبيقات هي الطرق التي يتم العثور عليها في الكائن gapi.analytics
.
ready
يضع قائمة انتظار لاستدعاء دالة الاستدعاء بمجرد تحميل مكتبة واجهة برمجة تطبيقات التضمين بالكامل. يتم استدعاء عمليات معاودة الاتصال حسب ترتيب إضافتها.
يتم تعريف الدالة ready
من خلال مقتطف واجهة برمجة التطبيقات للتضمين، بحيث يمكن استخدامها على الفور. يجب وضع جميع الدوال الأخرى داخل استدعاء ready
لضمان تحميل المكتبة قبل استدعاءها.
الاستخدام
gapi.analytics.ready(callback)
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
callback |
Function |
سيتم استدعاء الدالة فور تحميل مكتبة Include API بالكامل. |
مثال
gapi.analytics.ready(function() { // Code in here will be invoked once the library fully loads. });
createComponent
تنشئ مكوّنًا بالاسم المحدد وطرق النموذج الأولي. سيتم تخزين المكوِّن الذي تم إنشاؤه على gapi.analytics.ext
بالاسم الذي تم تمريره.
يجب استدعاء دالة createCallback
دائمًا داخل استدعاء جاهز لضمان تحميل مكتبة عميل"تضمين واجهة برمجة التطبيقات".
الاستخدام
gapi.analytics.createComponent(name, prototypeMethods)
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
name |
string |
اسم المكوِّن. |
prototypeMethods |
Object |
العنصر الذي سيتم تخزين خصائصه وأساليبه في النموذج الأولي للمكوّنات. |
مثال
gapi.analytics.ready(function() { gapi.analytics.createComponent('MyComponent', { foo: function() { alert('foo'); }, bar: function() { alert('bar'); } }); var myComponentInstance = new gapi.analytics.ext.MyComponent(); myComponentInstance.foo(); // Alerts 'foo'. });