Office365

Konektor Office365 memungkinkan Anda terhubung ke instance Office365 dan melakukan operasi yang didukung.

Sebelum memulai

Sebelum menggunakan konektor Office365, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • 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

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 + Buat baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor meliputi:

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Office365 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.

    8. Tenant Azure: Tenant Microsoft Online yang digunakan untuk mengakses data. Jika tidak ditentukan, tenant default Anda akan digunakan.
    9. Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
    10. Klik Berikutnya.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Office365:

      • Pemberian Kode Autentikasi OAuth 2.0

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

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

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Pemberian Kode Auth OAuth 2.0
    • Token akses: Token akses yang digunakan untuk mengautentikasi permintaan dengan koneksi berbasis alur kode autentikasi.
    • Client ID: Client ID yang digunakan untuk meminta token akses.
    • Rahasia klien: Rahasia klien yang digunakan untuk meminta token akses.

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.

  • 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:

    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.

Batasan sistem

Konektor Office365 dapat memproses 1 transaksi per detik, per node, dan mencegah transaksi apa pun melampaui 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.

Tindakan

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

Tindakan CancelEvent

Tindakan ini memungkinkan Anda membatalkan acara.

Parameter input tindakan CancelEvent

Nama parameter Jenis data Wajib Deskripsi
EventId String Ya ID peristiwa.
ID Pengguna String Tidak ID pengguna.
UserPrincipalName String Tidak Nama pengguna yang lisensinya perlu ditetapkan.
Komentar String Tidak Komentar yang akan disertakan.

Misalnya, cara mengonfigurasi tindakan CancelEvent, lihat Contoh tindakan.

Tindakan MoveMail

Tindakan ini memungkinkan Anda memindahkan email.

Parameter input tindakan MoveMail

Nama parameter Jenis data Wajib Deskripsi
MessageId String Ya ID Email.
DestinationId String Ya ID folder tujuan tempat email akan dipindahkan.

Misalnya, cara mengonfigurasi tindakan MoveMail, lihat Contoh tindakan.

Tindakan AssignLicense

Tindakan ini memungkinkan Anda menetapkan lisensi.

Parameter input tindakan AssignLicense

Nama parameter Jenis data Wajib Deskripsi
ID Pengguna String Tidak ID pengguna yang lisensinya perlu ditetapkan.
UserPrincipalName String Tidak Nama pengguna yang lisensinya perlu ditetapkan.
AddLicenseSkuId String Tidak ID unik untuk SKU.
DisabledPlans String Tidak Kumpulan ID unik yang dipisahkan koma untuk paket yang telah dinonaktifkan.
RemoveLicenses String Tidak Kumpulan ID yang dipisahkan koma yang mengidentifikasi lisensi yang akan dihapus.

Misalnya, cara mengonfigurasi tindakan AssignLicense, lihat Contoh tindakan.

Tindakan ForwardEvent

Tindakan ini memungkinkan Anda meneruskan peristiwa.

Parameter input tindakan ForwardEvent

Nama parameter Jenis data Wajib Deskripsi
EventId String Ya ID peristiwa.
ID Pengguna String Tidak ID pengguna.
UserPrincipalName String Tidak Nama pengguna yang lisensinya perlu ditetapkan.
Komentar String Tidak Komentar yang akan disertakan.
ToRecipients String Ya Daftar email penerima yang dipisahkan titik koma.

Misalnya, cara mengonfigurasi tindakan ForwardEvent, lihat Contoh tindakan.

Tindakan UploadFile

Tindakan ini memungkinkan Anda mengupload file.

Parameter input tindakan UploadFile

Nama parameter Jenis data Wajib Deskripsi
FileName String Tidak Nama file tempat Anda perlu mengupload konten.
LocalFile String Tidak File lokal yang berisi konten yang akan diupload.
ContentStream String Tidak Konten sebagai aliran input yang akan diupload jika localpath atau folderpath tidak ditentukan.
ParentId String Ya ID folder tempat item saat ini berada.
Konten String Tidak Konten file yang akan diupload.

Misalnya, cara mengonfigurasi tindakan UploadFile, lihat Contoh tindakan.

Tindakan DownloadFile

Tindakan ini memungkinkan Anda mendownload file.

Parameter input tindakan DownloadFile

Nama parameter Jenis data Wajib Deskripsi
FileId String Ya ID file yang ingin Anda download.
DownloadTo String Tidak Tempat untuk menyimpan file.
Encoding String Tidak Jenis encoding input FileData. Nilai yang diizinkan adalah NONE, BASE64, dan nilai defaultnya adalah BASE64.
FileStream String Tidak Instance output stream tempat data file ditulis. Hanya digunakan jika DownloadTo tidak ditentukan.

Misalnya, cara mengonfigurasi tindakan DownloadFile, lihat Contoh tindakan.

Tindakan CreateFolder

Tindakan ini memungkinkan Anda membuat folder.

Parameter input tindakan CreateFolder

Nama parameter Jenis data Wajib Deskripsi
ParentId String Tidak ID folder tempat item saat ini berada.
FolderName String Ya Nama folder yang akan dibuat.

Misalnya, cara mengonfigurasi tindakan CreateFolder, lihat Contoh tindakan.

Tindakan SendMail

Tindakan ini memungkinkan Anda mengirim email.

Parameter input tindakan SendMail

Nama parameter Jenis data Wajib Deskripsi
ToRecipients String Tidak Penerima yang akan menerima email.
Konten String Tidak Konten Email.
Subjek String Tidak Subjek Email.
ID String Tidak ID pesan yang akan dikirim (opsional). Pengguna dapat menggunakan ID email yang ada atau mengirim email baru dengan mengisi kolom lain secara opsional.
Lampiran String Tidak Lampiran file. Tentukan lampiran file dalam format berikut:

filename1,filecontent1;filename2,filecontent2. Setiap konten file dapat berupa data BASE64, atau jalur file lokal dengan karakter @ di depannya.
FileName String Tidak Penerima Tentukan penerima dalam urutan berikut.
LocalFile String Tidak File yang berisi konten lampiran.
ContentBytes String Tidak Konten lampiran yang dienkode ke BASE64.
CCRecipients String Tidak Nilai penerima yang dipisahkan titik koma di CC.
SenderEmail String Tidak Alamat email atas nama siapa email harus dikirim. Tetapkan ini jika Anda ingin mengirim email atas nama akun pengguna lain.
FromEmail String Tidak Alamat email Pengguna yang akan mengirim email. Tetapkan ini jika Anda ingin mengirim email dari akun pengguna lain.
ContentType String Tidak Jenis konten isi email.Nilai yang diizinkan adalah teks, html. Nilai defaultnya adalah teks.

Misalnya, cara mengonfigurasi tindakan SendMail, lihat Contoh tindakan.

Tindakan ForwardMail

Tindakan ini memungkinkan Anda meneruskan email.

Parameter input tindakan ForwardMail

Nama parameter Jenis data Wajib Deskripsi
MessageId String Ya ID email.
ToRecipients String Ya Daftar email penerima yang dipisahkan titik koma.
Komentar String Tidak Konten selain pesan asli.

Misalnya, cara mengonfigurasi tindakan ForwardMail, lihat Contoh tindakan.

Tindakan DownloadEmail

Tindakan ini memungkinkan Anda mendownload email.

Parameter input tindakan DownloadEmail

Nama parameter Jenis data Wajib Deskripsi
MessageId String Ya ID pesan yang ingin Anda download.
Encoding String Tidak Jenis encoding input data file.
DownloadTo String Tidak Tempat untuk menyimpan file.
FileStream String Tidak Instance output stream tempat data file harus ditulis. Nilai ini hanya digunakan jika DownloadTo tidak diberikan.

Misalnya, cara mengonfigurasi tindakan DownloadMail, lihat Contoh tindakan.

Tindakan DownloadAttachments

Tindakan ini memungkinkan Anda mendownload lampiran email.

Parameter input tindakan DownloadAttachments

Nama parameter Jenis data Wajib Deskripsi
MessageId String Ya ID email yang ingin Anda gunakan untuk mendapatkan lampiran.
Encoding String Tidak Jenis encoding input FileData. Nilai yang diizinkan adalah NONE, BASE64.
DownloadTo String Tidak Tempat untuk menyimpan lampiran. Jika tidak ditentukan, byte konten lampiran akan ditampilkan. Nilai ini wajib diisi jika MessageId ditentukan.
AttachmentId String Tidak ID lampiran yang ingin Anda download. Menampilkan semua lampiran email jika tidak ditentukan.
ID Pengguna String Tidak ID Pengguna. Tindakan ini hanya akan berfungsi jika pengguna yang diautentikasi memiliki izin Admin.
FileStream String Tidak Instance output stream tempat data file ditulis. Hanya digunakan jika DownloadTo tidak diberikan.

Misalnya, cara mengonfigurasi tindakan DownloadAttachments, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Membatalkan acara

Contoh ini membatalkan peristiwa dengan ID yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CancelEvent, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
"Comment": "Canceled due to rain"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CancelEvent akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Menetapkan dan menghapus lisensi

Contoh ini menetapkan dan menghapus lisensi untuk pengguna yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan AssignLicense, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
"AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
"RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AssignLicense akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Meneruskan peristiwa

Contoh ini meneruskan peristiwa.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan ForwardEvent, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
"Comment": "forwarded due to rain",   
"ToRecipients": "test99@example.com"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas ForwardEvent akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mengupload file

Contoh ini mengupload file.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan UploadFile, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"FileName": "Document1234.docx",   
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"Content": "test"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UploadFile akan memiliki nilai yang mirip dengan berikut:

     [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"Status": "Success"
}]

Contoh - Mendownload file

Contoh ini mendownload file.

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

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadFile akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

Contoh - Membuat folder

Contoh ini membuat folder.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateFolder, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"FolderName": "outbox1234"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CreateFolder akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mengirim email

Contoh ini mengirim email ke penerima yang ditentukan.

  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: 
    {
"ToRecipients": "test097@example.com",   
"Content": "Testing",   
"Subject": "Test subject",   
"FileName": "Google"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas SendMail akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Meneruskan email

Contoh ini meneruskan email.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan ForwardMail, 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": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
"ToRecipients": "test097@example.com",   
"Comment": "forwarded message"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas ForwardMail akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mendownload email

Contoh ini mendownload email.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadEmail, 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": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadEmail akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

Contoh - Mendownload lampiran

Contoh ini mendownload lampiran.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachments, 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": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
"DownloadTo": "My files/Office355/reports/"}
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadAttachments akan memiliki nilai yang mirip dengan berikut:

    [{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]

Menggunakan koneksi Office365 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