เริ่มต้นใช้งาน Python ด้วย Bing Ads API

หากต้องการเริ่มต้นพัฒนาแอปพลิเคชัน Bing Ads API ด้วย Python คุณสามารถเริ่มต้นด้วยตัวอย่างที่ให้ไว้หรือทําตามคําแนะนําแอปพลิเคชันสําหรับแอปพลิเคชันบนเว็บหรือเดสก์ท็อป

คุณจะต้องมีข้อมูลประจําตัวผู้ใช้ที่มีสิทธิ์เข้าถึง Microsoft Advertising ทั้งในการผลิตหรือแบบ Sandbox สําหรับสภาพแวดล้อมการใช้งานจริง คุณจะต้องใช้โทเค็นนักพัฒนาการผลิต ไคลเอ็นต์ Sandbox ทั้งหมดสามารถใช้โทเค็นสําหรับนักพัฒนา Universal Sandbox ได้ เช่น BBD37VB98 สําหรับข้อมูลเพิ่มเติม โปรดดู เริ่มต้นใช้งาน Bing Ads API และ Sandbox

เมื่อต้องการรับรองความถูกต้องผ่าน OAuth คุณต้องลงทะเบียนแอปพลิเคชันและรับตัวระบุไคลเอ็นต์ที่สอดคล้องกัน นอกจากนี้ คุณยังต้องจดบันทึกข้อมูลลับไคลเอ็นต์และ URI การเปลี่ยนเส้นทาง ถ้าคุณกําลังพัฒนาเว็บแอปพลิเคชัน สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับการลงทะเบียนแอปพลิเคชันในการผลิตและขั้นตอนการให้รหัสการตรวจสอบสิทธิ์ โปรดดู การรับรองความถูกต้องด้วย OAuth และการรับรองความถูกต้องด้วย SDK แม้ว่าในการผลิต คุณจะต้องใช้รหัสแอปพลิเคชันของคุณเอง (หรือที่เรียกว่า ID ไคลเอ็นต์) แต่ลูกค้า Microsoft Advertising ทั้งหมดสามารถใช้ ID ไคลเอ็นต์ "แอปตัวอย่างบทช่วยสอน" สาธารณะใน Sandbox ได้ เช่น 00001111-aaaa-2222-bbbb-3333cccc4444 สําหรับข้อมูลเพิ่มเติม โปรดดู Sandbox

การขึ้นต่อกัน

Bing Ads Python SDK รองรับ Python 3.8 หรือสูงกว่า คุณควรติดตั้งและเรียกใช้เวอร์ชันใดเวอร์ชันหนึ่งที่ได้รับการสนับสนุน

SDK ที่ใช้ REST จะขึ้นอยู่กับแพคเกจต่อไปนี้ ซึ่งจะติดตั้งโดยอัตโนมัติ:

• pydantic (>=2.0.0) — ตัวแบบข้อมูลที่พิมพ์สําหรับวัตถุ API ทั้งหมด
• การร้องขอ — การส่งผ่าน HTTP
• TYPING-EXTENSIONS (>=4.0.0)

ติดตั้ง SDK

เมื่อต้องการติดตั้ง Bing Ads Python SDK เป็นครั้งแรก ให้เรียกใช้คําสั่งต่อไปนี้จาก IDE หรือพร้อมท์บรรทัดคําสั่ง

pip.exe install msads

หากต้องการยืนยันว่ามีการติดตั้ง Bing Ads Python SDK แล้ว ให้เรียกใช้คําสั่งต่อไปนี้ คุณควรเห็น msads (<เวอร์ชัน>) ในรายการผลลัพธ์

pip.exe list

หากคุณติดตั้ง Bing Ads Python SDK ไว้แล้ว คุณสามารถเรียกใช้คําสั่งนี้เพื่อรับบิตล่าสุดได้

pip.exe install --upgrade msads

บทสรุป

เมื่อคุณติดตั้ง Bing Ads Python SDK แล้ว คุณสามารถดาวน์โหลดตัวอย่างจาก GitHub หรือทําตามหนึ่งในคําแนะนําแอปพลิเคชันสําหรับคําแนะนํา: แอปพลิเคชันเว็บ Bing Ads API ใน Python หรือบทสัมมนา: แอปพลิเคชันเดสก์ท็อป Bing Ads API ในแอปพลิเคชัน Python

การใช้ REST SDK

Bing Ads Python SDK สื่อสารกับ Microsoft Advertising REST API โดยใช้คลาสไคลเอ็นต์ที่สร้างโดย OpenAPI ซึ่งได้รับการสนับสนุนโดยโมเดล Pydantic คุณโต้ตอบกับ API ผ่านอินสแตนซ์ ServiceClient ซึ่งจัดการส่วนหัวของการรับรองความถูกต้อง การกําหนดเส้นทางของจุดสิ้นสุด และการส่งเมธอดโดยอัตโนมัติ

การตั้งค่า ServiceClient

สร้าง ServiceClient โดยการส่งผ่านชื่อบริการ เวอร์ชัน API, ข้อมูลการอนุญาต และสภาพแวดล้อมเป้าหมาย

from bingads.service_client import ServiceClient

campaign_service = ServiceClient(
    service='CampaignManagementService',
    version=13,
    authorization_data=authorization_data,
    environment=ENVIRONMENT,  # 'production' or 'sandbox'
)

ชื่อบริการต่อไปนี้ได้รับการสนับสนุน: CampaignManagementService, BulkService, ReportingService, CustomerManagementServiceCustomerBillingService, และ AdInsightService.

การสร้างวัตถุ

นําเข้าคลาสโมเดล openapi_client.models.campaign โดยตรง และสร้างอินสแตนซ์ด้วยอาร์กิวเมนต์คําสําคัญ ไม่มี ArrayOf* ชนิด wrapper ให้ใช้รายการ Python ธรรมดาทุกครั้งที่เขตข้อมูลยอมรับหลายรายการ

from openapi_client.models.campaign import *

campaign = Campaign(
    name="Women's Shoes",
    daily_budget=50.0,
    budget_type=BudgetLimitType.DAILYBUDGETSTANDARD,
    time_zone='PacificTimeUSCanadaTijuana',
    languages=['All'],
)

สําหรับชนิดที่ได้รับ เช่น ExpandedTextAd ให้สร้างอินสแตนซ์ให้กับคลาสย่อยที่เป็นรูปธรรมโดยตรง โดยไม่จําเป็นต้องมีการเรียกใช้จากโรงงานหรือการเข้ารหัสพิเศษ พารามิเตอร์แบบกําหนดเองและวัตถุที่ซ้อนกันอื่นๆ สามารถตั้งค่าแบบอินไลน์ผ่านทางตัวสร้างได้

expanded_text_ad = ExpandedTextAd(
    title_part1='Contoso',
    title_part2='Quick & Easy Setup',
    title_part3='Seamless Integration',
    text='Find New Customers & Increase Sales!',
    text_part2='Start Advertising on Contoso Today.',
    path1='seattle',
    path2='shoe sale',
    # With FinalUrls you can separate the tracking template, custom parameters,
    # and landing page URLs.
    final_urls=['https://www.contoso.com/womenshoesale'],
    # Final Mobile URLs can also be used if you want to direct the user to a
    # different page for mobile devices.
    final_mobile_urls=['https://mobile.contoso.com/womenshoesale'],
    # Set custom parameters that are specific to this ad.
    url_custom_parameters=CustomParameters(
        parameters=[
            CustomParameter(key='promoCode', value='PROMO' + str(index)),
            CustomParameter(key='season', value='summer'),
        ]
    ),
)

ads = [expanded_text_ad]

การดําเนินการบริการการโทร

สร้างวัตถุคําขอและส่งผ่านไปยังเมธอดที่สอดคล้องกันบน ServiceClient วิธีการใช้การตั้งชื่อ snake_case

add_request = AddCampaignsRequest(
    account_id=authorization_data.account_id,
    campaigns=[campaign],
)
response = campaign_service.add_campaigns(add_campaigns_request=add_request)
campaign_id = response.campaign_ids[0]

การรับรองความถูกต้อง

REST SDK ใช้ส่วนหัว HTTP มาตรฐานAuthorization: Bearer <token> โฟลว์ OAuth — การให้รหัสการตรวจสอบ การจัดการโทเค็นรีเฟรช และที่เก็บโทเค็น — จะเหมือนกับ SOAP SDK สําหรับรายละเอียด โปรดดูการรับรองความถูกต้องด้วย SDK

การจัดการข้อผิดพลาด

ข้อผิดพลาดการบริการเกิดขึ้นจาก ApiException แพ openapi_client คเกจ ข้อยกเว้นจะแสดงรหัสสถานะ HTTP และเนื้อความของการตอบสนองข้อผิดพลาด

from openapi_client.exceptions import ApiException

try:
    response = campaign_service.GetCampaignsByAccountId(
        AccountId=authorization_data.account_id,
        CampaignType='Search'
    )
except ApiException as ex:
    print(f"HTTP status {ex.status}: {ex.body}")

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

ดูเพิ่มเติม

ไลบรารีไคลเอ็นต์ Bing Ads API
ตัวอย่างโค้ด API ของ Bing Ads
ที่อยู่บริการเว็บ Bing Ads API
การจัดการข้อผิดพลาดและข้อยกเว้นของบริการ
Sandbox