Gmail

Konektor Gmail memungkinkan Anda melakukan operasi baca dan hapus di Gmail.

Versi yang didukung

Konektor ini mendukung Gmail REST API.

Sebelum memulai

Sebelum menggunakan konektor Gmail, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • 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.

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:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + BUAT BARU untuk membuka halaman Buat Koneksi.
  3. Di bagian Lokasi, selesaikan langkah-langkah berikut:
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih Gmail dari daftar konektor yang tersedia.
    2. Versi konektor: Pilih versi konektor dari daftar versi yang tersedia.
    3. Di kolom Nama Koneksi, masukkan nama untuk instance koneksi. Nama koneksi dapat berisi huruf kecil, angka, atau tanda hubung. Nama harus diawali dengan huruf dan diakhiri dengan huruf atau angka, serta tidak boleh lebih dari 49 karakter.
    4. Deskripsi: Masukkan deskripsi untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk 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.

    8. + TAMBAHKAN LABEL: Klik ini untuk menambahkan label ke koneksi dalam bentuk pasangan nilai kunci.
    9. Klik Berikutnya.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Gmail:

      • Autentikasi Akun Layanan
      • OAuth 2.0 - JWT Bearer
      • OAuth 2.0 - Kode otorisasi

      Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    2. Klik Berikutnya.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Buat.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Autentikasi Akun Layanan: Tidak ada konfigurasi tambahan yang diperlukan untuk jenis autentikasi ini. Akun layanan yang Anda pilih di bagian Detail Koneksi akan digunakan untuk autentikasi.
  • OAuth 2.0 - JWT Bearer
    • Sertifikat JWT: Pilih sertifikat yang akan digunakan untuk autentikasi JWT.
    • Versi secret: Masukkan versi secret sertifikat JWT.
    • Subjek JWT: Masukkan subjek JWT.
    • Aktifkan Penggantian Autentikasi: Aktifkan untuk mengganti autentikasi.
  • OAuth 2.0 - Kode otorisasi
    • Client ID: Masukkan client ID yang akan digunakan untuk autentikasi OAuth.
    • Cakupan: Masukkan daftar cakupan yang diinginkan.
    • Rahasia Klien: Rahasia klien yang akan digunakan untuk autentikasi OAuth.
    • Versi secret: Masukkan versi secret dari rahasia klien.
    • Aktifkan Penggantian Autentikasi: Aktifkan untuk mengganti autentikasi.

Contoh konfigurasi koneksi

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

OAuth 2.0 - Jenis koneksi pembawa JWT

Nama kolom Detail
Lokasi asia-east1
Konektor Gmail
Versi konektor 1
Nama Koneksi gmail-jwt-conn
Mengaktifkan Cloud Logging true
Akun Layanan my-service-account@my-project.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Autentikasi OAuth 2.0 - JWT Bearer
Sertifikat JWT Sertifikat JWT
Versi rahasia 1

OAuth 2.0 - jenis koneksi kode otorisasi

Nama kolom Detail
Lokasi us-central1
Konektor Gmail
Versi konektor 1
Nama Koneksi gmail-auth-conn
Mengaktifkan Cloud Logging Ya
Akun Layanan my-service-account@my-project.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Autentikasi OAuth 2.0 - Kode otorisasi
ID Klien 60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Cakupan https://mail.google.com/
Rahasia Klien ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Versi rahasia 1

Batasan sistem

Konektor Gmail dapat memproses maksimum 1 transaksi per detik, per node, dan membatasi transaksi apa pun yang melebihi 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.

Menggunakan koneksi Gmail 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.

Tindakan

Bagian ini menunjukkan cara melakukan beberapa tindakan di konektor ini.

Tindakan SendMailMessages

Tindakan ini akan mengirim pesan Gmail.

Parameter input tindakan SendMailMessages

Nama parameter Jenis data Wajib Deskripsi
Ke String Ya Alamat email penerima utama. Untuk beberapa penerima, gunakan daftar yang dipisahkan koma.
AttachmentHasBytes String Tidak Setel ke benar (true) jika konten lampiran disediakan dalam AttachmentContentBytes (berenkode Base64), atau salah (false) jika konten disediakan sebagai string dalam AttachmentContent. Nilai defaultnya adalah salah (false).
AttachmentFileName String Tidak Nama file yang akan dilampirkan. Parameter ini digunakan jika AttachmentHasBytes bernilai salah atau tidak diberikan.
Subjek String Ya Baris subjek email.
AttachmentContent String Tidak Konten string file yang akan dilampirkan. Parameter ini digunakan jika AttachmentHasBytes disetel ke false atau tidak diberikan.
BCC String Tidak Alamat email penerima yang di-BCC. Untuk beberapa penerima, gunakan daftar yang dipisahkan koma.
AttachmentContentBytes String Tidak Konten byte berenkode Base64 dari file yang akan dilampirkan. Parameter ini digunakan saat AttachmentHasBytes disetel ke benar (true).
CC String Tidak Alamat email penerima yang di-CC. Untuk beberapa penerima, gunakan daftar yang dipisahkan koma.
Konten String Ya Konten utama pesan email.
AttachmentPath String Tidak Daftar jalur file lokal yang dipisahkan koma untuk dilampirkan ke email.

Untuk contoh tentang cara mengonfigurasi tindakan SendMailMessages, lihat Contoh.

Tindakan DownloadAttachment

Tindakan ini akan mendownload lampiran dari Gmail.

Parameter input tindakan DownloadAttachment

Nama parameter Jenis data Wajib Deskripsi
MessageId String Ya ID email.
DownloadLocation String Tidak Lokasi tempat lampiran akan disimpan.
FileStream String Tidak Instance aliran output tempat data file ditulis.
AttachmentId String Tidak ID lampiran. Harus diberikan jika FileStream ditentukan.

Untuk contoh tentang cara mengonfigurasi tindakan DownloadAttachment, lihat Contoh.

Contoh tindakan

Bagian ini menunjukkan cara melakukan beberapa tindakan di konektor ini.

Contoh - Mengirim pesan Gmail

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data MapperCheck",
      "Content": "Gmail",
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

    [{
    "Id": "199334f660ff462a"
    }]
    

Contoh - Mengirim pesan Gmail dengan lampiran JPG

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
     {
    "To": "testbristleconeemail@gmail.com",
    "Subject": "Data Mapper Email Sep10 JPG",
    "Content": "Gmail",
    "AttachmentFileName": "TestSep10.jpg",
    "AttachmentContentBytes": "/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCANUBdwDAREAAhEBAxEB/8QAHgABAAAGAwEAAAAAAAAAAAAAAAEDBAcICQIFBgr/xABsEAABAwMCBAMFBQQHAwUJACMBAgMEAAURBgcIEiExCRNBChQiUWEVIzJxgUJSkaEWFzNicrHBJEPRNFOCkqIYJTlEY4O14fDxJmRzdXZ3k7PCNTY4haOytLYZN1RVV8NIVmV0eJSWpNLT4v/EAB0BAQABBAMBAAAAAAAAAAAAAAAHAQQFBgIDCAn/xABXEQABAwURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIv/Z",
    "AttachmentHasBytes": true
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

    [{
      "Id": "199334f660ff462a"
    }]
    

Contoh - Mengirim pesan Gmail dengan lampiran PDF

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data Mapper Email Sep10",
      "Content": "Gmail",
      "AttachmentFileName": "TestSep10.pdf",
      "AttachmentContent": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXy",
      "AttachmentHasBytes": true
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

    [{
      "Id": "1993341d558d7b07"
    }]
    

Contoh - Mengirim pesan Gmail dengan lampiran TXT

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMailMessages, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data Mapper Email Sep10",
      "Content": "Gmail",
      "AttachmentFileName": "TestSep10.txt",
      "AttachmentContent": "TestingwithAttachment",
      "AttachmentHasBytes": true
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

    [{
        "Id": "1993341d558d7b07"
    }]
    

Contoh - Mendownload lampiran dari Gmail

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachment, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
      "MessageId": "198acdcde5c09ce5"
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

    [{
        "Success": "true",
        "MessageId": "198acdcde5c09ce5",
        "AttachmentId": "1",
        "Size": "58005",
        "Data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoYWJvdXQ6YmxhbmspCi9DcmVhdG9yIChNb3ppbGxhLzUuMCBcKFgxMTsgTGludXggeDg2XzY0XCkgQXBwbGVXZWJLaXQvNTM3LjM2IFwoS0hUTUwsIGxpa2UgR2Vja29cKSBIZWFkbGVzc0Nocm9tZS8xMzguMC4wLjAgU2FmYXJpLzUzNy4zNikKL1Byb2R1Y2VyIChTa2lhL1BERiBtMTM4KQovQ3JlYXRpb25EYXRlIChEOjIwMjUwODE1MDgwMDE2KzAwJzAwJykKL01vZERhdGUgKEQ6MjAyNTA4MTUwODAwMTYrMDAnMDAnKT4-CmVuZG9iagozIDAgb2JqCjw8L2NhIDEKL0JNIC9Ob3JtYWw-PgplbmRvYmo",
        "Filename": "My_Store_404672162.pdf",
        "@isoutervalue": null
    }]
    

Contoh operasi entity

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

Contoh - Mencantumkan semua pesan Gmail

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Messages dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Di bagian Input Tugas pada tugas Konektor, Anda dapat menetapkan filterClause sesuai dengan persyaratan pelanggan.
  5. Anda harus menggunakan tanda kutip tunggal (') untuk menyertakan nilai filterClause. Anda dapat menggunakan filterClause untuk memfilter data berdasarkan kolom.

Contoh - Mendapatkan detail pesan Gmail dari kotak masuk

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Inbox dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Tetapkan entityId ke 1 yang merupakan kunci yang akan diteruskan. Untuk menyetel entityId, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 1 di kolom Nilai Input dan pilih entityId sebagai variabel lokal.
  5. Nilai untuk entityId harus diteruskan secara langsung, seperti "1". Di sini, "1" adalah nilai kunci utama unik yang diteruskan.

    Dalam beberapa kasus, meneruskan satu entityId dapat menyebabkan error karena entitas memiliki dua kunci gabungan. Dalam kasus seperti itu, Anda dapat menggunakan filterClause dan meneruskan nilai, seperti id='1'.

Contoh - Menghapus pesan Gmail

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Messages dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  4. Tetapkan entityId ke 1 yang merupakan kunci yang akan diteruskan.
  5. Untuk menyetel entityId, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 1 di kolom Nilai Input dan pilih entityId sebagai variabel lokal.

    Jika entity memiliki dua kunci bisnis gabungan atau kunci utama, bukan menentukan entityId, Anda juga dapat menyetel filterClause ke id='1'.

Mendapatkan bantuan dari komunitas Google Cloud

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

Langkah berikutnya