Bu dokümanda, ilk istemci başvurunuzu yazmadan önce yapmanız gerekenler açıklanmaktadır.
Bir Google Hesabı edinin
Bu API'yi kullanmak için Google Hesabınızın olması gerekir. Belirli bir mülk için o yöntemi çağırmak için hesabınızın ilgili Search Console iznine sahip olması gerekir. Örneğin, searchAnalytics.query komutunu çalıştırmak için o mülkte okuma izniniz olmalıdır.
Google Search Console'u deneyin
Bu API dokümanlarında, Google Search Console'u kullandığınız ve web programlama kavramları ve web veri 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şlevlerini temsil eder. Aldığınız verileri anlamak için, API'yi kullanmadan önce eşdeğer raporun dokümanlarını okumanız gerekir.
İstemciniz için proje ve kimlik bilgisi oluşturma
Google Search Console'a istek gönderebilmeniz için istemcinizi Google'a bildirmeniz ve API'ye erişimi etkinleştirmeniz gerekir. Bunu Google API Konsolu'nu kullanarak bir proje (ayarlar ve API erişim bilgilerinin adlandırılmış bir koleksiyonu) oluşturur ve uygulamanızı kaydedersiniz.
Test Araçları API'si hariç tüm Search Console API'leri OAuth2 kimlik bilgilerini gerektirir. Python ve Java hızlı başlangıç kılavuzları, proje oluşturma ve müşteriniz için kimlik bilgisi alma ile ilgili ayrıntıları sağlar.
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, HTTP fiilini kullanarak POST, GET, PUT veya DELETE gibi bir işlem belirtir. Bir kaynağı aşağıdaki biçimdeki global 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ı dokümanlarındaki 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'sının biçimi şuna benzer:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
Her bir yöntem için kullanılan URI'lerin ve fiillerin tamamı Google Search Console API Referansı'nda genel hatlarıyla paylaşılmıştır.
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 gösterimini sağlayan yaygın bir dilden bağımsız veri biçimidir. Daha fazla bilgi için json.org adresine bakın.