คิวคําสั่ง ga()
มีอินเทอร์เฟซสําหรับการดําเนินการเกือบทุกอย่างที่คุณต้องทําด้วยไลบรารี analytics.js
ข้อมูลโค้ดการติดตาม JavaScript กําหนดฟังก์ชันคิวคําสั่ง ga()
เริ่มต้นเพื่อให้ใช้ได้แม้ก่อนที่ไลบรารี analytics.js จะโหลดอย่างสมบูรณ์ ทันทีที่โหลดไลบรารี analytics.js ระบบจะดําเนินการกับรายการในคิวคําสั่งตามลําดับที่ได้รับ เมื่อดําเนินการเสร็จสิ้น ระบบจะใช้คําสั่งใหม่ที่พุชไปยังคิวทันที
เพื่อให้คิวข้อมูลมีขนาดเล็กที่สุด คิวคําสั่ง ga()
จะมีภาระงานมากเกินไปเพื่อยอมรับอาร์กิวเมนต์ในรูปแบบต่างๆ มากมาย เอกสารนี้แสดงรายละเอียดเกี่ยวกับวิธีการเรียกใช้ฟังก์ชันในคิวคําสั่ง ga()
แบบต่างๆ
ลายเซ็นของฟังก์ชัน | |
---|---|
ga(command, [...fields], [fieldsObject]) |
การเรียกใช้ฟังก์ชันคิวคําสั่ง |
ga(readyCallback) |
การเรียกใช้ฟังก์ชันคิวคําสั่ง เนื่องจากคําสั่งจะดําเนินการหลังจากที่ไลบรารี analytics.js โหลดเสร็จเรียบร้อยแล้วเท่านั้น สาเหตุที่พบบ่อยที่สุดในการข้ามคิวคําสั่งจึงทําให้ฟังก์ชันเป็นโค้ดเรียกกลับเมื่อมีการโหลดไลบรารี analytics.js |
การเพิ่มคําสั่งในคิว
การเรียกใช้ฟังก์ชันคิวคําสั่ง ga()
ด้วยลายเซ็นของฟังก์ชันต่อไปนี้จะพุชคําสั่งไปยังคิวเพื่อกําหนดเวลาสําหรับการดําเนินการเมื่อโหลดไลบรารีแล้ว
การใช้งาน
ga(command, [...fields], [fieldsObject])
พารามิเตอร์
ชื่อ | ประเภท | จำเป็น | คำอธิบาย | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
command |
string |
yes |
ตัวระบุที่แสดงคําสั่งที่จะเพิ่มลงในคิว ตัวระบุประกอบด้วย 3 ส่วน (2 ส่วนแรกไม่บังคับ) ได้แก่ [trackerName.][pluginName:]methodName
|
|||||||||
...fields |
* |
no | พารามิเตอร์ความสะดวกที่ไม่บังคับอย่างน้อย 1 รายการเพื่อระบุช่องทั่วไปได้อย่างรวดเร็ว จํานวนช่องข้อมูลที่ใช้ได้จะแตกต่างกันไปตามวิธีการใช้คําสั่ง | |||||||||
fieldsObject |
Object |
no |
ออบเจ็กต์สําหรับระบุค่าที่เหลือซึ่งไม่ได้ระบุในพารามิเตอร์ หากตั้งค่าช่องทั้งในพารามิเตอร์ |
ดูเอกสารประกอบของช่องแต่ละช่องได้ในข้อมูลอ้างอิงช่อง
ตัวอย่าง
ดูตัวอย่างคําสั่งแต่ละรายการได้ที่ส่วนเมธอดคําสั่งด้านล่าง
โค้ดเรียกกลับพร้อมใช้
การเรียกใช้ฟังก์ชันคิวคําสั่ง ga()
โดยการส่งฟังก์ชันจะทําให้กําหนดเวลาผ่านฟังก์ชันที่นําส่งแล้วในจุดถัดไปของคิว
เนื่องจากคําสั่งจะดําเนินการหลังจากที่ไลบรารี analytics.js โหลดเสร็จเรียบร้อยแล้วเท่านั้น สาเหตุที่พบบ่อยที่สุดในการข้ามคิวคําสั่งจึงทําให้ฟังก์ชันเป็นโค้ดเรียกกลับเมื่อมีการโหลดไลบรารี analytics.js
การใช้งาน
ga(readyCallback)
พารามิเตอร์
ชื่อ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
readyCallback |
Function |
yes |
ฟังก์ชันเรียกกลับที่จะเรียกใช้เมื่อไลบรารีโหลดอย่างสมบูรณ์และพร้อมโต้ตอบแล้ว มีการเรียกใช้ฟังก์ชันที่มีออบเจ็กต์เครื่องมือติดตามเริ่มต้นเป็นอาร์กิวเมนต์แรก หากไม่มีการสร้างเครื่องมือติดตามเริ่มต้น อาร์กิวเมนต์แรกคือ หมายเหตุ: เมื่อมีการเรียกใช้ฟังก์ชันเรียกกลับ เมธอดของออบเจ็กต์
|
ตัวอย่าง
// Queues a tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto'); // Once the tracker has been created, log the // client ID to the console. ga(function(tracker) { console.log(tracker.get('clientId')); });
// Queues a named tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker'); // When there is no default tracker, the first // argument of the ready callback is `undefined`. ga(function(tracker) { console.log(tracker); // Logs `undefined`. });
รายละเอียดเมธอดคําสั่ง
รายการต่อไปนี้คือรายการเมธอดทั้งหมดที่สามารถส่งไปยังคิวคําสั่งของ ga()
ได้ (ยกเว้นเมธอดของปลั๊กอิน)
create
สร้างอินสแตนซ์เครื่องมือติดตามใหม่ด้วยช่องที่ระบุ
การใช้งาน
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
พารามิเตอร์
ดูเอกสารประกอบของช่องแต่ละช่องได้ในข้อมูลอ้างอิงช่อง
การคืนสินค้า
undefined
ตัวอย่าง
// Creates a default tracker for the Property UA-XXXXX-Y // and uses automatic cookie domain configuration. ga('create', 'UA-XXXXX-Y', 'auto');
// Creates a tracker with the name "myTracker" for the Property // UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies // a transport mechanism of "beacon". ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', { transport: 'beacon' });
send
ส่ง Hit ไปยัง Google Analytics
การใช้งาน
ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);
ช่องที่ส่งคือค่าที่ระบุไว้ในพารามิเตอร์ ...fields
และ fieldsObject
ซึ่งผสานอยู่กับช่องที่เก็บไว้ในเครื่องมือติดตาม
พารามิเตอร์
ช่องที่ระบุโดยพารามิเตอร์ ...fields
จะแตกต่างกันไปตามประเภท Hit ตารางต่อไปนี้จะแสดงช่องที่สอดคล้องกับ Hit แต่ละประเภท ประเภท Hit ที่ไม่อยู่ในรายการไม่ยอมรับพารามิเตอร์ ...fields
แต่มีเฉพาะ fieldsObject
ประเภท Hit | ...fields |
---|---|
pageview |
page |
event |
eventCategory , eventAction , eventLabel , eventValue |
social |
socialNetwork , socialAction , socialTarget |
timing |
timingCategory , timingVar , timingValue , timingLabel |
ดูเอกสารประกอบของช่องแต่ละช่องได้ในข้อมูลอ้างอิงช่อง
การคืนสินค้า
undefined
ตัวอย่าง
// Sends a pageview hit. ga('send', 'pageview');
// Sends an event hit for the tracker named "myTracker" with the // following category, action, and label, and sets the nonInteraction // field value to true. ga('send', 'event', 'link', 'click', 'http://example.com', { nonInteraction: true });
set
ตั้งค่าคู่ของช่องและคู่ค่าหรือกลุ่มคู่ของช่อง/ค่าในออบเจ็กต์เครื่องมือติดตาม
การใช้งาน
// Sets a single field and value. ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs. ga('[trackerName.]set', fieldsObject);
พารามิเตอร์
ดูเอกสารประกอบของช่องแต่ละช่องได้ในข้อมูลอ้างอิงช่อง
การคืนสินค้า
undefined
ตัวอย่าง
// Sets the page field to "/about.html". ga('set', 'page', '/about.html');
// Sets the page field to "/about.html" and the title to "About". ga('set', { page: '/about.html', title: 'About' });
require
ต้องใช้ปลั๊กอิน analytics.js
การใช้งาน
ga('[trackerName.]require', pluginName, [pluginOptions]);
พารามิเตอร์
ชื่อ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
pluginName |
string |
yes | ชื่อของปลั๊กอินที่จะต้องระบุ หมายเหตุ: หากปลั๊กอินดังกล่าวไม่ใช่ปลั๊กอินอย่างเป็นทางการของ analytics.js คุณจะต้องระบุปลั๊กอินดังกล่าวไว้ที่อื่นในหน้าเว็บ |
pluginOptions |
Object |
no | ออบเจ็กต์เริ่มต้นที่จะส่งไปยังเครื่องมือสร้างปลั๊กอินเมื่อเริ่มต้น |
การคืนสินค้า
undefined
ตัวอย่าง
// Requires the Enhanced Ecommerce plugin. ga('require', 'ec');
// Requires the Advertising Features plugin // named "myTracker" and override its default cookie name. ga('myTracker.require', 'displayfeatures', { cookieName: 'display_features_cookie' });
provide
มีปลั๊กอิน analytics.js และวิธีการใช้กับคิวคําสั่ง ga()
ga('provide', pluginName, pluginConstuctor);
พารามิเตอร์
ชื่อ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
pluginName |
string |
yes | ชื่อปลั๊กอินที่จะระบุ ชื่อที่ใช้ต้องเป็นชื่อเดียวกับการเรียก require ทั้งหมด |
pluginConstuctor |
Function |
yes | ตัวสร้างจะระบุตรรกะและวิธีการปลั๊กอินทั้งหมด ระบบจะเรียกใช้เครื่องมือสร้างนี้โดยมีออบเจ็กต์ pluginsOptions ที่ระบุในเมธอด require |
ตัวอย่าง
// Defines a plugin constructor function MyPlugin(tracker, options) { // ... } // Provides the plugin for use with the ga() command queue. ga('provide', 'myplugin', MyPlugin);
remove
นําออบเจ็กต์เครื่องมือติดตามออก
การใช้งาน
ga('[trackerName.]remove');
ตัวอย่าง
// Remove the default tracker. ga('remove');
// Remove the tracker named "myTracker". ga('myTracker.remove');