Bu belgede, ilk istemci uygulamanızı yazmadan önce yapmanız gerekenler açıklanmaktadır.
Bir Google Hesabı edinin
Bu API'yi kullanmak için bir Google Hesabınız olmalıdır. Hesabınızın belirli bir mülkte ilgili yöntemi çağırabilmesi için söz konusu mülkte uygun Search Console izni olması gerekir. Örneğin, searchAnalytics.query dosyasını çalıştırmak için söz konusu mülkte okuma izinlerinizin olması gerekir.
Google Search Console'u deneyin
Bu API dokümanında Google Search Console'u kullandığınız, web programlama kavramları ve web verisi biçimleri hakkında bilgi sahibi olduğunuz varsayılır.
Google Search Console'u kullanmadıysanız kodlamaya başlamadan önce kullanıcı arayüzünü deneyin. Her API, Search Console'daki bir raporun işlevini temsil eder. Aldığınız verileri anlamak için bir API kullanmadan önce eşdeğer raporun dokümanlarını okumanız gerekir.
İstemciniz için proje ve kimlik bilgileri oluşturma
Google Search Console'a istek gönderebilmeniz için öncelikle Google'a istemcinizden bahsetmeniz ve API'ye erişimi etkinleştirmeniz gerekir. Bu işlemi, Google API Konsolu'nu kullanarak bir proje oluşturun. Proje, ayarlar ve API erişim bilgilerinin adlandırılmış bir koleksiyonudur ve uygulamanızı kaydeder.
Test Araçları API'si hariç tüm Search Console API'leri için OAuth2 kimlik bilgileri gerekir. Python ve Java hızlı başlangıç kılavuzlarında, proje oluşturma ve istemciniz için kimlik bilgileri alma hakkında ayrıntılı bilgi edinebilirsiniz.
REST ile ilgili temel bilgileri anlama
API'yi çağırmanın iki yolu vardır:
- HTTP istekleri gönderme ve yanıtları ayrıştırma.
- İstemci kitaplıklarını kullanma.
İstemci kitaplıklarını kullanmamayı tercih ederseniz REST ile ilgili temel bilgileri öğrenmeniz gerekir.
REST ile ilgili temel bilgiler
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, bir işlemi HTTP fiili kullanarak (ör. POST, GET, PUT veya DELETE) belirtir. Bir kaynağı, aşağıdaki biçimdeki küresel 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ı yararlı bulabilirsiniz. Bu tanımlar, GET, POST, PUT ve DELETE özelliklerini içerir.
Google Search Console API'de REST
Google Search Console API işlemleri, doğrudan REST HTTP fiilleriyle eşlenir.
Çoğu Google Search Console API URI'sinin biçimi aşağıdaki gibidir:
VERB https://www.googleapis.com/webmasters/v3/resourcePath ?parameters
Her yöntem için kullanılan URI'ların ve fiillerin tamamı, Google Search Console API Referansı'na genel bakış bölümünde verilmiştir.
JSON ile ilgili temel bilgileri anlama
Google Search Console API, verileri JSON biçiminde döndürür.
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.