Aracılığıyla paylaş


Bing Ads API'sini Kullanmaya Başlama

Geliştirici belirteci olan herhangi bir Microsoft Advertising kullanıcısı Bing Ads API'sini kullanmaya başlayabilir. Reklam araçları oluşturan çok sayıda reklam veya geliştirici yerleştiren reklamverenler için Bing Ads API'sinde Microsoft Advertising'e programlı bir arabirim sağlanır.

Bing Ads API uygulamanızı web hizmetlerini destekleyen herhangi bir dilde geliştirebilirsiniz. Belirli bir SDK'yı kullanmaya başlamak için bkz. C# | Java | PHP | Python'da Çalışmaya Başlama.

Kullanıcı erişim belirteci alma

Oturum açmak istediğiniz kullanıcıyı (örneğin, example@contoso.com) göz önünde bulundurun. Bing Ads API'sinde bu e-posta adresi ve parola kabul edilmeyecektir. Bunun yerine, kullanıcı erişim belirteci içeren AuthenticationToken üst bilgi öğesini ayarlamanız gerekir. Erişim belirtecini kullanıcı adı ve parolayı temsil ediyor olarak düşünebilirsiniz.

Bir kullanıcı için nasıl erişim belirteci alabilirsiniz? Uygulama geliştiricisi olarak Microsoft Advertising kullanıcısının onayını almak için bir Microsoft yetkilendirme URL'si kullanacaksınız. Kullanıcı onay verdikten sonra erişim belirteci alabilir ve kullanıcı adına işlem yapabilirsiniz. Erişim belirteci, bir veya daha fazla Microsoft Advertising hesabına erişimi olan kullanıcı kimlik bilgilerini temsil eder.

  1. Uygulama kaydetme

  2. Uygulamanızın Microsoft Advertising hesaplarını yönetmesi için kullanıcı onayı isteme

  3. Erişim ve yenileme belirteçlerini alma

  4. İlk API çağrınızı yapma

İpucu

Bing Ads SDK'larını kullanarak belirteçlere erişme ve belirteçleri yenileme hakkında ayrıntılı bilgi için bkz. SDK'larla Kimlik Doğrulaması.

Geliştirici Belirteci Alma

Bing Ads API'lerini kullanmak için bir geliştirici belirtecine ve geçerli kullanıcı kimlik bilgilerine sahip olmanız gerekir. Henüz bir Microsoft Advertising hesabınız yoksa Microsoft Advertising web uygulaması aracılığıyla kaydolabilirsiniz.

Not

Korumalı alan ve üretim ortamları ayrı kimlik bilgileri kullanır. Korumalı Alan hesabına buradan kaydolabilirsiniz. Herkes evrensel korumalı alan geliştirici belirtecini BBD37VB98 kullanabilir.

Üretim için geliştirici belirteci almak için bu adımları izleyebilirsiniz.

  1. Microsoft Reklam Geliştirici Portalı hesap sekmesinde Super Yönetici kimlik bilgileriyle oturum açın.
  2. Geliştirici belirteci ile ilişkilendirılmasını istediğiniz kullanıcıyı seçin. Genellikle, kaç kullanıcı desteklenecek olursa olsun bir uygulamanın yalnızca bir evrensel belirteci olması gerekir.
  3. Belirteç İste düğmesine tıklayın.

Evrensel geliştirici belirteci, herhangi bir Microsoft Advertising kullanıcı kimlik bilgileriyle kimlik doğrulaması yapmak için kullanılabilir. Uygulamanızın bir veya birden çok Microsoft Advertising kullanıcısı tarafından kullanılıp kullanılmayacağını fark ederek aynı evrensel geliştirici belirtecini kullanabilirsiniz. Temmuz 2019 itibarıyla bu varsayılan belirteç türüdür.

Tek kullanıcılı geliştirici belirteci, tek bir müşteriye erişim için yalnızca bir kullanıcının kimliğini doğrulamak için kullanılabilir. Bu belirteç türü, evrensel belirteç yerine kullanım dışı bırakıldı. Yine de kullanıcılarınızdan birine tek bir kullanıcı belirteci atandığını görüyorsanız" Evrensel'e Yükselt"i seçebilirsiniz.

Geliştirici belirteci, bir kullanıcı için izin verilen hesaplara program aracılığıyla erişim sağlar. API erişimi için geliştirici belirteci almak herhangi bir Microsoft Advertising hesabına ek izin vermez. Her Microsoft Advertising kullanıcısı, erişebileceği her müşteri için Super Yönetici veya Reklamveren Kampanya Yöneticisi gibi bir role atanır. Geliştirici belirteci ile Microsoft Advertising web uygulamasında bulunan hesapların aynıları API aracılığıyla program aracılığıyla kullanıcı tarafından kullanılabilir.

API Kimlik Bilgilerini Kullanma

GetCampaignsByAccountId gibi bir hizmet işlemini çağırdığınızda DeveloperToken, CustomerId ve CustomerAccountId gibi istek üst bilgisi öğelerini belirtmeniz gerekir.

<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'larından birini kullanıyorsanız , istek üst bilgisi öğeleri AuthorizationData kullanılarak ayarlanır. SDK kimlik doğrulama kitaplığı hakkında daha fazla bilgi için bkz. SDK'larla Kimlik Doğrulaması.

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>'
)

Hesabınızı ve Müşteri Kimliklerinizi Alma

Kullanıcının müşteri kimliğini ve hesap kimliğini almak için Microsoft Advertising web uygulamasında oturum açabilir ve Kampanyalar sekmesine tıklayabilirsiniz. URL, sorgu dizesinde müşteri kimliğinizi tanımlayan bir cid anahtarı/değer çifti ve hesap kimliğinizi tanımlayan bir yardım anahtarı/değer çifti içerir. Örneğin;https://ui.ads.microsoft.com/campaign/Campaigns.m?cid=FindCustomerIdHere& aid=FindAccountIdHere#/customer/FindCustomerIdHere/account/FindAccountIdHere/campaign.

İpucu

Hesap tanımlayıcısı için hesap numarasını yanlış kullanmayın. Hesap numarası, Microsoft Advertising web uygulamasında hesabı tanımlamak için kullanılan sistem tarafından oluşturulan hesap numarasıdır. Hesap numarası xxxxxx biçimindedir. Burada xxxxxxxxx, sekiz alfasayısal karakterden oluşan bir seridir. API hizmeti istekleri yalnızca hesap tanımlayıcısını kullanır ve hiçbir zaman hesap numarasını kullanmaz.

Müşteri Yönetimi API'siyle, kimliği doğrulanmış her kullanıcının müşteri ve hesap tanımlayıcılarını alabilirsiniz.

Microsoft Advertising kimlik bilgileriniz ve DeveloperToken ile GetUser'ı arayın. Body içinde UserId nil değerini ayarlayın. Yanıt, UserId değerini içeren bir User nesnesi içerir.

<?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>

Ardından, önceki adımda döndürülen UserId değeriyle SearchAccounts'ı çağırın. Döndürülen reklamveren hesabı (veya hesapları) hesap ve müşteri tanımlayıcılarını içerir.

<?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>

İpucu

Geçerli kimliği doğrulanmış kullanıcının hesaplarını döndüren bir kod örneği için bkz. Kullanıcı Hesaplarını Arama Kodu Örneği .

Üst bilgi öğeleri başvurusu

Bing Ads API hizmet işlemleri, istek ve yanıt iletilerini hizmet işlemiyle değiştirmek için Basit Nesne Erişim Protokolü (SOAP) kullanır. Daha fazla bilgi için bkz . Bing Ads API Hizmetleri Protokolü.

Her SOAP isteği, kullanıcının kimlik bilgilerini içeren aşağıdaki SOAP üst bilgilerini içermelidir.

Not

CustomerAccountId ve CustomerId öğeleri Müşteri Faturalama ve Müşteri Yönetimi hizmetleri için geçerli değildir.

Öğe Açıklama Veri Türü
ApplicationToken Bu üst bilgi öğesi kullanılmaz ve yoksayılmalıdır. Dize
AuthenticationToken Microsoft Advertising hesaplarına izinleri olan bir Microsoft Hesabı kullanıcısını temsil eden OAuth erişim belirteci. Daha fazla bilgi için bkz. OAuth ile kimlik doğrulaması. Dize
CustomerAccountId İstekteki varlıkların sahibi olan hesabın tanımlayıcısı. Her ikisi de gerektiğinde bu üst bilgi öğesi AccountId gövde öğesiyle aynı değere sahip olmalıdır. Bu öğe çoğu hizmet işlemi için gereklidir ve en iyi yöntem olarak her zaman ayarlamanız gerekir. Dize
Customerıd Hesabı içeren ve hesabın sahibi olan müşterinin tanımlayıcısı. Başka bir müşterinin hesabını yönetiyorsanız, kendi müşteri kimliğiniz yerine bu müşteri kimliğini kullanmanız gerekir. Bu öğe çoğu hizmet işlemi için gereklidir ve en iyi yöntem olarak her zaman ayarlamanız gerekir. Dize
DeveloperToken Bing Ads API'sine erişmek için kullanılan geliştirici belirteci. Dize
Password Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. Dize
Username Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. Dize

Yardım mı gerekiyor?

Sorun giderme ipuçları için bkz. Hizmet Hatalarını ve Özel Durumları İşleme.

Microsoft Q&A forumu, geliştirici topluluğunun Bing Ads API'leri ve Microsoft Reklam Betikleri hakkındaki soruları sorması ve yanıtlaması için kullanılabilir. Microsoft forumları izler ve topluluğun henüz yanıtlamadığı soruları yanıtlar.

Önemli

Sorunuzu gördüğümüzden emin olmak için bunu 'advertising-api' ile etiketleyin.

Araştırmada hassas hesap veya kişisel ayrıntılar varsa veya Microsoft Q&A aracılığıyla sorununuzu çözmek için ihtiyacınız olan bilgileri bulamadıysanız lütfen Microsoft Reklam Desteği ile iletişime geçin. Sorunu verimli bir şekilde çözmek için lütfen destek ekibiyle etkileşimde bulunma konusunda istenen ayrıntıları sağlayın.

Ayrıca Bkz

Bing Ads API'lerine Genel Bakış
Bing Ads API Kavramları