การอ้างอิงคอมโพเนนต์ในตัว

เอกสารนี้จะอธิบายตัวเลือก เมธอด พร็อพเพอร์ตี้ และเหตุการณ์สำหรับคอมโพเนนต์ เปิดใช้ API ในตัวทั้งหมด

การตรวจสอบสิทธิ์

gapi.analytics.auth

คอมโพเนนต์การตรวจสอบสิทธิ์คือ Singleton ที่สามารถใช้เพื่อให้สิทธิ์ผู้ใช้

วิธีการ
authorize(options:Object)	การคืนสินค้า:  gapi.analytics.auth แสดงปุ่มลงชื่อเข้าใช้ Google Analytics ภายในคอนเทนเนอร์ที่ระบุเพื่อให้ผู้ใช้ลงชื่อเข้าใช้ด้วยบัญชี Google ได้
isAuthorized()	การคืนสินค้า:  boolean แสดงผล true หากผู้ใช้อนุญาตเรียบร้อยแล้ว หากไม่ใช่ false
signOut()	การคืนสินค้า:  gapi.analytics.auth นำผู้ใช้ออกจากระบบ และจะทริกเกอร์เหตุการณ์ signOut ด้วย
getAuthResponse()	การคืนสินค้า:  Object รับข้อมูลการตรวจสอบสิทธิ์ที่ส่งคืนโดยคำขอการให้สิทธิ์เดิม ออบเจ็กต์ที่แสดงผลมีโทเค็นเพื่อการเข้าถึง ซึ่งมักสามารถทำเพื่อส่งคำขอที่ผ่านการตรวจสอบสิทธิ์ด้วยตนเองได้
getUserProfile()	การคืนสินค้า:  Object รับข้อมูลโปรไฟล์พื้นฐานเกี่ยวกับผู้ใช้ที่ลงชื่อเข้าใช้อยู่ในขณะนี้ ซึ่งรวมถึงชื่อ อีเมล และภาพโปรไฟล์สาธารณะของผู้ใช้ (หากตั้งค่าไว้)

วิธีการที่รับช่วงมา
on
once
off

ตัวเลือก
clientId	ประเภท:  string รหัสไคลเอ็นต์ของโปรเจ็กต์ใน คอนโซลของนักพัฒนาซอฟต์แวร์
container	ประเภท:  string|HTMLElement รหัสขององค์ประกอบ HTML ใน DOM ที่จะโฮสต์ปุ่มลงชื่อเข้าใช้ นอกจากนี้ คุณยังส่งผ่านการอ้างอิงไปยังองค์ประกอบได้อีกด้วย
userInfoLabel	ประเภท:  string ข้อความที่จะแสดงก่อนที่อยู่อีเมลของผู้ใช้ที่เข้าสู่ระบบ ค่าเริ่มต้นคือ 'You are logged in as: '
scopes	ประเภท:  Array รายการขอบเขตการตรวจสอบสิทธิ์ Google API ที่แอปพลิเคชันของคุณกำลังขอ หากต้องการดูขอบเขตที่ใช้ได้ทั้งหมด ให้ไปที่ OAuth 2.0 Playground สำหรับขอบเขตการตรวจสอบสิทธิ์ Google Analytics API โปรดดูคู่มือนักพัฒนาซอฟต์แวร์เกี่ยวกับทรัพยากรการกำหนดค่าและการรายงาน
overwriteDefaultScopes	ประเภท:  boolean ระบุว่าตัวเลือก scopes จะแทนที่ขอบเขต API ฝังเริ่มต้นหรือเพิ่มขอบเขต การระบุ false (ค่าเริ่มต้น) จะเพิ่มไปยังขอบเขตเริ่มต้น และการระบุ true จะแทนที่ขอบเขตดังกล่าวด้วยขอบเขตที่ระบุโดยตัวเลือก scopes ค่าขอบเขตเริ่มต้นคือ ['https://www.googleapis.com/auth/analytics.readonly'] หมายเหตุ: การตรวจสอบสิทธิ์ผ่าน API ที่ฝังจะต้องมีสิทธิ์เข้าถึงโปรไฟล์พื้นฐานของผู้ใช้ ขอบเขตเหล่านั้นไม่สามารถเขียนทับได้
serverAuth.access_token	ประเภท:  string หากมีโทเค็นเพื่อการเข้าถึงที่ถูกต้องอยู่แล้ว คุณสามารถส่งโทเค็นดังกล่าวไปยังวิธีการให้สิทธิ์ได้โดยตรง โดยผู้ใช้จะไม่ได้รับข้อความแจ้งให้ให้สิทธิ์ โปรดดูรายละเอียดเกี่ยวกับวิธีเรียกโทเค็นเพื่อการเข้าถึงในเอกสารประกอบเกี่ยวกับ OAuth 2.0

กิจกรรม
signIn	อาร์กิวเมนต์: ไม่มี เริ่มทำงานเมื่อผู้ใช้ลงชื่อเข้าใช้สำเร็จ
signOut	อาร์กิวเมนต์: ไม่มี เริ่มทำงานเมื่อผู้ใช้ออกจากระบบเรียบร้อยแล้ว
needsAuthorization	อาร์กิวเมนต์: ไม่มี เมื่อเรียกใช้เมธอด gapi.analytics.auth.authorize ระบบจะตรวจสอบเบื้องต้นว่าผู้ใช้ลงชื่อเข้าใช้อยู่หรือไม่ หากผู้ใช้ไม่ได้ลงชื่อเข้าใช้ เหตุการณ์จะเริ่มทำงานเพื่อระบุว่าต้องมีการให้สิทธิ์เพิ่มเติม
error	อาร์กิวเมนต์:  response เริ่มทำงานเมื่อเกิดข้อผิดพลาดระหว่างขั้นตอนการตรวจสอบสิทธิ์ หากคุณต้องการรับข้อความแสดงข้อผิดพลาดจากออบเจ็กต์การตอบกลับ ข้อความจะอยู่ที่ response.error.message

เหตุการณ์ที่เลิกใช้งานแล้ว
success	อาร์กิวเมนต์:  response เหตุการณ์นี้มีไว้เพื่อความเข้ากันได้แบบย้อนหลังและอาจถูกนำออกในเวอร์ชันในอนาคต โปรดใช้เหตุการณ์ signIn แทน

ตัวอย่าง

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});

// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

หมายเหตุ: การให้สิทธิ์จะเกิดขึ้นทันทีเมื่อใช้ serverAuth.access_token จึงไม่จำเป็นต้องลงทะเบียนเครื่องจัดการเหตุการณ์

สำคัญ: เมื่อใช้ serverAuth.access_token คุณต้องตรวจสอบว่าโทเค็นถูกต้องและไม่หมดอายุ โปรดดูรายละเอียดเกี่ยวกับวิธีรีเฟรชโทเค็นเพื่อการเข้าถึงที่หมดอายุแล้วในเอกสารประกอบของ OAuth 2.0

ข้อมูล

gapi.analytics.report.Data

ผู้ผลิต
Data(options:Object)	คอมโพเนนต์ข้อมูลช่วยให้คุณค้นหา Core Reporting API ของ Google Analytics และ รับผลลัพธ์กลับมาได้

ตัวเลือก
query	ประเภท:  Object ออบเจ็กต์ที่มี พารามิเตอร์การค้นหาจาก Core Reporting API ระบบจะใช้ค่าเริ่มต้นต่อไปนี้นอกเหนือจากค่าเริ่มต้นปกติที่ API มีให้ { 'start-date': '7daysAgo', 'end-date': 'yesterday }

วิธีการที่รับช่วงมา
get
set
execute
on
once
off
emit

กิจกรรม
success	อาร์กิวเมนต์:  response เริ่มทำงานเมื่อการค้นหาเสร็จสมบูรณ์
error	อาร์กิวเมนต์:  response เริ่มทำงานเมื่อเกิดข้อผิดพลาดระหว่างกระบวนการค้นหา หากคุณต้องการรับข้อความแสดงข้อผิดพลาดจากออบเจ็กต์การตอบกลับ ข้อความจะอยู่ที่ response.error.message

ตัวอย่าง

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

DataChart

gapi.analytics.googleCharts.DataChart

ผู้ผลิต
DataChart(options:Object)	DataChart จะรวมแผนภูมิ Google มาตรฐานและองค์ประกอบข้อมูลเพื่อให้คุณสร้างการแสดงภาพจากคำค้นหาได้อย่างง่ายดายโดยไม่ต้องต่อสายเข้าด้วยกัน

ตัวเลือก
query	ประเภท:  Object ดูตัวเลือกการค้นหาคอมโพเนนต์ข้อมูล
chart	ประเภท:  Object โปรดดูรายละเอียดตัวเลือกแผนภูมิแต่ละรายการด้านล่าง
chart.container	ประเภท:  string|HTMLElement รหัสขององค์ประกอบ HTML ใน DOM ที่จะโฮสต์ DataChart นอกจากนี้ คุณยังส่งผ่านการอ้างอิงไปยังองค์ประกอบได้อีกด้วย
chart.type	ประเภท:  string ประเภทของแผนภูมิ ตัวเลือกที่เป็นไปได้คือ LINE, COLUMN, BAR, TABLE และ GEO
chart.options	ประเภท:  Object ตัวเลือกใดๆ ที่สามารถส่งไปยังออบเจ็กต์ Google แผนภูมิ ที่เกี่ยวข้อง

วิธีการที่รับช่วงมา
get
set
execute
on
once
off
emit

กิจกรรม
success	อาร์กิวเมนต์:  result เริ่มทำงานเมื่อการค้นหาเสร็จสมบูรณ์และแผนภูมิแสดงผลอย่างสมบูรณ์แล้ว result.chart – อินสแตนซ์ของ Google Chart result.data – การตอบกลับรายงานในรูปแบบพารามิเตอร์ข้อมูล result.dataTable – อินสแตนซ์ DataTable ที่สร้างจากออบเจ็กต์ result.data result.response – ออบเจ็กต์การตอบกลับ API ดิบ
error	อาร์กิวเมนต์:  response เริ่มทำงานเมื่อเกิดข้อผิดพลาดระหว่างกระบวนการค้นหาหรือการแสดงผล หากคุณต้องการรับข้อความแสดงข้อผิดพลาดจากออบเจ็กต์การตอบกลับ ข้อความจะอยู่ที่ response.error.message

ตัวอย่าง

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

ViewSelector

gapi.analytics.ViewSelector

ผู้ผลิต
ViewSelector(options:Object)	คอมโพเนนต์ ViewSelector ช่วยให้คุณเลือกบัญชี พร็อพเพอร์ตี้ และข้อมูลพร็อพเพอร์ตี้ผ่านเมนูแบบเลื่อนลงได้

ตัวเลือก
container	ประเภท:  string|HTMLElement รหัสขององค์ประกอบ HTML ใน DOM ที่จะโฮสต์ ViewSelector นอกจากนี้ คุณยังส่งผ่านการอ้างอิงไปยังองค์ประกอบได้อีกด้วย

วิธีการที่รับช่วงมา
get
set
execute
on
once
off
emit

พร็อพเพอร์ตี้ของอินสแตนซ์
ids	ประเภท:  string รหัสตารางที่ไม่ซ้ำของแบบฟอร์ม ga:XXXX โดยที่ XXXX คือรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ของ Analytics

กิจกรรม
change	อาร์กิวเมนต์:  ids เริ่มทำงานทุกครั้งที่ผู้ใช้เลือกมุมมองใหม่จากเมนูแบบเลื่อนลง นอกจากนี้ เหตุการณ์ยังจะเริ่มทำงานเมื่ออินสแตนซ์ ViewSelector แสดงผลเป็นครั้งแรก และแสดงมุมมองเริ่มต้น

ตัวอย่าง

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

เมธอดคอมโพเนนต์ที่ใช้ร่วมกัน

วิธีการ
set(options)	การคืนสินค้า: this ตั้งค่าหรืออัปเดตตัวเลือกการกำหนดค่าของคอมโพเนนต์ (หรือดำเนินการในเวลาที่สร้างในตัวสร้างก็ได้เช่นกัน)
get()	การคืนสินค้า: Object แสดงผลตัวเลือกการกำหนดค่าปัจจุบันของคอมโพเนนต์
execute()	การคืนสินค้า: this เรียกใช้การดำเนินการหลักของคอมโพเนนต์ ซึ่งมักจะแสดงผลบางอย่างบนหน้าเว็บหรือเรียกใช้รายงาน (หรือทั้ง 2 อย่าง)
on(event, handler)	การคืนสินค้า: this ลงทะเบียนฟังก์ชันที่จะเรียกใช้เมื่อคอมโพเนนต์ปล่อยเหตุการณ์ที่ระบุ
once(event, handler)	การคืนสินค้า: this ลงทะเบียนฟังก์ชันที่จะเรียกใช้เมื่อเกิดเหตุการณ์ที่ระบุในครั้งถัดไปเท่านั้น หลังจากที่เครื่องจัดการจะทำงานเมื่อตัวแฮนเดิลยกเลิกการลงทะเบียนตัวเองโดยอัตโนมัติ
off(opt_event, opt_handler)	การคืนสินค้า: undefined นำเครื่องจัดการเหตุการณ์ออกจากคอมโพเนนต์ หากไม่มีตัวแฮนเดิลที่ส่งผ่าน ระบบจะนำตัวแฮนเดิลทั้งหมดของเหตุการณ์ที่ส่งผ่านออก หากไม่มีการผ่านเหตุการณ์ ระบบจะนำตัวแฮนเดิลทั้งหมดสำหรับเหตุการณ์ทั้งหมดออก
emit(event, ...opt_args)	การคืนสินค้า: undefined ส่งเหตุการณ์ คุณอาจระบุอาร์กิวเมนต์ที่จะส่งไปยังตัวแฮนเดิลที่ลงทะเบียนใดก็ได้

set

ตั้งค่าหรืออัปเดตตัวเลือกการกำหนดค่าของคอมโพเนนต์ (หรือดำเนินการในเวลาที่สร้างในตัวสร้างก็ได้เช่นกัน)

การใช้งาน

component.set(options);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
options	Object	ตัวเลือกการกำหนดค่าสำหรับคอมโพเนนต์นี้ ตัวเลือก "ที่ผ่าน" จะรวมเข้ากับตัวเลือกที่มีอยู่

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

this – อินสแตนซ์ของคอมโพเนนต์

---

get

แสดงผลตัวเลือกการกำหนดค่าปัจจุบันของคอมโพเนนต์

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

Object – ตัวเลือกการกำหนดค่าปัจจุบันของคอมโพเนนต์

---

execute()

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

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

this – อินสแตนซ์ของคอมโพเนนต์

---

on(event, handler)

ลงทะเบียนฟังก์ชันที่จะเรียกใช้เมื่อคอมโพเนนต์ปล่อยเหตุการณ์ที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
event	string	ชื่อเหตุการณ์
handler	Function	ฟังก์ชันที่จะเรียกใช้เมื่อเหตุการณ์เกิดขึ้น (ดูรายละเอียดพารามิเตอร์แต่ละรายการได้ในการอ้างอิงเหตุการณ์แต่ละรายการ)

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

this – อินสแตนซ์ของคอมโพเนนต์

---

once(event, handler)

ลงทะเบียนฟังก์ชันที่จะเรียกใช้เมื่อเกิดเหตุการณ์ที่ระบุในครั้งถัดไปเท่านั้น หลังจากที่เครื่องจัดการจะทำงานเมื่อตัวแฮนเดิลยกเลิกการลงทะเบียนตัวเองโดยอัตโนมัติ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
event	string	ชื่อเหตุการณ์
handler	Function	ฟังก์ชันที่จะเรียกใช้เมื่อเหตุการณ์เกิดขึ้น (ดูรายละเอียดพารามิเตอร์แต่ละรายการได้ในการอ้างอิงเหตุการณ์แต่ละรายการ)

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

this – อินสแตนซ์ของคอมโพเนนต์

---

off(opt_event, opt_handler)

นำเครื่องจัดการเหตุการณ์ออกจากคอมโพเนนต์ หากไม่มีตัวแฮนเดิลที่ส่งผ่าน ระบบจะนำตัวแฮนเดิลทั้งหมดของเหตุการณ์ที่ส่งผ่านออก หากไม่มีการผ่านเหตุการณ์ ระบบจะนำตัวแฮนเดิลทั้งหมดสำหรับเหตุการณ์ทั้งหมดออก

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
opt_event	string	ชื่อเหตุการณ์ หากไม่มีการระบุเหตุการณ์ ระบบจะนำเครื่องจัดการทั้งหมดสำหรับเหตุการณ์ทั้งหมดออก ไม่บังคับ
opt_handler	Function	การอ้างอิงตัวแฮนเดิลฟังก์ชันที่จะนำออก หากไม่มีการส่งฟังก์ชันเลย ระบบจะนำตัวแฮนเดิลทั้งหมดออก ไม่บังคับ

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

undefined

---

emit(event, ...opt_args)

ส่งเหตุการณ์ คุณอาจระบุอาร์กิวเมนต์ที่จะส่งไปยังตัวแฮนเดิลที่ลงทะเบียนใดก็ได้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
event	string	ชื่อเหตุการณ์
...opt_args	*	อาร์กิวเมนต์ที่ไม่บังคับที่จะส่งไปยังเครื่องจัดการเหตุการณ์ที่ลงทะเบียน

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

undefined