API Reference

การอ้างอิง API นี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแต่ละประเภทมีการนำเสนอข้อมูลอย่างน้อย 1 รายการและมีวิธีอย่างน้อย 1 วิธี

ประเภททรัพยากร

  1. บัญชี
  2. ตัวแปรบิวท์อิน
  3. ไคลเอ็นต์
  4. คอนเทนเนอร์
  5. ปลายทาง
  6. สภาพแวดล้อม
  7. โฟลเดอร์
  8. การกำหนดค่าแท็ก Google
  9. แท็ก
  10. เทมเพลต
  11. การเปลี่ยนรูปแบบ
  12. ทริกเกอร์
  13. สิทธิ์ของผู้ใช้
  14. ตัวแปร
  15. ส่วนหัวของเวอร์ชัน
  16. เวอร์ชัน
  17. พื้นที่ทำงาน
  18. โซน

บัญชี

สำหรับรายละเอียดทรัพยากรบัญชี โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
รับ GET  /path รับบัญชี GTM
list GET  /accounts แสดงบัญชี GTM ทั้งหมดที่ผู้ใช้มีสิทธิ์เข้าถึง
อัปเดต PUT  /path อัปเดตบัญชี GTM

ตัวแปรบิวท์อิน

โปรดดูรายละเอียดทรัพยากรตัวแปรบิวท์อินในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/built_in_variables สร้างตัวแปรบิวท์อิน GTM อย่างน้อย 1 รายการ
ลบ DELETE  /path ลบตัวแปรบิวท์อิน GTM อย่างน้อย 1 รายการ
list GET  /+parent/built_in_variables แสดงรายการตัวแปรบิวท์อินที่เปิดใช้ทั้งหมดของคอนเทนเนอร์ GTM
revert POST  /+path/built_in_variables:revert ยกเลิกการเปลี่ยนแปลงเป็นตัวแปรบิวท์อิน GTM ในพื้นที่ทำงานของ GTM

ในนามของลูกค้า

สำหรับรายละเอียดทรัพยากรของไคลเอ็นต์ โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/clients สร้างไคลเอ็นต์ GTM
ลบ DELETE  /path ลบไคลเอ็นต์ GTM
รับ GET  /path รับไคลเอ็นต์ GTM
list GET  /+parent/clients แสดงรายการไคลเอ็นต์ GTM ทั้งหมดของพื้นที่ทำงานคอนเทนเนอร์ GTM
revert POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงเป็นไคลเอ็นต์ GTM ใน GTM Workspace
อัปเดต PUT  /path อัปเดตไคลเอ็นต์ GTM

คอนเทนเนอร์

สำหรับรายละเอียดทรัพยากรคอนเทนเนอร์ โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
combine POST  /+path:combine รวมคอนเทนเนอร์
สร้าง POST  /+parent/containers สร้างคอนเทนเนอร์
ลบ DELETE  /path ลบคอนเทนเนอร์
รับ GET  /path รับคอนเทนเนอร์
list GET  /+parent/containers แสดงรายการคอนเทนเนอร์ทั้งหมดที่เป็นของบัญชี GTM
ค้นหา GET  /accounts/containers:lookup ค้นหาคอนเทนเนอร์ตามรหัสปลายทาง
move_tag_id POST  /+path:move_tag_id ย้ายรหัสแท็กออกจากคอนเทนเนอร์
ตัวอย่างข้อมูล GET  /+path:snippet รับข้อมูลโค้ดการติดแท็กสำหรับคอนเทนเนอร์
อัปเดต PUT  /path อัปเดตคอนเทนเนอร์

จุดหมาย

โปรดดูรายละเอียดทรัพยากรปลายทางในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
รับ GET  /path รับจุดหมาย
link POST  /+parent/destinations:link เพิ่มปลายทางไปยังคอนเทนเนอร์นี้ และนำออกจากคอนเทนเนอร์ที่ลิงก์อยู่ในปัจจุบัน
list GET  /+parent/destinations แสดงปลายทางทั้งหมดที่ลิงก์กับคอนเทนเนอร์ GTM

สภาพแวดล้อม

สำหรับรายละเอียดทรัพยากรสภาพแวดล้อม โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/environments สร้างสภาพแวดล้อม GTM
ลบ DELETE  /path ลบสภาพแวดล้อม GTM
รับ GET  /path รับสภาพแวดล้อม GTM
list GET  /+parent/environments แสดงสภาพแวดล้อม GTM ทั้งหมดของคอนเทนเนอร์ GTM
ให้สิทธิ์อีกครั้ง POST  /+path:reauthorize สร้างรหัสการให้สิทธิ์สำหรับสภาพแวดล้อม GTM อีกครั้ง
อัปเดต PUT  /path อัปเดตสภาพแวดล้อม GTM

โฟลเดอร์

สำหรับรายละเอียดของทรัพยากรโฟลเดอร์ โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/folders สร้างโฟลเดอร์ GTM
ลบ DELETE  /path ลบโฟลเดอร์ GTM
เอนทิตี POST  /+path:entities แสดงรายการเอนทิตีทั้งหมดในโฟลเดอร์ GTM
รับ GET  /path รับโฟลเดอร์ GTM
list GET  /+parent/folders แสดงรายการโฟลเดอร์ GTM ทั้งหมดของคอนเทนเนอร์
move_entities_to_folder POST  /+path:move_entities_to_folder ย้ายเอนทิตีไปยังโฟลเดอร์ GTM ถ้า {folder_id} ในเส้นทางคำขอเท่ากับ 0 จะเป็นการย้ายเอนทิตีออกจากโฟลเดอร์ที่อยู่ในปัจจุบันแทน
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงไปยังโฟลเดอร์ GTM ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดตโฟลเดอร์ GTM

การกำหนดค่าแท็ก Google

ดูรายละเอียดทรัพยากรการกำหนดค่าแท็ก Google ได้ที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/gtag_config สร้างการกําหนดค่าแท็ก Google
ลบ DELETE  /path ลบการกําหนดค่าแท็ก Google
รับ GET  /path รับการกําหนดค่าแท็ก Google
list GET  /+parent/gtag_config แสดงการกําหนดค่าแท็ก Google ทั้งหมดในคอนเทนเนอร์
อัปเดต PUT  /path อัปเดตการกําหนดค่าแท็ก Google

แท็ก

โปรดดูรายละเอียดทรัพยากรแท็กในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/tags สร้างแท็ก GTM
ลบ DELETE  /path ลบแท็ก GTM
รับ GET  /path รับแท็ก GTM
list GET  /+parent/tags แสดงรายการแท็ก GTM ทั้งหมดของคอนเทนเนอร์
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงไปยังแท็ก GTM ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดตแท็ก GTM

เทมเพลต

สำหรับรายละเอียดทรัพยากรเทมเพลต โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/templates สร้างเทมเพลตที่กำหนดเองของ GTM
ลบ DELETE  /path ลบเทมเพลต GTM
รับ GET  /path รับเทมเพลต GTM
list GET  /+parent/templates แสดงเทมเพลต GTM ทั้งหมดของพื้นที่ทำงานคอนเทนเนอร์ GTM
revert POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงเป็นเทมเพลต GTM ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดตเทมเพลต GTM

การแปลงโฉม

โปรดดูรายละเอียดของทรัพยากรการเปลี่ยนรูปแบบในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/transformations สร้างการเปลี่ยนรูปแบบ GTM
ลบ DELETE  /path ลบการเปลี่ยนรูปแบบ GTM
รับ GET  /path รับการเปลี่ยนรูปแบบ GTM
list GET  /+parent/transformations แสดงรายการการเปลี่ยนรูปแบบ GTM ทั้งหมดของพื้นที่ทำงานของคอนเทนเนอร์ GTM
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงไปยัง GTM Transformation ใน GTM Workspace
อัปเดต PUT  /path อัปเดตการเปลี่ยนรูปแบบ GTM

ทริกเกอร์

สำหรับรายละเอียดทรัพยากรของทริกเกอร์ โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/triggers สร้างทริกเกอร์ GTM
ลบ DELETE  /path ลบทริกเกอร์ GTM
รับ GET  /path รับทริกเกอร์ GTM
list GET  /+parent/triggers แสดงทริกเกอร์ GTM ทั้งหมดของคอนเทนเนอร์
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงเป็นทริกเกอร์ GTM ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดตทริกเกอร์ GTM

การอนุญาตผู้ใช้

สำหรับรายละเอียดทรัพยากรสิทธิ์ของผู้ใช้ โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/user_permissions สร้างบัญชีและสิทธิ์เข้าถึงคอนเทนเนอร์ของผู้ใช้
ลบ DELETE  /path นำผู้ใช้ออกจากบัญชี โดยเพิกถอนสิทธิ์เข้าถึงผู้ใช้และคอนเทนเนอร์ทั้งหมดของผู้ใช้
รับ GET  /path รับสิทธิ์เข้าถึงบัญชีและคอนเทนเนอร์ของผู้ใช้
list GET  /+parent/user_permissions แสดงรายชื่อผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงบัญชี พร้อมด้วยสิทธิ์การเข้าถึงของผู้ใช้บัญชีและคอนเทนเนอร์ที่ให้กับผู้ใช้แต่ละคน
อัปเดต PUT  /path อัปเดตบัญชีและสิทธิ์เข้าถึงคอนเทนเนอร์ของผู้ใช้

ตัวแปร

สำหรับรายละเอียดทรัพยากรตัวแปร โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/variables สร้างตัวแปร GTM
ลบ DELETE  /path ลบตัวแปร GTM
รับ GET  /path รับตัวแปร GTM
list GET  /+parent/variables แสดงตัวแปร GTM ทั้งหมดของคอนเทนเนอร์
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงเป็นตัวแปร GTM ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดตตัวแปร GTM

ส่วนหัวของเวอร์ชัน

สำหรับรายละเอียดทรัพยากรส่วนหัวเวอร์ชัน โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ล่าสุด GET  /+parent/version_headers:latest รับส่วนหัวเวอร์ชันล่าสุดของคอนเทนเนอร์
list GET  /+parent/version_headers แสดงเวอร์ชันคอนเทนเนอร์ทั้งหมดของคอนเทนเนอร์ GTM

ฉบับ

โปรดดูรายละเอียดทรัพยากรเวอร์ชันในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /path ลบเวอร์ชันคอนเทนเนอร์
รับ GET  /path รับเวอร์ชันคอนเทนเนอร์
เผยแพร่ GET  /+parent/versions:live รับเวอร์ชันคอนเทนเนอร์ที่ใช้งานอยู่ (เช่น นำไปใช้จริง)
publish POST  /+path:publish เผยแพร่เวอร์ชันของคอนเทนเนอร์
set_latest POST  /+path:set_latest ตั้งค่าเวอร์ชันล่าสุดที่ใช้สำหรับการซิงค์พื้นที่ทำงานเมื่อตรวจหาความขัดแย้งและข้อผิดพลาด
undelete POST  /+path:undelete ยกเลิกการลบเวอร์ชันคอนเทนเนอร์
อัปเดต PUT  /path อัปเดตเวอร์ชันคอนเทนเนอร์

พื้นที่ทำงาน

โปรดดูรายละเอียดทรัพยากรพื้นที่ทำงานในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/workspaces สร้างพื้นที่ทำงาน
create_version POST  /+path:create_version สร้างเวอร์ชันคอนเทนเนอร์จากเอนทิตีที่มีอยู่ในพื้นที่ทำงาน ลบพื้นที่ทำงาน และตั้งค่าเวอร์ชันคอนเทนเนอร์ฐานเป็นเวอร์ชันที่สร้างขึ้นใหม่
ลบ DELETE  /path ลบพื้นที่ทำงาน
รับ GET  /path ดาวน์โหลด Workspace
getStatus GET  /+path/status ค้นหาเอนทิตีที่ขัดแย้งกันและมีการแก้ไขในพื้นที่ทำงาน
list GET  /+parent/workspaces แสดงรายการพื้นที่ทำงานทั้งหมดที่เป็นของคอนเทนเนอร์ GTM
quick_preview POST  /+path:quick_preview แสดงตัวอย่างพื้นที่ทำงานอย่างรวดเร็วโดยสร้างเวอร์ชันคอนเทนเนอร์ปลอมจากเอนทิตีทั้งหมดในพื้นที่ทำงานที่จัดเตรียมไว้
resolve_conflict POST  /+path:resolve_conflict แก้ไขความขัดแย้งในการรวมสำหรับเอนทิตีพื้นที่ทำงานด้วยการอัปเดตความขัดแย้งนั้นเป็นเอนทิตีที่แก้ไขแล้วซึ่งส่งผ่านคำขอ
ซิงค์ POST  /+path:sync ซิงค์พื้นที่ทำงานกับคอนเทนเนอร์เวอร์ชันล่าสุดโดยการอัปเดตเอนทิตีพื้นที่ทำงานที่ไม่ได้แก้ไขทั้งหมด และแสดงความขัดแย้งสำหรับเอนทิตีที่แก้ไข
อัปเดต PUT  /path อัปเดตพื้นที่ทำงาน

โซน

สำหรับรายละเอียดของทรัพยากรโซน โปรดดูที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /+parent/zones สร้างโซน GTM
ลบ DELETE  /path ลบโซน GTM
รับ GET  /path รับโซน GTM
list GET  /+parent/zones แสดงรายการโซน GTM ทั้งหมดของพื้นที่ทำงานของคอนเทนเนอร์ GTM
revert POST  /+path:revert ยกเลิกการเปลี่ยนแปลงเป็น GTM Zone ในพื้นที่ทำงานของ GTM
อัปเดต PUT  /path อัปเดต GTM Zone