סקירה כללית של מועדוני לקוחות

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

באמצעות Merchant API, מוכרים וספקי מועדוני לקוחות של צד שלישי שפועלים בשם המוכרים יכולים להגדיר ולתחזק מועדוני לקוחות באופן פרוגרמטי באמצעות LoyaltyProgramService. השירות הזה מאפשר ליצור, לאחזר, להציג ברשימה, לעדכן ולמחוק מועדוני לקוחות.

מידע נוסף על הדרישות העסקיות והנחיות המדיניות זמין במאמר מידע על מועדון הלקוחות של המוכר במרכז העזרה של Merchant Center.

מושגים מרכזיים

כשעובדים עם מועדוני לקוחות, חשוב לזכור את המושגים והמגבלות הבאים:

  • מזהה ברמת החשבון: Merchant API מזהה מועדוני לקוחות לפי מספר החשבון של הבעלים ב-Merchant Center.
  • מועדון לקוחות אחד בלבד: Merchant API תומך רק במועדון לקוחות אחד לכל חשבון של מוכר.
  • בעלות ישירה על החשבון: צריך להגדיר את מועדוני הלקוחות ישירות בחשבון המוכר הרלוונטי (accounts/{ACCOUNT_ID}). השירות לא תומך בניהול מועדוני לקוחות ברמת החשבון המתקדם בשביל חשבונות משנה. ספקי מועדוני לקוחות של צד שלישי עם גישה מורשית לחשבון של המוכר יכולים לנהל את התוכנית בשם המוכר.
  • בדיקת עריכה: אחרי שיוצרים או מעדכנים מועדון לקוחות, הוא עובר בדיקה. השדה review_result.review_status מציין אם התוכנית היא UNDER_REVIEW,‏ APPROVED או REJECTED.
  • אזורים נתמכים: מועדוני לקוחות של מוכרים זמינים במדינות נתמכות, כולל אוסטרליה, איטליה, ארצות הברית, ברזיל, בריטניה, גרמניה, הודו, הולנד, מקסיקו, ספרד, צרפת, קוריאה הדרומית וקנדה.
  • דרישות להצטרפות לרמות: יכול להיות שההצטרפות לרמות תהיה בחינם, או שהיא תדרוש תשלום דמי חברות, הגעה לסף הוצאות מסוים או כרטיס אשראי ממותג של המוכר. אין תמיכה ברמות חברות שמבוססות על עיסוק (לדוגמה: סטודנטים, אנשי צבא ועוד).
  • הטבות וצ'ופרים: המועדונים תומכים במשלוח חינם, בנקודות למימוש ובמחירים לחברי מועדון. כדי שהמחיר לחברי מועדון יופיע במודעות, ההנחה לחברי המועדון צריכה להיות לפחות 5% או 5 יחידות מטבע פחות מהמחיר הרגיל או ממחיר המבצע.

דרישות מוקדמות

כדי לנהל מועדוני לקוחות באמצעות Merchant API, אתם צריכים לעמוד בדרישות הבאות:

  • צריך להיות לכם חשבון Merchant Center פעיל (או גישה מורשית לחשבון של המוכר, אם אתם ספק צד שלישי של מועדון לקוחות).
  • מפעילים בחשבון את התוסף של מועדון הלקוחות. אתם יכולים להפעיל את התוסף באחת מהדרכים הבאות:

הנה בקשה לדוגמה להפעלת התוסף של מועדון הלקוחות באמצעות Programs sub-API:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty:enable

cURL

curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty:enable?key={YOUR_API_KEY}' \
  --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

Methods

אתם יכולים לנהל את מועדוני הלקוחות בשיטות הבאות:

יצירת מועדון לקוחות

כדי ליצור מועדון לקוחות חדש בחשבון, משתמשים ב-method‏ loyaltyPrograms.create. מציינים פרטים כמו תיאורי התוכנית, כתובת ה-URL להרשמה ורמות החברות במועדון עם ההטבות והדרישות הייחודיות שלהן.

המאפיין הנדרש program_label מגדיר את המזהה הייחודי של מועדון הלקוחות. לדוגמה, אם מספקים את התווית my-rewards, התוצאה היא משאב name של accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards.

הנה דוגמה לבקשה:

HTTP

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms

{
  "programLabel": "my-rewards",
  "loyaltyProgram": {
    "programName": "my rewards",
    "tiers": [
      {
        "tierName": "gold",
        "tierLabel": "gold",
        "tierBenefits": [
          {
            "otherBenefit": "free gift on your birthday"
          },
          {
            "structuredBenefit": {
              "pointsEarningBenefit": {
                "minimumMoneySpent": {
                  "currencyCode": "USD",
                  "units": "25"
                },
                "pointsEarningBenefitAnnotation": {
                  "pointsEarned": 1.0,
                  "amountSpent": {
                    "currencyCode": "USD",
                    "units": "1"
                  }
                }
              }
            }
          }
        ],
        "requirements": {
          "freeToJoin": true
        }
      }
    ],
    "programDescriptions": [
      "earn rewards buying products you love"
    ],
    "signupUrl": "https://www.example.com/my_rewards_signup",
    "regionCodes": [
      "US"
    ]
  }
}

מחליפים את {ACCOUNT_ID} במזהה הייחודי של החשבון שלכם ב-Merchant Center.

זוהי דוגמה לתשובה לבקשה שהצליחה:

{
  "name": "accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards",
  "programName": "my rewards",
  "tiers": [
    {
      "tierName": "gold",
      "tierLabel": "gold",
      "tierBenefits": [
        {
          "otherBenefit": "free gift on your birthday"
        },
        {
          "structuredBenefit": {
            "pointsEarningBenefit": {
              "minimumMoneySpent": {
                "currencyCode": "USD",
                "units": "25"
              },
              "pointsEarningBenefitAnnotation": {
                "pointsEarned": 1.0,
                "amountSpent": {
                  "currencyCode": "USD",
                  "units": "1"
                }
              }
            }
          }
        }
      ],
      "requirements": {
        "freeToJoin": true
      },
      "signupUrl": "https://www.example.com/my-rewards/gold"
    }
  ],
  "programDescriptions": [
    "earn rewards buying products you love"
  ],
  "signupUrl": "https://www.example.com/my_rewards_signup",
  "reviewResult": {
    "reviewStatus": "UNDER_REVIEW"
  },
  "regionCodes": [
    "US"
  ]
}

אחזור של מועדון לקוחות

כדי לאחזר את הפרטים של מועדון לקוחות ספציפי בבעלותכם, אתם יכולים להשתמש ב-method‏ loyaltyPrograms.get.

הנה דוגמה לבקשה:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/{PROGRAM_LABEL}

מחליפים את {ACCOUNT_ID} במזהה החשבון ואת {PROGRAM_LABEL} בתווית הייחודית של מועדון הלקוחות (לדוגמה, my-rewards).

זוהי דוגמה לתשובה לבקשה שהצליחה:

{
  "name": "accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards",
  "programName": "my rewards",
  "tiers": [
    {
      "tierName": "gold",
      "tierLabel": "gold",
      "tierBenefits": [
        {
          "otherBenefit": "free gift on your birthday"
        },
        {
          "structuredBenefit": {
            "pointsEarningBenefit": {
              "minimumMoneySpent": {
                "currencyCode": "USD",
                "units": "25"
              },
              "pointsEarningBenefitAnnotation": {
                "pointsEarned": 1.0,
                "amountSpent": {
                  "currencyCode": "USD",
                  "units": "1"
                }
              }
            }
          }
        }
      ],
      "requirements": {
        "freeToJoin": true
      },
      "signupUrl": "https://www.example.com/my-rewards/gold"
    }
  ],
  "programDescriptions": [
    "earn rewards buying products you love"
  ],
  "signupUrl": "https://www.example.com/my_rewards_signup",
  "reviewResult": {
    "reviewStatus": "UNDER_REVIEW"
  },
  "regionCodes": [
    "US"
  ]
}

רשימת מועדוני לקוחות

כדי להציג את כל מועדוני הלקוחות שבבעלותכם שמשויכים לחשבון, משתמשים ב-method‏ loyaltyPrograms.list.

הנה דוגמה לבקשה:

HTTP

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms

זוהי דוגמה לתשובה לבקשה שהצליחה:

{
  "loyaltyPrograms": [
    {
      "name": "accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards",
      "programName": "my rewards",
      "tiers": [
        {
          "tierName": "gold",
          "tierLabel": "gold",
          "tierBenefits": [
            {
              "otherBenefit": "free gift on your birthday"
            },
            {
              "structuredBenefit": {
                "pointsEarningBenefit": {
                  "minimumMoneySpent": {
                    "currencyCode": "USD",
                    "units": "25"
                  },
                  "pointsEarningBenefitAnnotation": {
                    "pointsEarned": 1.0,
                    "amountSpent": {
                      "currencyCode": "USD",
                      "units": "1"
                    }
                  }
                }
              }
            }
          ],
          "requirements": {
            "freeToJoin": true
          },
          "signupUrl": "https://www.example.com/my-rewards/gold"
        }
      ],
      "programDescriptions": [
        "earn rewards buying products you love"
      ],
      "signupUrl": "https://www.example.com/my_rewards_signup",
      "reviewResult": {
        "reviewStatus": "UNDER_REVIEW"
      },
      "regionCodes": [
        "US"
      ]
    }
  ]
}

עדכון מועדון לקוחות

כדי לעדכן מועדון לקוחות קיים, משתמשים ב-method‏ loyaltyPrograms.update. מבצעים עדכון חלקי באמצעות update_mask, או החלפה מלאה על ידי השמטת המסכה.

עדכון חלקי באמצעות מסכת עדכון

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

בבקשה לדוגמה הבאה מעדכנים רק את programDescriptions ואת advancedSettings:

HTTP

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/{PROGRAM_LABEL}?update_mask=program_descriptions,advanced_settings

{
  "programDescriptions": [
    "a new description of the program"
  ],
  "advancedSettings": {
    "hideDisplayFromNonMembers": true
  },
  "signupUrl": "https://www.example.com"
}

בדוגמה הזו, השירות מתעלם מ-signupUrl כי הוא לא כלול ב-update_mask. השדה programDescriptions מחליף לחלוטין את כל התיאורים שהוגדרו בעבר.

זוהי דוגמה לתשובה לבקשה שהצליחה:

{
  "name": "accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards",
  "programName": "my rewards",
  "tiers": [
    {
      "tierName": "gold",
      "tierLabel": "gold",
      "tierBenefits": [
        {
          "otherBenefit": "free gift on your birthday"
        },
        {
          "structuredBenefit": {
            "pointsEarningBenefit": {
              "minimumMoneySpent": {
                "currencyCode": "USD",
                "units": "25"
              },
              "pointsEarningBenefitAnnotation": {
                "pointsEarned": 1.0,
                "amountSpent": {
                  "currencyCode": "USD",
                  "units": "1"
                }
              }
            }
          }
        }
      ],
      "requirements": {
        "freeToJoin": true
      },
      "signupUrl": "https://www.example.com/my-rewards/gold"
    }
  ],
  "programDescriptions": [
    "a new description of the program"
  ],
  "signupUrl": "https://www.example.com/my_rewards_signup",
  "reviewResult": {
    "reviewStatus": "UNDER_REVIEW"
  },
  "regionCodes": [
    "US"
  ],
  "advancedSettings": {
    "hideDisplayFromNonMembers": true
  }
}

החלפה מלאה בלי מסכת עדכון

אם לא תכללו את הפרמטר update_mask, הבקשה תחליף לגמרי את ההגדרות של מועדון הלקוחות.

הנה דוגמה לבקשה:

HTTP

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/{PROGRAM_LABEL}

{
  "programName": "Updated Program",
  "signupUrl": "https://example.com/updated",
  "programDescriptions": [
    "Updated description"
  ],
  "regionCodes": [
    "US"
  ],
  "tiers": [
    {
      "tierName": "Gold Tier",
      "tierLabel": "gold",
      "tierBenefits": [
        {
          "otherBenefit": "Free shipping"
        }
      ],
      "requirements": {
        "freeToJoin": true
      }
    }
  ]
}

זוהי דוגמה לתשובה לבקשה שהצליחה:

{
  "name": "accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/my-rewards",
  "programName": "Updated Program",
  "tiers": [
    {
      "tierName": "Gold Tier",
      "tierLabel": "gold",
      "tierBenefits": [
        {
          "otherBenefit": "Free shipping"
        }
      ],
      "requirements": {
        "freeToJoin": true
      }
    }
  ],
  "programDescriptions": [
    "Updated description"
  ],
  "signupUrl": "https://example.com/updated",
  "reviewResult": {
    "reviewStatus": "UNDER_REVIEW"
  },
  "regionCodes": [
    "US"
  ]
}

מחיקת מועדון לקוחות

כדי למחוק מועדון לקוחות מהחשבון, משתמשים ב-method‏ loyaltyPrograms.delete.

הנה דוגמה לבקשה:

HTTP

DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/loyalty/loyaltyPrograms/{PROGRAM_LABEL}

אם הפעולה בוצעה ללא שגיאות, גוף התגובה ריק.

השלבים הבאים

הקודם
Overview
הבא
Manage customer loyalty data