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

Mengonfigurasi konektor mengharuskan Anda 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 Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.

    Buka halaman Connections

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

      Region yang didukung untuk konektor mencakup:

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik Next.
  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 kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Secara opsional, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.

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

    7. Tenant Azure: Tenant Microsoft Online yang digunakan untuk mengakses data. Jika tidak ditentukan, tentant default Anda akan digunakan.
    8. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
    9. Klik Next.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu 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 Next.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Pemberian Kode Autentikasi 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.

Entitas, operasi, dan tindakan

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

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

    Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, 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 entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan 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 bervariasi dari satu konektor ke konektor lainnya. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Keterbatasan sistem

Konektor Office365 dapat memproses 1 transaksi per detik, per node, dan throttle setiap transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.

Untuk 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 Diperlukan Deskripsi
EventId String Ya ID peristiwa.
UserId String Tidak ID pengguna.
UserPrincipalName String Tidak Nama pengguna yang lisensinya perlu ditetapkan.
Komentar String Tidak Komentar untuk disertakan.

Untuk mengetahui contoh cara mengonfigurasi tindakan CancelEvent, lihat Contoh tindakan.

Tindakan MoveMail

Tindakan ini memungkinkan Anda memindahkan email.

Parameter input tindakan MoveMail

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

Untuk mengetahui contoh cara mengonfigurasi tindakan MoveMail, lihat Contoh tindakan.

Tindakan Tetapkan Lisensi

Tindakan ini memungkinkan Anda menetapkan lisensi.

Masukkan parameter tindakan ProvideLicense

Nama parameter Jenis data Diperlukan Deskripsi
UserId 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.

Untuk mengetahui contoh cara mengonfigurasi tindakan AssignLicense, lihat Contoh tindakan.

Tindakan ForwardEvent

Tindakan ini memungkinkan Anda meneruskan peristiwa.

Parameter input tindakan ForwardEvent

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

Untuk mengetahui contoh cara mengonfigurasi tindakan ForwardEvent, lihat Contoh tindakan.

Tindakan UploadFile

Tindakan ini memungkinkan Anda mengupload file.

Parameter input tindakan UploadFile

Nama parameter Jenis data Diperlukan 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 stream 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.

Untuk mengetahui contoh cara mengonfigurasi tindakan UploadFile, lihat Contoh tindakan.

Tindakan DownloadFile

Tindakan ini memungkinkan Anda mendownload file.

Parameter input tindakan DownloadFile

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

Untuk mengetahui contoh cara mengonfigurasi tindakan DownloadFile, lihat Contoh tindakan.

Tindakan CreateFolder

Tindakan ini memungkinkan Anda membuat folder.

Parameter input tindakan CreateFolder

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

Untuk mengetahui contoh cara mengonfigurasi tindakan CreateFolder, lihat Contoh tindakan.

Tindakan SendMail

Tindakan ini memungkinkan Anda mengirim email.

Parameter input tindakan SendMail

Nama parameter Jenis data Diperlukan Deskripsi
ToRecipients String Tidak Penerima yang akan dikirimi email.
Konten String Tidak Konten Email.
Subjek String Tidak Subjek Email.
ID String Tidak ID pesan yang akan dikirim (ini opsional). Pengguna dapat menggunakan ID email yang sudah ada atau mengirim email baru dengan mengisi kolom lainnya (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 Recipients 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 dalam CC.
SenderEmail String Tidak Alamat email yang atas nama siapa saja harus dikirim. Tetapkan opsi ini jika Anda ingin mengirim email atas nama akun pengguna lain.
FromEmail String Tidak Alamat email Pengguna yang menjadi sumber email yang perlu dikirim. Setel ini jika Anda ingin mengirim email dari akun pengguna lain.
ContentType String Tidak Jenis konten dari isi email.Nilai yang diizinkan adalah text, html. Nilai defaultnya adalah teks.

Untuk mengetahui contoh cara mengonfigurasi tindakan SendMail, lihat Contoh tindakan.

Tindakan ForwardMail

Tindakan ini memungkinkan Anda meneruskan email.

Parameter input tindakan ForwardMail

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

Untuk mengetahui contoh cara mengonfigurasi tindakan ForwardMail, lihat Contoh tindakan.

Tindakan DownloadEmail

Tindakan ini memungkinkan Anda mendownload email.

Parameter input tindakan DownloadEmail

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

Untuk mengetahui contoh cara mengonfigurasi tindakan DownloadMail, lihat Contoh tindakan.

Tindakan DownloadLampiran

Tindakan ini memungkinkan Anda mendownload lampiran email.

Parameter input tindakan DownloadLampiran

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

Untuk mengetahui contoh cara mengonfigurasi tindakan DownloadAttachments, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan dalam konektor ini.

Contoh - Membatalkan acara

Contoh ini membatalkan acara dengan ID yang ditentukan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CancelEvent, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas CancelEvent akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Menetapkan dan menghapus lisensi

Contoh ini menetapkan dan menghapus lisensi untuk pengguna yang ditentukan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan AssignLicense, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas AssignLicense akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Meneruskan peristiwa

Contoh ini meneruskan peristiwa.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan ForwardEvent, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas ForwardEvent akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Upload file

Contoh ini mengupload file.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan UploadFile, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas UploadFile akan memiliki nilai yang mirip dengan yang 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 - Mengunduh file

Contoh ini akan mendownload file.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadFile, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas DownloadFile akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Membuat folder

Contoh ini akan membuat folder.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateFolder, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas CreateFolder akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Mengirim email

Contoh ini mengirim email ke penerima yang ditentukan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan SendMail, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas SendMail akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Meneruskan email

Contoh ini meneruskan email.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan ForwardMail, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas ForwardMail akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Status": "Success"
}]

Contoh - Mendownload email

Contoh ini akan mendownload email.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadEmail, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas DownloadEmail akan memiliki nilai yang mirip dengan yang berikut:

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

Contoh - Download lampiran

Contoh ini mendownload lampiran.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachments, lalu klik Done.
  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 tersebut berhasil, parameter respons connectorOutputPayload tugas DownloadAttachments akan memiliki nilai yang mirip dengan yang 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 Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

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

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya