ข้อมูลอ้างอิงเมธอดหลัก

เอกสารนี้ให้ข้อมูลอ้างอิงสําหรับเมธอด API แบบฝังหลัก รวมทั้งภาพรวมของวิธีที่เมธอดเหล่านั้นทํางานกับคอมโพเนนต์ API ฝังและไลบรารีของไคลเอ็นต์ Analytics ที่สําคัญ

วิธีการหลัก

เมธอดหลักของ API การฝังเป็นเมธอดที่พบในออบเจ็กต์ gapi.analytics

ready

คิวฟังก์ชันเรียกกลับที่จะเรียกใช้ทันทีที่ไลบรารี API ฝังโหลดอย่างสมบูรณ์ ระบบจะเรียกใช้โค้ดเรียกกลับตามลําดับที่เพิ่ม

ฟังก์ชัน ready กําหนดโดยข้อมูลโค้ดฝังเพื่อให้ใช้งานได้ทันที ฟังก์ชันอื่นทั้งหมดควรอยู่ในการเรียกกลับ ready เพื่อให้แน่ใจว่าไลบรารีจะโหลดก่อนที่จะเรียกใช้

การใช้งาน

gapi.analytics.ready(callback)

พารามิเตอร์

ชื่อ ประเภท คำอธิบาย
callback Function ฟังก์ชันที่จะเรียกใช้ทันทีที่ไลบรารี Embedded API โหลดอย่างสมบูรณ์

ตัวอย่าง

gapi.analytics.ready(function() {
  // Code in here will be invoked once the library fully loads.
});

createComponent

สร้างคอมโพเนนต์ที่มีชื่อและวิธีการสร้างต้นแบบที่ระบุ ระบบจะจัดเก็บคอมโพเนนต์ที่สร้างในวันที่ gapi.analytics.ext โดยใช้ชื่อที่ส่งผ่าน

ระบบควรเรียกใช้ฟังก์ชัน createCallback ภายในโค้ดเรียกกลับพร้อมใช้เสมอ เพื่อให้ไลบรารีของไคลเอ็นต์ API ฝังทํางาน

การใช้งาน

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'.

});