Data Studio API

Data Studio API'si, Data Studio öğelerini aramanıza ve yönetmenize olanak tanır.

API'nin temel kullanım alanı, Google Workspace veya Cloud Identity kuruluşlarının Data Studio öğelerinin yönetimini ve taşınmasını otomatikleştirmesine olanak tanımaktır.

Koşullara genel bakış

Data Studio API'yi kullanmak için aşağıdaki adımlar gereklidir:

  1. Bir uygulamayı API'yi kullanacak şekilde yapılandırın.
  2. Uygulamayı yetkilendirmek için Google Yönetici Konsolu'nu kullanın.
  3. OAuth 2.0 erişim jetonları alın ve API'yi çağırın.

Yukarıdaki adımlar, aşağıdaki yaygın senaryolara bağlı olarak aynı veya farklı kuruluşlar tarafından gerçekleştirilebilir:

  • Bir kuruluş için geliştirilen dahili uygulamalar. Kuruluş, uygulamayı yapılandırır ve kuruluşunun tüm kullanıcıları için yetkilendirir.
  • Harici kullanıcılar/müşteriler için geliştirilen üçüncü taraf uygulamaları (ör. geliştirici ve kullanıcılar farklı kuruluşlara aittir). Geliştirici uygulamayı yapılandırır ancak kullanıcının kuruluşu 3. taraf uygulamasına yetki verir.

1. Bir uygulamayı API kullanacak şekilde yapılandırma

Uygulamanızı yapılandırmak için aşağıdakileri tamamlayın:

API'yi etkinleştirme

Projenizde bir API'yi etkinleştirmek için:

  1. Google API Konsolu'nda [Data Studio API]'yi açın.
  2. İstenirse bir proje seçin veya yeni bir proje oluşturun.
  3. Etkinleştir'i tıklayın.
  4. İstenirse API'nin Hizmet Şartları'nı okuyup kabul edin.

OAuth istemcisi oluşturma

OAuth istemcisi oluşturmayla ilgili aşağıdaki adımlar genel yönergelerdir ve uygulama gereksinimlerinizi karşılayacak şekilde ayarlanmalıdır.

  1. OAuth kullanıcı rızası ekranını yapılandırın bölümüne gidin.
    1. Dahili'yi seçip Oluştur'u tıklayın.
    2. Zorunlu alanları doldurun ve Kaydet'i tıklayın.
  2. Kimlik bilgileri'ne gidin.
    1. KİMLİK BİLGİLERİ OLUŞTUR'u tıklayın.
    2. OAuth istemci kimliği'ni seçin.
    3. Uygun Application Type seçeneğini belirleyin. (En yaygın olanı web uygulamasıdır.)
    4. Zorunlu alanları doldurun ve Oluştur'u tıklayın.
  3. Uygulamayı yetkilendirmek için kullanılan istemci kimliğini not edin.

2. Uygulamayı bir kuruluş için yetkilendirme

Data Studio API'yi kullanan uygulamalar yalnızca kullanıcının kuruluşunun API erişimini kontrol etmek için alan genelinde temsil kullanarak uygulamayı yetkilendirdiği Google Workspace kullanıcılarının kimliğini doğrulayabilir ve bu kullanıcılara yetki verebilir.

Uygulamanın OAuth istemci kimliği ve uygulama tarafından gerekli kapsamlarla alan genelinde yetkiyi yapılandırın.

  1. Google Yönetici Konsolunuzda oturum açın ve alan genelinde yetki'ye gidin.
  2. API clients bölümünde Yeni ekle'yi tıklayın.
  3. Yetkilendirilecek uygulamanın Client ID değerini (ör. Data Studio API'yi kullanan uygulama) girin.
  4. Uygulama için gereken tüm OAuth kapsamlarını girin. Öğeleri yönetmek için Data Studio API'si kullanılıyorsa genellikle aşağıdaki kapsamlar istenir:
    • https://www.googleapis.com/auth/datastudio
    • https://www.googleapis.com/auth/userinfo.profile
  5. Yetkilendir'i tıklayın.

Uygulamayı yetkilendirdikten sonra, kuruluşa ait herhangi bir Workspace kullanıcısı, uygulamayı Data Studio API ile kullanmak için otomatik olarak yetkilendirilir.

3. OAuth 2.0 erişim jetonlarını alma ve API'yi çağırma

Uygulamayı geliştirip yetkilendirdikten sonra Workspace kullanıcıları için API'yi çağırmak üzere gerekli erişime sahip olursunuz. Google API'leriyle OAuth kullanarak çalışma hakkında ayrıntılı bilgi için Google API'lerine Erişmek İçin OAuth 2.0'ı Kullanma başlıklı makaleyi inceleyin. Kullanılabilir işlemler için API referansına bakın.

Sorun giderme

OAuth iletişim kutusu eksik

Bir kullanıcının kuruluşu uygulamayı yetkilendirdiyse, bu kuruluştaki kullanıcılara uygulamayı yetkilendirirken OAuth iletişim kutusu gösterilmez. Tek istisna, uygulamanın Workspace yöneticisinin yapılandırmadığı ek Google API kapsamları için yetkilendirme istemesi durumunda geçerlidir. Bu durumda, kullanıcılara OAuth iletişim kutusu gösterilir.

400 hatası: invalid_scope

Bir kullanıcı, uygulamayı yetkilendirmeye çalışırken Error 400: invalid_scope mesajı alırsa kullanıcının kuruluşu uygulamayı yetkilendirmemiş veya yanlış yetkilendirmiştir. Sorunu çözmek için kullanıcının kuruluşundan uygulamayı yetkilendirmesini istemesi gerekir.

Geçersiz bir kapsamın istendiğini belirten bir OAuth 400 hata mesajı