เอกสารนี้อธิบายนโยบายการเลิกใช้งานข้อมูลสำหรับ API การรายงานหลักและข้อมูลเมตา
ภาพรวม
ระบบใช้มิติข้อมูลและเมตริก (คอลัมน์) เพื่อค้นหา Reporting API ของ Google Analytics ในบางครั้งอาจจำเป็นต้องเพิ่ม นำออก หรือเปลี่ยนชื่อคอลัมน์เหล่านี้ นโยบายการเลิกใช้งานข้อมูลมีไว้เพื่อเพิ่มความโปร่งใสเกี่ยวกับวิธีเกิดการเปลี่ยนแปลงเหล่านี้
ระบบจะแจ้งการเปลี่ยนแปลงคอลัมน์ทั้งหมดผ่าน changelogs และ API ข้อมูลเมตา จะอัปเดตโดยอัตโนมัติเพื่อแสดงการเปลี่ยนแปลงเหล่านี้
สิ่งที่นโยบายนี้ครอบคลุม
นโยบายนี้ครอบคลุมมิติข้อมูลและเมตริกที่แสดงโดย API สาธารณะ แต่ไม่ได้ครอบคลุมคำขอ API (พารามิเตอร์การค้นหา), การตอบกลับจาก API, ค่าที่ API แสดงผล หรือชุดมิติข้อมูลและเมตริกที่ถูกต้อง
ข้อมูลใหม่
เมื่อเพิ่มคอลัมน์ใหม่ใน API
- ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องพร้อมรายละเอียดเกี่ยวกับคอลัมน์ใหม่
- คอลัมน์ดังกล่าวจะพร้อมใช้งานใน Metadata API
การนำข้อมูลออก
สิ่งที่จะเกิดขึ้นเมื่อนำคอลัมน์ออกจาก API
- ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องพร้อมรายละเอียดเกี่ยวกับคอลัมน์ที่จะถูกนำออก
- ใน API ข้อมูลเมตา ระบบจะตั้งค่าแอตทริบิวต์คอลัมน์
statusเป็นDEPRECATED - คอลัมน์ดังกล่าวจะยังใช้ในการรายงานการค้นหาได้เป็นเวลาอย่างน้อย 6 เดือน
- หลังจากผ่านไป 6 เดือน ระบบจะนำคอลัมน์ออกจาก API ข้อมูลเมตาและการค้นหาคอลัมน์ใน API การรายงานจะทำให้เกิดข้อผิดพลาด
400 Bad Request
การเปลี่ยนชื่อข้อมูล
สิ่งที่จะเกิดขึ้นเมื่อเปลี่ยนชื่อคอลัมน์
- ระบบจะอัปเดต changelog ของ API ที่เกี่ยวข้องพร้อมรายละเอียดเกี่ยวกับคอลัมน์เดิมและคอลัมน์การแทนที่
- ใน API ข้อมูลเมตา
แอตทริบิวต์
statusของคอลัมน์ต้นฉบับจะตั้งค่าเป็นDEPRECATEDและแอตทริบิวต์replacedByจะตั้งค่าเป็นรหัสของคอลัมน์การแทนที่ - คอลัมน์เดิมจะยังคงใช้ในการรายงานการค้นหาได้เป็นเวลาอย่างน้อย 6 เดือน
- หลังจากผ่านไป 6 เดือน ระบบจะนำคอลัมน์เดิมออกจาก API ข้อมูลเมตาและการค้นหาคอลัมน์ใน API การรายงานจะทำให้เกิดข้อผิดพลาด
400 Bad Request
การนำแอตทริบิวต์ออก
สิ่งที่จะเกิดขึ้นเมื่อนำ แอตทริบิวต์ออกจาก API ข้อมูลเมตา
- ระบบจะอัปเดต บันทึกการเปลี่ยนแปลงของ API ข้อมูลเมตาพร้อมรายละเอียดเกี่ยวกับแอตทริบิวต์ที่จะนำออก
- แอตทริบิวต์จะพร้อมใช้งานใน API ข้อมูลเมตาต่อไปเป็นเวลาอย่างน้อย 6 เดือน
- หลังจากผ่านไป 6 เดือน ระบบจะนำแอตทริบิวต์ออกจาก Metadata API
กลุ่ม
บางครั้งคุณต้องเปลี่ยนชื่อของ กลุ่มหรือลำดับคอลัมน์ เมื่อเกิดกรณีนี้ขึ้น:
- ระบบจะอัปเดต บันทึกการเปลี่ยนแปลงของ API ข้อมูลเมตาพร้อมรายละเอียดเกี่ยวกับชื่อกลุ่มและการเปลี่ยนแปลงการจัดลำดับ