kitaplık ve örneklere göz atın. Ancak entegrasyonunuz desteklenmeyen bir dil kullanmak gibi özel ihtiyaçları varsa, aşağıda açıklandığı şekilde doğrudan talepte bulunmamalıdır.
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, HTTP fiili kullanarak (ör. POST
, GET
, PUT
veya DELETE
) bir işlem belirtir. Aşağıdaki biçimde yer alan küresel olarak benzersiz bir URI ile kaynak 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ı yararlı bulabilirsiniz; GET
, POST
, PUT
ve DELETE
özelliklerini içeriyor.
AdSense Management API'de REST
Desteklenen işlemler, aşağıda açıklandığı gibi doğrudan REST HTTP fiilleriyle eşlenir. AdSense Management API işlemleri.
AdSense Management API URI'leri için özel biçim şu şekildedir:
https://adsense.googleapis.com/v2/resourceID?parameters
burada resourceID
bir reklamın tanımlayıcısıdır
müşteri, reklam birimi, url kanalı, özel kanal veya rapor koleksiyonu ve
parameters
şu parametrelere uygulanacak:
gösterir.
resourceID
yol uzantısının biçimi
için, üzerinde çalıştığınız yeni kaynağı
belirlemenizi sağlar.
örnek:
https://adsense.googleapis.com/v2/accounts/account_id/adclients https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels ...
API'de desteklenen her işlem için kullanılan URI'ların tamamı AdSense Management API Referansı'nda özetlenmiştir. uygulayacaksınız.
Aşağıda, bu sürecin AdSense Management API'sinde nasıl işlediğine dair birkaç örnek verilmiştir.
Reklam müşterilerini listeleyin:
GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/
ca-pub-1234567890123456 reklam istemcisindeki reklam birimlerini listeleme:
GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits
Veri biçimi
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.
İstekleri yetkilendirme
AdSense'in Hizmet Hesaplarını desteklemediğini, bu hesapların Yüklü Uygulama akışını kullanmalıdır.
Uygulamanızın AdSense Management API'ye gönderdiği her istek bir yetkilendirme jetonu içermelidir. Bu jeton ayrıca uygulamanızı Google'a tanıtır.
Yetkilendirme protokolleri hakkında
Uygulamanız, istekleri yetkilendirmek için OAuth 2.0 kullanmalıdır. Başka hiçbir yetkilendirme protokolü desteklenmez. Uygulamanız Google ile Oturum Açma özelliğini kullanıyorsa yetkilendirme işleminin bazı kısımları sizin adınıza gerçekleştirilir.
OAuth 2.0 kullanarak istekleri yetkilendirme
AdSense Management API'ye yapılan tüm istekler, kimliği doğrulanmış bir kullanıcı tarafından yetkilendirilmelidir.
Bu işlem, bir OAuth istemci kimliğiyle gerçekleştirilir.
OAuth istemci kimliği almaveya Kimlik Bilgileri sayfasında bir tane oluşturun.
OAuth 2.0 ile yetkilendirme işleminin ("akış") ayrıntıları, yazdığınız uygulamanın türüne bağlı olarak değişiklik gösterir. Aşağıdaki genel işlem tüm uygulama türleri için geçerlidir:
- Uygulamanız kullanıcı verilerine erişmesi gerektiğinde Google'dan belirli bir erişim kapsamı ister.
- Google, kullanıcıya uygulamanızı kullanıcının verilerinden bazılarını istemeye yetkilendirmesi için bir onay ekranı gösterir.
- Kullanıcı onaylarsa Google, uygulamanıza kısa süreli bir erişim jetonu verir.
- Uygulamanız, erişim jetonunu isteğe ekleyerek kullanıcı verileri için istekte bulunur.
- Google, isteğinizin ve jetonun geçerli olduğuna kanaat getirirse istenen verileri döndürür.
Bazı akışlarda başka adımlar da yer alır. Örneğin, yeni erişim jetonları almak için yenileme jetonları kullanmak. Farklı uygulama türlerine yönelik akışlar hakkında ayrıntılı bilgi için Google'ın OAuth 2.0 dokümanlarına bakın.
AdSense Management API için OAuth 2.0 kapsam bilgileri aşağıda verilmiştir:
Kapsam | Anlamı |
---|---|
https://www.googleapis.com/auth/adsense |
AdSense verilerine okuma/yazma erişimi. |
https://www.googleapis.com/auth/adsense.readonly |
AdSense verilerine salt okuma erişimi. |
Uygulamanızın OAuth 2.0 kullanarak erişim isteğinde bulunabilmesi için hem kapsam bilgilerine hem de uygulamanızı kaydederken Google tarafından sağlanan bilgilere (ör. istemci kimliği ve istemci gizli anahtarı) ihtiyacı vardır.
İpucu: Google API'leri istemci kitaplıkları, yetkilendirme işleminin bazı adımlarını sizin yerinize gerçekleştirebilir. Bu kitaplıklar çeşitli programlama dilleri için kullanıma sunulmuştur. Ayrıntılar için kitaplıkların ve örneklerin bulunduğu sayfayı inceleyin.
İstekte bulunma
Son adım, API isteğinde bulunmaktır. Bkz. referans belgeleri ekleyebilirsiniz.