תחילת השימוש ב-Merchant API

בדף הזה מוסבר איך ליצור חשבון Merchant Center ולהעלות מוצר לדוגמה באמצעות Merchant API.

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

מפעילים את Merchant API בפרויקט ב-Google Cloud.

אם משתמשים בשילוב של API ב-AppScript באמצעות שירות התוכן של שופינג, המערכת יוצרת פרויקט Google Cloud שמוגדר כברירת מחדל ומפעילה את שירות Merchant API באופן אוטומטי. עם זאת, עדיין צריך להשלים הרשמה חד-פעמית כמפתח לפני שמשתמשים ב-Merchant API. מידע נוסף זמין במאמר בנושא שימוש בשירות Merchant API ב-Apps Script.

כניסה ל-Google Cloud

יצירת חשבון

כדי להשתמש ב-Merchant API, צריך שיהיה לכם חשבון Merchant Center. הוראות ליצירת חשבון Merchant Center מופיעות במאמר איך מתחילים להשתמש ב-Merchant Center.

מעבר אל Merchant Center

הירשם כמפתח

כדי להשתמש ב-Merchant API, צריך לקשר את חשבון Merchant Center ואת הפרויקט ב-Google Cloud באמצעות שיטת רישום המפתחים, באופן הבא:

1. קישור של Merchant Center לפרויקט Google Cloud: הקישור מאושר באופן אוטומטי, כי למבצע הקריאה החוזרת (caller) יש אסימון גישה או מפתח API תקפים מפרויקט Google Cloud , והוא משתמש מורשה בחשבון Merchant Center.

2. הוספת משתמש מסוג מפתח API לחשבון Merchant Center: ה-Registration API מוסיף משתמש מסוג מפתח API לחשבון Merchant Center. אם המשתמש כבר קיים, הוא יקבל את סוג הגישה החדש. במקרה של משתמש חדש, הוא יקבל הזמנה באימייל ל-Merchant Center.

מומלץ להשתמש בשיטה accounts.users.create כדי להוסיף מפתחי API נוספים או מפתחי API לגיבוי, כדי לוודא שאם האדם יעזוב את הארגון או יימחק, עדיין תהיה לכם הרשמה תקפה כמפתחים.

אחרי הרישום אפשר לראות את סטטוס הרישום באמצעות GetDeveloperRegistration או לבטל את הרישום באמצעות UnregisterGCP.

השיחה לצורך הרישום היא

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp

{
  developer_email:"example-email@example.com"
}

אחרי שהבקשה תפעל בהצלחה, תקבלו את התגובה:

{
  "developerRegistration": {
    "name": "accounts/ACCOUNT_ID/developerRegistration",
    "gcpIds": ["GOOGLE_CLOUD_PROJECT_ID"]
  }
}

אחרי שהמפתח של ה-API נרשם, אפשר להשתמש בשיטה accounts.users.patch כדי להקצות לו תפקידים נוספים, כמו STANDARD ו-ADMIN.

איך מאתרים את מספר החשבון

אפשר לאתר את מזהה החשבון באמצעות ה-method‏ accounts.list.

אתם יכולים להשתמש ב-Google APIs Explorer כדי להריץ בקשות ל-Merchant API. הכלי APIs Explorer משתמש ב-Google OAuth 2.0 לאימות. לפני שמריצים את הבקשות, מוודאים שתיבת הסימון Google OAuth 2.0 מסומנת.

כדי לבצע אימות באמצעות OAuth 2.0, צריך להיכנס לחשבון Google ואז להיכנס ל-APIs Explorer. בנוסף, צריך לאפשר ל-APIs Explorer לנהל את כרטיסי המוצר והחשבונות שלכם.

בדוגמה הבאה מוצג איך אפשר לאחזר את מזהה החשבון:

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts

או

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}

אחרי שהבקשה תפעל בהצלחה, תופיע התגובה הבאה:

{
  "accounts": [
    {
      "name": "{ACCOUNT_NAME}",
      "accountId": "{ACCOUNT_ID}",
      "accountName": "{ACCOUNT_DISPLAY_NAME}",
      "timeZone": {
        "id": "America/Los_Angeles"
      },
      "languageCode": "en-US"
    }
  ]
}

מעתיקים את {ACCOUNT_ID} כי תצטרכו אותו כדי להריץ בקשות אחרות.

יצירת מקור נתוני מוצרים ראשי

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

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/{ACCOUNT_ID}/dataSources HTTP/1.1

{
  "primaryProductDataSource": {
    "channel": "ONLINE_PRODUCTS",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "feedLabel": "US"
  },
  "name": "primary-data-source",
  "displayName": "Primary Products Data Source"
}

מחליפים את {ACCOUNT_ID} במספר החשבון של Merchant Center שיצרתם.

אחרי שהבקשה הזו תופעל בהצלחה, תופיע התגובה הבאה:

{
  "name": "accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}",
  "dataSourceId": "{DATASOURCE_ID}",
  "displayName": "Primary Products Data Source",
  "primaryProductDataSource": {
    "channel": "ONLINE_PRODUCTS",
    "feedLabel": "US",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "defaultRule": {
      "takeFromDataSources": [
        {
          "self": true
        }
      ]
    }
  },
  "input": "API"
}

מעתיקים את הערך של השדה name כי תצטרכו אותו כדי להוסיף מוצר.

יעברו כמה דקות עד שמקור הנתונים שנוצר יהיה זמין להוספת מוצרים.

אפשר לראות את מקור הנתונים הזה בממשק המשתמש של Merchant Center. מידע נוסף מופיע במאמר איך ניגשים לכרטיסייה 'מקורות נתונים'.

הוסף מוצר

כדי להוסיף מוצר לדוגמה לחשבון, מריצים את הבקשה הבאה:

POST https://merchantapi.googleapis.com/products/v1beta/accounts/{ACCOUNT_ID}/productInputs:insert?dataSource={DATASOURCE_NAME} HTTP/1.1

{
  "channel": "ONLINE",
  "contentLanguage": "en",
  "feedLabel": "US",
  "name": "Red T-shirt",
  "attributes": {
    "gender": "Male",
    "brand": "New brand"
  },
  "offerId": "tshirt-123"
}

מחליפים את {DATASOURCE_NAME} בערך שהעתקתם קודם.

אחרי שהבקשה הזו תופעל בהצלחה, תופיע התגובה הבאה:

{
  "name": "accounts/{ACCOUNT_ID}/productInputs/online~en~US~tshirt-123",
  "product": "accounts/{ACCOUNT_ID}/products/online~en~US~tshirt-123",
  "channel": "ONLINE",
  "offerId": "tshirt-123",
  "contentLanguage": "en",
  "feedLabel": "US",
  "attributes": {
    "brand": "New brand",
    "gender": "Male"
  }
}

מזהה המוצר של המוצר החדש שנוצר הוא online~en~US~tshirt-123. אפשר להשתמש בשיטה accounts.products.get כדי לאחזר פרטים על המוצר הזה. אפשר גם להשתמש בממשק המשתמש של Merchant Center כדי לראות את המוצר הזה.