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 telah 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 Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui 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
- Buka Setelan, lalu pilih Kunci API.
- Klik Create API Key
- Masukkan nama untuk kunci API Anda
- Pilih dari opsi Akses Penuh, Akses Terbatas, atau Akses Penagihan
- Pilih Akses Terbatas, atau Akses Penagihan, lalu pilih izin tertentu untuk setiap kategori.
- Klik Buat dan Lihat.
- Salin kunci API dan simpan untuk digunakan nanti.
Mengonfigurasi konektor
Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:
- Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.
- Klik + BUAT BARU untuk membuka halaman Buat Koneksi.
- Di bagian Location, pilih lokasi untuk koneksi.
- Wilayah: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Klik NEXT.
- Wilayah: Pilih lokasi dari menu drop-down.
- Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
- Konektor: Pilih SendGrid dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari daftar drop-down versi yang tersedia.
- Di kolom Connection Name, masukkan nama untuk instance Koneksi.
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.
- Secara opsional, masukkan Deskripsi untuk instance koneksi.
- Secara opsional, aktifkan Cloud Logging,
lalu pilih level log. Secara default, level log ditetapkan ke
Error
. - Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- Jika perlu, konfigurasikan Setelan node koneksi:
- Jumlah minimum node: Masukkan jumlah minimum node koneksi.
- Jumlah node maksimum: Masukkan jumlah maksimum node koneksi.
Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. 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.
- Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
- Klik NEXT.
- Di bagian Authentication, masukkan detail autentikasi. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi autentikasi. |
- Klik NEXT.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Buat.
Mengonfigurasi autentikasi
- Kunci API: Pilih secret Secret Manager dari kunci API.
- Versi secret: Pilih versi secret.
Contoh konfigurasi koneksi
Bagian ini mencantumkan nilai contoh 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 |
Entitas, operasi, dan tindakan
Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.
- Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke
konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.
Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar
Entities
akan kosong. - Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan
salah satu operasi berikut pada entitas:
Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar
Operations
. - Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan
berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan
konektor tidak mendukung tindakan apa pun, sehingga daftar
Actions
akan kosong.
Batasan sistem
Konektor SendGrid dapat memproses 8 transaksi per detik, per node, dan membatasi transaksi apa pun di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.
Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.
Tindakan
Bagian ini mencantumkan beberapa tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.
Tindakan SendMail2
Tindakan ini akan mengirim email beserta lampiran.
Parameter input tindakan kirim email
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 yang Anda inginkan untuk pengiriman email. Penjadwalan lebih dari 72 jam sebelumnya dilarang. |
FromEmail | String | Ya | Alamat email pengirim. |
FromName | String | Tidak | Nama pengirim. |
ToEmail | String | Tidak | Alamat email yang akan dikirimi email. |
ToName | String | Tidak | Nama masing-masing 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 salinan tersembunyi 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 pesan individual dan bagaimana pesan tersebut harus ditangani. |
Parameter output dari tindakan kirim email
Tindakan ini menampilkan pesan konfirmasi apakah email berhasil dikirim atau tidak.
Contoh tindakan
Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.
Contoh - Mengirim email
- Dalam dialog
Configure connector task
, klikActions
. - Pilih tindakan
SendMail2
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FromName": "Name", "FromEmail": "cloudysanfrancisco@gmail.com", "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\": \"email@gmail.com\",\"name\": \"test\"}\n ]}]", "Content": "[{\"value\": \"abc@cdata.com\",\"type\": \"text/plain\"}]" }
Tindakan ini akan menampilkan pesan konfirmasi. Jika tindakan berhasil,
parameter respons connectorOutputPayload
tugas akan memiliki nilai yang mirip dengan berikut:
[{ "Success": "True" }]
Contoh operasi entity
Bagian ini menunjukkan cara melakukan beberapa operasi entitas di konektor ini.
Contoh - Mencantumkan semua kontak
Contoh ini mencantumkan semua kontak dalam entitas NMCContacts
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCContacts
dari daftarEntity
. - Pilih operasi
List
, lalu klik Selesai. - Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat
memfilter kumpulan 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
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCSegments
dari daftarEntity
. - Pilih operasi
Get
, lalu klik Selesai. - 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 entityNMCSegments
.
Contoh - Membuat catatan
Contoh ini membuat data dalam entitas NMCSenders
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCSenders
dari daftarEntity
. - Pilih operasi
Create
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Nickname": "Test", "FromEmail": "test1@examplepetstore.com", "FromName": "testuser", "ReplytoEmail": "test1@examplepetstore.com", "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 catatan
Contoh ini membuat data dalam entitas NMCLists
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCLists
dari daftarEntity
. - Pilih operasi
Create
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault 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 dalam entitas NMCSenders
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCSenders
dari daftarEntity
. - Pilih operasi
Update
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Nickname": "Test", "FromEmail": "test2@examplepetstore.com", "FromName": "testuser", "ReplytoEmail": "test2@examplepetstore.com", "Address": "NA", "City": "NA", "Country": "India"}
- 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 di entitas NMCSegments
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
NMCSegments
dari daftarEntity
. - Pilih operasi
Delete
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan
c58b9151-7279-428a-bac2-12b4bf2b48b0
di kolom Default Value.
Membuat koneksi menggunakan Terraform
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 Apigee Integration dan Application Integration. 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 Forum Cloud.Langkah berikutnya
- Pahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.