‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

ריבוע

מחבר Square מאפשר לכם לבצע פעולות של הוספה, מחיקה, עדכון וקריאה של נתונים ב-Square.

גרסאות נתמכות

המחבר הזה תומך בגרסה 1.0 של Square.

לפני שמתחילים

לפני שמשתמשים במחבר Square, צריך לבצע את המשימות הבאות:

בפרויקט שלכם ב-Google Cloud:
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM‏ roles/connectors.admin.
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. מידע נוסף זמין במאמר בנושא יצירת חשבון שירות.
- מפעילים את השירותים הבאים:
  - ‫secretmanager.googleapis.com (Secret Manager API)
  - ‫connectors.googleapis.com (Connectors API)
  במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.

הגדרת המחבר

החיבור הוא ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:

במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
כניסה לדף Connections
לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
בקטע מיקום, בוחרים את המיקום של החיבור.
1. אזור: בוחרים מיקום מהרשימה הנפתחת.
  רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
2. לוחצים על הבא.
בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
1. מחבר: בוחרים באפשרות Square מתוך רשימת המחברים הזמינים.
2. גרסת המחבר: בוחרים את גרסת המחבר מתוך רשימת הגרסאות הזמינות.
3. בשדה Connection Name, מזינים שם למופע החיבור.
  השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
  - שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
  - האותיות צריכות להיות קטנות.
  - שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
  - שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
4. תיאור: מזינים תיאור של מופע החיבור.
5. אופציונלי: מפעילים את Cloud Logging ואז בוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-Error.
6. חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
7. סכימה: מציינים את הסכימה של החיבור, למשל v1 או v2.
8. שימוש בארגז חול: מציינים אם להשתמש בסביבת ארגז החול לחיבור.
9. מזהה מיקום: מציינים את מזהה המיקום של החיבור.
10. אופציונלי: מגדירים את ההגדרות של צומת החיבור:
  - מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
  - מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
  צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר עסקאות לחיבור נדרשים יותר צמתים, ולהפך: כדי לעבד פחות עסקאות נדרשים פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
11. + הוספת תווית לוחצים על האפשרות הזו כדי להוסיף תווית לחיבור בצורה של צמד מפתח/ערך.
12. לוחצים על הבא.
בקטע אימות, מזינים את פרטי האימות.
1. בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
  החיבור ל-Square תומך בסוגי האימות הבאים:
  - ‫OAuth 2.0 – קוד הרשאה
  - טוקן גישה אישי
  כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
2. לוחצים על הבא.
בדיקה: בודקים את פרטי החיבור והאימות.
לוחצים על יצירה.

הגדרת אימות

מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.

OAuth 2.0 - קוד הרשאה
- ‫Client ID (מספר לקוח): מזינים את מספר הלקוח שבו רוצים להשתמש לחיבור.
- היקפים: מזינים רשימה מופרדת בפסיקים של ההיקפים הרצויים.
- סוד לקוח: מזינים את סוד הלקוח שבו רוצים להשתמש לחיבור ל-Square.
- גרסה של סוד: בוחרים את הגרסה של הסוד שנבחר למעלה.
- כתובת URL לאישור: מזינים את כתובת ה-URL לאישור שנוצרה במהלך יצירת הלקוח.
- הפעלת ביטול אימות: מציינים אם להפעיל ביטול אימות לחיבור.
Personal Access Token
- Personal Access Token (טוקן גישה אישי): מזינים את טוקן הגישה האישי שבו רוצים להשתמש לחיבור.
- גרסה של סוד: בוחרים את הגרסה של הסוד שנבחר למעלה.
- הפעלת ביטול אימות: מציינים אם להפעיל ביטול אימות לחיבור.

דוגמאות להגדרת חיבור

בקטע הזה מפורטים ערכים לדוגמה לשדות השונים שאתם מגדירים כשאתם יוצרים את החיבור.

‫OAuth 2.0 – סוג החיבור של קוד הרשאה

שם השדה	פרטים
מיקום	us-central1
מחבר	ריבוע
גרסת המחבר	1
שם החיבור	square-oauth-ai
הפעלת Cloud Logging	TRUE
חשבון השירות	my-service-account@my-project.iam.gserviceaccount.com
סכימה	v2
מספר הצמתים המינימלי	2
מספר הצמתים המקסימלי	50
אימות	‫OAuth 2.0 – קוד הרשאה
מספר לקוח	CLIENT_ID
היקפים	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
סוד לקוח	CLIENT_SECRET
גרסה של סוד	1
כתובת אתר להרשאה	https://connect.squareup.com/oauth2/authorize

סוג החיבור של טוקן גישה אישי

שם השדה	פרטים
מיקום	asia-east1
מחבר	ריבוע
גרסת המחבר	1
שם החיבור	square-pat-prod-conn
הפעלת Cloud Logging	TRUE
חשבון השירות	my-service-account@my-project.iam.gserviceaccount.com
סכימה	v2
שימוש בארגז חול	TRUE
מספר הצמתים המינימלי	2
מספר הצמתים המקסימלי	50
אימות	טוקן גישה אישי
טוקן גישה אישי	PERSONAL_ACCESS_TOKEN
גרסה של סוד	1

מגבלות המערכת

המחבר של Square יכול לעבד עד 16 עסקאות בשנייה, לכל צומת, ומגביל את מספר העסקאות מעבר למגבלה הזו. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.

מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.

הערה: מספר צמתי Integration Connectors יותאם באופן אוטומטי ודינמי בהתאם לשימוש שלכם. עם זאת, אם אתם רוצים לשריין קיבולת לנפחים גדולים בלי לחכות להתאמה אוטומטית לעומס, אתם יכולים לשנות את הערך המינימלי של הצומת לחיבור. כדי לעבד יותר עסקאות בחיבור, צריך להוסיף עוד צמתים. לעומת זאת, אם החיבור מעבד פחות עסקאות, נדרשים פחות צמתים. כדי להגדיר את הערכים של הצומת:

אם אתם לקוחות עם תשלום לפי שימוש, אתם יכולים להגדיר את ערך הצומת המינימלי והמקסימלי בדף עריכת החיבור.
אם יש לכם מינוי, אתם יכולים לפנות לתמיכה.

מספר העסקאות המקסימלי שצומת יכול לטפל בהן תלוי בגורמים שונים. לכן, לפני שמשנים את מספר הצמתים המינימלי כדי לשפר את קצב העברת הנתונים, מומלץ לבדוק אם מערכות ה-Backend מוגדרות בצורה אופטימלית לטיפול בתנועת הגולשים הנדרשת.

שימוש בחיבור Square בשילוב

אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.

כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.

פעולות

בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.

הפעולה CancelPayment

הפעולה הזו מבטלת תשלום.

פרמטרים של קלט לפעולה CancelPayment

שם הפרמטר	סוג נתונים	חובה	תיאור
PaymentId	String	נכון	המזהה של התשלום שרוצים לבטל.

דוגמה להגדרת הפעולה CancelPayment מופיעה במאמר דוגמאות.

פעולת CompletePayment

הפעולה הזו משלימה תשלום.

פרמטרים של קלט לפעולה CompletePayment

שם הפרמטר	סוג נתונים	חובה	תיאור
PaymentId	String	נכון	המזהה של התשלום שרוצים להשלים.

דוגמה להגדרת הפעולה CompletePayment מופיעה במאמר דוגמאות.

CancelPaymentByIdempotencyKey action

הפעולה הזו מבטלת תשלום באמצעות מפתח האידמפוטנטיות שלו.

פרמטרים של קלט לפעולה CancelPaymentByIdempotencyKey

שם הפרמטר	סוג נתונים	חובה	תיאור
IdempotencyKey	String	נכון	מפתח האידמפוטנטיות שמשמש לזיהוי התשלום לביטול.

דוגמה להגדרת הפעולה CancelPaymentByIdempotencyKey מופיעה במאמר דוגמאות.

פעולת CancelInvoice

הפעולה הזו מבטלת חשבונית.

פרמטרים של קלט לפעולה CancelInvoice

שם הפרמטר	סוג נתונים	חובה	תיאור
InvoiceId	String	נכון	המזהה של החשבונית שרוצים לבטל.
InvoiceVersion	String	נכון	הגרסה של החשבונית שרוצים לבטל.

דוגמה להגדרת הפעולה CancelInvoice מופיעה במאמר דוגמאות.

פעולת PublishInvoice

הפעולה הזו מפרסמת חשבונית.

פרמטרים של קלט לפעולה PublishInvoice

שם הפרמטר	סוג נתונים	חובה	תיאור
InvoiceId	String	נכון	המזהה של החשבונית לפרסום.
InvoiceVersion	Int32	נכון	גרסת החשבונית לפרסום. המספר הזה צריך להיות זהה למספר שמופיע בגרסה הנוכחית של החשבונית, אחרת הבקשה תידחה.

דוגמה להגדרת הפעולה PublishInvoice מופיעה במאמר דוגמאות.

פעולת DeleteInvoiceAttachment

הפעולה הזו מוחקת קובץ מצורף לחשבונית.

פרמטרים של קלט לפעולה DeleteInvoiceAttachment

שם הפרמטר	סוג נתונים	חובה	תיאור
InvoiceId	String	נכון	המזהה של החשבונית שמכילה את הקובץ המצורף שרוצים למחוק.
AttachmentId	String	נכון	המזהה של הקובץ המצורף שרוצים למחוק.

דוגמה להגדרת הפעולה DeleteInvoiceAttachment מופיעה במאמר דוגמאות.

הפעולה CancelSubscriptions

הפעולה הזו מבטלת מינוי.

פרמטרים של קלט לפעולה CancelSubscriptions

שם הפרמטר	סוג נתונים	חובה	תיאור
מזהה	String	נכון	המזהה של המינוי שרוצים לבטל.

דוגמה להגדרת הפעולה CancelSubscriptions מופיעה במאמר דוגמאות.

דוגמאות לפעולות

בקטע הזה מוסבר איך לבצע חלק מהפעולות שמופיעות בדוגמאות במחבר הזה.

דוגמה – ביטול תשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה CancelPayment ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:

[
  {
    "Success": true
  }
]

דוגמה – השלמת תשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה CompletePayment ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:

[{
"Success": true
}]

דוגמה – ביטול תשלום באמצעות מפתח אידמפוטנטיות

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה CancelPaymentByIdempotencyKey ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לערך הבא:

[{
"Success": true
}]

דוגמה – ביטול חשבונית

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה CancelInvoice ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:

[
  {
    "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
  }
]

דוגמה – פרסום חשבונית

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה PublishInvoice ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:

[
  {
    "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
  }
]

דוגמה – מחיקת קובץ מצורף לחשבונית

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה DeleteInvoiceAttachment ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לערך הבא:

[{
"Success": true
}]

דוגמה – ביטול מינוי

בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
בוחרים את הפעולה CancelSubscriptions ולוחצים על סיום.
בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value:
```
{
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}
```

אם הפעולה מצליחה, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לערך הבא:

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

}]

דוגמאות לפעולות על ישויות

בקטע הזה מוסבר איך לבצע חלק מהפעולות על ישויות במחבר הזה.

דוגמה – הצגת רשימה של כל התשלומים

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Payments מהרשימה Entity.
בוחרים את הפעולה List ולוחצים על סיום.
בקטע Task Input במשימה Connectors, אפשר להגדיר את filterClause בהתאם לדרישות הסינון.

חובה להשתמש במירכאות בודדות (') כדי להקיף את הערך של filterClause. אפשר להשתמש ב-filterClause כדי לסנן רשומות על סמך העמודות.

דוגמה – קבלת פרטי תשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Payments מהרשימה Entity.
בוחרים את הפעולה Get ולוחצים על סיום.
מגדירים את entityId ל-"bb4756c7-38c0-426b-97aa-03b6443e7f16", שהוא המפתח שיועבר.
כדי להגדיר את entityId, בקטע Data Mapper של Data Mapping, לוחצים על Open Data Mapping Editor, מזינים "bb4756c7-38c0-426b-97aa-03b6443e7f16" בשדה Input Value ובוחרים באפשרות entityId כמשתנה מקומי.

הערך של entityId צריך להיות מועבר ישירות, למשל "bb4756c7-38c0-426b-97aa-03b6443e7f16". כאן, "bb4756c7-38c0-426b-97aa-03b6443e7f16" הוא הערך הייחודי של המפתח הראשי.

אם העברת entityId יחיד גורמת לשגיאה בגלל נוכחות של שני מפתחות מורכבים, אפשר להשתמש ב-filterClause כדי להעביר את הערך.

דוגמה – מחיקת תשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Payments מהרשימה Entity.
בוחרים את הפעולה Delete ולוחצים על סיום.
מגדירים את entityId ל-"62008bbe-effa-4341-9d29-eac7f67b84fe", שהוא המפתח שיועבר.
כדי להגדיר את entityId, בקטע Data Mapper של Data Mapping, לוחצים על Open Data Mapping Editor, מזינים "62008bbe-effa-4341-9d29-eac7f67b84fe" בשדה Input Value ובוחרים באפשרות entityId כמשתנה מקומי.

אם לישות יש שני מפתחות עסקיים מורכבים או מפתחות ראשיים, במקום לציין את entityId, אפשר גם להגדיר את filterClause ל-id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

דוגמה – יצירת תשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Payments מהרשימה Entity.
בוחרים את הפעולה Create ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId או connectorInputPayload כמשתנה מקומי.
```
{
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}
```
אם השילוב יצליח, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:
```
{
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}
```

דוגמה – יצירת החזר כספי

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Refunds מהרשימה Entity.
בוחרים את הפעולה Create ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId או connectorInputPayload כמשתנה מקומי.
```
{
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}
```
אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך שדומה לזה:
```
{
  "Success": true
}
```

דוגמה – יצירת מינוי

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Subscriptions מהרשימה Entity.
בוחרים את הפעולה Create ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId או connectorInputPayload כמשתנה מקומי.
```
{
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}
```
אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך שדומה לזה:
```
{
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}
```

דוגמה – יצירת לקוח

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Customers מהרשימה Entity.
בוחרים את הפעולה Create ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId או connectorInputPayload כמשתנה מקומי.
```
{
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}
```
אם השילוב יצליח, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:
```
{
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}
```

דוגמה – יצירת כרטיס מתנה

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות GiftCards מהרשימה Entity.
בוחרים את הפעולה Create ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId או connectorInputPayload כמשתנה מקומי.
```
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}
```
אם השילוב יצליח, פרמטר התגובה connectorOutputPayload של משימת המחבר יקבל ערך שדומה לזה:
```
{
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}
```

דוגמה – עדכון חשבונית

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Invoices מהרשימה Entity.
בוחרים את הפעולה Update ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor ואז מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId,‏ connectorInputPayload או filterClause כמשתנה מקומי.
```
{
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
```
מגדירים את entityId ב-Data Mapper לישות של החשבוניות.
כדי להגדיר את entityId, לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId, ‏ connectorInputPayload או filterClause כמשתנה מקומי.
במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:
```
{ }
```

דוגמה – עדכון מינוי

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות Subscriptions מהרשימה Entity.
בוחרים את הפעולה Update ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor ואז מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId,‏ connectorInputPayload או filterClause כמשתנה מקומי.
```
{
  "Note": "Update Subscription"
}
```
מגדירים את entityId בכלי למיפוי נתונים לישות של המינויים.
כדי להגדיר את entityId, לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId, ‏ connectorInputPayload או filterClause כמשתנה מקומי.
במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:
```
{ }
```

דוגמה – עדכון פרטי התשלום

בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
בוחרים באפשרות PayOuts מהרשימה Entity.
בוחרים את הפעולה Update ולוחצים על סיום.
בקטע Data Mapper (מיפוי נתונים) במשימה Data Mapping (מיפוי נתונים), לוחצים על Open Data Mapping Editor ואז מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId,‏ connectorInputPayload או filterClause כמשתנה מקומי.
```
{
  "Version": 1,
  "Description": "Update Payout"
}
```
מגדירים את entityId ב-Data Mapper לישות של PayOuts.
כדי להגדיר את entityId, לוחצים על Open Data Mapping Editor, מזינים ערך דומה לערך הבא בשדה Input Value ובוחרים את entityId, ‏ connectorInputPayload או filterClause כמשתנה מקומי.
במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך '181352d9-94ef-4e86-8bb9-e3759472325f'.

הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:
```
{ }
```

קבלת עזרה מקהילת Google Cloud

אתם יכולים לפרסם את השאלות שלכם ולדון במחבר הזה בקהילת Google Cloud בפורומים של Cloud.

ריבוע

גרסאות נתמכות

לפני שמתחילים

הגדרת המחבר

הגדרת אימות

דוגמאות להגדרת חיבור

‫OAuth 2.0 – סוג החיבור של קוד הרשאה

סוג החיבור של טוקן גישה אישי

מגבלות המערכת

שימוש בחיבור Square בשילוב

פעולות

הפעולה CancelPayment

פרמטרים של קלט לפעולה CancelPayment

פעולת CompletePayment

פרמטרים של קלט לפעולה CompletePayment

CancelPaymentByIdempotencyKey action

פרמטרים של קלט לפעולה CancelPaymentByIdempotencyKey

פעולת CancelInvoice

פרמטרים של קלט לפעולה CancelInvoice

פעולת PublishInvoice

פרמטרים של קלט לפעולה PublishInvoice

פעולת DeleteInvoiceAttachment

פרמטרים של קלט לפעולה DeleteInvoiceAttachment

הפעולה CancelSubscriptions

פרמטרים של קלט לפעולה CancelSubscriptions

דוגמאות לפעולות

דוגמה – ביטול תשלום

דוגמה – השלמת תשלום

דוגמה – ביטול תשלום באמצעות מפתח אידמפוטנטיות

דוגמה – ביטול חשבונית

דוגמה – פרסום חשבונית

דוגמה – מחיקת קובץ מצורף לחשבונית

דוגמה – ביטול מינוי

דוגמאות לפעולות על ישויות

דוגמה – הצגת רשימה של כל התשלומים

דוגמה – קבלת פרטי תשלום

דוגמה – מחיקת תשלום

דוגמה – יצירת תשלום

דוגמה – יצירת החזר כספי

דוגמה – יצירת מינוי

דוגמה – יצירת לקוח

דוגמה – יצירת כרטיס מתנה

דוגמה – עדכון חשבונית

דוגמה – עדכון מינוי

דוגמה – עדכון פרטי התשלום

קבלת עזרה מקהילת Google Cloud

המאמרים הבאים