إنشاء المناطق وتعديلها

يمثّل هذا الدليل منطقة جغرافية يمكنك استخدامها كهدف للخدمة المرتبطة بمورد accounts.products.regionalInventories. يمكنك تحديد المناطق على أنّها مجموعات من الرموز البريدية أو باستخدام استهدافات جغرافية محدّدة مسبقًا في بعض البلدان. لمزيد من المعلومات، يُرجى الاطّلاع على إعداد المناطق.

لإنشاء المناطق وتعديلها، يمكنك استخدام الطرق التالية:

• Get
• List
• Create
• Patch
• Delete

استرداد منطقة

لاسترداد منطقة محدّدة في حسابك على Merchant Center، استخدِم الطريقة 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، استخدِم الطريقة 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، استخدِم الطريقة 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، استخدِم الطريقة التالية: 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، استخدِم الطريقة التالية: 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
{}