ภาพรวม

ไลบรารีของไคลเอ็นต์ Python โฮสต์ใน GitHub และแพ็กเกจมีอยู่ใน PyPI

ข้อกำหนด

ไลบรารีต้องใช้ Python 3.8 ขึ้นไป

ข้อกำหนดเบื้องต้น

ก่อนติดตั้งไลบรารี คุณจะต้องมีโทเค็นนักพัฒนาแอปและรหัสลูกค้า วิธีการรับข้อมูลดังกล่าวระบุไว้ในส่วนข้อกําหนดเบื้องต้น โปรดทราบว่าคุณจะสร้างโทเค็น OAuth2 อื่นๆ ที่จำเป็นในขั้นตอนต่อๆ ไป

ความเข้ากันได้ของรันไทม์และทรัพยากร Dependency

ไลบรารีของไคลเอ็นต์ Python ยังคงใช้งานร่วมกับรันไทม์ Python ได้ในส่วนเวอร์ชันที่รองรับซึ่งเผยแพร่โดย Python Software Foundation ยกเว้นเวอร์ชันที่มีสถานะเป็น "ฟีเจอร์" หรือ "รุ่นก่อนเผยแพร่"

เมื่อใช้รันไทม์ Python เวอร์ชันใหม่ เรามุ่งมั่นที่จะเผยแพร่ไลบรารีของไคลเอ็นต์ Python เวอร์ชันใหม่ที่เข้ากันได้กับรันไทม์ล่าสุดภายในสิ้นไตรมาสหลังจากการเผยแพร่ เช่น หากรันไทม์ใหม่เปิดตัวในเดือนตุลาคม ไลบรารีไคลเอ็นต์ Python เวอร์ชันที่เข้ากันได้จะพร้อมใช้งานภายในสิ้นเดือนมีนาคมของปีถัดไป

ระบบจะไม่รองรับรันไทม์ Python ที่สิ้นสุดอายุการใช้งาน (EOL) ไปแล้วหลังจากเลยวันที่สิ้นสุดอายุการใช้งานในส่วนเวอร์ชันที่ไม่รองรับของ python.org

เราอาจเผยแพร่ไลบรารีของไคลเอ็นต์ Python เวอร์ชันที่ใช้ร่วมกับรันไทม์ Python ที่ไม่รองรับไม่ได้เมื่อถึงช่วงสิ้นสุดการรองรับ

สำหรับไลบรารีที่ใช้ร่วมกัน (โดยเฉพาะแพ็กเกจที่ Google ดูแลซึ่งระบุไว้ว่าต้องใช้งานโดยไลบรารีไคลเอ็นต์ Python) เราจะรักษาความเข้ากันได้กับแพ็กเกจที่ Google ดูแล และถือว่า "รองรับ" ตามนโยบายการเปลี่ยนแปลงที่ก่อให้เกิดข้อขัดข้องของ OSS ของ Google

โปรดดูรายการรันไทม์และไลบรารีที่รองรับของ Python ทั้งหมดในหน้าไลบรารี

การติดตั้ง

ทำตามวิธีการในเอกสารประกอบการติดตั้งเพื่อติดตั้งไลบรารีจาก PyPi แล้วกลับไปที่หน้านี้

การกำหนดค่า

เมื่อติดตั้งไลบรารีแล้ว คุณจะต้องตั้งค่าการกําหนดค่าสําหรับ การกำหนดค่าคลังมีได้หลายวิธีตามที่อธิบายไว้ในเอกสารประกอบเกี่ยวกับการกำหนดค่า

การตรวจสอบสิทธิ์

เมื่อเลือกประเภทการกําหนดค่าแล้ว ให้ดําเนินการต่อเพื่อสร้างโทเค็น OAuth2 ที่เหลือที่จําเป็นสําหรับส่งคําขอไปยัง API มีหลายขั้นตอน OAuth2 ที่รองรับ ซึ่งระบุไว้ในรายการด้านล่าง ดูรายละเอียดเกี่ยวกับความแตกต่างระหว่างขั้นตอนต่างๆ และความช่วยเหลือในการตัดสินใจว่าขั้นตอนใดเหมาะกับแอปพลิเคชันของคุณมากที่สุดได้ที่เอกสารประกอบเกี่ยวกับ OAuth

การส่งคําขอ API

เมื่อรวมโทเค็น OAuth2 ไว้ในการกำหนดค่าแล้ว คุณก็พร้อมที่จะส่งคำขอ API ดูตัวอย่าง get campaigns เพื่อดูวิธีง่ายๆ ในการทดสอบว่าไลบรารีได้รับการกําหนดค่าอย่างถูกต้องเพื่อส่งคําขอ API

หากต้องการเรียกใช้ตัวอย่าง get_campaigns.py ให้เรียกใช้คําสั่งต่อไปนี้ในไดเรกทอรีรูทของไลบรารีไคลเอ็นต์ googleads-python ที่ติดตั้งในเครื่อง

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

แหล่งข้อมูลเพิ่มเติม

หลังจากส่งคําขอ API ได้ ให้ดําเนินการต่อโดยใช้คลังไลบรารีไคลเอ็นต์ดังนี้