Google Workspace Events API kapsamlarını seçme

Bu belgede, Google Workspace Events API'ye özel yetkilendirme ve kimlik doğrulama bilgileri yer almaktadır. Bu dokümanı okumadan önce Kimlik doğrulama ve yetkilendirme hakkında bilgi edinme başlıklı makalede Google Workspace'in genel kimlik doğrulama ve yetkilendirme bilgilerini okuyun.

Yetkilendirme için OAuth 2.0'ı yapılandırma

Kullanıcılara ve uygulama incelemecilerine hangi bilgilerin gösterileceğini tanımlamak için OAuth kullanıcı rızası ekranını yapılandırın ve kapsamları seçin. Ardından, uygulamanızı daha sonra yayınlayabilmek için kaydedin.

Google Workspace Events API kapsamları

Uygulamanıza verilen erişim düzeyini tanımlamak için yetkilendirme kapsamlarını tanımlamanız ve beyan etmeniz gerekir. Yetkilendirme kapsamı, Google Workspace uygulamasının adını, eriştiği veri türünü ve erişim düzeyini içeren bir OAuth 2.0 URI dizesidir. Kapsamlar, uygulamanızın kullanıcıların Google Hesabı verileri de dahil olmak üzere Google Workspace verileriyle çalışma istekleridir.

Uygulamanız yüklendiğinde kullanıcıdan uygulama tarafından kullanılan kapsamları doğrulaması istenir. Genellikle, mümkün olan en dar kapsamı seçmeli ve uygulamanızın gerektirmediği kapsamları istemekten kaçınmalısınız. Kullanıcılar, sınırlı ve açıkça açıklanan kapsamlara daha kolay erişim izni verir.

Mümkün olduğunda, dosya başına erişim kapsamı sağladığı ve bir uygulamanın ihtiyaç duyduğu belirli işlevlere erişimi daralttığı için hassas olmayan kapsamlar kullanmanızı öneririz.

Google Workspace Events API, abonelikleri destekleyen Google Workspace uygulamalarından kapsamlar kullanır. Uygulamanız aboneliğiniz için gereken kapsamları zaten kullanıyorsa Google Workspace Events API'yi kullanmak için ek kapsam eklemeniz gerekmez.

Aşağıdaki tabloda, Google Workspace Events API için desteklenen kapsamlar gösterilmektedir:

Kapsam kodu Açıklama Kullanım
Google Chat  
https://www.googleapis.com/auth/chat.bot Google Chat uygulamalarının sohbetleri görüntülemesine ve mesaj göndermesine olanak tanır. Chat uygulamalarında kullanılabilen tüm özelliklere erişim sağlar. Hassas olmayan
https://www.googleapis.com/auth/chat.memberships Google Chat'teki görüşmelerde üyeleri görüntüleme, ekleme ve kaldırma
Hassas
https://www.googleapis.com/auth/chat.memberships.readonly Google Chat görüşmelerindeki üyeleri görüntüler.
Hassas
https://www.googleapis.com/auth/chat.spaces Google Chat'te görüşmeler ve alanlar oluşturma ve meta verileri (geçmiş ayarları dahil) görüntüleme veya güncelleme Hassas
https://www.googleapis.com/auth/chat.spaces.readonly Google Chat'te sohbet ve alanları görüntüleme.
Hassas
https://www.googleapis.com/auth/chat.messages.reaction sn Chat'te mesajlara tepki ekleme, verilen tepkileri görüntüleme ve silme
Hassas
https://www.googleapis.com/auth/chat.messages.reactions.readonly Chat'te bir mesaja verilen tepkileri görüntüleyin.
Hassas
https://www.googleapis.com/auth/chat.messages Mesajları görüntüleme, oluşturma, gönderme, güncelleme ve silme; mesajlara tepki ekleme, verilen tepkileri görüntüleme ve silme. Kısıtlanmış
https://www.googleapis.com/auth/chat.messages.readonly Google Chat'te mesajları ve tepkileri görüntüleyin.
Kısıtlanmış
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Uygulamaların, uygulamanız tarafından oluşturulan toplantı alanlarıyla ilgili meta verileri oluşturmasına, değiştirmesine ve okumasına izin verme.
Hassas
https://www.googleapis.com/auth/meetings.space.readonly Uygulamaların, kullanıcının erişebildiği tüm toplantı alanlarıyla ilgili meta verileri okumasına izin verin.
Hassas

Önceki tablodaki Kullanım sütunu, aşağıdaki tanımlara göre her bir kapsamın hassasiyetini belirtir:

  • Hassas olmayan: Bu kapsamlar, en küçük yetkilendirme erişimi kapsamını sağlar ve yalnızca temel uygulama doğrulaması gerektirir. Bu şart hakkında bilgi edinmek için Doğrulamaya hazırlanmayla ilgili adımlar başlıklı makaleyi inceleyin.

  • Hassas: Bu kapsamlar, uygulamanız için kullanıcı tarafından yetkilendirilmiş belirli Google kullanıcı verilerine erişim sağlar. Bu kapsamlar için ek uygulama doğrulamasından geçmeniz gerekir. Bu şart hakkında bilgi edinmek için Hassas kapsamlar isteyen uygulamalar için adımlar başlıklı makaleyi inceleyin.

  • Kısıtlanmış: Bu kapsamlar, Google kullanıcı verilerine geniş erişim sağlar ve kısıtlanmış kapsam doğrulama sürecinden geçmenizi gerektirir. Bu şart hakkında bilgi edinmek için Google API Hizmetleri: Kullanıcı Verileri Politikası ve Belirli API Kapsamları İçin Ek Gereksinimler başlıklı makaleleri inceleyin. Kısıtlanmış kapsam verilerini sunucularda depoluyorsanız (veya iletiyorsanız) güvenlik değerlendirmesinden geçmeniz gerekir.

Uygulamanız başka Google API'lerine erişim gerektiriyorsa bu kapsamları da ekleyebilirsiniz. Google API kapsamları hakkında daha fazla bilgi için Google API'lerine erişmek için OAuth 2.0'ı kullanma başlıklı makaleyi inceleyin.

Belirli OAuth 2.0 kapsamları hakkında daha fazla bilgi için Google API'leri için OAuth 2.0 Kapsamları başlıklı makaleyi inceleyin.

OAuth doğrulaması

Belirli OAuth kapsamlarını kullanmak, uygulamanızın Google'ın OAuth doğrulama sürecinden geçmesini gerektirebilir. Uygulamanızın ne zaman doğrulama işlemine tabi tutulması gerektiğini ve ne tür bir doğrulama gerektiğini belirlemek için OAuth API doğrulamayla ilgili SSS bölümünü okuyun. Google Drive Ek Hizmet Şartları'na da göz atın.

Gerekli kimlik doğrulama türleri

Bu bölümde, hangi kimlik doğrulama türlerinin zorunlu veya desteklendiğini açıklanmakta ve Google Workspace Events API'nin her yöntemi için desteklenen kapsamlar sağlanmaktadır.

Google Chat etkinliklerine aboneliklerde Google Workspace Events API, bazı yöntemlerini çağırmak için hem kullanıcı hem de uygulama kimlik doğrulamasını destekler. Bir API yöntemi her iki kimlik bilgisini de destekliyorsa çağrıda kullanılan kimlik bilgisi türü döndürülen sonucu etkiler. Örneğin, subscriptions.list() yöntemini kullanıcı kimlik doğrulamasıyla çağırırsanız API, kimliği doğrulanmış kullanıcının erişebileceği aboneliklerin listesini döndürür. Uygulama kimlik doğrulamasını kullanıyorsanız API, uygulamanın erişebileceği aboneliklerin listesini döndürür. Chat kimlik doğrulama türleri hakkında daha fazla bilgi edinmek için Chat uygulamaları ve Google Chat API isteklerinin kimliğini doğrulama ve yetkilendirme başlıklı makaleyi inceleyin.

Aşağıdaki tabloda, her bir Google Workspace Events API yöntemi için hangi kapsamların ve kimlik doğrulama türlerinin gerekli veya desteklendiğini görebilirsiniz:

Yöntem Kullanıcı kimlik doğrulaması gerekli veya desteklenir Uygulama kimlik doğrulaması desteklenir (yalnızca Google Chat uygulamaları) Desteklenen yetkilendirme kapsamları
Abonelik oluşturma

Her etkinlik türü için desteklenen bir kapsam gerekir:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Abonelik alma Kullanıcı kimlik doğrulamasında bu yöntem, abonelik için en az bir etkinlik türünü destekleyen bir kapsam gerektirir.

Uygulama kimlik doğrulamasıyla (yalnızca Google Chat uygulamaları):

  • chat.bot
Abonelikleri listeleme Kullanıcı kimlik doğrulamasında bu yöntem, abonelik için en az bir etkinlik türünü destekleyen bir kapsam gerektirir.

Uygulama kimlik doğrulamasıyla (yalnızca Google Chat uygulamaları):

  • chat.bot
Aboneliği güncelleme

Her etkinlik türü için desteklenen bir kapsam gerekir:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Aboneliği yeniden etkinleştirme

Her etkinlik türü için desteklenen bir kapsam gerekir:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Aboneliği silme Kullanıcı kimlik doğrulamasında bu yöntem, abonelik için en az bir etkinlik türünü destekleyen bir kapsam gerektirir.

Uygulama kimlik doğrulamasıyla (yalnızca Google Chat uygulamaları):

  • chat.bot

Etkinlik türüne göre kapsamlar

Google Workspace Events API'yi kullanıcı kimlik doğrulamasını kullanarak çağırdığınızda aboneliğin etkinlik türlerine karşılık gelen bir veya daha fazla kapsam belirtmeniz gerekir.

Aşağıdaki tabloda, her etkinlik türü için hangi yetkilendirme kapsamlarının desteklendiği gösterilmektedir:

Etkinlikler Etkinlik türleri Desteklenen yetkilendirme kapsamları
Google Chat  
Bir mesaj yayınlanır veya güncellenir.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
Bir tepki eklenir veya silinir ya da birden fazla tepki değiştirilir.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Bir üyelik oluşturulur, güncellenir veya kaldırılır ya da birden fazla üyelik değiştirilir.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
Bir alan güncellenir veya silinir.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
Konferans başlar veya sona erer.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
Bir katılımcı konferansa katılır veya konferanstan ayrılır.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
Bir kayıt oluşturuldu.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
Bir transkript oluşturuldu.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly