Kapsamlar

Kullanıcılar, verilerine erişen veya kendi adlarına işlem yapan eklentileri ve diğer uygulamaları yetkilendirmelidir. Kullanıcı bir eklentiyi ilk kez çalıştırdığında, eklenti kullanıcı arayüzünde yetkilendirme akışını başlatmak için bir yetkilendirme istemi gösterilir.

Bu akış sırasında istem, uygulamanın ne yapmak için izin istediğini kullanıcıya bildirir. Örneğin, bir eklenti, kullanıcının e-posta iletisini okuma veya takviminde etkinlik oluşturma izni isteyebilir. Eklentinin komut dosyası projesi, bu izinleri OAuth kapsamları olarak tanımlar.

URL dizelerini kullanarak manifest dosyanızda kapsamları beyan edersiniz. Yetkilendirme akışı sırasında Apps Komut Dosyası, kapsamın okunabilir bir açıklamasını kullanıcıya sunar. Örneğin, Google Workspace eklentiniz, manifestinizde https://www.googleapis.com/auth/gmail.addons.current.message.readonly olarak yazılan "Mevcut mesajı oku" kapsamını kullanabilir. Yetkilendirme akışı sırasında bu kapsama sahip bir eklenti, kullanıcıdan eklentinin çalışırken e-posta iletilerinizi görüntülemesine izin vermesini ister.

Apps Komut Dosyası'nın çeşitli hizmetleri için kullandığı kapsamlar, ilgili API'nin kullandığı kapsamlarla çakışıyor. Örneğin, Apps Komut Dosyası'nın Takvim hizmeti, Calendar API ile aynı kapsamların çoğunu kullanır. Belirli Apps Komut Dosyası hizmeti yöntemlerinin gerektirdiği kapsamları Apps Komut Dosyası referans belgelerinde bulabilirsiniz.

Kapsamları görüntüleme

Aşağıdaki adımları uygulayarak komut dosyası projenizin şu anda gerektirdiği kapsamları görebilirsiniz:

1. Senaryo projesini açın.
2. Sol tarafta Genel bakış'ı tıklayın info_outline.
3. "Project OAuth Scopes" (Proje OAuth Kapsamları) bölümündeki kapsamları görüntüleyin.

Ayrıca, komut dosyası projesinin mevcut kapsamlarını proje manifestosundaki oauthScopes alanında da görüntüleyebilirsiniz ancak bu kapsamları yalnızca açıkça ayarladıysanız.

Açık kapsamlar ayarlama

Apps Komut Dosyası, kodunu tarayarak bir komut dosyasının hangi kapsamlara ihtiyacı olduğunu otomatik olarak belirler. Bu, çoğu komut dosyası için yeterlidir ve zamandan tasarruf etmenizi sağlar. Ancak yayınlanmış eklentiler için kapsamlar üzerinde daha doğrudan kontrol sahibi olmanız gerekir.

Örneğin, Apps Komut Dosyası, eklenti komut dosyası projesine varsayılan olarak çok izin verici bir kapsam (https://mail.google.com) verebilir. Bir kullanıcı bu kapsamla bir komut dosyası projesine yetki verdiğinde, projeye kullanıcının Gmail hesabına tam erişim izni verilir. Yayınlanmış eklentiler için bu kapsamı, eklentilerin ihtiyaçlarını karşılayan ve daha sınırlı bir kapsamla değiştirmeniz gerekir.

Komut dosyası projenizin kullandığı kapsamları manifest dosyasını düzenleyerek açıkça ayarlayabilirsiniz. Manifest alanı oauthScopes, eklenti tarafından kullanılan tüm kapsamların dizisidir. Projenizin kapsamlarını ayarlamak için aşağıdakileri yapın:

1. Eklentinizin kullandığı kapsamları görüntüleyin. Daha dar bir kapsam kullanmak gibi hangi değişikliklerin yapılması gerektiğini belirleyin.
2. Eklentinizin manifest dosyasını açın.
3. oauthScopes etiketli üst düzey alanı bulun. Bu seçenek yoksa ekleyebilirsiniz.

4. oauthScopes alanı, bir dizi dize belirtir. Projenizin kullandığı kapsamları ayarlamak için bu dizinin içeriğini, projenin kullanmasını istediğiniz kapsamlarla değiştirin. Örneğin, Gmail'i genişleten bir Google Workspace eklentisi için aşağıdakilere sahip olabilirsiniz:

    {
      ...
      "oauthScopes": [
        "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
        "https://www.googleapis.com/auth/userinfo.email"
      ],
      ...
    }
   

5. Manifest dosyası değişikliklerini kaydedin.

OAuth doğrulaması

Belirli hassas OAuth kapsamlarının kullanılması, eklentinizin yayınlanabilmesi için OAuth istemci doğrulaması sürecinden geçmesini gerektirebilir. Daha fazla bilgi için aşağıdaki kılavuzlara bakın:

• Apps Komut Dosyası için OAuth istemci doğrulaması
• Doğrulanmamış uygulamalar
• OAuth doğrulaması ile ilgili SSS
• Google API'leri Hizmeti: Kullanıcı Verileri Politikası

Kısıtlanmış kapsamlar

Belirli kapsamlar kısıtlanmıştır ve kullanıcı verilerinin korunmasına yardımcı olan ek kurallara tabidir. Bir veya daha fazla kısıtlanmış kapsam kullanan bir Gmail ya da Düzenleyici eklentisi yayınlamayı planlıyorsanız eklenti, yayınlanmadan önce belirtilen tüm kısıtlamalara uymalıdır.

Yayınlamayı denemeden önce kısıtlanmış kapsamların tam listesini inceleyin. Eklentiniz bunlardan herhangi birini kullanıyorsa yayınlamadan önce Belirli API kapsamları için ek koşullar'a uymanız gerekir.

Visual Studio Code için Google Workspace Geliştirici Araçları uzantısı, kapsamın açıklaması ve hassas veya kısıtlanmış olup olmadığı da dahil olmak üzere tüm kapsamlarla ilgili teşhis bilgileri sağlar.

Google Workspace eklentileri için kapsam seçme

Aşağıdaki bölümlerde, Google Workspace eklentileri için en çok tercih edilen kapsamlar verilmiştir.

Düzenleyici kapsamları

Google Workspace eklentileri için sık kullanılan aşağıdaki kapsamlar, Google Dokümanlar, Google E-Tablolar ve Google Slaytlar'ı genişletir.

Gmail

Kullanıcı Gmail verilerinin korunmasına yardımcı olmak için Google Workspace eklentilerine özel olarak oluşturulmuş kapsamlar vardır. Bu kapsamları, gereken diğer kapsamlarla birlikte eklenti manifestinize açıkça ekleyin.

Aşağıdaki tabloda, Gmail'i genişleten Google Workspace eklentileri için sık kullanılan kapsamlar listelenmektedir. Eklentiniz Gmail'i genişletiyorsa Zorunlu olarak etiketlenen tüm kapsamları Google Workspace eklenti manifestinize eklemeniz gerekir.

Geniş kapsamlı https://mail.google.com kapsamını, eklentinizin ihtiyaç duyduğu etkileşimlere izin veren daha dar bir kapsam grubuyla değiştirin.

Google Takvim kapsamları

Aşağıdaki tabloda, Google Takvim'i genişleten Google Workspace eklentileri için sık kullanılan kapsamlar listelenmektedir.

Google Chat kapsamları

Google Chat API'sini çağırmak için Google Chat kullanıcısı veya Google Chat uygulaması olarak kimliğinizi doğrulayın. Her kimlik doğrulama türü farklı kapsamlar gerektirir ve tüm Chat API yöntemleri uygulama kimlik doğrulamasını desteklemez.

Chat kapsamları ve kimlik doğrulama türleri hakkında daha fazla bilgi edinmek için Chat API Kimlik doğrulama ve yetkilendirmeye genel bakış başlıklı makaleyi inceleyin.

Aşağıdaki tabloda, desteklenen kimlik doğrulama türlerine göre sık kullanılan Chat API yöntemleri ve kapsamları gösterilmektedir:

Google Drive kapsamları

Aşağıdaki tabloda, Google Drive'ı genişleten Google Workspace eklentileri için sık kullanılan kapsamlar listelenmektedir.

Erişim jetonları

Google Workspace eklentilerinde kullanılan Gmail kapsamları, kullanıcı verilerini korumak için kullanıcı verilerine geçici erişim izni verir. Geçici erişimi etkinleştirmek için GmailApp.setCurrentMessageAccessToken işlevini işlem etkinliği nesnesinden alınan bir erişim jetonuyla çağırın.

Gmail kapsamlarını etkinleştiren erişim jetonu, ScriptApp.getOAuthToken tarafından döndürülen erişim jetonuyla aynı değil. İşlem etkinliği nesnesinde sağlanan jetonu kullanın.

Aşağıda, bir mesajın meta verilerine erişime izin vermek için erişim jetonunun ayarlanmasına ilişkin bir örnek gösterilmektedir. Bu örnek için gerekli tek kapsam https://www.googleapis.com/auth/gmail.addons.current.message.metadata'dır.

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

Diğer Google Workspace kapsamları

Eklentiniz, diğer Google Workspace veya Apps Komut Dosyası hizmetlerini kullanıyorsa ek kapsamlar gerektirebilir. Çoğu durumda Apps Komut Dosyası bu kapsamları algılar ve manifesti otomatik olarak günceller. Manifestinizin kapsam listesini düzenlerken, daha dar bir alternatifle değiştirmediğiniz sürece kapsamları kaldırmayın.

Aşağıdaki tabloda, Google Workspace eklentilerinin sıklıkla kullandığı kapsamlar gösterilmektedir: