นโยบายการเลิกใช้งานข้อมูลสําหรับ Google Analytics API

เอกสารนี้อธิบายนโยบายการเลิกใช้งานข้อมูลสําหรับ API การรายงานและข้อมูลเมตาหลัก

ภาพรวม

ระบบใช้มิติข้อมูลและเมตริก (คอลัมน์) เพื่อค้นหา API การรายงานของ Google Analytics บางครั้งอาจจําเป็นต้องเพิ่ม นําออก หรือเปลี่ยนชื่อคอลัมน์เหล่านี้ เราบังคับใช้นโยบายการเลิกใช้งานข้อมูลเพื่อเพิ่มความโปร่งใสของการเปลี่ยนแปลงเหล่านี้

ระบบจะแจ้งการเปลี่ยนแปลงคอลัมน์ทั้งหมดผ่าน changelogs และ Metadata API จะอัปเดตโดยอัตโนมัติเพื่อแสดงการเปลี่ยนแปลงเหล่านี้

นโยบายนี้ครอบคลุมอะไรบ้าง

นโยบายนี้ครอบคลุมมิติข้อมูลและเมตริกที่เปิดเผยโดย API สาธารณะ แต่ไม่รวมคําขอ API (พารามิเตอร์การค้นหา) การตอบกลับ API ค่าที่ API แสดงผล หรือชุดค่าผสมของมิติข้อมูลและเมตริกที่ถูกต้อง

ข้อมูลใหม่

เมื่อเพิ่มคอลัมน์ใหม่ลงใน API

  • ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องด้วยรายละเอียดเกี่ยวกับคอลัมน์ใหม่
  • คอลัมน์จะพร้อมใช้งานใน Metadata API

การลบข้อมูล

เมื่อนําคอลัมน์ออกจาก API

  • ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องด้วยรายละเอียดเกี่ยวกับคอลัมน์ที่นําออก
  • ใน Metadata API ระบบจะตั้งค่าแอตทริบิวต์คอลัมน์ status เป็น DEPRECATED
  • คอลัมน์จะใช้งานได้ในการรายงานการค้นหาต่อไปเป็นเวลาอย่างน้อย 6 เดือน
  • หลังจากผ่านไป 6 เดือน ระบบจะนําคอลัมน์ออกจาก Metadata API และการค้นหาคอลัมน์ใน API การรายงานจะทําให้เกิดข้อผิดพลาด 400 Bad Request

การเปลี่ยนชื่อข้อมูล

เมื่อเปลี่ยนชื่อคอลัมน์

  • ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องด้วยรายละเอียดเกี่ยวกับคอลัมน์เดิมและคอลัมน์ทดแทน
  • ใน Metadata API ระบบจะตั้งค่าแอตทริบิวต์ status ของคอลัมน์เดิมเป็น DEPRECATED และแอตทริบิวต์ replacedBy เป็นรหัสของคอลัมน์ทดแทน
  • คอลัมน์ต้นฉบับจะใช้ได้ในการรายงานการค้นหาต่อไปเป็นเวลาอย่างน้อย 6 เดือน
  • หลังจาก 6 เดือน ระบบจะนําคอลัมน์ดั้งเดิมออกจาก Metadata API และการค้นหาคอลัมน์ใน API การรายงานจะทําให้เกิดข้อผิดพลาด 400 Bad Request

การนําแอตทริบิวต์ออก

เมื่อแอตทริบิวต์ถูกนําออกจาก Metadata API ให้ทําดังนี้

  • เราจะอัปเดตบันทึกการเปลี่ยนแปลง API ข้อมูลเมตาด้วยรายละเอียดเกี่ยวกับแอตทริบิวต์ที่จะถูกนําออก
  • แอตทริบิวต์ดังกล่าวจะยังคงมีอยู่ใน Metadata API เป็นเวลาอย่างน้อย 6 เดือน
  • ระบบจะนําแอตทริบิวต์ออกจาก Metadata API หลังจากผ่านไป 6 เดือน

กลุ่ม

บางครั้งคุณอาจจําเป็นต้องเปลี่ยนชื่อกลุ่มหรือลําดับคอลัมน์ เมื่อเกิดกรณีนี้ขึ้น