Node.js çalışma zamanını kullanarak Cloud Functions'ta Google Workspace eklentileri oluşturun.
Hedefler
- Ortamınızı ayarlayın.
- Cloud Functions işlevi oluşturma ve dağıtma
- Eklentiyi oluşturun ve dağıtın.
- Eklentiyi yükleyin.
Ön koşullar
Cloud projeniz için faturalandırmayı etkinleştirdiğinizden emin olun. Projelerinizin faturalandırma durumunu nasıl doğrulayacağınızı öğrenin.
Google Cloud SDK, Cloud projesiyle yapılandırılır.
Ortamınızı ayarlama
Cloud projenizi Google Cloud Console'da açın.
- Google Cloud Console'da Proje seçin sayfasına gidin.
- Kullanmak istediğiniz Google Cloud projesini seçin. Alternatif olarak, Proje oluştur'u tıklayıp ekrandaki talimatları uygulayın. Google Cloud projesi oluşturursanız proje için faturalandırmayı etkinleştirmeniz gerekebilir.
OAuth kullanıcı rızası ekranını yapılandırma
Google Workspace eklentileri için izin ekranı yapılandırması gerekir. Eklentinizin OAuth kullanıcı rızası ekranını yapılandırmak, Google'ın kullanıcılara ne göstereceğini tanımlar.
- Google Cloud Console'da Menü > Google Auth platform > Markalama'ya gidin.
- Google Auth platformyapılandırdıysanız Markalama, Kitle ve Veri Erişimi'nde aşağıdaki OAuth kullanıcı rızası ekranı ayarlarını yapılandırabilirsiniz. Google Auth platform henüz yapılandırılmadı mesajını görürseniz Başlayın'ı tıklayın:
- Uygulama Bilgileri bölümündeki Uygulama adı alanına uygulamanın adını girin.
- Kullanıcı destek e-postası bölümünde, kullanıcıların rızalarıyla ilgili soruları olduğunda sizinle iletişime geçebileceği bir destek e-posta adresi seçin.
- İleri'yi tıklayın.
- Kitle bölümünde Dahili'yi seçin.
- İleri'yi tıklayın.
- İletişim bilgileri bölümünde, projenizde yapılan değişikliklerle ilgili bildirim alabileceğiniz bir e-posta adresi girin.
- İleri'yi tıklayın.
- Bitir bölümünde Google API Hizmetleri Kullanıcı Verileri Politikası'nı inceleyin ve kabul ediyorsanız Google API Hizmetleri: Kullanıcı Verileri Politikası'nı kabul ediyorum'u seçin.
- Devam'ı tıklayın.
- Oluştur'u tıklayın.
- Şimdilik kapsam eklemeyi atlayabilirsiniz. Gelecekte Google Workspace kuruluşunuzun dışında kullanılacak bir uygulama oluşturduğunuzda Kullanıcı türü'nü Harici olarak değiştirmeniz gerekir. Ardından, uygulamanızın gerektirdiği yetkilendirme kapsamlarını ekleyin. Daha fazla bilgi için OAuth iznini yapılandırma başlıklı kılavuzun tamamını inceleyin.
Cloud Functions işlevi oluşturma ve dağıtma
Google Cloud Console'da Cloud Shell'i etkinleştir'i
tıklayın.
Cloud Shell terminali açılır ve Google Cloud Console'un alt bölmesinde bir oturum başlatılır.
Cloud Shell'i sağlama ve Cloud Shell'e bağlanma için Yetkilendir'i tıklayın.
Cloud Shell Terminali'nde Cloud Functions API, Cloud Build API, Google Workspace eklentileri API'si ve Compute Engine API'yi etkinleştirin:
gcloud services enable cloudfunctions.googleapis.com \ cloudbuild.googleapis.com \ gsuiteaddons.googleapis.com \ compute.googleapis.com
Cloud Shell penceresinin araç çubuğunda
Open Editor'ı (Düzenleyiciyi aç) tıklayarak Cloud Shell Düzenleyici'yi başlatın.
Bu yerleşik kod düzenleyici, projelerin oluşturulup dağıtıldığı ortamda dosyaları görüntüleme ve düzenleme kolaylığı sağlar.
Boş dizinde, aşağıdaki örnek kodu kullanarak
function.js
dosyasını oluşturun:/** * Cloud Function that loads the homepage for a * Google Workspace add-on. * * @param {Object} req Request sent from Google * @param {Object} res Response to send back */ exports.loadHomePage = function addonsHomePage (req, res) { res.send(createAction()); }; /** Creates a card with two widgets. */ function createAction() { return { "action": { "navigations": [ { "pushCard": { "header": { "title": "Cats!" }, "sections": [ { "widgets": [ { "textParagraph": { "text": "Your random cat:" } }, { "image": { "imageUrl": "https://cataas.com/cat" } } ] } ] } } ] } }; }
Aynı dizinde, aşağıdaki örnek kodu kullanarak
package.json
dosyasını oluşturun:{ "dependencies": { "@google-cloud/functions-framework": "^3.0.0" } }
Open Terminal'ı (Terminali aç) tıklayarak Cloud Shell Terminali'ne dönün.
Compute Engine varsayılan hizmet hesabına
Cloud Build Service Account
rolünü (roles/cloudbuild.builds.builder
) ekleyin.Öncelikle hizmet hesabı iznini ayarlayın:
export PROJECT_ID=$(gcloud config get project) export SERVICE_ACCOUNT_NAME=$(gcloud compute project-info describe \ --format="value(defaultServiceAccount)")
Ardından, eksik hizmet hesabı iznini verin:
gcloud projects add-iam-policy-binding $PROJECT_ID \ --member="serviceAccount:$SERVICE_ACCOUNT_NAME" \ --role="roles/cloudbuild.builds.builder"
İşlevi dağıtmak için aşağıdaki komutu çalıştırın:
gcloud functions deploy loadHomePage --runtime nodejs22 --trigger-http
İstenirse işlevin kimliği doğrulanmamış çağrılarına izin vermediğinizi belirtin. İşlevin dağıtılması birkaç dakika sürebilir.
Eklenti dağıtımı oluşturma
Eklentinin hizmet hesabı e-postasını bulun:
gcloud workspace-add-ons get-authorization
Hizmet hesabına
cloudfunctions.invoker
rolünü verin. SERVICE_ACCOUNT_EMAIL kısmını önceki adımdakiserviceAccountEmail
alanı ile değiştirin.gcloud functions add-iam-policy-binding loadHomePage \ --role roles/cloudfunctions.invoker \ --member serviceAccount:SERVICE_ACCOUNT_EMAIL
Dağıtılan işlevin URL'sini alın. URL'yi almak için aşağıdaki komutu çalıştırın ve
httpsTrigger
bölümündekiurl
alanını bulun:gcloud functions describe loadHomePage
Open Editor'ı (Düzenleyiciyi Aç) tıklayarak Cloud Shell Düzenleyici'ye dönün.
package.json
ile aynı dizinde, aşağıdaki örnek kodu içerendeployment.json
dosyasını oluşturun. URL kısmını, önceki adımdaki dağıtılan işlevinurl
ile değiştirin.{ "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"], "addOns": { "common": { "name": "My HTTP Add-on", "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png", "homepageTrigger": { "runFunction": "URL" } }, "gmail": {}, "drive": {}, "calendar": {}, "docs": {}, "sheets": {}, "slides": {}, "httpOptions": { "granularOauthPermissionSupport": "OPT_IN" } } }
Dağıtımı oluşturmak için Cloud Shell terminaline dönün:
gcloud workspace-add-ons deployments create quickstart \ --deployment-file=deployment.json
Eklentiyi yükleme
Dağıtımı geliştirme modunda yükleyin:
gcloud workspace-add-ons deployments install quickstart
Eklentiyi görüntülemek için Gmail'i açın veya yeniden yükleyin. Sağdaki araç çubuğunda beher simgesini bulun.
Eklentiyi açmak için simgeyi tıklayın. İstenirse eklentiyi yetkilendirin.
İsteğe bağlı: Temizleme
Hesabınızın ücretlendirilmesini önlemek için oluşturduğunuz kaynakları silin:
Eklentiyi Google Hesabınızdan kaldırma:
gcloud workspace-add-ons deployments uninstall quickstart
Bu hızlı başlangıç kılavuzunda kullanılan kaynaklar için ücretlendirilmemek amacıyla Cloud projesini silin:
gcloud projects delete PROJECT_ID
PROJECT_ID kısmını, hızlı başlangıç için kullandığınız Cloud projesinin kimliğiyle değiştirin. Cloud projesi kimliğini Google Cloud Console'daki Kontrol Paneli sayfasında bulabilirsiniz.
İlgili konular
Google Workspace eklentinize daha fazla özellik eklemek için aşağıdaki kaynaklara bakın:
- HTTP uç noktalarını kullanarak Google Workspace eklentisi oluşturma
- Codelab: Node.js ve Cloud Run ile Google Workspace eklentisi oluşturma
- Akıllı çiplerle bağlantıları önizleme