การอ้างอิงคิวคำสั่ง ga

คิวคำสั่ง ga() มีอินเทอร์เฟซสำหรับทำสิ่งต่างๆ ในไลบรารี analytics.js เกือบทุกอย่าง

ข้อมูลโค้ดการติดตาม JavaScript กำหนดฟังก์ชันของคิวคำสั่ง ga() เริ่มต้น ดังนั้นจึงสามารถใช้งานได้ก่อนที่ไลบรารี analytics.js จะโหลดโดยสมบูรณ์ ทันทีที่ไลบรารี analytics.js โหลดเสร็จ รายการต่างๆ ในคิวคำสั่งจะถูกดำเนินการตามลำดับที่ได้รับ เมื่อเพิ่มแล้ว คำสั่งใหม่ที่พุชเข้าไปในคิวจะทำงานทันที

ระบบจะมีการโหลดคิวคำสั่ง ga() มากเกินไปสำหรับยอมรับอาร์กิวเมนต์ในรูปแบบต่างๆ เพื่อให้ตัวอย่างข้อมูลติดตามมีขนาดเล็กที่สุด เอกสารนี้แสดงรายละเอียดวิธีต่างๆ ทั้งหมดที่เรียกใช้ฟังก์ชันคิวคำสั่ง ga() ได้

ลายเซ็นของฟังก์ชัน
ga(command, [...fields], [fieldsObject])

การเรียกใช้ฟังก์ชันคิวคำสั่ง ga() ที่มีลายเซ็นของฟังก์ชันต่อไปนี้จะพุชคำสั่งลงในคิวเพื่อกำหนดเวลาการดำเนินการเมื่อไลบรารีโหลดขึ้น
ga(readyCallback)

การเรียกใช้ฟังก์ชันคิวคำสั่ง ga() โดยการส่งฟังก์ชันจะเป็นการกำหนดเวลาให้ฟังก์ชันที่ส่งผ่านเพื่อดำเนินการในจุดถัดไปในคิว

เนื่องจากระบบจะดำเนินการคำสั่งหลังจากที่ไลบรารี analytics.js โหลดจนเสร็จสมบูรณ์แล้วเท่านั้น สาเหตุที่พบบ่อยที่สุดในการส่งคิวคำสั่งให้กับฟังก์ชันจึงเป็นการเรียกกลับเมื่อไลบรารี analytics.js โหลดและพร้อมใช้งาน

การเพิ่มคำสั่งลงในคิว

การเรียกใช้ฟังก์ชันคิวคำสั่ง ga() ที่มีลายเซ็นของฟังก์ชันต่อไปนี้จะพุชคำสั่งลงในคิวเพื่อกำหนดเวลาการดำเนินการเมื่อไลบรารีโหลดขึ้น

การใช้งาน

ga(command, [...fields], [fieldsObject])

พารามิเตอร์

ชื่อ ประเภท จำเป็น คำอธิบาย
command string ใช่

ตัวระบุที่แสดงคำสั่งที่จะเพิ่มลงในคิว ตัวระบุประกอบด้วย 3 ส่วน (2 ส่วนแรกเป็นตัวเลือกที่ไม่บังคับ) ดังนี้

[trackerName.][pluginName:]methodName
trackerName ชื่อของเครื่องมือติดตามที่จะเรียกใช้คำสั่งที่กำหนดเวลาไว้ หากไม่ได้ระบุชื่อเครื่องมือติดตามไว้ ระบบจะเรียกใช้คำสั่งในอุปกรณ์ติดตามเริ่มต้น
pluginName ชื่อของปลั๊กอิน analytics.js ที่ต้องระบุ หากระบุ pluginName แล้ว methodName ต้องเป็นเมธอดที่ปลั๊กอินระบุไว้
methodName ชื่อของเมธอดที่จะตั้งเวลาสำหรับการดำเนินการ เมื่อไม่ได้ระบุชื่อปลั๊กอิน เมธอดนี้ต้องเป็นเมธอดคำสั่งอย่างใดอย่างหนึ่งที่แสดงด้านล่าง
...fields * ไม่ พารามิเตอร์อำนวยความสะดวก (ไม่บังคับ) อย่างน้อย 1 รายการเพื่อระบุช่องทั่วไปได้อย่างรวดเร็ว จำนวนช่องและบางช่องที่อนุญาตจะแตกต่างกันไปขึ้นอยู่กับเมธอดคำสั่งที่เรียกใช้
fieldsObject Object ไม่

ออบเจ็กต์สำหรับระบุค่าที่เหลือที่ไม่ได้ระบุไว้ในพารามิเตอร์ fields

หากตั้งค่าช่องทั้งในพารามิเตอร์ fields และ fieldsObject ระบบจะใช้ค่าใน fieldsObject

โปรดดูข้อมูลอ้างอิงของช่องสำหรับเอกสารประกอบแต่ละช่อง

ตัวอย่าง

โปรดดูตัวอย่างคำสั่งแต่ละรายการในส่วนเมธอดคำสั่งด้านล่าง

พร้อมติดต่อกลับ

การเรียกใช้ฟังก์ชันคิวคำสั่ง ga() โดยการส่งฟังก์ชันจะเป็นการกำหนดเวลาให้ฟังก์ชันที่ส่งผ่านเพื่อดำเนินการในจุดถัดไปในคิว

เนื่องจากระบบจะดำเนินการคำสั่งหลังจากที่ไลบรารี analytics.js โหลดจนเสร็จสมบูรณ์แล้วเท่านั้น สาเหตุที่พบบ่อยที่สุดในการส่งคิวคำสั่งให้กับฟังก์ชันจึงเป็นการเรียกกลับเมื่อไลบรารี analytics.js โหลดและพร้อมใช้งาน

การใช้งาน

ga(readyCallback)

พารามิเตอร์

ชื่อ ประเภท จำเป็น คำอธิบาย
readyCallback Function ใช่

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

หมายเหตุ: เมื่อมีการเรียกใช้ฟังก์ชันเรียกกลับ เมธอดออบเจ็กต์ ga รายการทั้งหมดจะพร้อมให้ใช้งาน

ตัวอย่าง

// 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 ใช่ ชื่อของปลั๊กอินที่จำเป็นต้องระบุ หมายเหตุ: หากปลั๊กอินไม่ใช่ปลั๊กอิน analytics.js อย่างเป็นทางการ คุณจะต้องระบุปลั๊กอินไว้ที่อื่นในหน้า
pluginOptions Object ไม่ ออบเจ็กต์การเริ่มต้นที่จะส่งไปยังตัวสร้างปลั๊กอินเมื่อมีการทำอินสแตนซ์

การคืนสินค้า

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 ใช่ ชื่อของปลั๊กอินที่ระบุ ชื่อที่ใช้ต้องเป็นชื่อเดียวกับที่การเรียก require ใช้
pluginConstuctor Function ใช่ ตัวสร้างฟังก์ชันจะให้ตรรกะและเมธอดของปลั๊กอินทั้งหมด ระบบจะเรียกใช้ตัวสร้างนี้ด้วยออบเจ็กต์ 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');