HubSpot
Konektor HubSpot memungkinkan Anda melakukan operasi sisipkan, hapus, perbarui, dan baca pada set data HubSpot.
Versi yang didukung
Konektor ini mendukung versi HubSpot API berikut:
- HubSpot
- HubSpotV3
- HubSpotV4
Sebelum memulai
Sebelum menggunakan konektor HubSpot, 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika 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
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:
- Di Konsol Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.
- Klik + Create new untuk membuka halaman Create Connection.
- Di bagian Lokasi, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Region yang didukung untuk konektor mencakup:
Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
- Klik Next.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Konektor: Pilih HubSpot 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 kecil.
- Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh lebih dari 63 karakter.
- Secara opsional, masukkan Deskripsi untuk instance koneksi.
- Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- Untuk menggunakan koneksi untuk langganan acara, pilih Aktifkan langganan acara. Jika dipilih, opsi berikut akan ditampilkan:
- Enable event subscription with entity and actions: Pilih opsi ini untuk menggunakan koneksi untuk operasi konektor dan langganan peristiwa (entity dan tindakan).
- Aktifkan hanya langganan acara: Pilih opsi ini untuk menggunakan koneksi hanya untuk langganan acara.
Untuk kedua pilihan ini, Anda akan diminta untuk mengonfigurasi detail peristiwa pada langkah berikutnya.
- Skema: Menentukan versi HubSpot API yang akan digunakan. HubSpotV4 adalah API baru.
- BrowsableSchemas: Properti ini membatasi skema yang dilaporkan ke sebagian skema yang tersedia. Misalnya, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
-
Contacts Properties: Masukkan nama kolom yang dipisahkan koma dari entity
Contacts
yang ingin Anda pilih dari operasi entityList
. Misalnya,fieldA, fieldB, fieldC
-
Companies Properties: Masukkan nama kolom yang dipisahkan koma dari entity
Companies
yang ingin Anda pilih dari operasi entityList
. Misalnya,fieldA, fieldB, fieldC
-
Properti Transaksi: Masukkan nama kolom yang dipisahkan koma dari entitas
Deals
yang ingin Anda pilih dari operasi entitasList
. Misalnya,fieldA, fieldB, fieldC
- Use proxy: Centang kotak ini guna mengonfigurasi server proxy untuk koneksi.
- Proxy Auth Scheme: Jenis autentikasi yang digunakan untuk mengautentikasi ke proxy ProxyServer.
- Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
- Sandi Proxy: Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
- Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer.
- 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.
- Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
- Klik Next.
- Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
- Jenis Tujuan: Anda dapat menentukan detail tujuan sebagai alamat host atau lampiran layanan. Pilih salah satu jenis tujuan berikut:
- Alamat host: Jika Anda ingin menentukan nama host atau alamat IP tujuan.
- Lampiran layanan: Jika Anda ingin menentukan endpoint pribadi untuk alamat IP internal. Dengan lampiran layanan, Anda dapat menyembunyikan alamat IP internal dari jaringan eksternal. Anda dapat membuat lampiran layanan di Google Cloud, dengan menggunakan fitur Private Service Connect. Untuk mengetahui informasi tentang cara mengonfigurasi Private Service Connect, lihat Memublikasikan layanan terkelola.
Berdasarkan pilihan jenis tujuan Anda, masukkan alamat host atau nama lampiran layanan.
Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.
- Klik Next.
- Jenis Tujuan: Anda dapat menentukan detail tujuan sebagai alamat host atau lampiran layanan. Pilih salah satu jenis tujuan berikut:
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi HubSpot:
- Token Akses Aplikasi Pribadi: Pilih Secret Manager yang berisi token akses aplikasi pribadi.
Dengan aplikasi pribadi, Anda dapat menggunakan API HubSpot untuk mengakses data tertentu dari akun HubSpot. Anda dapat mengizinkan hal yang dapat diminta atau diubah oleh setiap aplikasi pribadi di akun Anda, yang akan menghasilkan token akses yang unik untuk aplikasi pribadi Anda. Di aplikasi pribadi, pastikan Anda telah memberikan izin baca setidaknya untuk cakupan berikut:
- crm.schemas.line_items.read
- crm.schemas.quotes.read
- crm.schemas.deals.read
- crm.schemas.companies.read
- crm.schemas.custom.read
- crm.schemas.contacts.read
Untuk mengetahui informasi selengkapnya, lihat Aplikasi pribadi.
- Token Akses Aplikasi Pribadi: Pilih Secret Manager yang berisi token akses aplikasi pribadi.
- Klik Next.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
-
Jika Anda telah mengaktifkan langganan acara, bagian Detail Langganan Acara akan muncul di halaman pembuatan koneksi. Pada langkah Detail langganan acara, berikan detail autentikasi yang akan digunakan untuk memvalidasi payload token HubSpot:
- Rahasia Klien: (Opsional) Pilih rahasia Secret Manager dari rahasia klien aplikasi pribadi Anda, dan versi rahasia yang sesuai dari menu drop-down Secret Version.
- Pilih Aktifkan konektivitas pribadi untuk konektivitas yang aman antara aplikasi backend dan koneksi Anda. Jika memilih opsi ini, Anda harus melakukan langkah konfigurasi tambahan setelah membuat koneksi. Untuk mengetahui informasi selengkapnya, lihat Konektivitas pribadi untuk langganan acara.
- Masukkan konfigurasi yang dihentikan pengirimannya. Jika Anda mengonfigurasi huruf mati, koneksi akan menulis
peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
- ID project yang dihentikan pengirimannya: ID project Google Cloud tempat Anda mengonfigurasi topik Pub/Sub yang dihentikan pengirimannya.
- Topik yang dihentikan pengirimannya: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang belum diproses.
- Klik Next.
Untuk mengetahui informasi selengkapnya, lihat Aplikasi pribadi.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
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.
Masalah umum
- Operasi update pada beberapa entity akan menampilkan respons kosong meskipun update berhasil. Dalam kasus tersebut, sebaiknya verifikasi update di instance HubSpot Anda.
- Di HubSpot, Anda dapat memiliki banyak kolom kustom untuk entity berikut:
- Kontak
- Perusahaan
- Promo
Untuk entity ini, memilih semua kolom sekaligus dalam operasi entity
List
, dapat menyebabkan konektor HubSpot menampilkan error. Jika Anda ingin membatasi jumlah kolom kustom dari operasiList
, tentukan nama kolom yang wajib diisi (sebagai nilai yang dipisahkan koma) di konfigurasi konektor HubSpot. Misalnya, untuk membatasi kolom entityContacts
, tentukan nama kolom wajib diisi di kolomContacts Properties
konfigurasi konektor. Demikian pula, untuk entityCompanies
, tentukan nama kolom wajib di kolomCompanies Properties
, dan untuk entityDeals
, tentukan nama kolom wajib diisi di kolomDeals Properties
.Anda dapat menentukan kolom selama langkah pembuatan koneksi. Namun, jika sudah memiliki koneksi, Anda harus mengedit koneksi tersebut, lalu menentukan kolom wajib diisi.
- Jika Anda menetapkan hasil yang sangat besar, operasi
List
mungkin akan gagal karena waktu tunggu koneksi habis. Dalam skenario seperti itu, Anda dapat mempelajari opsi untuk membatasi kumpulan hasil dengan menentukan klausa filter untuk operasi Daftar.
Contoh operasi entitas
Bagian ini menunjukkan cara melakukan beberapa operasi entity di konektor ini.
Contoh - Menampilkan daftar semua kontak
Contoh ini mencantumkan semua data dalam entity Contacts
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Contacts
dari daftarEntity
. - Pilih operasi
LIST
, lalu klik Done.
Contoh - Mendapatkan catatan transaksi
Contoh ini mendapatkan data yang ID-nya 45
dari entity Deals
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Deals
dari daftarEntity
. - Pilih operasi
GET
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik EntityId lalu masukkan
45
di kolom Default Value.Di sini,
45
adalah nilai kunci utama dalam entityDeals
.
Contoh - Membuat tiket
Contoh ini membuat tiket dalam entity Ticket
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Tickets
dari daftarEntity
. - 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": "Test735362767", "Label": "Test735362767", "Type": "String", "FieldType": "Insert ticket1", "GroupName": "ticketinformation", "Description": "Test ticket" }
Jika integrasi berhasil, kolom
connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:{ "Name": "Test1695971640609" }
Contoh - Memperbarui entri transaksi
Contoh ini memperbarui data yang ID-nya adalah 97 di entity Contacts
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Deals
dari daftarEntity
. - 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
:{ "Description": "New description" }
- Klik entityId, lalu masukkan
97
di kolom Nilai Default.Atau, daripada menentukan entityId, Anda juga dapat menetapkan filterClause ke
97
.
Contoh - Menghapus formulir
Contoh ini menghapus data yang ID-nya 78 dalam entity Forms
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Forms
dari daftarEntity
. - Pilih operasi
Delete
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan
78
di kolom Default Value.
Gunakan 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 | Diperlukan | Deskripsi |
---|---|---|---|
schema | ENUM | Benar | Tentukan versi HubSpot API yang akan digunakan. HubSpotV4 adalah API baru. Nilai yang didukung adalah: HubSpot, HubSpotV3, HubSpotV4 |
browsable_schemas | STRING | Salah | Properti ini membatasi skema yang dilaporkan ke sebagian skema yang tersedia. Misalnya, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
contacts_columns | STRING | Salah | Daftar properti yang dipisahkan koma untuk dipilih dari HubSpot untuk entitas Kontak. |
companies_columns | STRING | Salah | Daftar properti yang dipisahkan koma untuk dipilih dari entitas HubSpot for the Companies. |
deals_columns | STRING | Salah | Daftar properti yang dipisahkan koma untuk dipilih dari HubSpot untuk entitas Transaksi. |
proxy_enabled | BOOLEAN | Salah | Pilih kotak centang 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 mengautentikasi ke proxy ProxyServer. |
proxy_ssltype | ENUM | Salah | Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager |
Menggunakan koneksi HubSpot 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
- Memahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.