יצירה ועדכון של אזורים

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

כדי ליצור ולעדכן אזורים, אפשר להשתמש בשיטות הבאות:

• Get
• List
• Create
• Patch
• Delete

אחזור אזור

כדי לאחזר אזור שהוגדר בחשבון Merchant Center, משתמשים ב-method‏ accounts.regions.get.

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

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions/234567?key=[YOUR_API_KEY]

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

HTTP/1.1 200

{
  "name": "accounts/125222396/regions/234567",
  "displayName": "Canada",
  "postalCodeArea": {
    "regionCode": "CA",
    "postalCodes": [
      {
        "begin": "L6A"
      }
    ]
  }

הצגת רשימה של כל האזורים

כדי לקבל רשימה של האזורים בחשבון Merchant Center, משתמשים ב-method‏ accounts.regions.list.

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

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions?pageSize=100&key=[YOUR_API_KEY]

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

HTTP/1.1 200

{
  "regions": [
    {
      "name": "accounts/125222396/regions/234567",
      "displayName": "Canada",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "L6A"
          }
        ]
      },
      "regionalInventoryEligible": true,
      "shippingEligible": true
    },
    {
      "name": "accounts/125222396/regions/Inline region",
      "displayName": "Inline region",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "M7B"
          }
        ]
      },
      "regionalInventoryEligible": false,
      "shippingEligible": true
    },
  ]
}

הוספת אזור

כדי להוסיף הגדרה של אזור בחשבון Merchant Center, משתמשים ב-method‏ accounts.regions.create. כדי להריץ את השיטה הזו נדרשת הרשאת אדמין.

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

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=987654&key=[YOUR_API_KEY]

{
  "displayName": "TestRegion",
  "name": "987654",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98109"
      }
    ],
    "regionCode": "US"
  }
}

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

{
     "name": "accounts/102959835/regions/987654",
  "displayName": "TestRegion",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98109"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

כדי ליצור אזור חדש באמצעות AreaCode:

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

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=168888&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "WA_test",
  "name": "168888",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20101
    ]
  }
}

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

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "WA_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20101"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

כדי לעדכן את displayName ו-GeoTargetCriteriaIds של האזור שנוצר:

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

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20100
    ]
  }
}

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

HTTP/1.1 200

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20100"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

עדכון אזור

כדי לעדכן הגדרה של אזור בחשבון Merchant Center, משתמשים ב-method‏ accounts.regions.patch. כדי להריץ את השיטה הזו נדרשת הרשאת אדמין.

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

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?updateMask=displayName%2CpostalCodeArea&key=[YOUR_API_KEY] HTTP/1.1

Authorization: Bearer [YOUR_ACCESS_TOKEN]
Accept: application/json
Content-Type: application/json

{
  "displayName": "Test",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98108"
      }
    ],
    "regionCode": "US"
  }
}

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

{
  "name": "accounts/102959835/regions/987654",
  "displayName": "Test",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98108"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

מחיקת אזור

כדי למחוק הגדרת אזור מחשבון Merchant Center, משתמשים ב-method‏ accounts.regions.delete. כדי להריץ את השיטה הזו נדרשת הרשאת אדמין.

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

DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?key=[YOUR_API_KEY] HTTP/1.1

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

HTTP/1.1 200
{}