Box
Konektor Box memungkinkan Anda terhubung ke backend Box dan menggunakan SQL untuk mengambil serta memperbarui data Box.
Versi yang didukung
Konektor ini mendukung Box Content API versi 2.0.
Sebelum memulai
Sebelum menggunakan konektor Box, 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.
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:
- Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.
- Klik + CREATE NEW untuk membuka halaman Create Connection.
- Di bagian Location, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Klik NEXT.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Konektor: Pilih Box dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
- 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.
- Secara opsional, masukkan Description untuk instance koneksi.
- Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke
Error
. - Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
- 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.
- Mode Meniru Identitas Pengguna: Tentukan jenis peniruan identitas pengguna. Mode ini harus berupa Mode pengguna atau Mode admin.
- Gunakan proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi dan konfigurasi nilai berikut:
-
Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
- Dasar: Autentikasi HTTP dasar.
- Digest: Ringkasan autentikasi HTTP.
- Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi dengan server proxy.
- Sandi Proxy: Secret Secret Manager dari sandi pengguna.
-
Proxy SSL Type: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
- Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi NEVER akan digunakan.
- Selalu: Koneksi selalu mengaktifkan SSL.
- Tidak pernah: Koneksi tidak mengaktifkan SSL.
- Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
- Di bagian Server Proxy, masukkan detail server proxy.
- Klik + Tambahkan tujuan.
- Pilih Jenis Tujuan.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
Jika Anda ingin membuat koneksi pribadi ke sistem backend, lakukan langkah berikut:
- Buat lampiran layanan PSC.
- Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
- Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
- Klik NEXT.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi Box:
- Autentikasi JWT
- OAuth 2.0 - Kode otorisasi
- JSON Kotak
- OAuth 2.0 - Kredensial klien
- Klik NEXT.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
-
Autentikasi JWT
- Client ID: Client ID yang disediakan oleh Box untuk aplikasi yang Anda buat.
- Rahasia Klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi yang Anda buat.
- Secret version: Versi secret klien.
- Kunci Pribadi: Secret Pengelola Secret yang berisi konten file kunci pribadi. Kunci pribadi harus cocok dengan kunci publik/sertifikat yang diberikan ke Konektor.
- Secret version: Versi secret kunci pribadi.
- Sandi Kunci Pribadi: Secret Secret Manager yang berisi sandi (parafrase) file kunci pribadi.
- Secret version: Versi sandi kunci pribadi.
- Tingkat Akses Aplikasi Box: Tingkat Akses Aplikasi untuk aplikasi Box.
- ID Perusahaan/ID Pengguna: ID Perusahaan jika Tingkat aplikasi adalah perusahaan dan ID Pengguna jika Tingkat aplikasi adalah pengguna
- ID Kunci Publik JWT OAuth: ID kunci publik untuk JWT.
- Auth Scheme: Auth Scheme untuk konektor Box.
- Memulai OAuth: Memulai parameter OAuth untuk konektor Box.
- OAuth JWT Cert Type: Jenis sertifikat OAuth JWT untuk konektor Box.
- OAuth 2.0 - Kode otorisasi
- Client ID: Client ID yang disediakan oleh Box untuk aplikasi yang Anda buat.
- Cakupan: Cakupan izin. Contoh,
root_readonly
. Untuk memahami cara kerja cakupan dan melihat semua cakupan yang tersedia untuk Box, lihat Cakupan. - Rahasia klien: Pilih Rahasia Secret Manager. Sebelum mengonfigurasi otorisasi ini, Anda harus membuat secret Secret Manager.
- Versi secret: Versi secret Secret Manager untuk secret klien.
-
JSON Kotak
- JSON Box untuk Autentikasi JWT: Secret yang berisi konten file JSON yang disediakan oleh Box.
- Versi secret: Versi secret file JSON.
-
OAuth 2.0 - Kredensial klien
- Client ID OAuth: Client ID yang disediakan oleh Box untuk aplikasi yang Anda buat.
- Rahasia Klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi yang Anda buat.
- Secret version: Versi secret klien.
- ID Subjek: Subjek pengguna yang aksesnya didelegasikan oleh aplikasi.
- Tingkat Akses Aplikasi Box: Tingkat akses aplikasi untuk aplikasi Box.
Untuk jenis autentikasi Authorization code
, setelah membuat koneksi, Anda
harus melakukan beberapa langkah tambahan untuk mengonfigurasi autentikasi. Untuk informasi selengkapnya,
lihat Langkah tambahan setelah pembuatan koneksi.
Contoh konfigurasi koneksi
Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi.
Jenis koneksi metode token JWT OAuth
Nama kolom | Detail |
---|---|
Lokasi | us-central1 |
Konektor | Box |
Versi konektor | 1 |
Nama Koneksi | box-conn |
Mengaktifkan Cloud Logging | ya |
Akun Layanan | XXXX@serviceaccount |
Meniru Identitas Mode Pengguna | Pengguna |
Jumlah minimum node | 2 |
Jumlah maksimum node | 2 |
Autentikasi | Autentikasi JWT |
ID Klien | XXXX |
Rahasia Klien | XXXX |
Versi Secret | 1 |
Kunci pribadi | XXXX |
Versi Secret | 1 |
Sandi kunci pribadi | XXXX |
Versi Secret | 1 |
Tingkat Akses Aplikasi Box | Enterprise |
ID Perusahaan/ID Pengguna | XXXX |
ID Kunci Publik JWT OAuth | XXXX |
Skema Auth | OAuthJWT |
Memulai OAuth | GETANDREFRESH |
Jenis Sertifikat JWT OAuth | PEMKEY_BLOB |
Anda dapat mengakses Client ID, Client Secret, Tingkat Akses Aplikasi Box, dan ID Perusahaan/ID Pengguna dari akun Box.
Anda dapat mengakses Kunci Pribadi dan Sandi Kunci Pribadi dari file Private keypair.json
yang Anda download. Untuk mengetahui informasi selengkapnya, lihat Informasi pasangan kunci Publik dan Pribadi. Selain itu, sebelum Anda meneruskan sandi kunci pribadi, ganti \n
dalam file json
dengan baris baru.
Jenis koneksi kode otorisasi OAuth
Nama kolom | Detail |
---|---|
Lokasi | us-central1 |
Konektor | Box |
Versi konektor | 1 |
Nama Koneksi | box-conn |
Mengaktifkan Cloud Logging | ya |
Akun Layanan | XXXX@serviceaccount |
Meniru Identitas Mode Pengguna | Pengguna |
Otorisasi | OAuth 2.0 - Kode otorisasi |
Jumlah minimum node | 2 |
Jumlah maksimum node | 2 |
ID Klien | XXXX |
Cakupan | root_readwrite |
Rahasia Klien | XXXX |
Versi Secret | 1 |
Untuk informasi tentang konfigurasi OAuth Box, lihat Membuat aplikasi OAuth.
JSON Box untuk jenis koneksi metode JWT Auth
Nama kolom | Detail |
---|---|
Lokasi | us-central1 |
Konektor | Box |
Versi konektor | 1 |
Nama Koneksi | gcp-box-conn-new |
Mengaktifkan Cloud Logging | ya |
Akun Layanan | XXXX@serviceaccount |
Meniru Identitas Mode Pengguna | Pengguna |
Sebagai User-ID | XXXX |
Jumlah minimum node | 2 |
Jumlah maksimum node | 2 |
Autentikasi | JSON Kotak |
JSON Box untuk Autentikasi JWT | XXXX |
Versi Secret | 1 |
Anda dapat menggunakan akun Box untuk menyiapkan Box Json untuk autentikasi JWT. Untuk informasi tentang cara menyiapkan Box Json untuk JWT, lihat Langkah-langkah pembuatan token JWT
Akses JSON Box untuk nilai autentikasi JWT dari file Private keypair.json
yang Anda download. Untuk informasi selengkapnya, lihat Informasi pasangan kunci Publik dan Pribadi. Anda harus meneruskan konten lengkap file .json
di kolom Box Json for JWT Auth.
Jenis koneksi Kredensial Klien OAuth
Nama kolom | Detail |
---|---|
Lokasi | us-central1 |
Konektor | Box |
Versi konektor | 1 |
Nama Koneksi | oauth-clientcred-conn |
Mengaktifkan Cloud Logging | ya |
Akun Layanan | XXXX@serviceaccount |
Meniru Identitas Mode Pengguna | Pengguna |
Sebagai User-ID | XXXX |
Jumlah minimum node | 2 |
Jumlah maksimum node | 2 |
Autentikasi | Kredensial Klien OAuth |
Client ID OAuth | XXXX |
Rahasia Klien OAuth | XXXX |
Versi Secret | 1 |
ID Subjek | XXXX |
Tingkat Akses Aplikasi Box | perusahaan |
Anda dapat mengakses Client ID, Client Secret, Tingkat Akses Aplikasi Box, dan ID Perusahaan/ID Pengguna dari akun Box.
Otorisasi ulang untuk kode otorisasi
Jika menggunakan jenis autentikasi Authorization code
dan telah melakukan perubahan konfigurasi di aplikasi Box,
Anda harus memberikan otorisasi ulang ke koneksi Box. Untuk memberikan otorisasi ulang pada koneksi, lakukan langkah-langkah berikut:
- Klik koneksi yang diperlukan di halaman Koneksi.
Tindakan ini akan membuka halaman detail koneksi.
- Klik Edit untuk mengedit detail koneksi.
- Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.
Jika diperlukan, buat perubahan yang diperlukan.
- Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
- Klik Edit authorization di bagian Authentication. Tindakan ini akan menampilkan panel Authorize.
- Klik Otorisasi.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
Langkah-langkah tambahan setelah pembuatan koneksi
Jika memilih OAuth 2.0 - Authorization code
untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:
- Di halaman Koneksi,
cari koneksi yang baru dibuat.
Perhatikan bahwa Status untuk konektor baru akan menjadi Otorisasi diperlukan.
- Klik Otorisasi diperlukan.
Tindakan ini akan menampilkan panel Edit otorisasi.
- Salin nilai Redirect URI ke aplikasi eksternal Anda.
- Verifikasi detail otorisasi.
- Klik Otorisasi.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
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.
Tindakan
Bagian ini mencantumkan semua tindakan yang didukung oleh koneksi Box.
Tindakan DownloadFile
Tindakan ini memungkinkan Anda mendownload file dari instance Box.
Parameter input tindakan DownloadFile
Nama Parameter | Jenis Data | Wajib | Deskripsi |
---|---|---|---|
FileID | String | Ya | ID file yang akan didownload. |
HasBytes | Boolean | Ya | Menentukan apakah akan mendownload file sebagai string atau sebagai string yang dienkode Base64. |
Parameter output tindakan DownloadFile
Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah download file berhasil. |
ContentBytes | String | Konten file sebagai string yang dienkode Base64. |
Misalnya, cara mengonfigurasi tindakan DownloadFile
,
lihat Contoh tindakan.
Tindakan UploadFile
Tindakan ini memungkinkan Anda mengupload file ke instance Box.
Parameter input tindakan UploadFile
Nama Parameter | Jenis Data | Wajib | Deskripsi |
---|---|---|---|
ParentID | String | Ya | ID folder tempat Anda ingin mengupload file. Jika parameter ini tidak ditentukan, file akan diupload ke root akun Box. Nilai defaultnya adalah 0. |
Konten | String | Ya | Konten file yang akan diupload. |
Parameter output tindakan UploadFile
Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah upload file berhasil. |
ID | String | ID file yang baru dibuat. |
VersionID | String | ID versi file tertentu. |
Hash | String | Hash SHA1 file. |
Etag | String | Nilai etag file atau folder. Nilai defaultnya adalah 0. |
Misalnya, cara mengonfigurasi tindakan UploadFile
,
lihat Contoh tindakan.
Tindakan CopyFile
Tindakan ini memungkinkan Anda menyalin file dari instance Box.
Parameter input tindakan CopyFile
Nama Parameter | Jenis Data | Wajib | Deskripsi |
---|---|---|---|
FileID | String | Ya | ID file yang ingin Anda salin. |
DestinationFolderId | String | Tidak | ID folder tujuan tempat Anda ingin menyalin file. Jika Anda tidak menentukan nilai apa pun, versi terbaru file akan disalin. |
NewName | String | Ya | Nama file baru untuk file yang disalin. |
Parameter output tindakan CopyFile
Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah penyalinan file berhasil. |
ID | String | ID file yang disalin. |
Misalnya, cara mengonfigurasi tindakan CopyFile
,
lihat Contoh tindakan.
Tindakan CopyFolder
Tindakan ini memungkinkan Anda menyalin seluruh folder dari instance Box.
Parameter input tindakan CopyFolder
Nama Parameter | Jenis Data | Wajib | Deskripsi |
---|---|---|---|
FolderID | String | Ya | ID folder yang ingin Anda salin. |
DestinationFolderId | String | Ya | ID folder tujuan tempat Anda ingin menyalin folder. |
NewName | String | Tidak | Nama file baru untuk folder yang disalin. |
Parameter output tindakan CopyFolder
Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah penyalinan folder berhasil. |
ID | String | ID folder yang disalin. |
Misalnya, cara mengonfigurasi tindakan CopyFolder
,
lihat Contoh tindakan.
Contoh tindakan
Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.
Contoh - Mendownload file
- Pada dialog
Configure connector task
, klikActions
. - Pilih tindakan
DownloadFile
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FileID": "1283194869422", "HasBytes": true }
Contoh ini mendownload file sebagai string yang dienkode Base64. Jika tindakan berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut:
[ { "Success": "True"}, {"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"} ]
Contoh - Mengupload file
- Pada dialog
Configure connector task
, klikActions
. - Pilih tindakan
UploadFile
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "ParentId": "0", "Content": "12345" }
Contoh ini mengupload konten string sebagai file. Jika tindakan berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut:
[{ "Success": "true", "ID": "1283902965389", "VersionID": "1403546001389", "Hash": "8cb2237d0679ca88db6464eac60da96345513964", "Etag": "0" }]
Contoh - Menyalin file
- Pada dialog
Configure connector task
, klikActions
. - Pilih tindakan
CopyFile
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FileID": "1288751886061", "DestinationFolderId": "219105724517", "NewName": "NewCopiedFile" }
Contoh ini menyalin file dengan ID 1288751886061
ke folder dengan ID 219105724517
. Jika tindakan berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut:
[{ "Success": "true", "ID": "1308006018536" }]
Contoh - Menyalin folder
- Pada dialog
Configure connector task
, klikActions
. - Pilih tindakan
CopyFolder
, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FolderID": "218475301279", "DestinationFolderId": "0", "NewName": "NewCopiedFolder" }
Contoh ini menyalin folder dengan ID 218475301279
ke folder dengan ID 219105724517
. Jika tindakan berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut:
[{ "Success": "true", "ID": "226312444517" }]
Contoh operasi entity
Contoh - Mencantumkan semua file
- Pada dialog
Configure connector task
, klikEntities
. - Pilih File dari Daftar
Entity
. - Pilih operasi
LIST
, lalu klik Selesai.
Anda dapat melakukan operasi LIST pada entitas berikut: Folder, TrashedItems, SharedItems, Collaborations, TaskAssignments, dan Tasks
Contoh - Mendapatkan file
- Pada dialog
Configure connector task
, klikEntities
. - Pilih File dari daftar
Entity
. - Pilih operasi
GET
, lalu klik Selesai. - Tetapkan ID entity ke 1262397830475 yang merupakan Kunci yang akan diteruskan. Untuk menetapkan ID entitas, di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan
1262397830475
di kolom Default Value.
Nilai untuk ID Entitas harus diteruskan secara langsung seperti, 1262397830475. Dengan 1262397830475 adalah nilai kunci utama yang unik.
Anda dapat melakukan operasi GET pada entitas berikut: Folder, SharedItems, Collaborations, TaskAssignments, dan Tasks
Contoh - Menghapus file
- Pada dialog
Configure connector task
, klikEntities
. - Pilih File dari daftar
Entity
. - Pilih operasi
DELETE
, lalu klik Selesai. - Tetapkan ID entity ke 1258725940971 yang merupakan Kunci yang akan diteruskan. Untuk menetapkan ID entitas, di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan
1258725940971
di kolom Default Value.Atau, jika Entitas memiliki dua Kunci Utama atau Bisnis Komposit, bukan menentukan entityId, Anda juga dapat menetapkan filterClause ke
Id='1258725940971'
.
Anda dapat melakukan operasi DELETE pada entitas berikut: Folder, Tugas, Kolaborasi, SharedItems, dan TaskAssignments
Contoh - Membuat folder
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Folder dari daftar
Entity
. - Pilih operasi
Create
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Name": "Google Cloud Platforms_created_folders", "ParentId": "0" }
Jika integrasi berhasil, parameter respons
connectorOutputPayload
tugasFolder
akan memiliki nilai yang mirip dengan berikut:{ "Id": "222269371053" }
Contoh - Membuat kolaborasi
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Kolaborasi dari daftar
Entity
. - Pilih operasi
Create
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "ItemId": "216592737829", "ItemType": "folder", "AccessibleById": "27370766275", "AccessibleByType": "user", "AccessibleByLogin": "baklavainthebalkans@gmail.com", "Role": "editor" }
Jika integrasi berhasil, parameter respons
connectorOutputPayload
tugasFolder
akan memiliki nilai yang mirip dengan :{ "Success": false }
Contoh - Membuat tugas
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Tasks dari daftar
Entity
. - Pilih operasi
Create
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "ItemId": "1253997361112", "ItemType": "file", "Action": "review", "Message": "Creating a task from Google Cloud Platform", "DueAt": "2023-12-12 09:01:15.0", "CompletionRule": "all_assignees" }
Jika integrasi berhasil, parameter respons
connectorOutputPayload
tugasFolder
akan memiliki nilai yang mirip dengan berikut:{ "Id": "1253997361112" }
Contoh - Membuat penetapan tugas
- Pada dialog
Configure connector task
, klikEntities
. - Pilih TaskAssignments dari daftar
Entity
. - Pilih operasi
Create
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "TaskId": "21507516872", "AssignedToId": "27370766275" }
Jika integrasi berhasil, parameter respons
connectorOutputPayload
tugasFolder
akan memiliki nilai yang mirip dengan berikut:{ "Id": "50804351753" }
Contoh - File Update
- Pada dialog
Configure connector task
, klikEntities
. - Pilih File dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Name": "Get Started with Box Files.pdf" }
- Tetapkan ID entitas ke 1253997361112. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
1253997361112
di kolom Default Value.Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke
1253997361112
.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ "Id": "1253997361112" }
Anda dapat melakukan operasi UPDATE pada entitas berikut: Folder, Tugas, Kolaborasi, SharedItems, dan TaskAssignments
Contoh - Memperbarui folder
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Folder dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Name": "Demo Update" }
- Tetapkan ID entitas ke 216457668125. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
216457668125
di kolom Default Value.Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke
216457668125
.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ "Id": "216457668125" }
Contoh - Memperbarui kolaborasi
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Kolaborasi dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Role": "Viewer" }
- Tetapkan ID entity ke 46685648757. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
46685648757
di kolom Default Value.Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke
46685648757
.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ }
Contoh - Memperbarui tugas
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Tasks dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Message": "This is a new task is updated and assigned to you by me" }
- Tetapkan ID entitas ke 21507516872. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
21507516872
di kolom Default Value.Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke
21507516872
.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ "Id": "21507516872" }
Contoh - Memperbarui taskassignments
- Pada dialog
Configure connector task
, klikEntities
. - Pilih TaskAssignments dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Message": "Looks good to me", "ResolutionState": "completed" }
- Tetapkan ID entitas ke 49542929469. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
49542929469
di kolom Default Value.Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke
49542929469
.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ "Id": "49542929469" }
Contoh - Memperbarui Transferfolders
- Pada dialog
Configure connector task
, klikEntities
. - Pilih Folder dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Name": "Demo Update" "ParentId": "216596059374" }
- Tetapkan ID entitas ke 216457668125. Untuk menetapkan ID entity,
klik entityId, lalu masukkan
216457668125
di kolom Default Value.Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output
connectorOutputPayload
tugas Konektor:{ "Id": "216457668125" }
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 |
---|---|---|---|
impersonate_user_mode | ENUM | Benar | Tentukan jenis peniruan identitas pengguna. Mode ini harus berupa Mode pengguna atau Mode admin. Nilai yang didukung adalah: Pengguna, Admin |
proxy_enabled | BOOLEAN | Salah | Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi. |
proxy_auth_scheme | ENUM | Salah | Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE |
proxy_user | STRING | Salah | Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. |
proxy_password | SECRET | Salah | Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer. |
proxy_ssltype | ENUM | Salah | Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL |
Menggunakan koneksi Box 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.