Kod örneklerini yürütme

Google API Gezgini, kod örneklerini dinamik olarak oluşturur. Bu kod örnekleri, yerel olarak kopyalanıp çalışacak şekilde tasarlanmıştır. Örnekleri görüntülemek için API Gezgini yan panelinde Tam ekran'ı tıklayın. Aşağıdaki şekilde, genişletilmiş tam ekran API'ler Gezgini gösterilmektedir:

Google Kitaplar API'si için API Gezgini tam ekran paneli
Şekil 2: Google Books API için API Gezgini tam ekran paneli.

Varsayılan olarak, API Gezgini, isteğinizi yürütmek için cURL'nin nasıl kullanılacağını gösterir. Bazı API'ler JavaScript, Java ve Python gibi diğer diller için de örnekler gösterebilir.

Kod örneklerini yerel olarak çalıştır

Aşağıdaki sekmelerde, kod örneklerini çalıştırmanın ön koşulları ve adımları açıklanmaktadır. Kod örneklerini çalıştırmak için kendi yetkilendirme kimlik bilgilerinizi oluşturup kullanmanız gerekir. Proje ve kimlik bilgisi oluşturma konusunda açıklama için Google API'lerinizin dokümanlarına bakın.

Kimlik bilgileri, yöntemin eriştiği veri türüne (herkese açık veya gizli) bağlı olarak aşağıdakilerden biridir:

  • Herkese açık verilerde kimlik bilgisi bir API anahtarıdır.

  • Gizli verilerde kimlik bilgisi, OAuth 2.0 istemci kimliğinizi ve istemci sırrınızı içeren bir client_secret.json dosyası veya OAuth 2.0 erişim jetonudur.

cURL

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Cloud Console'da bir API anahtarı oluşturun.
  3. Cloud Console'da bir web uygulaması için OAuth istemci kimliği kimlik bilgisi oluşturun ve yönlendirme URI'si olarak https://developers.google.com/oauthplayground kullanın.
  4. OAuth 2.0 Playground'da, OAuth 2.0 Yapılandırması 'nı tıklayın.
  5. Kendi kimlik bilgilerinizi kullanma'yı işaretleyin.
  6. 3. adımda oluşturulan istemci kimliğini ve gizli anahtarı girin.
  7. Kapsamlar alanına, yönteminizle kullanılacak kapsamı yazın ve API'leri Yetkilendir'i tıklayın.
  8. (İsteğe bağlı) Bir Oturum açma ekranı gösterilirse kullanılacak hesabı seçin.
  9. (İsteğe bağlı) Yetkilendirme ekranı gösterilirse Kabul et'i tıklayın.
  10. Jetonlar için yetkilendirme kodu takası'nı tıklayın. Jeton döndürülür.
  11. cURL kodu örneğinde [YOUR_API_KEY] değerini 2. adımda oluşturulan API anahtarıyla değiştirin: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
  12. cURL kodu örneğinde [YOUR_ACCESS_TOKEN]'yi 10. adımda oluşturulan erişim jetonuyla değiştirin: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Kod yürütme örneği

Komut satırında cURL komutunu çalıştırın. Komut şunun gibi olmalıdır:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Cloud Console'da bir API anahtarı oluşturun.
  3. Cloud Console'da bir "Web uygulaması" için OAuth istemci kimliği kimlik bilgisi oluşturun ve istek göndereceğiniz URL'yi (ör. http://localhost) tanımlamak için yetkili JavaScript kaynaklarını ayarlayın.
  4. Kod kodunun tamamını, web sunucunuz tarafından erişilebilen bir yerel dosyaya (örneğin, /var/www/html/example.html) kopyalayın.

  5. Kod örneğinde API anahtarını veya istemci kimliğini belirleyen satırı bulup değeri 2. ve 3. adımda oluşturulan değerlerle değiştirin:

    • API anahtarı: gapi.client.setApiKey(YOUR_API_KEY);
    • OAuth 2.0 istemci kimliği: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Kod yürütme örneği

  1. Tarayıcınızda dosyayı açın (örneğin, http://localhost/example.html). Google Chrome gibi hata ayıklama konsollarına sahip bir tarayıcı kullanmanızı öneririz.
  2. (İsteğe bağlı) Bir Oturum açma ekranı gösterilirse kullanılacak hesabı seçin.
  3. (İsteğe bağlı) Yetkilendirme ekranı gösterilirse Kabul et'i tıklayın. Hata ayıklama konsolu, yöntem yanıtını bir JSON nesnesi olarak görüntülemelidir.

Java

Ön koşullar

  • Java 1.7 veya üstü.
  • 7 veya daha büyük Gradle.

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Yöntemin eriştiği verilerin türüne bağlı olarak bir API anahtarı (herkese açık veriler) veya OAuth 2.0 istemci kimliği (gizli veriler) oluşturun.
  3. Uygulama türünü Masaüstü uygulaması olarak ayarlayın.
  4. OAuth 2.0 istemci kimliği oluşturduysanız OAuth 2.0 kimlik bilgilerinizi içeren JSON dosyasını indirin. Bu dosya, client_secret_CLIENTID.json benzeri bir ada sahip. Burada CLIENTID, projenizin istemci kimliğidir.

  5. Çalışma dizininizde, yeni bir proje yapısı oluşturmak için aşağıdaki komutları çalıştırın:

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  6. 2. adımda OAuth 2.0 istemci kimliği oluşturduysanız client_secret.json ürününe indirdiğiniz JSON dosyasını yeniden adlandırın.

  7. Yeniden adlandırılan dosyayı 5. adımda oluşturduğunuz src/main/resources dizinine kaydedin.

  8. Çalışma dizininizde build.gradle dosyasını açın ve içeriğini aşağıdaki şekilde değiştirin:

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

  9. build.gradle dosyasında, API_SPECIFIC_DEPENDENCY ifadesini içeren satırı, çağırdığınız API'nin kodunu derleme talimatıyla değiştirin. Aşağıda YouTube Analytics API için bir örnek verilmiştir:

    compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'

    Talimat şu şablona göre hazırlanır:

    compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'

Burada:

  • API_NAME, API için GitHub'da listelenen API adıdır. Adı bulmak için Desteklenen Google API'leri sayfasında API'nizin yanında bulunan sürüm bağlantısını tıklayın. Sürüm bağlantısı, GitHub'a gider. API adı, sayfanın üst orta kısmındadır ve önünde googleapis/google-apis-services- bulunur. Örneğin, Drive API'sinin v3 sürümü için API_NAME, drive şeklindedir.
  • API_VERSION, Desteklenen Google API'leri sayfasında API adının altında API için listelenen API sürümüdür.
  • REVISION, API'nin JavaDoc referansında listelenen düzeltme numarasıdır. JavaDoc referansını şu adreste bulabilirsiniz: https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
  • CL_VERSION, istemci kitaplığı sürümüdür. Bu değer, JavaDoc referansında da görünür.
  • Çalışma dizininizden API Gezgini'ndeki kod örneğini src/main/java/ApiExample.java konumuna kopyalayın. (Her örnekte sınıf adı ApiExample olduğundan farklı örnekler çalıştırmak için build.gradle dosyasını değiştirmeniz gerekmez.

Kod yürütme örneği

Örneği çalıştırmak için aşağıdaki komutu kullanın:

  gradle -q run

Örnek, API isteğinizi yürütmeli ve yanıtı STDOUT adresine yazdırmalıdır. Veri yazan isteklerin etkilerini görmek için, aradığınız hizmeti de kontrol edebilirsiniz.

Node.js

Ön koşullar

  • Node.js

  • Node.js için Google API'leri İstemci Kitaplığı

    • İstemci kitaplığını daha önce yüklemediyseniz komutu çalıştırın:
    npm install googleapis --save
    • İstemci kitaplığını daha önce yüklediyseniz test ettiğiniz kitaplık için en güncel sınıflara sahip olduğunuzdan emin olmak amacıyla kitaplığı güncellemenizi öneririz. İstemci kitaplığını güncellemek için komutu çalıştırın:
    npm update googleapis --save

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Yöntemin eriştiği verilerin türüne bağlı olarak bir API anahtarı (herkese açık veriler) veya OAuth 2.0 istemci kimliği (gizli veriler) oluşturun.
  3. Uygulama türünü Masaüstü uygulaması olarak ayarlayın.
  4. OAuth 2.0 istemci kimliği oluşturduysanız OAuth 2.0 kimlik bilgilerinizi içeren JSON dosyasını indirin. Bu dosya, client_secret_CLIENTID.json benzeri bir ada sahip. Burada CLIENTID, projenizin istemci kimliğidir.
  5. Kod örneğini yerel bir dosyaya kopyalayın ve API anahtarınızı veya istemci gizli anahtarları dosyanızı doğru bir şekilde tanımlamak için örneği değiştirin. Örnekte, API anahtarı değeri YOUR_API_KEY ve istemci gizli anahtarları dosyası konumu YOUR_CLIENT_SECRET_FILE.json şeklindedir.

Kod yürütme örneği

Örneği çalıştırmak için aşağıdaki komutu kullanın:

  node sample.js

Çoğu örnek, STDOUT'ye bir API yanıtı (veya başka bir şey) yazdırır.

PHP

Ön koşullar

  • Komut satırı arayüzü (KSA) ve JSON uzantısıyla PHP 5.4 veya sonraki sürümler.
  • Dünya genelinde yüklenen Oluşturucu bağımlı yönetim aracı.

  • PHP için Google API'leri İstemci Kitaplığı

    • İstemci kitaplığını daha önce yüklemediyseniz komutu çalıştırın:

      composer require google/apiclient:^2.0

    • İstemci kitaplığını önceden yüklediyseniz test ettiğiniz kitaplık için en güncel sınıflara sahip olduğunuzdan emin olmak amacıyla kitaplığı güncellemenizi öneririz. İstemci kitaplığını güncellemek için komutu çalıştırın:

      composer update google/apiclient --with-dependencies

Kod yürütme örneği

Örneği çalıştırmak için aşağıdaki komutu kullanın:

  php sample.php

Çoğu örnek, STDOUT'ye bir API yanıtı (veya başka bir şey) yazdırır.

Python

Ön koşullar

  • Python 2.7 veya Python 3.5+
  • Pip paketi yönetim aracı

  • Python için Google API'leri İstemci Kitaplığı

    pip install --upgrade google-api-python-client

  • Kullanıcı yetkilendirme için google-auth-oauthlib ve google-auth-httplib2 kitaplıkları:

    pip install --upgrade google-auth-oauthlib google-auth-httplib2

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Yöntemin eriştiği verilerin türüne bağlı olarak bir API anahtarı (herkese açık veriler) veya OAuth 2.0 istemci kimliği (gizli veriler) oluşturun.
  3. Uygulama türünü Masaüstü uygulaması olarak ayarlayın.
  4. OAuth 2.0 istemci kimliği oluşturduysanız OAuth 2.0 kimlik bilgilerinizi içeren JSON dosyasını indirin. Bu dosya, client_secret_CLIENTID.json benzeri bir ada sahip. Burada CLIENTID, projenizin istemci kimliğidir.
  5. Kod örneğini yerel bir dosyaya kopyalayın ve API anahtarınızı veya istemci gizli anahtarları dosyanızı doğru bir şekilde tanımlamak için örneği değiştirin. Örnekte, API anahtarı değeri YOUR_API_KEY ve istemci gizli anahtarları dosyası konumu YOUR_CLIENT_SECRET_FILE.json şeklindedir.

Kod yürütme örneği

Örneği çalıştırmak için aşağıdaki komutu kullanın:

  python sample.py

Çoğu örnek, STDOUT'ye bir API yanıtı (veya başka bir şey) yazdırır.

Ruby

Ön koşullar

  • Yakut 2.0 veya üzeri

  • Yakut için Google API'leri İstemci Kitaplığı:

    gem install google-api-client`

Ayarlama

  1. Uygulamanız için bir proje oluşturmak veya seçmek ve API'yi etkinleştirmek üzere API dokümanlarındaki talimatları uygulayın.
  2. Yöntemin eriştiği verilerin türüne bağlı olarak bir API anahtarı (herkese açık veriler) veya OAuth 2.0 istemci kimliği (gizli veriler) oluşturun.
  3. Uygulama türünü Masaüstü uygulaması olarak ayarlayın.
  4. OAuth 2.0 istemci kimliği oluşturduysanız OAuth 2.0 kimlik bilgilerinizi içeren JSON dosyasını indirin. Bu dosya, client_secret_CLIENTID.json benzeri bir ada sahip. Burada CLIENTID, projenizin istemci kimliğidir.
  5. Kod örneğini yerel bir dosyaya kopyalayın ve API anahtarınızı veya istemci gizli anahtarları dosyanızı doğru bir şekilde tanımlamak için örneği değiştirin. Örnekte, API anahtarı değeri YOUR_API_KEY ve istemci gizli anahtarları dosyası konumu YOUR_CLIENT_SECRET_FILE.json şeklindedir.

Kod yürütme örneği

Örneği çalıştırmak için aşağıdaki komutu kullanın:

  ruby sample.rb

Çoğu örnek, STDOUT'ye bir API yanıtı (veya başka bir şey) yazdırır.

Örnek sorunları giderme

Yetkilendirme iletişim kutusu görünmüyor

API Gezgini, özel verilerinize erişim vermek için bir pop-up kullanır. Tarayıcınız pop-up'ları engellerse bu pop-up görünmez ve erişim izni veremezsiniz.

Yetkilendirme ekranında "İzin Ver"i tıklarsanız ve bir şey olmazsa tarayıcınızın pop-up ayarlarını değiştirerek pop-up'ları etkinleştirmeyi deneyin.

401 veya 403 hatası alma

Bir örneği test ederken 401 veya 403 hatası alıyorsanız bunun nedeni aşağıdakilerden biri olabilir:

  • API, projeniz için etkin değil. API oluşturma ve API'yi etkinleştirmeyle ilgili talimatları inceleyin.
  • Yanlış yetkilendirme türü (OAuth 2.0 yerine API anahtarı) kullanıyorsunuz.
  • OAuth 2.0 kullanıyorsunuz, ancak kapsamı çok dar.
  • API anahtarınızı oluştururken, kimlik bilgilerinizin yetkisiz kullanımını önlemek için kısıtlamalar ayarlarsınız. Ancak istek bu kısıtlamaları karşılamıyor. Daha fazla bilgi için API anahtarı kısıtlamalarını kullanma bölümüne bakın.

Karma içerik hakkında uyarı alındı

Google Cloud Uç Noktalarını kullanıyorsanız ve uç noktanızı bir geliştirme sunucusunda çalıştırıyorsanız tarayıcınız karma içerik hakkında bir uyarı verebilir. Bu uyarı, API Gezgini HTTPS üzerinden yüklendiğinden ancak API'niz yerel olarak çalıştığında HTTP üzerinde barındırıldığı için meydana gelir.

Bu uyarıyı Chrome kullanarak gizlemek için özel flag'leri olan bir Chrome oturumunu aşağıdaki şekilde başlatın:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Örnek:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Bu uyarıyı yalnızca yerel test amacıyla gizlemelisiniz.

Yalnızca JavaScript: gapi tanımlanmamış

"Gapi tanımlanmamış" hatası, JavaScript kodu kitaplık yüklenmeden önce JavaScript için Google API İstemci Kitaplığı'nı çağırmaya çalıştığında meydana gelir. gapi değişkenine başvuruda bulunan kodunuzun, istemci kitaplığı yüklenene kadar çağrılmadığından emin olun.