Campaign Manager 360 API เวอร์ชันใหม่จะเผยแพร่เป็นประจํา เมื่อมีการเผยแพร่เวอร์ชันใหม่ เราจะเลิกใช้งานเวอร์ชันเก่าและหยุดให้บริการในที่สุด เมื่อมีการหยุดให้บริการเวอร์ชันหนึ่ง คำขอทั้งหมดสำหรับเวอร์ชันนั้นจะเริ่มแสดงข้อผิดพลาด
หากมีการเลิกใช้งาน API เวอร์ชันที่คุณใช้อยู่ คุณจะต้องย้ายข้อมูลไปใช้เวอร์ชันใหม่ก่อนวันที่หยุดให้บริการตามกำหนด คู่มือนี้จะให้รายละเอียดเกี่ยวกับวิธีตรวจสอบว่ามีการเลิกใช้งานเวอร์ชัน API ที่คุณใช้อยู่หรือไม่ รวมถึงขั้นตอนที่แนะนำในการย้ายข้อมูล
ขั้นตอนที่ 1: ตรวจสอบเวอร์ชันที่ใช้
หากคุณดูแลรักษาแอปพลิเคชันที่สงสัยว่าอาจใช้ Campaign Manager 360 API เวอร์ชันที่เลิกใช้งานแล้ว คุณควรตรวจสอบเวอร์ชันที่คุณใช้อยู่ก่อน ในกรณีส่วนใหญ่ คุณจะเข้าถึง API ผ่านไลบรารีของไคลเอ็นต์สำหรับภาษาใดภาษาหนึ่งหรือการผสานรวมอย่างเป็นทางการ วิธีการค้นหาเวอร์ชัน API ที่ไลบรารีของไคลเอ็นต์และการผสานรวมเหล่านี้ใช้อยู่มีดังนี้
เครื่องมือแก้ไข Apps Script เวอร์ชันใหม่
ข้อมูลเวอร์ชันของ Apps Script จะแสดงในกล่องโต้ตอบบริการขั้นสูง
- จากเครื่องมือแก้ไข Apps Script ให้คลิกเพิ่มบริการ
- ค้นหา Campaign Manager 360 API ในรายการบริการที่ใช้ได้
- ค่าที่เลือกในเมนูแบบเลื่อนลงเวอร์ชันคือเวอร์ชัน Campaign Manager 360 API ที่ใช้อยู่ในปัจจุบัน
เครื่องมือแก้ไข Apps Script รุ่นเดิม
ข้อมูลเวอร์ชันของ Apps Script จะแสดงในกล่องโต้ตอบบริการขั้นสูง
- จากเครื่องมือแก้ไข Apps Script ให้ไปที่แหล่งข้อมูล > บริการขั้นสูงของ Google
- ค้นหา Campaign Manager 360 API ในรายการบริการที่ใช้ได้
- ค่าที่เลือกในเมนูแบบเลื่อนลงเวอร์ชันคือเวอร์ชัน Campaign Manager 360 API ที่ใช้อยู่ในปัจจุบัน
C#
ข้อมูลเวอร์ชันของไลบรารีของไคลเอ็นต์ Google API สำหรับ .NET จะแสดงในตำแหน่งต่อไปนี้
- รวมอยู่ในชื่อแพ็กเกจ nuget และเนมสเปซของบริการ
Google.Apis.Dfareporting.v3_4
- แสดงผ่านพร็อพเพอร์ตี้สาธารณะของ
DfareportingService
Console.WriteLine(DfareportingService.Version);
Java
ข้อมูลเวอร์ชันของไลบรารีของไคลเอ็นต์ Google API สำหรับ Java จะแสดงในตำแหน่งต่อไปนี้
- ระบุไว้ใน artifactId ของ Maven
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v3.4-rev1-1.21.0</version> </dependency>
- รวมอยู่ในชื่อไฟล์ JAR
google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
- แสดงผ่านพร็อพเพอร์ตี้สาธารณะของ
Dfareporting
System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);
PHP
ข้อมูลเวอร์ชันของไลบรารีของไคลเอ็นต์ Google API สำหรับ PHP จะแสดงผ่านพร็อพเพอร์ตี้สาธารณะของ Google_Service_Dfareporting
ดังนี้
$service = new Google_Service_Dfareporting($client) print $service->version;
Python
ไลบรารีของไคลเอ็นต์ Google API สำหรับ Python (v1/v2) ไม่มีเวอร์ชัน เวอร์ชัน API ที่จะใช้จะระบุเป็นอาร์กิวเมนต์ให้กับเครื่องมือสร้างการค้นพบ
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
ไลบรารีของไคลเอ็นต์ Google API สำหรับ Ruby เวอร์ชันที่ต่ำกว่า 0.9 จะไม่มีการกำหนดเวอร์ชัน เวอร์ชัน API ที่จะใช้จะระบุเป็นอาร์กิวเมนต์สำหรับตัวสร้างบริการ ดังนี้
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
สำหรับไลบรารีของไคลเอ็นต์ Google API สำหรับ Ruby เวอร์ชันตั้งแต่ 0.9 ขึ้นไป ระบบจะแสดงเวอร์ชันในเนมสเปซของบริการ ดังนี้
Google.Apis.DfareportingV3_4
จดบันทึกเวอร์ชันที่คุณใช้อยู่ เนื่องจากคุณจะต้องใช้ข้อมูลนี้ในภายหลัง
ขั้นตอนที่ 2: ตรวจสอบสถานะของเวอร์ชัน
กำหนดการเลิกใช้งานจะแสดงสถานะของทุกเวอร์ชันที่รองรับในปัจจุบัน ค้นหาเวอร์ชันของคุณในรายการนี้และดูสถานะดังต่อไปนี้
- หากไม่มีวันที่แสดงในคอลัมน์วันที่เลิกใช้งานและวันที่หยุดให้บริการ แสดงว่าคุณกำลังใช้เวอร์ชันที่รองรับอย่างเต็มรูปแบบ
- หากมีวันที่แสดงอยู่ แสดงว่าเวอร์ชันที่คุณใช้อยู่นั้นเลิกใช้งานแล้วและจะหยุดให้บริการในวันที่ที่ระบุ
- หากเวอร์ชันของคุณไม่อยู่ในรายการ แสดงว่าเวอร์ชันดังกล่าวเลิกใช้งานแล้วและไม่มีการสนับสนุนอีกต่อไป
หากคุณอยู่ในข้อ 2 หรือ 3 ข้างต้น คุณจะต้องย้ายข้อมูลไปยังเวอร์ชันใหม่เพื่อไม่ให้บริการหยุดชะงัก เราขอแนะนำให้คุณย้ายข้อมูลไปยังเวอร์ชันล่าสุดที่แสดงอยู่ที่ด้านบนของตารางกำหนดการเลิกใช้งาน (ไม่รวมรุ่นเบต้า) วิธีนี้จะช่วยให้คุณมีเวลาสูงสุดระหว่างการอัปเกรด
ขั้นตอนที่ 3: อัปเกรดเวอร์ชัน
หากพิจารณาแล้วว่าจําเป็นต้องย้ายข้อมูล ขั้นตอนถัดไปคือการอัปเดตการผสานรวมหรือรับบิลด์ที่อัปเดตแล้วของคลังไคลเอ็นต์ที่ต้องการ โปรดทราบว่าไลบรารีของไคลเอ็นต์บางรายการอาจมีเพียงบิลด์เดียวที่ใช้งานได้กับ API ทุกเวอร์ชัน แต่ไลบรารีอื่นๆ จะมีบิลด์แยกกันสำหรับแต่ละเวอร์ชัน รายการด้านล่างแสดงข้อมูลการอัปเกรดทั่วไปสำหรับไลบรารีไคลเอ็นต์และการผสานรวมที่ใช้กันอย่างแพร่หลายที่สุด
เครื่องมือแก้ไข Apps Script เวอร์ชันใหม่
Google Apps Script รองรับ Campaign Manager 360 API ทุกเวอร์ชันและให้คุณเลือกเวอร์ชันที่จะใช้ในแต่ละสคริปต์ได้ วิธีเปลี่ยนเวอร์ชันที่ใช้โดยสคริปต์หนึ่งๆ
- จากเครื่องมือแก้ไข Apps Script ให้คลิกเพิ่มบริการ
- ค้นหา Campaign Manager 360 API ในรายการบริการที่ใช้ได้
- เปลี่ยนเวอร์ชัน Campaign Manager 360 API ที่ใช้อยู่ผ่านเมนูแบบเลื่อนลงของเวอร์ชัน
- คลิกเพิ่มเพื่อบันทึกการเปลี่ยนแปลง
เครื่องมือแก้ไข Apps Script รุ่นเดิม
Google Apps Script รองรับ Campaign Manager 360 API ทุกเวอร์ชันและให้คุณเลือกเวอร์ชันที่จะใช้ในแต่ละสคริปต์ วิธีเปลี่ยนเวอร์ชันที่ใช้โดยสคริปต์หนึ่งๆ
- จากเครื่องมือแก้ไข Apps Script ให้ไปที่แหล่งข้อมูล > บริการขั้นสูงของ Google
- ค้นหา Campaign Manager 360 API ในรายการบริการที่ใช้ได้
- เปลี่ยนเวอร์ชัน Campaign Manager 360 API ที่ใช้อยู่ผ่านเมนูแบบเลื่อนลงของเวอร์ชัน
- คลิกตกลงเพื่อบันทึกการเปลี่ยนแปลงของคุณ
C#
ไลบรารีของไคลเอ็นต์ Google API สําหรับ .NET มีบิลด์แยกต่างหากสําหรับ Campaign Manager 360 API แต่ละเวอร์ชัน ซึ่งเผยแพร่ผ่าน Nuget
ดูวิธีการติดตั้งโดยละเอียดหรือตัวเลือกการดาวน์โหลดอื่นๆ ได้ที่เอกสารประกอบเกี่ยวกับไลบรารีไคลเอ็นต์
Java
ไลบรารีของไคลเอ็นต์ Google API สำหรับ Java มีบิลด์แยกต่างหากสำหรับ Campaign Manager 360 API แต่ละเวอร์ชัน ซึ่งเผยแพร่ผ่าน Maven
ดูวิธีการติดตั้งโดยละเอียดหรือตัวเลือกการดาวน์โหลดอื่นๆ ได้ที่เอกสารประกอบเกี่ยวกับไลบรารีไคลเอ็นต์
PHP
ไลบรารีของไคลเอ็นต์ Google API สำหรับ PHP มีบิลด์แยกต่างหากสำหรับ Campaign Manager 360 API แต่ละเวอร์ชัน ซึ่งเผยแพร่ผ่าน Packagist
ดูวิธีการติดตั้งโดยละเอียดหรือตัวเลือกการดาวน์โหลดอื่นๆ ได้ที่เอกสารประกอบเกี่ยวกับไลบรารีไคลเอ็นต์
Python
บิลด์ทั้งหมดของไลบรารีของไคลเอ็นต์ Google API สำหรับ Python (v1/v2) รองรับ Campaign Manager 360 API ทุกเวอร์ชัน เพียงอัปเดตสตริงเวอร์ชันที่ส่งเป็นอาร์กิวเมนต์ไปยังเครื่องมือสร้าง Discovery
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
ไลบรารีของไคลเอ็นต์ Google API สําหรับ Ruby เวอร์ชัน 0.8 และต่ำกว่ารองรับ Campaign Manager 360 API ทุกเวอร์ชัน เพียงอัปเดตสตริงเวอร์ชันที่ส่งเป็นอาร์กิวเมนต์ไปยังคอนสตรัคเตอร์บริการ
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
ขั้นตอนที่ 4: แก้ไขความแตกต่างของเวอร์ชัน
เรามุ่งมั่นที่จะทำให้รุ่นใหม่ๆ ใช้งานร่วมกับรุ่นเก่าได้ ซึ่งหมายความว่าการย้ายข้อมูลระหว่าง API เวอร์ชันต่างๆ จะไม่จําเป็นต้องเปลี่ยนแปลงโค้ด หากดำเนินการดังกล่าวไม่ได้ เราจะประกาศการเปลี่ยนแปลงที่นักพัฒนาแอปต้องดำเนินการ (หรือที่เรียกว่าการเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้อง) ในหมายเหตุประจำรุ่น
ณ จุดนี้ คุณควรอ่านบันทึกประจำรุ่นของเรา โดยเริ่มจากเวอร์ชันหลังเวอร์ชันที่คุณเริ่มต้น (ซึ่งคุณจดไว้ในส่วนก่อนหน้า) ไปจนถึงเวอร์ชันที่คุณกำลังจะอัปเกรด ส่วนต่างๆ ของบันทึกประจำรุ่นควรตีความดังนี้
- ฟีเจอร์ใหม่ - ฟังก์ชันการทำงานที่เพิ่มเข้ามาใหม่
- การหยุดให้บริการ - ฟังก์ชันการทำงานที่ถูกนําออกจาก API ฟังก์ชันการแทนที่จะอยู่ในส่วนนี้หากมี
- ปัญหาที่ทราบ - การเปลี่ยนแปลงที่ไม่ใช่การเพิ่มหรือนําออก เช่น ส่วนนี้อาจครอบคลุมถึงช่องหรือเมธอดที่มีการเปลี่ยนชื่อ หรือตรรกะการตรวจสอบที่มีการเปลี่ยนแปลง
ฟังก์ชันการทำงานในฟีเจอร์ใหม่จะไม่ต้องมีการเปลี่ยนโค้ดและสามารถละเว้นได้ในตอนนี้ คุณกลับมาที่ส่วนนี้ในภายหลังได้หากต้องการลองใช้ฟีเจอร์ที่เราเพิ่มเข้ามา
แต่หากพบการเปลี่ยนแปลงในส่วนการหยุดให้บริการหรือปัญหาที่ทราบ คุณอาจต้องดำเนินการบางอย่าง คุณควรค้นหาโค้ดเพื่อดูว่าแอปพลิเคชันของคุณใช้ฟังก์ชันการทำงานที่นําออกหรือแก้ไขแล้วหรือไม่ ในกรณีนี้ คุณจะต้องอัปเดตโค้ดเพื่อจัดการกับการเปลี่ยนแปลงเหล่านี้
ติดตามข้อมูลอัปเดต
ดังที่ได้กล่าวไว้ก่อนหน้านี้ การเผยแพร่และเลิกใช้งาน Campaign Manager 360 API เกิดขึ้นเป็นประจำ เราจะโพสต์ข้อมูลอัปเดตเกี่ยวกับรุ่นใหม่ การเลิกใช้งาน และการหยุดให้บริการในช่องทางต่อไปนี้
เราขอแนะนําให้คุณติดตามช่องเหล่านี้อย่างน้อย 1 ช่องเพื่อให้ทราบข่าวสารล่าสุดเกี่ยวกับ API