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
เปลี่ยนกลับ 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
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงไคลเอ็นต์ GTM ใน GTM Workspace
อัปเดต PUT  /path อัปเดตไคลเอ็นต์ GTM

คอนเทนเนอร์

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

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/tagmanager/v2 เว้นแต่จะระบุไว้เป็นอย่างอื่น
รวม 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 หาก {โฟลเดอร์_id} ในเส้นทางคำขอเท่ากับ 0 การดำเนินการนี้จะย้ายเอนทิตีออกจากโฟลเดอร์ที่อยู่ในปัจจุบันแทน
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงโฟลเดอร์ GTM ใน GTM Workspace
อัปเดต 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 ทั้งหมดของคอนเทนเนอร์
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงแท็ก GTM ใน GTM Workspace
อัปเดต 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
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงเทมเพลต GTM ใน GTM Workspace
อัปเดต 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
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนการเปลี่ยนแปลงเป็นการเปลี่ยนรูปแบบ GTM ใน 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 ทั้งหมดของคอนเทนเนอร์
เปลี่ยนกลับ POST  /+path:revert เปลี่ยนกลับการเปลี่ยนแปลงทริกเกอร์ GTM ใน GTM Workspace
อัปเดต 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 ทั้งหมดของคอนเทนเนอร์
เปลี่ยนกลับ 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 รับเวอร์ชันคอนเทนเนอร์ที่ใช้งานอยู่ (นำไปใช้จริง)
เผยแพร่ POST  /+path:publish นำเวอร์ชันคอนเทนเนอร์ไปใช้จริง
set_latest POST  /+path:set_latest ตั้งค่าเวอร์ชันล่าสุดที่ใช้สำหรับการซิงค์พื้นที่ทำงานเมื่อตรวจหาความขัดแย้งและข้อผิดพลาด
ยกเลิกการลบ POST  /+path:undelete ยกเลิกการลบเวอร์ชันคอนเทนเนอร์
อัปเดต PUT  /path อัปเดตเวอร์ชันคอนเทนเนอร์

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

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

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