Temel kurulum

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

API'leri etkinleştirme

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

  • Google My Business API
  • My Business Account Management API
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • My Business Verifications API
  • My Business Business Information API
  • My Business Q&A API

Bir API'yi etkinleştirin

Tüm önkoşulları tamamladıysanız ve API'ye erişim izni aldıysanız ancak sağlanan kısayolu hâlâ kullanamıyorsanız aşağıdaki adımları uygulayarak API'yi manuel olarak etkinleştirebilirsiniz.

Projeniz için bir API'yi etkinleştirmek üzere şunları yapın:

  1. Google API Konsolu'nda API Kitaplığı'nı açın. İstenirse bir proje seçin veya yeni proje oluşturun. API Kitaplığı, mevcut tüm API'leri ürün ailesine ve popülerliğe göre gruplandırarak listeler.
  2. Etkinleştirmek istediğiniz API listede görünmüyorsa aramayı kullanarak API'yi bulun.
  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şunuzda Google İşletme Profili'nin hesabınız için etkinleştirildiğini onaylayın. Google Workspace kuruluşunuzdaki hesabınız için Google İşletme Profili devre dışıysa GBP API'lerini kullanırken "error 403 - PERMISSION DENIED" (403 hatası - İZİN REDDEDİLDİ) alırsınız.

OAuth 2.0 istemci kimliği isteme

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

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

Henüz yapmadıysanız OAuth 2.0 kimlik bilgilerinizi oluşturmak için Google API Console'un "Kimlik bilgileri" bölümüne gidin ve Kimlik bilgileri oluştur > OAuth istemci kimliği'ni tıklayın. Kimlik bilgilerini oluşturduktan sonra istemci kimliğinizi Kimlik Bilgileri sayfasında görebilirsiniz. İstemci gizli anahtarı, URI'leri yeniden yönlendirme, JavaScript başlangıç noktası 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 çağırmanın iki yolu vardır:

Müşteri kitaplıklarını kullanmamaya karar verirseniz REST'in temellerini anlamanız gerekir.

REST, verileri istemek ve değiştirmek için kullanışlı ve tutarlı bir yaklaşım sunan bir yazılım mimarisi stilidir.

REST, "Representational State Transfer" (Temsili Durum Aktarımı) ifadesinin 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ımını ifade eder.

RESTful sistem, kaynakları bir veri deposunda depolar. İstemci, sunucunun belirli bir işlemi (ör. kaynak oluşturma, getirme, 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 genellikle belirtilen kaynağın bir temsili şeklindedir.

Google'ın RESTful API'lerinde istemci, GET, POST, PUT veya DELETE gibi bir HTTP fiili içeren bir işlem belirtir. Müşteri, bir kaynağı aşağıdaki biçime sahip genel olarak benzersiz bir tekdüzen kaynak tanımlayıcısı (URI) ile belirtir:

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

Tüm API kaynaklarının benzersiz HTTP erişilebilir URI'leri olduğundan REST, veri önbelleğe almayı sağlar ve web'in dağıtılmış altyapısıyla çalışmak için optimize edilmiştir.

HTTP 1.1 standartları dokümanlarında yer alan yöntem tanımlarını faydalı bulabilirsiniz. GET, POST, PUT ve DELETE ile ilgili özellikleri içerir.

İşletme Profili API'lerinde REST

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

Business Profile API'leri için ö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'lerin tamamı, İşletme Profili API'leri Referans dokümanlarında yer alır.

Kaynak yolları uç noktaya göre değişir.

Örneğin, bir hesaba ait kaynak yolu aşağıdaki örnekte gösterildiği gibi görünür:

accounts/accountId

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

locations/locationId

JSON ile ilgili temel bilgileri öğrenin

İşletme Profili API'leri verileri JSON biçiminde döndürür.

JavaScript Nesne Gösterimi (JSON), rastgele veri yapılarının basit bir metin temsilini sağlayan, yaygın ve dile bağlı olmayan bir veri biçimidir. Daha fazla bilgi için json.org adresini ziyaret edin.

Basit bir HTTP isteği yapmak için Oauth Playground'u kullanma

İşletme Profili API'lerini denemek için OAuth 2.0 Playground'u kullanabilirsiniz. İşletme Profili API'leri herkese açık API'ler olmadığından, bunları Playground'da kullanmak için birkaç ek adım uygulamanız gerekir. Devam etmek için bir web uygulamasının istemci kimliğine ihtiyacınız vardır.

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

    3. Aşağıdakileri 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 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'ye isteği yapılandırın" bölümünde, 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, 200 OK durumunu göstermelidir.

Çeşitli istek türleri gönderme hakkında daha fazla bilgi için Business Profile API'leri Referansı'na bakın.

İstemci kitaplıkları

Business Profile API'leri istemci kitaplıkları, Business Profile 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şlevleri sağlarlar.

İstemci kitaplıklarını indirmek için Kitaplıklar bölümüne bakın.