ภาพรวม

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

ข้อกำหนด

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

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

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

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

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

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

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

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

สำหรับ Dependencies (โดยเฉพาะอย่างยิ่งแพ็กเกจที่ 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 ได้แล้ว ให้ดำเนินการต่อเพื่อใช้ไลบรารีไคลเอ็นต์ดังนี้