HubSpot

Konektor HubSpot memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan 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:
  • 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:

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 HubSpot 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.
      • Untuk konektor yang mendukung langganan peristiwa, nama koneksi tidak boleh diawali dengan awalan "goog".
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   6. Untuk menggunakan koneksi untuk langganan peristiwa, pilih Aktifkan langganan peristiwa. Dengan memilih opsi ini, opsi berikut akan ditampilkan:
      • Aktifkan langganan peristiwa dengan entity dan tindakan: Pilih opsi ini untuk menggunakan koneksi untuk langganan peristiwa dan operasi konektor (entity dan tindakan).
      • Aktifkan hanya langganan peristiwa: Pilih opsi ini untuk menggunakan koneksi hanya untuk langganan peristiwa. Jika Anda memilih opsi ini, klik Berikutnya, lalu konfigurasi langganan peristiwa.
   7. Schema: Tentukan versi HubSpot API yang akan digunakan. HubSpotV4 adalah API baru.
   8. BrowsableSchemas: Properti ini membatasi skema yang dilaporkan ke sebagian skema yang tersedia. Misalnya, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
   9. Contacts Properties: Masukkan nama kolom yang dipisahkan koma dari entitas Contacts yang ingin Anda pilih dari operasi entitas List. Misalnya, fieldA, fieldB, fieldC
   10. Companies Properties: Masukkan nama kolom yang dipisahkan koma dari entity Companies yang ingin Anda pilih dari operasi entity List. Misalnya, fieldA, fieldB, fieldC
   11. Deals Properties: Masukkan nama kolom yang dipisahkan koma dari entitas Deals yang ingin Anda pilih dari operasi entitas List. Misalnya, fieldA, fieldB, fieldC
   12. Gunakan proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
   13. Proxy Auth Scheme: Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
   14. Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
   15. Proxy Password: Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
   16. Proxy SSL Type: Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer.
   17. 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.

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika merupakan pelanggan Bayar sesuai penggunaan.
   18. Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
   19. Klik Berikutnya.
5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
   1. 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. Lampiran layanan memungkinkan Anda menyembunyikan alamat IP internal dari jaringan eksternal. Anda dapat membuat lampiran layanan di Google Cloud, dengan menggunakan fitur Private Service Connect. Untuk informasi tentang cara mengonfigurasi Private Service Connect, lihat Memublikasikan layanan terkelola.

      Berdasarkan pilihan jenis tujuan, masukkan alamat host atau nama lampiran layanan.

      Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.

   2. Klik Berikutnya.
6. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi HubSpot:

      • Token Akses Aplikasi Pribadi: Pilih Secret Manager Secret yang berisi token akses aplikasi pribadi.

        Aplikasi pribadi memungkinkan Anda menggunakan API HubSpot untuk mengakses data tertentu dari akun HubSpot Anda. Anda dapat memberikan otorisasi atas apa 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 ke 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 informasi selengkapnya, lihat Aplikasi pribadi.

   2. Klik Berikutnya.
7. Jika Anda telah mengaktifkan langganan peristiwa, bagian Detail Langganan Peristiwa akan muncul di halaman pembuatan koneksi. Pada langkah Detail langganan peristiwa, berikan detail autentikasi yang akan digunakan untuk memvalidasi payload token HubSpot:
   1. Rahasia Klien: (Opsional) Pilih secret Secret Manager dari secret klien aplikasi pribadi Anda, dan versi secret yang sesuai dari drop-down Versi Secret.

   Untuk informasi selengkapnya, lihat Aplikasi pribadi.

   2. Pilih Aktifkan konektivitas pribadi untuk konektivitas 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 peristiwa.
   3. Masukkan konfigurasi dead-letter. Jika Anda mengonfigurasi dead-letter, koneksi akan menulis peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
      1. Project ID dead-letter: Project ID Google Cloud tempat Anda mengonfigurasi topik dead-letter Pub/Sub.
      2. Topik dead-letter: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang tidak diproses.
   4. Klik Berikutnya.
8. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
9. Klik Create.

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.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Konektor.

• 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:
  • Cantumkan
  • Dapatkan
  • Buat
  • Update
  • Hapus

  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.

Catatan: Semua entitas dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Masalah umum

• Operasi pembaruan pada beberapa entity menampilkan respons kosong meskipun pembaruan berhasil. Dalam kasus seperti ini, sebaiknya verifikasi update di instance HubSpot Anda.
• Di HubSpot, Anda berpotensi memiliki banyak kolom kustom untuk entitas berikut:
  • Kontak
  • Perusahaan
  • Promo

  Untuk entitas ini, memilih semua kolom sekaligus dalam operasi entitas List, dapat menyebabkan konektor HubSpot menampilkan error. Dalam skenario saat Anda ingin membatasi jumlah kolom kustom dari operasi List, tentukan nama kolom yang diperlukan (sebagai nilai yang dipisahkan koma) dalam konfigurasi konektor HubSpot. Misalnya, untuk membatasi kolom entitas Contacts, tentukan nama kolom yang diperlukan di kolom Contacts Properties konfigurasi konektor. Demikian pula, untuk entity Companies, tentukan nama kolom yang diperlukan di kolom Companies Properties, dan untuk entity Deals, tentukan nama kolom yang diperlukan di kolom Deals Properties.

  Anda dapat menentukan kolom selama langkah pembuatan koneksi. Namun, jika sudah memiliki koneksi, Anda harus mengedit koneksi, lalu menentukan kolom yang diperlukan.

• Jika Anda memiliki kumpulan hasil yang sangat besar, operasi List mungkin gagal karena waktu tunggu koneksi habis. Dalam skenario tersebut, Anda dapat mempelajari opsi untuk membatasi set hasil dengan menentukan klausa filter untuk operasi List.

Contoh operasi entity

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

Contoh - Mencantumkan semua kontak

Contoh ini mencantumkan semua data dalam entitas Contacts.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Contacts dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.

Contoh - Mendapatkan data transaksi

Contoh ini mendapatkan data yang ID-nya adalah 45 dari entitas Deals.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Deals dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 45 di kolom Default Value.

   Di sini, 45 adalah nilai kunci utama dalam entity Deals.

Contoh - Membuat tiket

Contoh ini membuat tiket di entitas Ticket.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi Create, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default 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 promo

Contoh ini memperbarui data yang ID-nya adalah 97 di entity Contacts.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Deals dari daftar Entity.
3. Pilih operasi Update, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Description": "New description"
   }

5. Klik entityId, lalu masukkan 97 di kolom Default Value.

   Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke 97.

Contoh - Menghapus formulir

Contoh ini menghapus data dengan ID 78 di entitas Forms.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Forms dari daftar Entity.
3. Pilih operasi Delete, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 78 di kolom Default Value.

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
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 HubSpot untuk entitas Perusahaan.
deals_columns	STRING	Salah	Daftar properti yang dipisahkan koma untuk dipilih dari HubSpot untuk entitas Deals.
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 HubSpot 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.