يوفر هذا المستند مرجعًا للطرق الأساسية لواجهة برمجة التطبيقات inline API بالإضافة إلى نظرة عامة حول كيفية تفاعل هذه الطرق مع مكوّنات embed API ومكتبة عملاء "إحصاءات Google" الأساسية.
الطرق الأساسية
إنّ الطرق الأساسية لواجهة برمجة تطبيقات التضمين هي الطرق التي يمكن العثور عليها في الكائن gapi.analytics.
ready
تضع دالة معاودة الاتصال في قائمة انتظار ليتم استدعاؤها بمجرد تحميل مكتبة واجهة برمجة التطبيقات inline API بشكل كامل. يتم استدعاء عمليات معاودة الاتصال بالترتيب الذي تمت إضافتها به.
يتم تحديد الدالة ready من خلال مقتطف inline API، لذا يمكن استخدامها على الفور. يجب وضع جميع الدوال الأخرى في استدعاء ready لضمان تحميل المكتبة قبل استدعائها.
الاستخدام
gapi.analytics.ready(callback)
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
callback |
Function |
الدالة التي سيتم استدعاؤها بمجرد تحميل مكتبة واجهة برمجة التطبيقات inline 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'.
});