เอกสารนี้จะอธิบายวิธีใช้ API ของแกดเจ็ตใหม่สำหรับการติดตามแกดเจ็ต Analytics API นี้มีโมเดลข้อมูลและการติดตามประสิทธิภาพที่ปรับปรุงแล้วเพื่อรวบรวมสถิติรายงาน Analytics สำหรับแกดเจ็ตของคุณ
ก่อนที่คุณจะเริ่มต้น
ใน Google Analytics โดเมนเว็บไซต์หรือโดเมนย่อยที่ไม่ซ้ำกันแต่ละรายการที่คุณเพิ่มในบัญชีจะได้รับการติดตามในข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) แยกต่างหาก และจะมีรหัสโดเมนแยกต่างหาก เนื่องจากแกดเจ็ตแต่ละรายการทำงานบนโดเมนย่อยของตัวเองบนเว็บไซต์โฮสต์ gmodules.com
คุณจึงต้องติดตามแกดเจ็ตแต่ละรายการที่คุณสร้างในมุมมอง (โปรไฟล์) ของตัวเองและด้วยรหัสโดเมนที่ไม่ซ้ำกัน
วิธีที่ง่ายที่สุดในการดำเนินการดังกล่าวคือให้ Google Analytics สร้างรหัสที่ไม่ซ้ำกันให้คุณ
- ในการเริ่มต้น ให้ลงชื่อเข้าใช้ Google Analytics หรือลงชื่อสมัครใช้บัญชี Google Analytics
- ผู้ใช้ใหม่ควรจะเห็นหน้าลงชื่อสมัครใช้บัญชีใหม่
- ผู้ใช้ปัจจุบันควรไปที่หน้าการตั้งค่า Analytics แล้วคลิกเพิ่มมุมมองเว็บไซต์ (โปรไฟล์) (โปรดเลือกโดเมนใหม่)
- จากหน้าใดหน้าหนึ่งเหล่านี้ ให้ป้อน URL ของเว็บไซต์ที่ถูกต้อง
- เนื่องจาก URL ของเว็บไซต์เป็นเพียงสตริงที่ซอฟต์แวร์ Google Analytics จับคู่กับรหัสโดเมนของคุณ URL นี้จึงเป็นสตริง URL ของเว็บไซต์ที่ถูกต้อง ไม่ว่าจะเป็นข้อมูลที่แต่งขึ้นหรือจริง คุณจะไม่ต้องติดตั้งโค้ดติดตามในหน้าเว็บใดๆ เลย และไม่จำเป็นต้องเข้าถึงหน้าเว็บไซต์ใดๆ
- คลิกปุ่มเพื่อไปยังหน้าจอถัดไป
- เมื่อข้อมูลโค้ดติดตามปรากฏขึ้น ให้คัดลอกรหัสโดเมนที่ไม่ซ้ำลงในแผ่นขูด ข้อมูลโค้ดที่สร้างขึ้นโดยอัตโนมัติจะมีรหัสโดเมนนี้ในรูปแบบ
UA-123456-1
- คลิกปุ่มเสร็จสิ้น
- คุณควรจะเห็นชื่อ URL ของเว็บไซต์ในรายการข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นอกจากนี้คุณยังเปลี่ยนชื่อข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) เป็นชื่อที่มีความหมายยิ่งขึ้นได้ โดยคลิกลิงก์แก้ไขของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นั้น แล้วคลิกแก้ไขอีกครั้ง
- ใช้รหัสโดเมนที่สร้างขึ้นในโค้ดติดตามแกดเจ็ตของคุณ
- รหัสโดเมน Analytics จะอยู่ในรูปแบบ
UA-123456-1
การติดตามแกดเจ็ตของคุณ
กระบวนการติดตามแกดเจ็ตของคุณประกอบด้วยการเพิ่มเติมสามอย่างในรหัสแกดเจ็ตของคุณ:
- กำลังเปิดใช้ฟีเจอร์
- กำลังสร้างออบเจ็กต์ตัวติดตาม
- การติดตามแกดเจ็ตของคุณโดยใช้หนึ่งในสองวิธี
ตัวอย่างโค้ดของแกดเจ็ตต่อไปนี้จะแสดงการเพิ่มโค้ดเหล่านี้แต่ละครั้ง ซึ่งจะมีการอธิบายไว้ด้านล่างนี้ คุณสามารถใช้ไฟล์ตัวอย่างนี้เพื่อเริ่มแกดเจ็ตของคุณเอง
<?xml version="1.0" encoding="UTF-8" ?>
<Module>
<ModulePrefs title="Analytics Test">
<!-- Sets the feature -->
<Require feature="com.google.gadgets.analytics" />
<Require feature="setprefs" />
</ModulePrefs>
<UserPref
name="counter"
datatype="hidden"
default_value="0" />
<Content type="html">
<![CDATA[
<script> // Track this gadget using Google Analytics. // Creates a tracking object and uses reportPageview method to call gadget view var ga = new _IG_GA("UA-00000-1"); ga.reportPageview('/view/counterGadget'); // Suppose, for example, you have a gadget with two counter buttons. // You can track interactions with those counters via Analytics. // Increment value of "counter" user preference function incrementCounter() { var count = prefs.getInt("counter"); prefs.set("counter", count + 1); // Tracks button click as an event ga.reportEvent("Counter Gadget", "Increment", "Button", 0); } // Reset value of "counter" userpref to 0 function resetCounter(){ prefs.set("counter", 0); // Tracks button click as an event ga.reportEvent("Counter Gadget", "Reset", "Button", 0); } </script> <form name="counter"> <input type=button value="Reset" name="reset" onClick="resetCounter()"> <input type=button value="Count" name="count" onClick="incrementCounter()"> </form> ]]> </Content> </Module>
1. การเปิดใช้ฟีเจอร์นี้
ก่อนอื่นให้เปิดใช้ฟีเจอร์ดังกล่าวโดยการนำเข้าไลบรารี Analytics โดยใช้เนมสเปซของฟีเจอร์ ดังนี้
<Require feature="com.google.gadgets.analytics" />
2. การสร้างออบเจ็กต์ตัวติดตาม
API ติดตามของ Analytics ยึดตามรูปแบบเชิงวัตถุเดียวกันของโค้ดติดตาม ga.js
ดังนั้น ก่อนที่จะติดตามแกดเจ็ตของคุณ ให้สร้างอินสแตนซ์ของอ็อบเจ็กต์เครื่องมือติดตาม:
var ga = new _IG_GA("UA-123456-1");
ซึ่งคุณจะแทรกรหัสโดเมนที่สร้างขึ้นโดยทำตามขั้นตอนข้างต้น
คุณต้องใช้รหัสโดเมนแบบเต็มที่มีตัวเลขเดียวลงท้าย ไม่เช่นนั้นการเรียกอ็อบเจ็กต์การติดตามจะล้มเหลว
3. การติดตามแกดเจ็ตของคุณ
แกดเจ็ต API มีสองวิธีการที่คุณสามารถใช้เพื่อติดตามการทำงานของแกดเจ็ตของคุณ:
- เมธอด URL เสมือน
-
ga.reportPageview(path);
วิธีนี้ติดตามสถิติของแกดเจ็ตเป็นการดูหน้าเว็บพิเศษ และเป็นวิธีเดียวกับที่ใช้ใน API แกดเจ็ต Analytics รุ่นก่อนหน้า เมื่อใช้วิธีการนี้ คุณจะสามารถอัปเดตโค้ดติดตามแกดเจ็ตใดๆ ที่มีอยู่แล้วได้โดยไม่ส่งผลต่อรูปแบบรายงาน Analytics ที่มีอยู่ คุณสามารถดูข้อมูลการรายงานในแกดเจ็ตเช่นเดียวกับที่คุณดูข้อมูลการรายงานของหน้าเว็บ
เมื่อคุณใช้วิธีการ URL เสมือนเพื่อติดตามการโต้ตอบของแกดเจ็ต การเรียกแต่ละครั้งจะถูกบันทึกเป็นคำขอหน้าเว็บสำหรับสตริงที่คุณระบุเป็นพารามิเตอร์ของเมธอดนั้น คุณสามารถใช้ประโยชน์จากพฤติกรรมนี้เพื่อส่งต่อไปในเส้นทาง URL ที่ดัดแปลง เพื่อให้คุณดูรายงานสำหรับแกดเจ็ตในอินเทอร์เฟซ Google Analytics ได้เหมือนกับที่รายงานหน้าเว็บไซต์ ตัวอย่างเช่น คุณสามารถใช้เส้นทางแยกต่างหากเพื่อติดตามทั้งการดูแกดเจ็ตและการโต้ตอบกับแกดเจ็ต ดังนี้
ga.reportPageview('/view/counterGadget'); ga.reportPageview('/click/increment'); ga.reportPageview('/click/reset');
- วิธีการติดตามกิจกรรม
-
ga.reportEvent(name, action, [[]label], [[]value]);
วิธีนี้ใช้ได้เฉพาะใน API แกดเจ็ต Analytics ใหม่เท่านั้น เมื่อใช้วิธีการนี้ คุณสามารถติดตามการดูหน้าเว็บ (เช่น การแสดงแกดเจ็ต) แยกจากการโต้ตอบของผู้ใช้ในแกดเจ็ตของคุณ
หมายเหตุ: ขณะนี้การติดตามกิจกรรมยังอยู่ในรุ่นเบต้าแบบปิด ใช้เมธอด URL เสมือนหากคุณไม่มีสิทธิ์เข้าถึงการติดตามเหตุการณ์
เมธอดเหตุการณ์จะมีโมเดลอื่นให้คุณใช้กับการติดตามแกดเจ็ต ประการแรก การเรียกเหตุการณ์จะคำนวณแยกจากการเรียกการดูหน้าเว็บ และข้อมูลที่ได้จะแสดงในส่วนที่แยกต่างหากของรายงานเนื้อหาของ Google Analytics ดังนั้น คุณสามารถติดตามมุมมองของแกดเจ็ตแยกต่างหากจากการโต้ตอบของผู้ใช้กับแกดเจ็ต โดยที่การโต้ตอบของผู้ใช้จะทำให้ตัวเลขโดยรวมเพิ่มขึ้นสำหรับการดูแกดเจ็ต ประการที่สอง วิธีนี้ใช้รูปแบบการติดตามเหตุการณ์ ซึ่งมีโครงสร้างที่ออกแบบมาโดยเฉพาะเพื่อวิเคราะห์การโต้ตอบของผู้ใช้ในแกดเจ็ต ในโมเดลนี้ ทั้งป้ายกำกับและค่าเป็นพารามิเตอร์ที่ไม่บังคับ
เมื่อใช้ตัวอย่างตัวนับ เราสามารถใช้วิธีของเหตุการณ์เพื่อติดตามว่าฟังก์ชันของแกดเจ็ตใดจะถูกเรียกใช้ และเราสามารถส่งต่อในประเภทของการควบคุม ซึ่งเป็นปุ่มในทั้งสองกรณี
ga.reportEvent("Counter Gadget", "Increment", "Button"); ga.reportEvent("Counter Gadget", "Reset", "Button");
นี่เป็นตัวอย่างง่ายๆ แต่รูปแบบการติดตามกิจกรรมเป็นโครงสร้างที่มีความยืดหยุ่นสูง ซึ่งคุณสามารถปรับแต่งเพื่อให้ใช้ประโยชน์จากความต้องการติดตามเฉพาะของแกดเจ็ตของคุณ ดูข้อมูลเพิ่มเติมได้ในเอกสารการติดตามเหตุการณ์
วิธีการติดตาม
ปัจจุบันฟีเจอร์ของ Analytics ให้บริการเมธอดต่อไปนี้ ซึ่งจะกล่าวถึงการใช้งานข้างต้น
- reportPageview()
- ต้องระบุสตริงเพื่อป้อนข้อมูลรายงานเนื้อหาอย่างถูกต้อง โดยปกติแล้วสตริงนี้จะอยู่ในรูปแบบของเส้นทางที่คุณกำหนดเพื่อวัตถุประสงค์ในการรายงาน ระบบจะส่งค่าที่ส่งผ่านไปยังเมธอดนี้ในคำขอ
GIF
ผ่านตัวแปรutmp
ใช้วิธีนี้เพื่อติดตามการโหลดแกดเจ็ตและการโต้ตอบกับแกดเจ็ตga.reportPageview("/view/gadgetName");
parameters
String
path
เส้นทางที่จะระบุสำหรับ URL เสมือนขององค์ประกอบนี้
- reportEvent()
- ต้องระบุชื่อของแกดเจ็ตและพารามิเตอร์การกระทำเพื่อแทรกข้อมูลที่ติดตามลงในรายงานการติดตามเหตุการณ์อย่างถูกต้อง ส่วนพารามิเตอร์อื่นๆ นั้นจะระบุหรือไม่ก็ได้
ค่าที่ส่งผ่านเมธอดนี้จะส่งไปในมุมมองคำขอ
GIF
ที่ตัวแปรutme
Uparameters
String
name
ต้องระบุสตริงที่ใช้ที่ระดับบนสุดของรายงานการติดตามกิจกรรม ตัวอย่างเช่น ถ้าคุณกำลังติดตามการโต้ตอบของส่วนประกอบแกดเจ็ตจำนวนหนึ่ง คุณอาจใช้ชื่อของแกดเจ็ตนั้นเองสำหรับพารามิเตอร์นี้ เพื่อให้การติดตามการโต้ตอบทั้งหมดสำหรับแกดเจ็ตนั้นถูกรวมไว้ในส่วนเดียวกันของรายงาน Google Analytics
String
action
ต้องระบุ สตริงสำหรับแบ่งกลุ่มการโต้ตอบของแกดเจ็ตเพิ่มเติมในรายงานการติดตามเหตุการณ์ ดูข้อมูลเพิ่มเติมได้ในเอกสารการติดตามเหตุการณ์
String
label
ไม่บังคับ สตริงที่คุณสามารถใช้เป็นกลุ่มรองสำหรับแกดเจ็ตของคุณ
Int
value
ไม่บังคับ ตัวเลขที่คุณสามารถระบุเป็นค่าสำหรับการโต้ตอบกับแกดเจ็ต จำนวนนี้จะถูกรวมทุกครั้งที่มีการเรียกใช้เมธอด
ข้อควรพิจารณาเกี่ยวกับการใช้งาน
API แกดเจ็ตของ Google Analytics มีข้อควรพิจารณาเกี่ยวกับการใช้งานหลายประการดังนี้
- คอนเทนเนอร์ที่รองรับ
-
คอนเทนเนอร์หลายประเภทได้รับการสนับสนุนด้วย API ของ Google Analytics ซึ่งรวมถึงแต่ไม่จำกัดเพียงรายการต่อไปนี้
- iGoogle
- การเผยแพร่แบบเปิด
- Open Social
- แกดเจ็ต
- ประเภทแกดเจ็ตที่ไม่รองรับ
- Google Analytics
แกดเจ็ต API ไม่ สนับสนุนประเภทแกดเจ็ตต่อไปนี้
- แกดเจ็ตในบรรทัด
(type=html-inline)
- Mapplets
- แกดเจ็ตประเภท URL
(type-url)
- โฆษณาแกดเจ็ตบน Google AdSense
- แกดเจ็ตในบรรทัด
- ข้อควรพิจารณาเกี่ยวกับโดเมน
- เมื่อคุณต้องใช้ฟีเจอร์ Analytics สำหรับแกดเจ็ต แกดเจ็ตจะเปลี่ยนเส้นทางไปที่
<subdomain>.gmodules.com
โดยที่<subdomain>
เป็นโดเมนย่อยแบบสุ่มที่ไม่ซ้ำกัน ดังนั้น เนื้อหาทั้งหมดในแกดเจ็ตจึงปรากฏอยู่ในโดเมนย่อยนั้น ตัวอย่าง:3nvma227-a.gmodules.com
นอกจากนี้ คุกกี้ติดตามทั้งหมดของ Google Analytics จะได้รับการตั้งค่าเป็นโดเมนย่อยที่ไม่ซ้ำกันนี้ด้วย ด้วยเหตุผลนี้ คุณลักษณะการติดตามของ Analytics จึงไม่สนับสนุน แม็ปเล็ต และคุณต้องอนุญาตสิทธิ์พิเศษในการเข้าถึงเนื้อหา Flash ให้กับคุณลักษณะการติดตาม (ดูด้านล่าง) - แกดเจ็ตที่ใช้เนื้อหา Flash
- แกดเจ็ตที่ใช้เนื้อหา Flash ต้องเปิดใช้การสื่อสารระหว่าง URL ของ Flash กับ URL ของแกดเจ็ตโดยเฉพาะโดยการตั้งค่าพารามิเตอร์
allowScriptAccess
เป็น "เสมอ"_IG_EmbedFlash("example.swf", "wrapper", {allowScriptAccess: "always"});
เคล็ดลับ
วิธีที่ดีที่สุดในการใช้เมธอด URL เสมือน
ถ้าคุณไม่สามารถเข้าถึงวิธีการติดตามกิจกรรมสำหรับแกดเจ็ตของคุณ ให้ทำตามคำแนะนำต่อไปนี้ในการติดตามแกดเจ็ตของคุณด้วยเมธอด URL เสมือน:
- แบ่งกลุ่มการโหลดแกดเจ็ตของคุณอย่างชัดเจน
- คุณสามารถเรียกใช้
ga.reportPageview()
เมื่อโหลดแกดเจ็ตซึ่งมีเส้นทางที่จัดกลุ่มสถิติการโหลด/การดูแกดเจ็ตแยกจากเมตริกการโต้ตอบกับแกดเจ็ต วิธีนี้จะช่วยให้ข้อมูลการรายงานเนื้อหาของแกดเจ็ตอยู่ใน "ไดเรกทอรี" แยกต่างหากจากการโต้ตอบกับแกดเจ็ต เพื่อให้คุณสามารถดูมุมมองโดยรวมแยกจากจำนวนการโต้ตอบในแกดเจ็ตได้ ตัวอย่างเช่น คุณสามารถใช้ข้อมูลโค้ดต่อไปนี้ในแกดเจ็ตเพื่อแสดงสถิติทั้งหมดสำหรับการโหลดแกดเจ็ตของคุณ:ga.reportPageview('/view/gadgetName');
- แบ่งกลุ่มการโต้ตอบประเภทต่างๆ ออกจากกัน
- เรียกใช้
ga.reportPageview()
ด้วยเส้นทางที่แบ่งกลุ่มการโต้ตอบของผู้ใช้ออกเป็นกลุ่มต่างๆ ด้วยวิธีนี้ คุณสามารถรับการรายงานเนื้อหาแยกต่างหากสำหรับลิงก์แกดเจ็ต ปุ่มแกดเจ็ต หรือวิดเจ็ตอื่นๆ ที่คุณอาจต้องการติดตามข้อมูลการโต้ตอบ เช่นga.reportPageview('/link/click');
ga.reportPageview('/link/submit');
การใช้เมธอดการติดตามเหตุการณ์
หากมีสิทธิ์เข้าถึงฟีเจอร์การติดตามเหตุการณ์ในรายงาน Google Analytics คุณจะใช้ประโยชน์จากโมเดลข้อมูลที่มีความยืดหยุ่นสูงเพื่อรับประโยชน์สูงสุดจากการติดตามออบเจ็กต์ได้ มาดูเคล็ดลับบางส่วนกัน
- ติดตามการดูหรือการแสดงผลแกดเจ็ตโดยใช้
ga.reportPageview()
และติดตามการทำงานของแกดเจ็ตโดยใช้ga.reportEvent()
- มุมมองแกดเจ็ตจะแสดงในส่วนเนื้อหาสำหรับข้อมูลหน้าเว็บ และการโต้ตอบกับแกดเจ็ตจะปรากฏในส่วนเหตุการณ์ภายใต้รายงานเนื้อหา
- ใช้
document.referrer
เป็นพารามิเตอร์เพื่อดูว่าแกดเจ็ตวางอยู่ที่ตำแหน่งใด - ในแกดเจ็ต ปกติแล้ว
document.referrer
คือ URL ของหน้าคอนเทนเนอร์ คุณจึงสามารถส่ง URL นี้เป็นพารามิเตอร์ป้ายกำกับในเมธอดga.reportEvent()
ดังนี้
var containerPage = document.referrer; ga.reportEvent("Counter Gadget", "Increment", containerPage, 0);
การแก้ปัญหา
คุณสามารถใช้เครื่องมือของบุคคลที่สามในการวิเคราะห์สตริงคำขอ GIF สำหรับแกดเจ็ตของคุณ เพื่อยืนยันว่าข้อมูลจะส่งไปยังรายงาน Google Analytics ตามที่คุณคาดหวัง เมื่อคุณโฮสต์แกดเจ็ตอย่างถูกต้องและทำงานในหน้าทดสอบแล้ว ให้วิเคราะห์สตริงคำขอ GIF ดังนี้
- วิธีการดูหน้าเว็บ
- มองหาตัวแปร
utmp
ในพารามิเตอร์คำขอ GIF ข้อมูลที่เชื่อมโยงกับตัวแปรดังกล่าวคือสิ่งที่จะส่งไปยังรายงาน Google Analytics เป็น "เส้นทาง" สำหรับแกดเจ็ต - วิธีการติดตามเหตุการณ์
- มองหาตัวแปร UTM ในพารามิเตอร์คำขอ GIF ข้อมูลนี้ควรอยู่ในรูปแบบ
5(object*action*label)(value)
ดูข้อมูลเพิ่มเติมเกี่ยวกับการแก้ปัญหาโค้ดติดตามได้ที่คู่มือการแก้ปัญหาของ GATC