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

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

วิธีการหลัก

เมธอดหลักของ embedded API คือเมธอดที่พบในออบเจ็กต์ gapi.analytics

ready

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

ฟังก์ชัน ready จะกำหนดโดยข้อมูลโค้ด ฝัง API เพื่อให้สามารถใช้งานได้ทันที ควรวางฟังก์ชันอื่นๆ ทั้งหมดไว้ในโค้ดเรียกกลับ 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'.

});

หมายเหตุ: ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างคอมโพเนนต์ได้ในคู่มือนักพัฒนาซอฟต์แวร์การสร้างคอมโพเนนต์ที่กำหนดเอง