Persegi

Konektor Square memungkinkan Anda melakukan tindakan penyisipan, penghapusan, pembaruan, dan pembacaan pada data Square.

Versi yang didukung

Konektor ini mendukung Square versi 1.0.

Sebelum memulai

Sebelum menggunakan konektor Square, 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 diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika Anda 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

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections 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.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik NEXT.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih Square dari daftar konektor yang tersedia.
    2. Versi konektor: Pilih versi konektor dari daftar versi yang tersedia.
    3. Di kolom Nama Koneksi, masukkan nama untuk instance koneksi.

      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. Deskripsi: Masukkan deskripsi untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Skema: Tentukan skema untuk koneksi, seperti v1 atau v2.
    8. Gunakan Sandbox: Tentukan apakah akan menggunakan lingkungan sandbox untuk koneksi.
    9. Location Id: Tentukan ID lokasi untuk koneksi.
    10. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. 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.

    11. + TAMBAHKAN LABEL Klik ini untuk menambahkan label ke koneksi dalam bentuk pasangan kunci/nilai.
    12. Klik NEXT.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Square:

      • OAuth 2.0 - Kode Otorisasi
      • Token Akses Pribadi

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

    2. Klik NEXT.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Buat.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • OAuth 2.0 - Kode Otorisasi
    • Client ID: Masukkan client ID yang akan digunakan untuk koneksi.
    • Cakupan: Masukkan daftar cakupan yang diinginkan, yang dipisahkan dengan koma.
    • Rahasia Klien: Masukkan rahasia klien yang akan digunakan untuk koneksi Square.
    • Versi rahasia: Pilih versi rahasia untuk rahasia yang dipilih di atas.
    • URL otorisasi: Masukkan URL otorisasi yang dibuat saat membuat klien.
    • Aktifkan Penggantian Autentikasi: Tentukan apakah akan mengaktifkan penggantian autentikasi untuk koneksi.
  • Token Akses Pribadi
    • Token Akses Pribadi: Masukkan token akses pribadi yang akan digunakan untuk koneksi.
    • Versi rahasia: Pilih versi rahasia untuk rahasia yang dipilih di atas.
    • Aktifkan Penggantian Autentikasi: Tentukan apakah akan mengaktifkan penggantian autentikasi untuk koneksi.

Contoh konfigurasi koneksi

Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi.

OAuth 2.0 - Jenis koneksi kode otorisasi

Nama kolom Detail
Lokasi us-central1
Konektor Persegi
Versi konektor 1
Nama Koneksi square-oauth-ai
Mengaktifkan Cloud Logging true
Akun Layanan my-service-account@my-project.iam.gserviceaccount.com
Skema v2
Jumlah minimum node 2
Jumlah maksimum node 50
Autentikasi OAuth 2.0 - Kode Otorisasi
ID klien CLIENT_ID
Cakupan BANK_ACCOUNTS_READ, CASH_DRAWER_READ, CUSTOMERS_READ, CUSTOMERS_WRITE, DEVICE_CREDENTIAL_MANAGEMENT, EMPLOYEES_READ, EMPLOYEES_WRITE, INVENTORY_READ, INVENTORY_WRITE, ITEMS_READ, ITEMS_WRITE, LOYALTY_READ, LOYALTY_WRITE, MERCHANT_PROFILE_READ, ORDERS_READ, ORDERS_WRITE, PAYMENTS_READ, PAYMENTS_WRITE, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS, PAYMENTS_WRITE_IN_PERSON, SETTLEMENTS_READ, TIMECARDS_READ, TIMECARDS_WRITE, TIMECARDS_SETTINGS_READ, TIMECARDS_SETTINGS_WRITE, APPOINTMENTS_READ, APPOINTMENTS_WRITE, APPOINTMENTS_BUSINESS_SETTINGS_READ, INVOICES_READ, INVOICES_WRITE, SUBSCRIPTIONS_READ, SUBSCRIPTIONS_WRITE, DISPUTES_READ, DISPUTES_WRITE, GIFTCARDS_READ, GIFTCARDS_WRITE, ONLINE_STORE_SNIPPETS_WRITE, ONLINE_STORE_SNIPPETS_READ, ONLINE_STORE_SITE_READ, PAYMENTS_WRITE_SHARED_ONFILE, APPOINTMENTS_ALL_READ, APPOINTMENTS_ALL_WRITE, MERCHANT_PROFILE_WRITE, VENDOR_READ, VENDOR_WRITE, PAYOUTS_READ, DEVICES_READ
Rahasia Klien CLIENT_SECRET
Versi rahasia 1
URL otorisasi https://connect.squareup.com/oauth2/authorize

Jenis koneksi token akses pribadi

Nama kolom Detail
Lokasi asia-east1
Konektor Persegi
Versi konektor 1
Nama Koneksi square-pat-prod-conn
Mengaktifkan Cloud Logging true
Akun Layanan my-service-account@my-project.iam.gserviceaccount.com
Skema v2
Menggunakan Sandbox true
Jumlah minimum node 2
Jumlah maksimum node 50
Autentikasi Token Akses Pribadi
Token Akses Pribadi PERSONAL_ACCESS_TOKEN
Versi rahasia 1

Batasan sistem

Konektor Square dapat memproses maksimum 16 transaksi per detik, per node, dan membatasi transaksi apa pun yang melampaui batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.

Menggunakan koneksi Square 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 Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Tindakan

Bagian ini menunjukkan cara melakukan beberapa tindakan di konektor ini.

Tindakan CancelPayment

Tindakan ini membatalkan pembayaran.

Parameter input tindakan CancelPayment

Nama parameter Jenis data Wajib Deskripsi
PaymentId String Benar ID pembayaran yang akan dibatalkan.

Untuk contoh tentang cara mengonfigurasi tindakan CancelPayment, lihat Contoh.

Tindakan CompletePayment

Tindakan ini menyelesaikan pembayaran.

Parameter input tindakan CompletePayment

Nama parameter Jenis data Wajib Deskripsi
PaymentId String Benar ID pembayaran yang akan diselesaikan.

Untuk contoh tentang cara mengonfigurasi tindakan CompletePayment, lihat Contoh.

Tindakan CancelPaymentByIdempotencyKey

Tindakan ini membatalkan pembayaran menggunakan kunci idempotensinya.

Parameter input tindakan CancelPaymentByIdempotencyKey

Nama parameter Jenis data Wajib Deskripsi
IdempotencyKey String Benar Kunci keidempotensi yang digunakan untuk mengidentifikasi pembayaran yang akan dibatalkan.

Untuk contoh tentang cara mengonfigurasi tindakan CancelPaymentByIdempotencyKey, lihat Contoh.

Tindakan CancelInvoice

Tindakan ini membatalkan invoice.

Parameter input tindakan CancelInvoice

Nama parameter Jenis data Wajib Deskripsi
InvoiceId String Benar ID invoice yang akan dibatalkan.
InvoiceVersion String Benar Versi invoice yang akan dibatalkan.

Untuk contoh tentang cara mengonfigurasi tindakan CancelInvoice, lihat Contoh.

Tindakan PublishInvoice

Tindakan ini akan memublikasikan invoice.

Parameter input tindakan PublishInvoice

Nama parameter Jenis data Wajib Deskripsi
InvoiceId String Benar ID invoice yang akan dipublikasikan.
InvoiceVersion Int32 Benar Versi invoice yang akan dipublikasikan. Nomor ini harus cocok dengan versi invoice saat ini; jika tidak, permintaan akan ditolak.

Untuk contoh tentang cara mengonfigurasi tindakan PublishInvoice, lihat Contoh.

Tindakan DeleteInvoiceAttachment

Tindakan ini akan menghapus lampiran invoice.

Parameter input tindakan DeleteInvoiceAttachment

Nama parameter Jenis data Wajib Deskripsi
InvoiceId String Benar ID invoice yang berisi lampiran yang akan dihapus.
AttachmentId String Benar ID lampiran yang akan dihapus.

Untuk contoh tentang cara mengonfigurasi tindakan DeleteInvoiceAttachment, lihat Contoh.

Tindakan CancelSubscriptions

Tindakan ini akan membatalkan langganan.

Parameter input tindakan CancelSubscriptions

Nama parameter Jenis data Wajib Deskripsi
ID String Benar ID langganan yang akan dibatalkan.

Untuk contoh tentang cara mengonfigurasi tindakan CancelSubscriptions, lihat Contoh.

Contoh tindakan

Bagian ini menunjukkan cara melakukan beberapa contoh tindakan di konektor ini.

Contoh - Membatalkan pembayaran

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

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

    [
  {
    "Success": true
  }
]

Contoh - Menyelesaikan pembayaran

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

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

    [{
"Success": true
}]

Contoh - Membatalkan pembayaran menggunakan kunci idempotensi

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CancelPaymentByIdempotencyKey, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

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

    [{
"Success": true
}]

Contoh - Membatalkan invoice

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CancelInvoice, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "3",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "NOT_APPLICABLE",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_status": "CANCELED",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:57:24Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Contoh - Memublikasikan invoice

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan PublishInvoice, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "2",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "PENDING",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_next_payment_amount_money_amount": "60",
    "invoice_next_payment_amount_money_currency": "USD",
    "invoice_status": "UNPAID",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:52:13Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Contoh - Menghapus lampiran invoice

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DeleteInvoiceAttachment, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

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

    [{
"Success": true
}]

Contoh - Membatalkan langganan

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CancelSubscriptions, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

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

    [{
"Success": true,
"Status": "CANCELED"

}]

Contoh operasi entity

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

Contoh - Mencantumkan semua pembayaran

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Payments dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Di bagian Input Tugas pada tugas Konektor, Anda dapat menetapkan filterClause berdasarkan persyaratan pemfilteran Anda.

    5. Anda harus menggunakan tanda kutip tunggal (') untuk menyertakan nilai filterClause. Anda dapat menggunakan filterClause untuk memfilter data berdasarkan kolom.

Contoh - Mendapatkan detail pembayaran

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Payments dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Tetapkan entityId ke "bb4756c7-38c0-426b-97aa-03b6443e7f16" yang merupakan kunci yang akan diteruskan.
  5. Untuk menyetel entityId, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan "bb4756c7-38c0-426b-97aa-03b6443e7f16" di kolom Nilai Input dan pilih entityId sebagai variabel lokal.

    6. Nilai untuk entityId harus diteruskan secara langsung, seperti "bb4756c7-38c0-426b-97aa-03b6443e7f16". Di sini, "bb4756c7-38c0-426b-97aa-03b6443e7f16" adalah nilai kunci utama yang unik.

    Jika meneruskan satu entityId memunculkan error karena adanya dua kunci komposit, Anda dapat menggunakan filterClause untuk meneruskan nilai.

Contoh - Menghapus pembayaran

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Payments dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  4. Tetapkan entityId ke "62008bbe-effa-4341-9d29-eac7f67b84fe" yang merupakan kunci yang akan diteruskan.
  5. Untuk menyetel entityId, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan "62008bbe-effa-4341-9d29-eac7f67b84fe" di kolom Nilai Input dan pilih entityId sebagai variabel lokal.

    6. Jika entitas memiliki dua kunci bisnis atau kunci utama gabungan, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

Contoh - Membuat pembayaran

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Payments dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId atau connectorInputPayload sebagai variabel lokal. 
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

    Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut:

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Contoh - Membuat pengembalian dana

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Refunds dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId atau connectorInputPayload sebagai variabel lokal. 
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

    Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut:

    {
  "Success": true
}

Contoh - Membuat langganan

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Subscriptions dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId atau connectorInputPayload sebagai variabel lokal. 
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

    Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut:

    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

Contoh - Membuat pelanggan

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Customers dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId atau connectorInputPayload sebagai variabel lokal. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

    Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Contoh - Membuat kartu voucher

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih GiftCards dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId atau connectorInputPayload sebagai variabel lokal. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

    Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Contoh - Memperbarui invoice

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Invoices dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Tetapkan entityId di Pemeta Data ke entity Invoice.
  6. Untuk menetapkan entityId, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, lalu pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal.

    Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

    Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas konektor:

    { }

Contoh - Memperbarui langganan

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Subscriptions dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal. 
    {
  "Note": "Update Subscription"
}
  5. Tetapkan entityId di Pemeta Data ke entity Langganan.
  6. Untuk menetapkan entityId, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal.

    Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

    Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas konektor:

    { }

Contoh - Perbarui detail pembayaran

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih PayOuts dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  4. Di bagian Pemeta Data pada tugas Pemetaan Data, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Tetapkan entityId di Pemeta Data ke entity PayOuts.
  6. Untuk menetapkan entityId, klik Open Data Mapping Editor, lalu masukkan nilai yang mirip dengan berikut di kolom Input Value, dan pilih entityId, connectorInputPayload, atau filterClause sebagai variabel lokal.

    Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke '181352d9-94ef-4e86-8bb9-e3759472325f'.

    Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas konektor:

    { }

Mendapatkan bantuan dari komunitas Google Cloud

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

Langkah berikutnya