Başlamadan önce
- Hesap temsilcinizden uygulamanızın erişeceği hesaplar için uygun izinleri ayarlamasını isteyin.
- Authorized Buyers kavramlarına aşina değilseniz Authorized Buyers Yardım Merkezi'ni ziyaret edin ve kullanıcı arayüzü ile denemeler yapın. Uygulamanızın gerçek zamanlı teklif vermesi bekleniyorsa GZT Protokolü belgelerini okuyun.
- Yeni proje oluşturmak için API Konsolu'nu ziyaret edin. Geliştirici Google hesabınızda oturum açın veya hesap oluşturun. Ardından bir proje oluşturmanız ve birkaç Hizmet Şartları'nı onaylamanız istenir.
Üst ve alt hesaplar
Üst ve alt hesaplar içeren bir hesap yapısında çalışıyorsanız bunların nasıl etkileşimde bulunduğunu anlarsanız daha verimli şekilde çalışabilirsiniz. Aşağıda kısa bir özet yer almaktadır:
Alt hesaplar
Bir alt hesaba erişim veren kimlik bilgilerine sahip bir kullanıcı, yalnızca hesabıyla ilişkili kaynakları görüntüleyebilir ve değiştirebilir. Alt hesaplar, diğer alt veya üst hesaplara ait kaynakları görüntüleyemez ya da değiştiremez.
Üst hesaplar
Üst hesaba erişim izni veren kimlik bilgilerine sahip bir kullanıcı, ilişkili tüm alt hesapların yanı sıra üst hesabın kaynaklarını da görüntüleyebilir ve değiştirebilir. Bu kullanıcı, belirli bir kaynağın tümünü listeleyen işlemler için kendi hesabına ve tüm alt hesaplarına ait verileri içeren bir yanıt alır. Alt lisanslar için kaynakları hedefleyen diğer istek türlerinde, üst hesabın alt hesap için kendi accountId parametresi yerine accountId yol parametresi belirtmesi gerekir.
REST API veri modeli
Kaynak, benzersiz bir tanımlayıcıya sahip bağımsız bir veri varlığıdır. Hesaplar kaynağı bir Authorized Buyers hesap girişini temsil eder ve Ad Exchange Buyer API'nin kök veri sınıfıdır. API'nin yöntemleri, tek tek Hesap kaynaklarında ve Hesap kaynakları koleksiyonlarında çalışır.
Hesaplar Kaynağı şunları içerir: Hesap kimliği, çerez eşleştirmede kullanılan bilgiler, teklif veren konumları, teklif isteklerinin gönderildiği URL ve Ad Exchange tarafından gönderilecek saniyede maksimum sorgu sayısını belirtme isteği.
Ad Exchange Buyer API, Hesaplar kaynağına ve koleksiyonuna ek olarak aşağıdaki veri yapılarını tanımlar:
- Teklif verenin konumu
Teklif veren konumları, Ad Exchange'in teklif istekleri göndermesi gereken URL'yi ve Ad Exchange'in göndermesi gereken saniye başına maksimum sorgu sayısını sağlamak için Hesap Kaynakları ile döndürülen yapılardır. Aşağıda, JSON ile ifade edilen bir teklif veren konumu örneği verilmiştir:
"bidderLocation": [ { "url": "http://bid.url.com/bidder", "maximumQps": 1500 } ],- Öğe sayısı
Öğeler hesap listesi sağlar. Aşağıda, JSON ile ifade edilen bir öğe örneği verilmiştir:
{ "kind": "adexchangebuyer#accountsList", "items": [ accounts Resource ] }
Desteklenen işlemler
Ad Exchange Buyer API'sindeki koleksiyonlar ve kaynaklarda üç farklı yöntemi aşağıdaki tabloda açıklandığı gibi çağırabilirsiniz. Tüm işlemler için yetkilendirme gerekir.
| İşlem | Açıklama | REST HTTP eşlemeleri |
|---|---|---|
| list | Şu anda kimliği doğrulanmış kullanıcının erişebildiği tüm hesapları listeler. | GET koleksiyonunu eklemeniz gerekir. |
| al | Belirli bir Hesaplar kaynağını alır. | Kaynak URI üzerinde GET. |
| güncelleme | Belirli bir Hesaplar kaynağını günceller. | Güncellenen kaynak için verileri ilettiğiniz kaynak URI'sinde PUT. |
Görüşme stili
REST, veri isteme ve değiştirmeye kullanışlı ve tutarlı yaklaşım sağlayan bir yazılım mimarisi stilidir.
REST terimi, "Representational State Transfer"in (Temsili Durum Aktarımı) kısaltmasıdır. Google API'leri bağlamında, Google tarafından saklanan verilerin temsillerini almak ve değiştirmek için HTTP fiillerini kullanma anlamına gelir.
RESTful bir sistemde, kaynaklar bir veri deposunda saklanır. Bir istemci, sunucunun belirli bir işlemi (ör. kaynak oluşturma, alma, güncelleme veya silme) gerçekleştirmesi için istek gönderir. Sunucu, işlemi gerçekleştirir ve yanıt gönderir. Bu yanıt genelde belirtilen kaynağın bir temsili biçimindedir.
Google'ın RESTful API'lerinde istemci, POST, GET, PUT veya DELETE gibi bir HTTP fiili kullanarak işlem belirtir. Bir kaynağı, aşağıdaki biçimde genel olarak benzersiz bir URI ile belirtir:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Tüm API kaynaklarının HTTP tarafından erişilebilen benzersiz URI'ları olduğu için REST, veri önbelleğe almayı etkinleştirir ve web'deki dağıtılan altyapıyla birlikte çalışmak üzere optimize edilmiştir.
HTTP 1.1 standartları belgelerindeki yöntem tanımlarını faydalı bulabilirsiniz. Bu tanımlar, GET, POST, PUT ve DELETE özelliklerini içerir.
Ad Exchange Buyer API'de REST
Desteklenen işlemler, API işlemlerinde açıklandığı gibi doğrudan REST HTTP fiilleriyle eşlenir.
API URI'ları için özel biçim şöyledir:
https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters
Burada resourceID, Hesaplar kaynağı tanımlayıcısıdır ve parameters sorguya uygulanacak parametrelerdir. Ayrıntılar için standart sorgu parametreleri bölümüne ve referans belgelerine bakın.
resourceID yol uzantılarının biçimi, şu anda üzerinde çalıştığınız kaynağı tanımlamanızı sağlar. Örneğin:
https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id
API'de desteklenen her işlem için kullanılan URI'ların tamamı referans belgelerinde özetlenmiştir.
Bunun Ad Exchange Buyer API'sinde nasıl işlediğine dair bir örneği aşağıda bulabilirsiniz.
Kimliği doğrulanmış kullanıcının hesap listesini alın:
GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts
Veri biçimi
JSON
JSON (JavaScript Object Notation - JavaScript Nesne Gösterimi), rastgele veri yapılarının basit metin temsilini sağlayan yaygın, dilden bağımsız bir veri biçimidir. Daha fazla bilgi için json.org adresine bakın.