การเติมโค้ดอัตโนมัติใน IDE

IDE เช่น VS Code และ PyCharm มีฟีเจอร์เติมโค้ดในตัวสำหรับภาษา Python

ไลบรารี google-ads-python จะสร้างคลาสข้อความ protobuf แบบไดนามิกที่รันไทม์โดยใช้เมธอด Getter ในคลาส GoogleAdsClient ซึ่งอาจยับยั้งฟีเจอร์เติมโค้ดอัตโนมัติของ IDE ที่อาศัยการวิเคราะห์ซอร์สโค้ดแบบคงที่

หากต้องการปรับปรุงความเข้ากันได้กับเครื่องมือเติมโค้ดที่อาศัยการวิเคราะห์แบบคงที่ คุณสามารถทำอย่างใดอย่างหนึ่งต่อไปนี้

  1. ใช้คำอธิบายประกอบประเภทกับเมธอด Getter แบบไดนามิก (แนะนำ)
  2. นำเข้าคลาสข้อความ protobuf และไคลเอ็นต์บริการโดยตรง

การนำเข้าแบบไดนามิกพร้อมคำแนะนำประเภท

การใช้การนําเข้าแบบไดนามิกช่วยให้มั่นใจได้ว่าโค้ดของคุณจะยังคงยืดหยุ่นในการอัปเดตไลบรารี การเพิ่มคำอธิบายประกอบประเภทจะช่วยให้ IDE เติมโค้ดให้สมบูรณ์ได้โดยไม่สูญเสียประโยชน์ของการเริ่มต้นแบบไดนามิก

from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.v26.resources.types.campaign import (
    Campaign,
)

client = GoogleAdsClient.load_from_storage()

# Type hints allow the IDE to provide code completion suggestions while
# retaining dynamic class generation.
campaign: Campaign = client.get_type("Campaign")

การนำเข้าโดยตรง

นอกจากนี้ คุณยังนําเข้าคลาสข้อความ protobuf ได้โดยตรงด้วย วิธีนี้ช่วยให้การเติมโค้ด IDE ทำงานได้ทันทีโดยไม่ต้องใช้เมธอด Getter

from google.ads.googleads.v26.resources import Campaign

# The Campaign class is imported directly, enabling the IDE to read the
# class definition and make code completion suggestions.
campaign = Campaign()

ข้อเสียของการนำเข้าโดยตรง

แม้ว่าการนำเข้าคลาสที่สร้างขึ้นโดยตรงจะช่วยในการเติมโค้ดให้สมบูรณ์ แต่ก็มีข้อเสียบางประการด้วย ดังนี้

  1. ค้นหาได้ยากขึ้น: ไม่ใช่เรื่องง่ายเสมอไปที่จะทราบว่าคลาสหนึ่งๆ อยู่ในโมดูลใด ดังนั้นการค้นหาเส้นทางการนำเข้าที่ถูกต้องจึงอาจเป็นเรื่องยาก
  2. ไม่เสถียรเมื่ออัปเกรด: โครงสร้างไดเรกทอรีของคลาสที่สร้างขึ้นอาจเปลี่ยนแปลงไปตามไลบรารีของไคลเอ็นต์เวอร์ชันใหม่ หากคุณนำเข้าคลาสโดยตรง โค้ดอาจใช้งานไม่ได้เมื่ออัปเกรด ในขณะที่โค้ดที่ใช้เมธอด Getter จะไม่ได้รับผลกระทบจากการเปลี่ยนแปลงประเภทนี้
  3. ต้องเริ่มต้นด้วยตนเอง: เมธอด get_service จะเริ่มต้นบริการด้วยการตรวจสอบสิทธิ์ การตั้งค่าการรับส่ง และตัวสกัดกั้น gRPC (ซึ่งจะแนบส่วนหัว เช่น login-customer-id และ linked-customer-id, จัดการการบันทึก และรวมข้อผิดพลาดไว้ใน GoogleAdsException) ก่อนที่จะแสดงผล หากคุณนำเข้าและสร้างอินสแตนซ์บริการโดยตรง ระบบจะข้ามตัวสกัดกั้นเหล่านั้น และคุณต้องกำหนดค่าข้อมูลเข้าสู่ระบบและช่องทางการรับส่งด้วยตนเอง ดังนี้

    from google.ads.googleads.v26.services.services import (
        campaign_service as campaign_service_module,
    )
    
    # Dynamic service getter (initializes credentials, transport, and gRPC
    # interceptors automatically).
    campaign_service = client.get_service("CampaignService")
    
    # Direct service client import (requires manual credential and interceptor
    # configuration).
    campaign_service_client = campaign_service_module.CampaignServiceClient(
        credentials=client.credentials,
    )