เริ่มต้นใช้งาน Bing Ads API

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

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

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

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

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

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

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

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

4. เรียกใช้ API ครั้งแรกของคุณ

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

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

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

1. ลงชื่อเข้าใช้ด้วยข้อมูลประจําตัวของ Super Admin ที่แท็บบัญชีพอร์ทัลนักพัฒนา Microsoft Advertising
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>

ถ้าคุณกําลังใช้หนึ่งใน Microsoft Advertising SDK องค์ประกอบส่วนหัวคําขอจะถูกตั้งค่าโดยใช้ 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 ลูกค้าของคุณ

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

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

โทรหา GetUser ด้วยข้อมูลประจําตัว Microsoft Advertising และ DeveloperToken ของคุณ ภายในเนื้อความ ให้ตั้งค่า UserId nil การตอบกลับจะมีวัตถุ User ที่มี 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) เพื่อแลกเปลี่ยนข้อความคําขอและการตอบกลับกับการดําเนินการบริการ สําหรับข้อมูลเพิ่มเติม โปรดดู Bing Ads API Services Protocol

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

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

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

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

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

ดูเพิ่มเติม

ภาพรวม API ของ Bing Ads
แนวคิด API ของ Bing Ads