เริ่มต้นใช้งาน API โฆษณา Bing

ผู้ใช้ Microsoft Advertising ใด ๆ ที่มีโทเค็นนักพัฒนาสามารถเริ่มใช้ Bing Ads API ได้ สําหรับผู้ลงโฆษณาที่วางโฆษณาหรือนักพัฒนาซอฟต์แวร์จํานวนมากในการสร้างเครื่องมือโฆษณา API โฆษณา Bing มีอินเทอร์เฟซทางโปรแกรมเพื่อการโฆษณาของ Microsoft

คุณสามารถพัฒนาแอปพลิเคชัน Bing Ads API ของคุณในภาษาใดก็ได้ที่สนับสนุนบริการเว็บ เมื่อต้องการเริ่มต้นใช้งาน SDK ที่เฉพาะเจาะจง ดูเริ่มต้นใช้งานใน C# | Java | PHP | Python

รับโทเค็นการเข้าถึงของผู้ใช้

พิจารณาผู้ใช้ที่คุณต้องการลงชื่อเข้าใช้ เช่น example@contoso.com API โฆษณา Bing จะไม่ยอมรับที่อยู่อีเมลและรหัสผ่านนั้น แต่คุณจําเป็นต้องตั้งค่าองค์ประกอบส่วนหัว AuthenticationToken ที่ประกอบด้วยโทเค็นการเข้าถึงของผู้ใช้ คุณสามารถนึกภาพโทเค็นการเข้าถึงเป็นตัวแทนชื่อผู้ใช้และรหัสผ่านได้

คุณสามารถรับโทเค็นการเข้าถึงสําหรับผู้ใช้ได้อย่างไร? ในฐานะนักพัฒนาแอปพลิเคชัน คุณจะใช้ URL การอนุญาตของ Microsoft เพื่อพร้อมท์ผู้ใช้ Microsoft Advertising ให้ได้รับความยินยอม เมื่อผู้ใช้ให้ความยินยอม คุณสามารถรับโทเค็นการเข้าถึงและดําเนินการในนามของผู้ใช้ได้ โทเค็นการเข้าถึงแสดงข้อมูลประจําตัวผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising อย่างน้อยหนึ่งบัญชี

1. ลงทะเบียนแอปพลิเคชัน

2. ร้องขอความยินยอมของผู้ใช้ สําหรับแอปพลิเคชันของคุณเพื่อจัดการบัญชี Microsoft Advertising ของพวกเขา

3. รับโทเค็นการเข้าถึงและการรีเฟรช

4. ทําการเรียก API แรกของคุณ

เคล็ดลับ

สําหรับรายละเอียดเกี่ยวกับวิธีการรับโทเค็นการเข้าถึงและรีเฟรชโดยใช้ SDK โฆษณา Bing โปรดดูการรับรองความถูกต้องด้วย SDK

รับโทเค็นนักพัฒนา

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

หมายเหตุ

สภาพแวดล้อม Sandbox และการผลิตใช้ข้อมูลประจําตัวที่แยกต่างหาก คุณสามารถลงทะเบียนสําหรับบัญชีผู้ใช้ Sandbox ได้ที่นี่ ทุกคนสามารถใช้โทเค็นสําหรับนักพัฒนา Sandbox สากลได้ เช่น BBD37VB98

คุณสามารถทําตามขั้นตอนเหล่านี้เพื่อรับโทเค็นนักพัฒนาสําหรับการผลิต

1. ลงชื่อเข้าใช้ด้วยข้อมูลประจําตัว Super Admin ที่แท็บบัญชีพอร์ทัลนักพัฒนาโฆษณา Microsoft
2. เลือกผู้ใช้ที่คุณต้องการเชื่อมโยงกับโทเค็นนักพัฒนา โดยทั่วไปแล้ว แอปพลิเคชันต้องการโทเค็นสากลเพียงโทเค็นเดียวเท่านั้น โดยไม่คํานึงว่ามีผู้ใช้กี่คนที่ได้รับการสนับสนุน
3. คลิกที่ปุ่มโทเค็นคําขอ

โทเค็นนักพัฒนาสากลสามารถใช้เพื่อรับรองความถูกต้องกับข้อมูลประจําตัวผู้ใช้ Microsoft Advertising ใด ๆ คุณสามารถใช้โทเค็นสําหรับนักพัฒนาสากลเดียวกันไม่ว่าแอปพลิเคชันของคุณจะถูกใช้โดยผู้ใช้ Microsoft Advertising หนึ่งรายหรือหลายราย ณ เดือนกรกฎาคม 2019 นี่คือชนิดโทเค็นเริ่มต้น

โทเค็นนักพัฒนาแบบผู้ใช้คนเดียวสามารถใช้เพื่อรับรองความถูกต้องผู้ใช้รายเดียวสําหรับการเข้าถึงลูกค้ารายเดียวเท่านั้น ชนิดโทเค็นนี้ไม่ได้รับการสนับสนุนจากโทเค็นสากล ถ้าคุณยังคงเห็นว่ามีการกําหนดโทเค็นผู้ใช้รายเดียวให้กับหนึ่งในผู้ใช้ของคุณ คุณสามารถเลือก "อัปเกรดเป็นสากล" ได้

โทเค็นนักพัฒนาเปิดใช้งานการเข้าถึงทางโปรแกรมไปยังบัญชีที่อนุญาตสําหรับผู้ใช้ การได้รับโทเค็นนักพัฒนาสําหรับการเข้าถึง API ไม่ได้ให้สิทธิ์เพิ่มเติมแก่บัญชี Microsoft Advertising ใด ๆ ผู้ใช้ Microsoft Advertising แต่ละรายจะได้รับบทบาท เช่น Super Admin หรือ Advertiser Campaign Manager สําหรับลูกค้าทุกรายที่พวกเขาสามารถเข้าถึงได้ ด้วยโทเค็นนักพัฒนา บัญชีเดียวกันที่มีอยู่ในเว็บแอปพลิเคชัน Microsoft Advertising จะพร้อมใช้งานโดยทางโปรแกรมผ่าน API

ตําแหน่งที่จะใช้ข้อมูลประจําตัวของ API

เมื่อคุณเรียกใช้การดําเนินการบริการ เช่น GetCampaignsByAccountId คุณต้องระบุองค์ประกอบ ส่วนหัวของคําขอ เช่น DeveloperToken, CustomerId และ CustomerAccountId

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">GetCampaignsByAccountId</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCampaignsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <CampaignType>ValueHere</CampaignType>
    </GetCampaignsByAccountIdRequest>
  </s:Body>
</s:Envelope>

ถ้าคุณกําลังใช้หนึ่งใน SDK การโฆษณาของ Microsoft องค์ประกอบส่วนหัวของคําขอจะถูกตั้งค่าโดยใช้ AuthorizationData สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับไลบรารีการรับรองความถูกต้องของ SDK ดูการรับรองความถูกต้องด้วย SDK

var authorizationData = new AuthorizationData
{
    Authentication = <AuthenticationGoesHere>, 
    CustomerId = <CustomerIdGoesHere>,
    AccountId = <AccountIdGoesHere>,
    DeveloperToken = "<DeveloperTokenGoesHere>"
};

static AuthorizationData authorizationData = new AuthorizationData();
authorizationData.setAuthentication(<AuthenticationGoesHere>);
authorizationData.setCustomerId("<CustomerIdGoesHere>");
authorizationData.setAccountId("<AccountIdGoesHere>");
authorizationData.setDeveloperToken("<DeveloperTokenGoesHere>");

$authorizationData = (new AuthorizationData())
    ->withAuthentication($AuthenticationGoesHere)
    ->withCustomerId($CustomerIdGoesHere)
    ->withAccountId($AccountIdGoesHere)
    ->withDeveloperToken($DeveloperTokenGoesHere);

authorization_data = AuthorizationData(
    authentication = <AuthenticationGoesHere>,
    customer_id = <CustomerIdGoesHere>,
    account_id = <AccountIdGoesHere>,
    developer_token = '<DeveloperTokenGoesHere>'
)

รับบัญชีและรหัสลูกค้าของคุณ

หากต้องการรับ ID ลูกค้าและ ID บัญชีของผู้ใช้ คุณสามารถลงชื่อเข้าใช้เว็บแอปพลิเคชัน Microsoft Advertising และคลิกที่แท็บ แคมเปญ URL จะมีคู่คีย์/ค่า ของ cid ในสตริงคิวรีที่ระบุ ID ลูกค้าของคุณ และคู่คีย์/ค่า ความช่วยเหลือ ที่ระบุ ID บัญชีของคุณ ตัวอย่างเช่น ;https://ui.ads.microsoft.com/campaign/Campaigns.m?cid=FindCustomerIdHere& aid=FindAccountIdHere#/customer/FindCustomerIdHere/account/FindAccountIdHere/campaign

เคล็ดลับ

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

ด้วยการจัดการลูกค้า API คุณสามารถรับตัวระบุลูกค้าและบัญชีสําหรับผู้ใช้ที่ได้รับการรับรองความถูกต้องแต่ละราย

เรียกใช้ GetUser ด้วยข้อมูลประจําตัว Microsoft Advertising และ DeveloperToken ของคุณ ภายในเนื้อความ ให้ตั้งค่า UserId nil การตอบสนองจะรวมวัตถุ ผู้ใช้ ที่มี UserId

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ApplicationToken i:nil="true" xmlns:h="https://bingads.microsoft.com/Customer/v13" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    <h:AuthenticationToken xmlns:h="https://bingads.microsoft.com/Customer/v13">OAuthAccessTokenGoesHere</h:AuthenticationToken>
    <h:DeveloperToken xmlns:h="https://bingads.microsoft.com/Customer/v13">DeveloperTokenGoesHere</h:DeveloperToken>
  </s:Header>
  <s:Body>
    <GetUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    </GetUserRequest>
  </s:Body>
</s:Envelope>

จากนั้นเรียกใช้ SearchAccounts ด้วย UserId ที่ส่งกลับผ่านขั้นตอนก่อนหน้า บัญชีผู้โฆษณาที่ส่งคืน (หรือบัญชี) จะรวมถึงบัญชีและตัวระบุลูกค้า

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ApplicationToken i:nil="true" xmlns:h="https://bingads.microsoft.com/Customer/v13" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    <h:AuthenticationToken xmlns:h="https://bingads.microsoft.com/Customer/v13">OAuthAccessTokenGoesHere</h:AuthenticationToken>
    <h:DeveloperToken xmlns:h="https://bingads.microsoft.com/Customer/v13">DeveloperTokenGoesHere</h:DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Predicate>
          <a:Field>UserId</a:Field>
          <a:Operator>Equals</a:Operator>
          <a:Value>UserIdGoesHere</a:Value>
        </a:Predicate>
      </Predicates>
      <Ordering i:nil="true" xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
      <PageInfo xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Index>0</a:Index>
        <a:Size>10</a:Size>
      </PageInfo>
    </SearchAccountsRequest>
  </s:Body>
</s:Envelope>

เคล็ดลับ

ดู ค้นหารหัสบัญชีผู้ใช้ตัวอย่าง สําหรับตัวอย่างรหัสที่ส่งกลับบัญชีสําหรับผู้ใช้ที่ได้รับการรับรองความถูกต้องในปัจจุบัน

การอ้างอิงองค์ประกอบส่วนหัว

การดําเนินการของบริการ Bing Ads API ใช้ Simple Object Access Protocol (SOAP) เพื่อแลกเปลี่ยนคําขอและข้อความตอบกลับกับการดําเนินการบริการ สําหรับข้อมูลเพิ่มเติม โปรดดูโพรโทคอลบริการ API ของ Bing Ads

คําขอ SOAP แต่ละรายการต้องมีส่วนหัว SOAP ต่อไปนี้ ซึ่งประกอบด้วยข้อมูลประจําตัวของผู้ใช้

หมายเหตุ

องค์ประกอบ CustomerAccountId และ CustomerId ไม่สามารถใช้กับการเรียกเก็บเงินของลูกค้าและบริการการจัดการลูกค้าได้

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
ApplicationToken	องค์ประกอบส่วนหัวนี้ไม่ได้ถูกใช้และควรละเว้น	สาย อักขระ
AuthenticationToken	โทเค็นการเข้าถึง OAuth ที่แสดงถึงผู้ใช้บัญชี Microsoft ที่มีสิทธิ์ในการเข้าถึงบัญชี Microsoft Advertising สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth	สาย อักขระ
CustomerAccountId	ตัวระบุของบัญชีที่เป็นเจ้าของเอนทิตีในคําขอ องค์ประกอบส่วนหัวนี้ต้องมีค่าเดียวกันกับองค์ประกอบเนื้อความ AccountId เมื่อต้องการทั้งสองอย่าง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ	สาย อักขระ
CustomerId	ตัวระบุลูกค้าที่ประกอบด้วย และ เป็นเจ้าของบัญชี หากคุณจัดการบัญชีของลูกค้ารายอื่น คุณควรใช้รหัสลูกค้านั้นแทนรหัสลูกค้าของคุณเอง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ	สาย อักขระ
DeveloperToken	โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API	สาย อักขระ
รหัส ผ่าน	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ
ชื่อ	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ

ต้องการความช่วยเหลือหรือไม่

สําหรับเคล็ดลับการแก้ไขปัญหา โปรดดู การจัดการข้อผิดพลาดและข้อยกเว้นของบริการ

ฟอรั่ม Microsoft Q&A มีให้สําหรับชุมชนนักพัฒนาเพื่อถามและตอบคําถามเกี่ยวกับ Bing Ads API และสคริปต์โฆษณาของ Microsoft Microsoft จะตรวจสอบฟอรั่มและตอบกลับคําถามที่ชุมชนยังไม่ได้ตอบ

สิ่งสำคัญ

หากต้องการตรวจสอบให้แน่ใจว่าเราเห็นคําถามของคุณ ให้แท็กด้วย "api โฆษณา"

หากการตรวจสอบเกี่ยวข้องกับบัญชีที่ละเอียดอ่อนหรือรายละเอียดส่วนบุคคลหรือหากคุณไม่พบข้อมูลที่คุณต้องการในการแก้ไขปัญหาของคุณผ่านทาง Microsoft Q&A โปรดติดต่อฝ่ายสนับสนุนโฆษณาของ Microsoft หากต้องการแก้ไขปัญหาอย่างมีประสิทธิภาพ โปรดให้การสนับสนุนพร้อมรายละเอียดที่ร้องขอในการสนับสนุนการมีส่วนร่วม

ดูเพิ่มเติม

ภาพรวมของ API โฆษณา Bing
แนวคิด API ของโฆษณา Bing