Temel kurulum

Devam etmek için Ön koşullar bölümündeki adımları tamamladığınızdan ve projenizi İşletme Profili API'lerine erişim için onayladığımızdan emin olun.

API'leri etkinleştirme

Google API Konsolu'nda etkinleştirilmesi gereken, İşletme Profili ile ilişkili sekiz API vardır:

  • Google My Business API
  • Benim İşletmem Hesap Yönetim API'sı
  • My Business Lodging API'sı
  • My Business Place Actions API'sı
  • My Business Notifications API
  • Benim İşletmem Doğrulama API'sı
  • Benim İşletmem Bilgileri API'sı
  • Benim İşletmem Soru-Cevap API'sı

Bir API'yi etkinleştirin

Önkoşulların tümünü tamamlamanıza ve API'ye erişim izniniz olmasına rağmen sağlanan kısayolu yine de kullanamıyorsanız aşağıdaki adımları uygulayarak API'yi manuel olarak etkinleştirebilirsiniz.

Projenizde bir API'yi etkinleştirmek için şunları yapın:

  1. Google API Konsolu'nda API Kitaplığı'nı açın. İstenirse bir proje seçin veya yeni bir proje oluşturun. API Kitaplığı'nda, kullanılabilir tüm API'ler ürün ailesine ve popülerliğe göre gruplandırılmış şekilde listelenir.
  2. Etkinleştirmek istediğiniz API listede görünmüyorsa bulmak için arama işlevini kullanın.
  3. Etkinleştirmek istediğiniz API'yi seçin, ardından Etkinleştir düğmesini tıklayın.
  4. İstenirse faturalandırmayı etkinleştirin.
  5. İstenirse API'nin Hizmet Şartları'nı kabul edin.

Google Workspace kullanıcısıysanız Google Workspace kuruluşunuzdaki hesabınızda Google İşletme Profili'nin etkinleştirildiğinden emin olun. Google İşletme Profili, Google Workspace kuruluşunuzdaki hesabınız için devre dışıysa GİP API'lerini kullanırken "hata 403 - İZİN REDDEDİLDİ" mesajı alırsınız.

OAuth 2.0 istemci kimliği isteyin

Uygulamanız korumalı, herkese açık olmayan verilere eriştiği için bir OAuth 2.0 istemci kimliğine ihtiyacınız vardır. Bu sayede uygulamanız, kullanıcıları adına, kuruluşunuzun konum verilerine erişmek için yetkilendirme isteyebilir.

Uygulamanız, gizli kullanıcı verilerine erişen tüm İşletme Profili API'leri istekleriyle birlikte bir OAuth 2.0 jetonu göndermelidir.

Henüz yapmadıysanız Google API Konsolu'nun "Kimlik Bilgileri" bölümüne gidin ve OAuth 2.0 kimlik bilgilerinizi oluşturmak için Kimlik bilgileri oluştur > OAuth istemci kimliği'ni tıklayın. Kimlik bilgilerini oluşturduktan sonra, Kimlik Bilgileri sayfasında istemci kimliğinizi görebilirsiniz. İstemci gizli anahtarı, yönlendirme URI'leri, JavaScript kaynak adresi ve e-posta adresi gibi ayrıntılar için istemci kimliğini tıklayın.

REST ile ilgili temel bilgileri öğrenin

API'leri iki şekilde çağırabilirsiniz:

İstemci kitaplıklarını kullanmamaya karar verirseniz REST ile ilgili temel bilgileri anlamanız gerekir.

REST, veri isteme ve değiştirme için kullanışlı ve tutarlı bir yaklaşım sunan 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 depolanan verilerin temsillerini almak ve değiştirmek için HTTP fiillerinin kullanılmasını belirtir.

RESTful sistem, kaynakları veri deposunda depolar. Bir istemci, kaynak oluşturma, alma, güncelleme veya silme gibi belirli bir işlemi gerçekleştirmek için sunucuya bir istek gönderir. Sunucu, işlemi gerçekleştirir ve bir yanıt gönderir. Bu yanıt genellikle belirtilen kaynağın temsil edilmesi şeklinde verilir.

Google'ın RESTful API'lerinde istemci, HTTP fiil içeren bir işlem (ör. GET, POST, PUT veya DELETE) belirtir. İstemci, bir kaynağı aşağıdaki biçimdeki genel olarak benzersiz bir tek tip kaynak tanımlayıcısına (URI) göre belirtir:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

Tüm API kaynaklarında HTTP tarafından erişilebilen benzersiz URI'ler olduğu için REST, verileri önbelleğe almayı etkinleştirir ve web'in dağıtılan altyapısıyla çalışmak üzere optimize edilmiştir.

HTTP 1.1 standartları belgelerindeki yöntem tanımlarını faydalı bulabilirsiniz. Bunlar GET, POST, PUT ve DELETE için spesifikasyonları içerir.

İşletme Profili API'lerinde REST

İşletme Profili API'leri işlemleri, doğrudan REST HTTP fiilleriyle eşlenir.

Business Profile API'lere özel biçim aşağıdaki URI'de gösterilmektedir:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

API'lerde desteklenen her işlem için kullanılan URI'ların tam grubu, İşletme Profili API'lerinin Referans dokümanlarında görünür.

Kaynak yolları, uç noktaya göre farklılık gösterir.

Örneğin, bir hesabın kaynak yolu aşağıdaki örnekteki gibi görünür:

accounts/accountId

Bir konum için kaynak yolu aşağıdaki biçimde görünür:

locations/locationId

JSON ile ilgili temel bilgileri öğrenin

Business Profile API, verileri JSON biçiminde döndürür.

JavaScript Object Notation (JSON), rastgele veri yapılarının basit metin temsilini sağlayan yaygın ve dilden bağımsız bir veri biçimidir. Daha fazla bilgi için json.org adresine bakın.

Basit bir HTTP isteği gönderme

OAuth 2.0 Playground'u kullanarak Business Profile API'lerle denemeler yapabilirsiniz. İşletme Profili API'leri herkese açık API olmadığından, Playground'da kullanmak için uygulamanız gereken birkaç ek adım vardır. Web uygulamasının devam etmesi için istemci kimliği gerekir.

  1. Google API Konsolu'na gidin ve projenizi açın. Web uygulamaları için OAuth istemci kimliğiniz yoksa hemen bir tane oluşturun:
    1. Kimlik bilgileri oluşturun açılır listesinden OAuth istemci kimliği'ni seçin.
    2. Uygulama türü için Web Uygulaması'nı tıklayın.

    3. Aşağıdakini geçerli bir yönlendirme URI'si olarak ekleyin:

       https://developers.google.com/oauthplayground
    4. Oluştur'u tıklayın.
  2. İstemci kimliğini panoya kopyalayın.
  3. OAuth 2.0 Playground'a (OAuth 2.0 Playground) gidin.
  4. Yapılandırma seçeneklerini açmak ve aşağıdaki değişiklikleri yapmak için dişli simgesini tıklayın:
    1. OAuth akışı'nı İstemci tarafı olarak ayarlayın.
    2. Kendi OAuth kimlik bilgilerinizi kullanın'ı seçin.
    3. OAuth istemci kimliğinizi yapıştırın.
  5. Yapılandırma seçeneklerini kapatın.

  6. "1. Adım - API'leri seçin ve yetkilendirin" bölümünde İşletme Profili API'leri için aşağıdaki kapsamı Kendi kapsamlarınızı girin alanına yapıştırın:

    https://www.googleapis.com/auth/business.manage
  7. API'leri yetkilendir'i tıklayın.
  8. İstendiğinde Kabul et'i tıklayın.

  9. "2. Adım - API isteğini yapılandırın" altında aşağıdaki URI'yi İstek URI'si alanına yapıştırın: 

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. İsteği gönder'i tıklayın. Yanıtın durumu 200 OK olarak görünmelidir.

Çeşitli türde istekler gönderme hakkında daha fazla bilgi edinmek için İşletme Profili API'leri Referansı'nı inceleyin.

İstemci kitaplıkları

İşletme Profili API'leri istemci kitaplıkları, İşletme Profili API'lerinin işlevlerini destekler. HTTP aktarımı, hata işleme, kimlik doğrulama ve JSON ayrıştırma gibi tüm Google API'lerinde ortak olan işlevler sunarlar.

İstemci kitaplıklarını indirmek için Kitaplıklar konusuna bakın.