SendGrid

Konektor SendGrid memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan pada set data SendGrid.

Sebelum memulai

Sebelum menggunakan konektor SendGrid, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
  • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.

  • Aktifkan layanan berikut:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

  Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Menyiapkan autentikasi menggunakan kunci API

1. Buka Setelan, lalu pilih Kunci API.
2. Klik Create API Key
3. Masukkan nama untuk kunci API Anda
4. Pilih dari opsi Akses Penuh, Akses Dibatasi, atau Akses Penagihan
5. Pilih Akses Terbatas, atau Akses Penagihan, lalu pilih izin tertentu untuk setiap kategori.
6. Klik Buat dan Lihat.
7. Salin kunci API dan simpan untuk digunakan nanti.

Mengonfigurasi konektor

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

   Buka halaman Koneksi

2. Klik + CREATE NEW untuk membuka halaman Create Connection.
3. Di bagian Location, pilih lokasi untuk koneksi.
   1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

   2. Klik NEXT.
4. Di bagian Connection Details, selesaikan tindakan berikut:
   1. Konektor: Pilih SendGrid dari menu drop-down Konektor yang tersedia.
   2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
   3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default, node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika merupakan pelanggan Bayar sesuai penggunaan.
   8. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   9. Klik NEXT.
5. Di bagian Authentication, masukkan detail autentikasi. Untuk informasi selengkapnya, lihat Mengonfigurasi autentikasi. |
6. Klik NEXT.
7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
8. Klik Create.

Mengonfigurasi autentikasi

Autentikasi kunci API

• Kunci API: Pilih secret Secret Manager dari kunci API.
• Versi secret: Pilih versi secret.

Contoh konfigurasi koneksi

Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi SendGrid.

Jenis koneksi web

Nama kolom	Detail
Lokasi	us-central1
Konektor	Sendgrid
Versi konektor	1
Nama Koneksi	sendgrid-google-cloud-conn
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Jumlah minimum node	2
Jumlah maksimum node	50
Kunci API	API_KEY
Versi Secret	1

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Konektor.

• Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

  Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Cantumkan
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Catatan: Semua entitas dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Batasan sistem

Konektor SendGrid dapat memproses 8 transaksi per detik, per node, dan mencegah transaksi apa pun yang melebihi batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Catatan: Jumlah node Konektor Integrasi akan diskalakan secara otomatis secara dinamis berdasarkan penggunaan Anda. Namun, jika ingin mencadangkan kapasitas untuk volume besar tanpa menunggu penskalaan otomatis, Anda dapat menyesuaikan nilai node minimum untuk koneksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses lebih sedikit transaksi. Untuk mengonfigurasi nilai node, lakukan hal berikut:

• Jika Anda adalah pelanggan bayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
• Jika Anda adalah pelanggan berbasis langganan, hubungi dukungan.

Transaksi maksimum yang dapat ditangani node bergantung pada berbagai faktor. Jadi, sebelum menyesuaikan node minimum untuk throughput yang lebih baik, sebaiknya periksa apakah sistem backend Anda disiapkan secara optimal untuk menangani traffic yang diperlukan.

Tindakan

Bagian ini mencantumkan beberapa tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Catatan: Hasil semua tindakan akan tersedia sebagai respons JSON dalam parameter respons connectorOutputPayload tugas Connectors setelah Anda menjalankan integrasi.

Tindakan SendMail

Tindakan ini Mengirim email beserta lampiran.

Parameter input tindakan SendMail

Nama parameter	Jenis data	Wajib	Deskripsi
Subjek	String	Ya	Subjek email yang akan dikirim.
ContentValue	String	Tidak	Konten email yang akan dikirim.
ContentType	String	Tidak	Jenis konten yang akan dikirim. Nilai yang didukung adalah text/plain dan text/html.
Konten	String	Ya	Agregat untuk objek Konten.
SendAt	String	Tidak	Tanggal dan waktu pengiriman email yang Anda inginkan. Penjadwalan lebih dari 72 jam sebelumnya dilarang.
FromEmail	String	Ya	Alamat email pengirim.
FromName	String	Tidak	Nama pengirim.
ToEmail	String	Tidak	Alamat email tujuan pengiriman email.
ToName	String	Tidak	Nama email yang akan dikirimi email.
Ke	String	Tidak	Agregat untuk penerima Kepada.
ToCCEmail	String	Tidak	Alamat email penerima yang akan menerima salinan email Anda.
ToCCName	String	Tidak	Nama penerima yang akan menerima salinan email Anda.
ToBCCName	String	Tidak	Nama penerima yang akan menerima blind carbon copy email Anda.
ToBCC	String	Tidak	Agregat untuk penerima ToBCC.
ReplyToEmail	String	Tidak	Alamat email orang yang Anda balas.
ReplyToName	String	Tidak	Nama orang yang Anda balas.
AttachmentPaths	String	Tidak	Jalur file yang akan dilampirkan ke email yang akan dikirim.
TemplateId	String	Ya	ID template yang mungkin ingin Anda kirim.
DynamicTemplateData	String	Tidak	Data template dinamis.
Personalisasi	String	Ya	Array pesan dan metadatanya. Setiap objek dalam personalisasi dapat dianggap sebagai amplop - objek ini menentukan siapa yang harus menerima setiap pesan dan bagaimana pesan tersebut harus ditangani.

Parameter output tindakan SendMail

Tindakan ini menampilkan pesan konfirmasi apakah email berhasil dikirim dari SendMail atau tidak.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Mengirim email

1. Pada dialog Configure connector task, klik Actions.
2. Pilih tindakan SendMail, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "FromName": "Name",
       "FromEmail": "[e-mail]",
       "Subject": "[{\"value\": \"cymbalgroup.com\",\"type\": \"text/plain\"}]",
       "TemplateId": "d-c4bc730a0b094a3a9d9cabb7347b5edc",
       "Personalizations": "[{\"subject\": \"Test Subject3\",\"send_at\": 1698659820,\"from\": {\"name\": \"hi\",\"email\": \"email@gmail\"},\"to\":      
       [{\"email\": \"[e-mail]\",\"name\": \"test\"}\n ]}]",
       "Content": "[{\"value\": \"[e-mail]\",\"type\": \"text/plain\"}]"
   }

Tindakan ini menampilkan pesan konfirmasi SendMail. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "True"
}]

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entity di konektor ini.

Contoh - Mencantumkan semua kontak

Contoh ini mencantumkan semua kontak dalam entitas NMCContacts.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCContacts dari daftar Entity.
3. Pilih operasi List, lalu klik Done.
4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter set hasil dengan menentukan klausa filter. Contohnya, City='Bangalore' Anda juga dapat menentukan beberapa kondisi filter menggunakan operator logika. Sebagai contoh, City='Bangalore' and region='asia-south2'

Contoh - Mendapatkan data

Contoh ini mendapatkan data dengan ID yang ditentukan dari entitas NMCSegments.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCSegments dari daftar Entity.
3. Pilih operasi Get, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 di kolom Default Value.

   Di sini, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 adalah nilai kunci utama dalam entity NMCSegments.

Contoh - Membuat data

Contoh ini membuat data di entitas NMCSenders.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCSenders dari daftar Entity.
3. Pilih operasi Create, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

   Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

   {
   "Id": 5360940.0
   }

Contoh - Membuat data

Contoh ini membuat data di entitas NMCLists.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCLists dari daftar Entity.
3. Pilih operasi Create, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Name": "TEST_CON_LIST1699262238224",
   "ContactCount": 3.0}

   Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

   {
   "Id": "d927f128-b718-447a-affe-417f1a8b3abd"}

Contoh - Memperbarui data

Contoh ini memperbarui data di entity NMCSenders.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCSenders dari daftar Entity.
3. Pilih operasi Update, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

5. Klik entityId, lalu masukkan 5360940.0 di kolom Default Value.

   Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

   {
   "Id":"5360940.0"
   }

Contoh - Menghapus data

Contoh ini menghapus data dengan ID yang ditentukan dalam entitas NMCSegments.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih NMCSegments dari daftar Entity.
3. Pilih operasi Delete, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan c58b9151-7279-428a-bac2-12b4bf2b48b0 di kolom Default Value.

Catatan: Jika entitas memiliki kunci utama komposit, Anda dapat menentukan klausa filter.

Menggunakan terraform untuk membuat koneksi

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter	Jenis data	Wajib	Deskripsi

Menggunakan koneksi SendGrid dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

• Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya

• Pahami cara menangguhkan dan melanjutkan koneksi.
• Pahami cara memantau penggunaan konektor.
• Pahami cara melihat log konektor.