استخدم هذا المرجع لعرض الحقول المدعومة والأمثلة ذات الصلة لنقطتي النهاية POST /{catalog_id}/batch
وPOST [/{catalog_id}/items_batch
.
قد تبدو أسماء المعلمات في /{catalog_id}/batch
و/{catalog_id}/items_batch
متشابهة، لكنها مختلفة بشكل واضح.
نوصي باستخدام API /{catalog_id}/items_batch
، والتي تدعم المزيد من حالات الاستخدام وتتم صيانتها باستمرار.
/{catalog_id}/batch
هذه الحقول مدعومة لطريقتي CREATE
وUPDATE
.
عند تحديث العناصر، عليك توفير سلسلة فارغة كقيمة لإلغاء تعيين حقل اختياري. تعيين القيمة كـ null
لن يؤدي إلى إلغاء تعيين الحقل.
الحقل | الوصف |
---|---|
النوع: array (مصفوفة)<string> | اختياري. عناوين URL لما يصل إلى 9-10 صور مختلفة. |
النوع: list (قائمة)<KeyValue:string,string> | اختياري. سمات إضافية لتمييز المنتج في مجموعته المتغيرة. مثال: |
النوع: string (سلسلة) | مطلوب يحدد حالة التوفر:
|
النوع: string (سلسلة) | اختياري. مجموعة من الأشخاص في نفس العمر. القيم المقبولة |
النوع: object (كائن)<> | اختياري. روابط لتطبيقات الهاتف المحمول. |
النوع: string (سلسلة) | اختياري ولكن يوصى به لإعلانات كتالوج Advantage+ (قد يساهم في تحسين أداء الإعلان). اختياري للتسوق على Instagram ومتاجر الصفحات، ولكن مطلوب لتمكين إتمام الشراء في الموقع على هذه القنوات (الولايات المتحدة فقط). مطلوب لـ Marketplace (الولايات المتحدة فقط). فئة منتج Google (GPC) للعنصر. استخدم مسار تصنيف الفئة أو رقم معرفها المدرج هنا. إذا كنت تستخدم إتمام الشراء على Instagram أو فيسبوك (الولايات المتحدة فقط)، فإن فئة منتج Google (GPC) الخاص بالعنصر يؤثر على الضرائب وسياسة الإرجاع الخاصة به. تعرّف على المزيد حول فئة منتج Google لعناصر الكتالوج، مركز مساعدة الإعلانات. مثال: |
النوع: string (سلسلة) | اختياري. أقصى حجم: 100. لون العنصر. |
النوع: string (سلسلة) | مطلوب. حالة العنصر: |
النوع: string (سلسلة) | مطلوب. عملة القيمة المحددة. تدعم API التسويق جميع العملات التي تدعمها الحسابات الإعلانية. استخدم ISO 4217 لمعايير العملات. |
النوع: string (سلسلة) | اختياري. الحد الأقصى لعدد الأحرف: 100 معلومات إضافية عن العنصر. قم بتوفير سلسلة فارغة لإلغاء التعيين. |
النوع: string (سلسلة) | مطلوب. أقصى حجم: 5000. وصف قصير للعنصر. |
النوع: string (سلسلة) | اختياري. الجنس لضبط الحجم. تشمل القيم |
النوع: string (سلسلة) | اختياري. أقصى حجم: 70. يمكن أن يشمل رقم العنصر التجاري العالمي |
النوع: string (سلسلة) | مطلوب. رابط لصورة العنصر المستخدمة في الإعلان. عليك توفير أحجام مناسبة للصور. بالنسبة لإعلانات كتالوج Advantage+ ذات الصورة الواحدة
إذا كانت الصورة خارج نسبة العرض إلى الارتفاع هذه، فسيقوم فيسبوك باقتصاصها لتكون أقرب إلى الحد الأدنى لنسبة العرض إلى الارتفاع أو الحد الأقصى لنسبة العرض إلى الارتفاع اعتمادًا على نسبة العرض إلى الارتفاع الأصلية. بالنسبة لإعلانات كتالوج Advantage+ ذات الصور الدوّارة - الحد الأدنى لمتطلبات دقة الصورة هو 500 بيكسل * 500 بيكسل، ويقوم فيسبوك باقتصاصها إلى نسبة عرض إلى ارتفاع تبلغ 1:1. التوصيات: تجنب إجراء تغييرات متكررة في |
النوع: number (رقم) | اختياري. عدد صحيح يمكن للمعلنين استخدامه لتخزين معلومات حول مستوى المخزون. |
النوع: string (سلسلة) | غير متاح لإعلانات كتالوج Advantage+. اختياري للإعلانات التجارية. يشير إلى ما إذا كان سيتم استخدام أحد العناصر في عملية طرح المنتج. علمًا بأن القيم المدعومة هي:
|
النوع: string (سلسلة) | مطلوب. أقصى حجم: 100. عنوان العنصر. |
النوع: string (سلسلة) | اختياري أقصى حجم: 100. النمط أو الرسم المطبوع على العنصر. |
النوع: integer (عدد صحيح) | مطلوب. السعر مضروبًا في 100، لجميع العملات. مثال: 490 عند استخدامه مع الدولار الأمريكي يشير إلى 4.90 دولارات، و49000 عند استخدامه مع الين الياباني يشير إلى 490 ين ياباني. |
النوع: string (سلسلة) | اختياري. أقصى حجم: 750. الفئة المحددة من قبل بائع التجزئة للعنصر. مثال: في تنسيق TSV المنزل والحديقة > المطبخ وتناول الطعام > الأجهزة > الثلاجات. مثال: في تنسيق XML product_type > المنزل والحديقة > المطبخ وتناول الطعام > الأجهزة > الثلاجات > product_type. |
النوع: string (سلسلة) | اختياري. يقبل السلاسل. يمكن للمعلنين استخدامه لتجميع المنتجات معًا. |
النوع: integer (عدد صحيح) | اختياري. السعر المخفض إذا كان هناك خصم على العنصر. هذا هو السعر بعد الخصم مضروبًا في 100، لجميع العملات. مثال: 490 عند استخدامه مع الدولار الأمريكي يشير إلى 4.90 دولارات، و49000 عند استخدامه مع الين الياباني يشير إلى 490 ين ياباني. |
النوع: string (سلسلة) | اختياري. تاريخ انتهاء الخصم ووقته. مثال: |
النوع: string (سلسلة) | اختياري. تاريخ بدء الخصم ووقته. مثال: |
النوع: array (مصفوفة)<object> | اختياري. معلومات الشحن. |
النوع: string (سلسلة) | اختياري. حجم العنصر. مثال: |
النوع: string (سلسلة) | مطلوب. رابط إلى موقع التاجر حيث يمكن لأي شخص شراء العنصر. |
النوع: string (سلسلة) | اختياري. معرف المورد/البائع الذي يبيع العنصر. |
/{catalog_id}/batch
{ "access_token": "<ACCESS_TOKEN>", "requests": [ { "method": "DELETE", "retailer_id": "retailer-1" }, { "method": "CREATE", "retailer_id": "retailer-2", "data": { "availability": "in stock", "brand": "Nike", "category": "t-shirts", "description": "product description", "image_url": "http://www.images.example.com/t-shirts/1.png", "name": "product name", "price": 1000, "currency": "USD", "shipping": [ { "country": "US", "region": "CA", "service": "service", "price_value": "10", "price_currency": "USD" } ], "condition": "new", "url":"http://www.images.example.com/t-shirts/1.png", "retailer_product_group_id": "product-group-1" }, "applinks": { "android": [{ "app_name": "Electronic Example Android", "package": "com.electronic", "url": "example-android://electronic" }], "ios": [{ "app_name": "Electronic Example iOS", "app_store_id": 2222, "url": "example-ios://electronic" }] }, }, { "method": "UPDATE", "retailer_id": "retailer-3", "data": { "availability": "out of stock", } } ] }
/{catalog_id}/batch
سيتم إرجاع حساب واحد أو أكثر.
"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch
/{catalog_id}/items_batch
بالنسبة لكتالوجات التجارة — استخدم API هذه إذا كنت تريد تحديث معلومات المنتج لأكثر من مرة في الساعة (بخلاف ذلك، استخدم API قائمة البيانات). يمكنك تحديث عناصر متعددة في طلب HTTP واحد.
حقول المنتجات هذه مدعومة لطريقتي CREATE
وUPDATE
، للإصدارين 3.3 و3.2:
الحقل | الوصف |
---|---|
النوع: array (مصفوفة)<string> | اختياري. روابط لما يصل إلى 9-10 صور مختلفة. |
النوع: list (قائمة)<KeyValue:string,string> | اختياري. سمات إضافية لتمييز المنتج في مجموعته المتغيرة. مثال: |
النوع: string (سلسلة) | اختياري. مجموعة من الأشخاص في نفس العمر. القيم المقبولة |
النوع: object (كائن)<string> | اختياري. روابط لتطبيقات الهاتف المحمول. مثال: "applink" : { "ios_url": "example-ios://electronic", "ios_app_store_id": "42", "ios_app_name": "Electronic Example iOS", "iphone_url": "example-iphone://electronic", "iphone_app_store_id": "43", "iphone_app_name": "Electronic Example iPhone", "ipad_url": "example-ipad://electronic", "ipad_app_store_id": "44", "ipad_app_name": "Electronic Example iPad", "android_url": "example-android://electronic", "android_package": "com.electronic", "android_class": "com.electronic.Example", "android_app_name": "Electronic Example Android", "windows_phone_url": "example-windows://electronic", "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name": "Electronic Example Windows", } |
النوع: string (سلسلة) | مطلوب. يحدد حالة التوفر:
|
النوع: string (سلسلة) | اختياري. العلامة التجارية للعنصر. |
النوع: string (سلسلة) | اختياري. أقصى حجم: 100. لون العنصر. |
النوع: string (سلسلة) | مطلوب. حالة المنتج: |
النوع: string (سلسلة) | اختياري. الحد الأقصى لعدد الأحرف: 100 معلومات إضافية عن العنصر. |
النوع: string (سلسلة) | مطلوب. أقصى حجم: 5000. نص قصير يصف المنتج. |
النوع: array (مصفوفة)<string> | اختياري. قائمة الإمكانيات المراد تعطيلها. القيم المحتملة هي: |
النوع: string (سلسلة) | اختياري. الجنس لضبط الحجم. تشمل القيم |
النوع: string (سلسلة) | اختياري. أقصى حجم: 250. القيم المحددة مسبقًا (السلسلة أو معرف الفئة) من تصنيف المنتجات في Google. مثال: الأزياء والإكسسوارات > الملابس > الفساتين أو 2271. |
النوع: string (سلسلة) | اختياري. أقصى حجم: 70. يمكن أن يشمل رقم العنصر التجاري العالمي (GTIN) |
النوع: string (سلسلة) | مطلوب. معرف بائع التجزئة |
النوع: array (مصفوفة) <object> | عناوين URL وعلامات الصور التي سيتم استخدامها في إعلاناتك أو في المتاجر. يدعم ما يصل إلى 20 صورة مختلفة. العلامات اختيارية، وفي حالة استخدامها، يجب أن تصف ما هو موجود في الصورة. مثال: "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ] |
النوع: string (سلسلة) | غير مطلوب إذا تم توفير نوصي باستخدام رابط لصورة العنصر المستخدمة في الإعلان. عليك توفير أحجام مناسبة للصور. بالنسبة لإعلانات كتالوج Advantage+ ذات الصورة الواحدة:
بالنسبة لإعلانات كتالوج Advantage+ ذات الصور الدوّارة: الحد الأدنى لمتطلبات دقة الصورة هو 500 بيكسل * 500 بيكسل، ويقوم فيسبوك باقتصاصها إلى نسبة عرض إلى ارتفاع تبلغ 1:1. |
النوع: string (سلسلة) | أضف تصنيفات داخلية للمساعدة في فلترة العناصر عند إنشاء مجموعات منتجات. على سبيل المثال، يمكنك إضافة تصنيف "صيف" لجميع العناصر المدرجة في عرض ترويجي صيفي، ثم فلترة هذه العناصر في مجموعة فرعية. لن تظهر التصنيفات سوى لك استخدم علامات اقتباس فردية (') حول كل تصنيف وافصل بين التسميات المتعددة بفاصلات (،). لا تقم بتضمين مسافات بيضاء في بداية التصنيف أو نهايته. الحد الأقصى للأحرف: ما يصل إلى 5000 تصنيف لكل منتج و110 أحرف لكل تصنيف. مثال (TSV، XLSX، Google Sheets): ['summer','trending'] مثال (CSV): "['summer','trending']" ملاحظة: إذا كنت تستخدم حاليًا تصنيفات مخصصة ( كان يُسمى هذا الحقل |
النوع: object (كائن) | اختياري. عدد صحيح يمكن للمعلنين استخدامه لتخزين معلومات حول مستوى المخزون. |
النوع: string (سلسلة) | اختياري. المعرف الذي يقدمه المعلن لمجموعة المنتجات، وليس معرف فيسبوك (FBID). يقبل السلاسل. يمكن للمعلنين استخدامه لتجميع مجموعة متنوعة من الكائنات المختلفة (عناصر المنتجات والمركبات والفنادق ورحلات الطيران وما إلى ذلك) معًا. |
النوع: string (سلسلة) | مطلوب. رابط إلى موقع التاجر حيث يمكن لأي شخص شراء العنصر. |
النوع: string (سلسلة) | اختياري. معرف الشركة المصنعة الفريد للمنتج. |
النوع: string (سلسلة) | اختياري. أقصى حجم: 100. النمط أو الرسم المطبوع على المنتج. |
النوع: string (سلسلة) | مطلوب. سعر العنصر. يجب تنسيق السعر كتكلفة، متبوعًا بـ رمز ISO للعملة المكون من 3 أرقام، مع وضع مسافة بين التكلفة والعملة. مثال: |
النوع: number (رقم) | اختياري. عدد التقييمات التي قدمها المشترون لهذا المنتج. يجب أن يكون أكبر من 0. يجب استخدام هذا بالاقتران مع مثال: 100 |
النوع: string (سلسلة) | اختياري، ولكنه مطلوب لاستخدام ميزة التراكب لإعلانات كتالوج Advantage+. السعر المخفض إذا كان هناك خصم على العنصر. يجب تنسيق السعر كتكلفة، متبوعًا بـ رمز ISO للعملة المكون من 3 أرقام، مع وضع مسافة بين التكلفة والعملة. مثال: |
النوع: string (سلسلة) | اختياري. تاريخ ووقت البدء والانتهاء لفترة الخصومات، مفصولة بشرطة مائلة. اكتب تاريخي البداية والنهاية بالتنسيق سنة-شهر-يوم. أضف حرف "T" بعد كل تاريخ ثم أدخل الوقت. اكتب الوقت بتنسيق 24 ساعة (من 0:00 إلى 23:59). مثال: |
النوع: string (سلسلة) | اختياري. كائن ثنائي بأسعار مختلفة لكل بلد ومنطقة. يتم الفصل بين المناطق المختلفة بفواصل. ينبغي أن يكون التنسيق مثال: |
النوع: string (سلسلة) | اختياري. حجم العنصر. مثال: |
النوع: string (سلسلة) | مطلوب. أقصى حجم: 100. عنوان العنصر. |
النوع: number (رقم) | اختياري. متوسط التقييمات التي قدمها المشترون لهذا المنتج. يتراوح بين 1.0 و5.0. مسموح بقيمة عشرية واحدة. يجب استخدام هذا بالاقتران مع مثال: 4.5 |
النوع: array (مصفوفة) <object> | عناوين URL وعلامات مقاطع الفيديو التي سيتم استخدامها في إعلاناتك أو في المتاجر. يدعم ما يصل إلى 30000 مقطع فيديو على مستوى الكتالوج. العلامات اختيارية، وفي حالة استخدامها، يجب أن تصف ما هو موجود في مقطع الفيديو. الحد الأقصى لحجم ملف الفيديو هو 200 ميجابايت. تتضمن التنسيقات المدعومة ما يلي: 3g2 و3gp و3gpp وasf وavi وdat وdivx وdv وf4v وflv وgif وm2ts وm4v وmkv وmod وmov وmp4 وmpe وmpeg وmpeg4 وmpg وmts وnsv وogm وogv وqt وtod وts وvob وwmv مثال: "video": [ { "url":"http://example.com/video_1.mp4", "tag": ['Swimming pool','Gym'], } ] ملاحظة: لحذف الفيديو 1 إذا كان المنتج يحتوي على فيديو 1 و2، قم بإزالة الفيديو 1 من المصفوفة: [ { "method": "UPDATE", "data": { "video": [ { "url": "https://google.com/video_2.mp4", "tag": ["video_2"] } ] } } ] لحذف جميع مقاطع الفيديو، أرسل مصفوفة فارغة: [ { "method": "UPDATE", "data": { "video": [] } } ] |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
تعرّف على المزيد حول مجالات المنتج في مرجع API.
PRODUCT_ITEM
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "PRODUCT_ITEM", "requests": [ { "method": "DELETE", "data": { "id": "retailer-1" } }, { "method": "CREATE", "data": { "id": "retailer-2", "applink" : { "ios_url":"example-ios://electronic", "ios_app_store_id":"42", "ios_app_name":"Electronic Example iOS", "iphone_url":"example-iphone://electronic", "iphone_app_store_id":"43", "iphone_app_name":"Electronic Example iPhone", "ipad_url":"example-ipad://electronic", "ipad_app_store_id":"44", "ipad_app_name":"Electronic Example iPad", "android_url":"example-android://electronic", "android_package":"com.electronic", "android_class":"com.electronic.Example", "android_app_name":"Electronic Example Android", "windows_phone_url":"example-windows://electronic", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Electronic Example Windows", }, "availability": "in stock", "brand": "Nike", "google_product_category": "t-shirts", "description": "product description", "image_link": "http://www.images.example.com/t-shirts/1.png", "title": "product name", "price": "10.00 USD", "shipping": [ { "shipping_country": "US", "shipping_region": "CA", "shipping_service": "service", "shipping_price_value": "10", "shipping_price_currency": "USD" } ], "condition": "new", "link":"http://www.images.example.com/t-shirts/1.png", "item_group_id": "product-group-1" } }, { "method": "UPDATE", "data": { "availability": "out of stock", "id": "retailer-3", } } ] }
PRODUCT_ITEM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
تعرّف على المزيد حول إضافة عناصر الكتالوج مع قائمة بيانات.
حقول المنتج المدعومة لطريقتي CREATE
وUPDATE
للنوع HOTEL
، للإصدار 3.2:
الحقل | الوصف |
---|---|
النوع: object (كائن)<string> | مطلوب. عنوان الفندق. |
النوع: | اختياري. روابط لتطبيقات الهاتف المحمول. |
النوع: string (سلسلة) | مطلوب. السعر الأساسي للإقامة ليلة واحدة في غرفة فندقية. أضف نوع العملة إلى السعر. يجب تنسيق السعر كتكلفة، متبوعًا بـ رمز ISO للعملة، مع وضع مسافة بين التكلفة والعملة. مثال: |
النوع: string (سلسلة) | اختياري. يمثل العلامة التجارية لسلسلة الفندق. |
النوع: string (سلسلة) | الحد الأقصى لعدد الأحرف: 100 يتيح لك ما يصل إلى خمسة حقول مخصصة لأي معلومات إضافية تريد فلترة العناصر بها عند إنشاء مجموعات فرعية. على سبيل المثال، يمكنك استخدام حقل مخصص لتحديد جميع الغرف المدرجة في خصومات الصيف، ثم فلترة هذه الغرف في مجموعة فرعية. يدعم هذا الحقل أي قيمة نصية، بما في ذلك الأرقام. مثال: قوائم البيانات التكميلية تدعم هذا الحقل. |
النوع: int (عدد صحيح) | يتيح لك ما يصل إلى خمسة حقول مخصصة لأي معلومات إضافية تتعلق بالأرقام تريد فلترة العناصر بها عند إنشاء مجموعات فرعية. يسمح لك هذا الحقل بالفلترة حسب نطاقات الأرقام (أكبر من وأقل من) عند إنشاء مجموعة. على سبيل المثال، يمكنك استخدام هذا الحقل لتحديد العام الذي تم فيه افتتاح الفندق، ثم فلترة نطاق عام محدَّد في مجموعة. يدعم هذا الحقل الأعداد الصحيحة من 0 إلى 4294967295. ولا يدعم الأرقام السالبة أو الأرقام العشرية أو الفاصلات، مثل -2 أو 5.5 أو 10،000. مثال: |
النوع: string (سلسلة) | مطلوب. أقصى حد لعدد الأحرف: 5000. وصف قصير للفندق. |
النوع: array (مصفوفة)<object> | اختياري. تقييمات ضيوف الفندق. |
النوع: string (سلسلة) | مطلوب. المعرف الفريد للفندق. |
النوع: array (مصفوفة)<object> | مطلوب. عناوين URL وعلامات الصور التي سيتم استخدامها في الإعلانات. يدعم ما يصل إلى 20 صورة مختلفة. العلامات اختيارية، عند استخدامها. يجب أن يصف ما هو موجود في الصورة. مثال: |
النوع: string (سلسلة) | مطلوب. موقع خط العرض للفندق. |
النوع: string (سلسلة) | مطلوب. موقع خط الطول للفندق. |
النوع: string (سلسلة) | اختياري. برنامج الولاء المستخدم للفندق. |
النوع: string (سلسلة) | اختياري. مؤشر ربحية الفندق، تتراوح القيمة من |
النوع: string (سلسلة) | مطلوب. اسم الفندق. |
النوع: array (مصفوفة)<string> | اختياري. حي مجاور واحد أو أكثر للفندق. مثال: |
النوع: string (سلسلة) | اختياري. رقم الهاتف مع رمز البلد. |
النوع: string (سلسلة) | اختياري. سعر الخصم للإقامة ليلة واحدة في الفندق. استخدم هذا للإعلان عن خصومات على سعر الفندق العادي. مطلوب: أضف نوع العملة إلى السعر. يجب تنسيق السعر كتكلفة، متبوعًا بـ رمز ISO للعملة، مع وضع مسافة بين التكلفة والعملة. مثال: |
النوع: string (سلسلة) | اختياري. تقييم الفندق بالنجوم. يجب أن يكون الرقم بين |
النوع: string (سلسلة) | مطلوب. رابط لموقع الويب الخارجي الذي تحجز منه غرفة فندقية. |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
HOTEL
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "HOTEL", "requests": [ { "method": "DELETE", "data": { "hotel_id": "hotel-1" } }, { "method": "CREATE", "data": { "hotel_id": "1234", "brand": "Premium_brand", "description": "A very nice hotel", "name": "The best hotel", "base_price": "100.00 USD", "longitude":"42.10", "latitude":"42.10", "address": { "addr1":"100 Main Street", "city":"North Pole", "region":"ABC", "country":"US", "postal_code":"11111" }, "guest_rating" : [ { "rating_system":"tripAdvisor", "score":"7.8", "number_of_reviewers":"300", "max_score":"10", }, { "rating_system":"Yelp", "score":"5.1", "number_of_reviewers":"123", "max_score":"10", }, ], "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ], "applink" : { "ios_url":"example-ios://electronic", "ios_app_store_id":"42", "ios_app_name":"Electronic Example iOS", "iphone_url":"example-iphone://electronic", "iphone_app_store_id":"43", "iphone_app_name":"Electronic Example iPhone", "ipad_url":"example-ipad://electronic", "ipad_app_store_id":"44", "ipad_app_name":"Electronic Example iPad", "android_url":"example-android://electronic", "android_package":"com.electronic", "android_class":"com.electronic.Example", "android_app_name":"Electronic Example Android", "windows_phone_url":"example-windows://electronic", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Electronic Example Windows", }, "loyalty_program":"Premium_program", "margin_level": "8", "phone":"+61 2-96027455", "star_rating":"4", "url":"http://www.images.example.com/t-shirts/1.png" } }, { "method": "UPDATE", "data": { "base_price": "90.00 USD", "hotel_id": "hotel-3", } } ] }
HOTEL
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
حقول المنتج هذه مدعومة لطريقتي CREATE
وUPDATE
للنوع HOTEL_ROOM
، للإصدار 3.2.
الحقل | الوصف |
---|---|
النوع: string (سلسلة) | مطلوب. السعر الأساسي للإقامة لليلة واحدة. يجب أن تتبع العملة رموز العملة بتنسيق ISO 4217. مثال: |
النوع: string (سلسلة) | مطلوب. أقصى حجم: 5000. نص قصير يصف الغرفة. |
النوع: string (سلسلة) | مطلوب. المعرف الفريد لتاجر التجزئة في الفندق. |
النوع: string (سلسلة) | مطلوب. المعرف الفريد للفندق. |
النوع: array (مصفوفة)<object> | مطلوب. صور للغرفة. |
النوع: string (سلسلة) | مطلوب. أقصى حجم: 100. اسم الغرفة. |
النوع: string (سلسلة) | مطلوب. رابط إلى موقع المعلن حيث يمكن لأي شخص حجز الإقامة. |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
HOTEL_ROOM
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "HOTEL_ROOM", "requests": [ { "method": "DELETE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-1", } }, { "method": "CREATE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-2", "description": "product description", "name": "product name", "base_price": "100 USD", "url": "http://www.example.com/t-shirts/1.html", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ] }, { "method": "UPDATE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-3", "base_price": "120 USD", } } ] }
HOTEL_ROOM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
حقول المنتج هذه مدعومة لطريقتي CREATE
وUPDATE
للنوع FLIGHT
، للإصدار 3.2.
الحقل | الوصف |
---|---|
النوع: string (سلسلة) | اختياري. أقصى حد لعدد الأحرف: 5000. وصف للرحلة الجوية. |
النوع: string (سلسلة) | مطلوب. مطار الوجهة للرحلة الجوية. يجب أن تُكتب كرمز IATA. مثال: |
النوع: string (سلسلة) | اختياري. اسم المدينة الوجهة للرحلة الجوية. |
النوع: array (مصفوفة)<object> | مطلوب. عناوين URL وعلامات الصور التي سيتم استخدامها في الإعلانات. يدعم ما يصل إلى 20 صورة مختلفة. العلامات اختيارية، وفي حالة استخدامها، يجب أن تصف ما هو موجود في الصورة. مثال: |
النوع: string (سلسلة) | مطلوب. المطار الأصلي للرحلة الجوية. يجب أن تُكتب كرمز IATA. مثال: |
النوع: string (سلسلة) | اختياري. اسم المدينة الأصلية للرحلة الجوية. |
النوع: string (سلسلة) | اختياري. تكلفة الرحلة الجوية وعملتها. السعر هو رقم يتبعه رمز العملة، استخدم معايير ISO 4217. استخدم ""."" كعلامة عشرية للسعر. |
النوع: string (سلسلة) | اختياري. رابط ينقلك إلى الموقع حيث يمكنك حجز الرحلة الجوية. |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
FLIGHT
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "FLIGHT", "requests": [ { "method": "DELETE", "data": { "origin_airport": "BOS", "destination_airport": "JFK", } }, { "method": "CREATE", "data": { "origin_airport": "BOS", "destination_airport": "SFO", "description": "Best Flight to SFO", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['City'], }, { "url":"http://example.com/some.image_2.jpg", "tag": ['Food'], } ], "price":"100.00 USD", } }, { "method": "UPDATE", "data": {
FLIGHT
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
حقول المنتج هذه مدعومة لطريقتي CREATE
وUPDATE
للنوع DESTINATION
، للإصدار 3.2.
الحقل | الوصف |
---|---|
النوع: object (كائن)<string> | اختياري. روابط لتطبيقات الهاتف المحمول. |
النوع: object (كائن)<string> | مطلوب. عنوان الفندق. |
النوع: string (سلسلة) | اختياري. أقصى حد لعدد الأحرف: 5000. فقرة قصيرة تصف الوجهة. |
النوع: string (سلسلة) | مطلوب. الحد الأقصى لعدد الأحرف: 100. المعرف الفريد للوجهة. |
النوع: array (مصفوفة)<object> | مطلوب. عناوين URL وعلامات الصور التي سيتم استخدامها في الإعلانات. يدعم ما يصل إلى 20 صورة مختلفة. العلامات اختيارية، وفي حالة استخدامها، يجب أن تصف ما هو موجود في الصورة. مثال: |
النوع: string (سلسلة) | مطلوب. موقع خط العرض للوجهة. |
النوع: string (سلسلة) | مطلوب. موقع خط الطول للوجهة. |
النوع: string (سلسلة) | مطلوب. اسم الوجهة. |
النوع: array (مصفوفة)<string> | اختياري. الحد الأقصى لعدد الأحياء المسموح بها: 20. حي مجاور واحد أو أكثر من للأحياء المجاورة للوجهة. مثال: |
النوع: string (سلسلة) | اختياري. أقل متوسط للتكلفة وعملة الوجهة. يجب تنسيق السعر كرقم متبوعًا برمز العملة، استخدم معايير ISO 4217. استخدم ""."" كعلامة عشرية للسعر. |
النوع: string (سلسلة) | اختياري. تغيير السعر. يمكن استخدامه لبناء مجموعات المنتجات وفي تصميم الإعلان:
مثال: ""انخفض متوسط السعر في مدينة نيويورك بمقدار X"" أو ""انخفض متوسط السعر في مدينة نيويورك"" |
النوع: array (مصفوفة)<string> | مطلوب. الحد الأقصى لعدد أنواع الوجهة: 20. أنواع الوجهة. يمكن أن يكون للوجهة أنواع متعددة. مثال: |
النوع: string (سلسلة) | مطلوب. رابط ينقلك إلى الموقع حيث يمكنك حجز الوجهة. |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
DESTINATION
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "DESTINATION", "requests": [ { "method": "DELETE", "data": { "destination_id": "destination-1" } }, { "method": "CREATE", "data": { "destination_id": "123456789", "description": "My destination is the best.", "name": "The best destination", "price": "199.00 USD", "price_change": "-20", "longitude":"-122.4424", "latitude":"37.7712", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['City','Package'], }, { "url":"http://example.com/some.image_2.jpg", "tag": ['Tour','Landmark'], } ], "address": { "addr1":"1 Market Street", "city":"San Francisco", "region":"California", "country":"United States", "postal_code":"94117" }, "applink" : { "ios_url":"example-ios://travelapp", "ios_app_store_id":"42", "ios_app_name":"Travel App iOS", "iphone_url":"example-iphone://travelapp", "iphone_app_store_id":"43", "iphone_app_name":"Travel App iPhone", "ipad_url":"example-ipad://travelapp", "ipad_app_store_id":"44", "ipad_app_name":"Travel App iPad", "android_url":"example-android://travelapp", "android_package":"com.travelapp", "android_class":"com.travelapp.Example", "android_app_name":"Travel App Android", "windows_phone_url":"example-windows://travelapp", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Travel App Windows", }, "type":["city","culture"], "neighborhood":["Mission","SoMa"], "url":"http://www.thebestdestination.com" } }, { "method": "UPDATE", "data": { "price": "159.99", "destination_id": "destination-3", } } ] }
DESTINATION
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
حقول المنتج هذه مدعومة لطريقتي CREATE
وUPDATE
للنوع HOME_LISTING
، للإصدارين 3.3 و3.2.
الحقل | الوصف |
---|---|
النوع: object (كائن)<string> | اختياري. روابط لتطبيقات الهاتف المحمول. |
النوع: object (كائن)<string> | مطلوب. عنوان الشارع لقائمة المنازل المعروضة. |
النوع: string (سلسلة) | مطلوب. التوفر الحالي لقائمة المنازل المعروضة. القيم المدعومة: |
النوع: array (مصفوفة)<object> | اختياري. تكوينات السعر. |
النوع: string (سلسلة) | اختياري. أقصى حد لعدد الأحرف: 5000. فقرة قصيرة تصف قائمة المنازل المعروضة. |
النوع: array (مصفوفة)<object> | مطلوب. عناوين URL وعلامات الصور التي سيتم استخدامها في الإعلانات. يدعم ما يصل إلى 20 صورة مختلفة. العلامات اختيارية، وفي حالة استخدامها، يجب أن تصف ما هو موجود في الصورة. مثال: |
النوع: string (سلسلة) | اختياري. موقع خط العرض لقائمة المنازل المعروضة. |
النوع: string (سلسلة) | اختياري. موقع خط الطول لقائمة المنازل المعروضة. |
النوع: string (سلسلة) | اختياري. نوع القائمة المعروضة. القيم المدعومة: |
النوع: string (سلسلة) | مطلوب. اسم قائمة المنازل المعروضة. |
النوع: array (مصفوفة)<object> | اختياري. الحي المجاور لقائمة المنازل المعروضة. الحد الأقصى لعدد الأحياء المجاورة المسموح بها: 20. |
النوع: string (سلسلة) | اختياري. عدد الحمامات. |
النوع: string (سلسلة) | اختياري. عدد غرف النوم. |
النوع: string (سلسلة) | اختياري. عدد الوحدات المتاحة. يُستخدم فقط للشقق أو الوحدات الفاخرة المتاحة للإيجار. |
النوع: string (سلسلة) | مطلوب. التكلفة والعملة لقائمة المنازل المعروضة. السعر هو رقم يتبعه رمز العملة، استخدم معايير ISO 4217. استخدم ""."" كعلامة عشرية للسعر. |
النوع: string (سلسلة) | اختياري. تغيير السعر. يمكن استخدامه لبناء مجموعات المنتجات وفي تصميم الإعلان:
مثال: ""انخفض متوسط السعر في مدينة نيويورك بمقدار X"" أو ""انخفض متوسط السعر في مدينة نيويورك"" |
النوع: string (سلسلة) | اختياري. نوع العقار. القيم المدعومة: |
النوع: string (سلسلة) | مطلوب. رابط ينقلك إلى الموقع حيث يمكنك عرض القائمة المعروضة. |
النوع: string (سلسلة) | اختياري. السنة التي تم فيها بناء المنزل. |
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
HOME_LISTING
{ "access_token": "<ACCESS_TOKEN>", "item_type": "HOME_LISTING", "requests": [ { "method": "DELETE", "data": { "home_listing_id": "home-listing-1" } }, { "method": "CREATE", "data": { "home_listing_id": "12345678", "availability": "for_sale", "description": "An amazing listing", "name": "1 Hacker Way, Menlo Park, CA 94025", "price": "110000 USD", "longitude":"1.11414", "latitude":"-1.835003", "address": { "addr1":"1 Hacker Way", "city":"Menlo Park", "region":"California", "country":"United States", "postal_code":"94025" }, "neighborhood":["Menlo Oaks"], "image": [ { "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg", }, ], "listing_type": "for_sale_by_agent", "num_baths":"6", "num_beds":"5", "num_units":"1", "property_type":"house", "year_built":"2007", "available_dates_price_config" : [ { "start_date":"2020-11-15", "end_date":"2020-12-15", "rate":"10000", "currency":"USD", "interval":"nightly", }, { "start_date":"2020-11-15", "end_date":"2020-12-15", "rate":"50000", "currency":"USD", "interval":"weekly", }, ], "applink" : { "ios_url":"example-ios://travelapp", "ios_app_store_id":"42", "ios_app_name":"Travel App iOS", "android_url":"example-android://travelapp", "android_package":"com.travelapp", "android_class":"com.travelapp.Example", "android_app_name":"Travel App Android", }, "url":"http://www.example.com/link_to_listing" } }, { "method": "UPDATE", "data": { "price": "100000 USD", "home_listing_id": "home-listing-3", } } ] }
HOME_LISTING
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
للتعرف على الحقول المدعومة لطريقتي CREATE
وUPDATE
للنوع VEHICLE
، راجع حقول كتالوج مخزون السيارات - المركبة.
الحقول المدعومة متاحة لكل من المركبة والوكيل.
يمكن أيضًا استخدام طريقة UPDATE
لإنشاء عناصر إذا لم تكن موجودة بالفعل.
VEHICLE
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "VEHICLE", "requests": [ { "method": "DELETE", "data": { "vehicle_id": "vehicle-1" } }, { "method": "CREATE", "data": { "vehicle_id": "i2 2017 Ford Fusion", "availability": "AVAILABLE", "make": "Ford", "model": "Fusion", "year": "2017", "mileage": { "value": "1500", "unit": "KM", }, "image": [ { "url":"http://www.facebook.com/teapic.jpg", "tag":["Car"], }, ], "fuel_type":"gasoline", "body_style":"sedan", "drivetrain":"FWD", "vin":"1FADP5AU6DL536022", "condition":"EXCELLENT", "description": "Turbocharged! Gasoline!", "title": "SE Ford Certified and 6-Speed Automatic.", "price": "18000 USD", "exterior_color":"white", "sale_price":"16000 USD", "state_of_vehicle":"new", "longitude":"52.35", "latitude":"42.1", "address": { "addr1":"550 Auto Center Dr", "city":"Watsonville", "region":"CA", "country":"US", "postal_code":"96075" }, "url":"http://www.example.com/test" } }, { "method": "UPDATE", "data": { "price": "16000 USD", "vehicle_id": "vehicle-3", } } ] }
VEHICLE
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
/{catalog_id}/localized_items_batch
راجع قائمة الحقول المدعومة وأوصافها المقابلة لكل حقل، لنقطة النهاية /{catalog_id}/localized_items_batch
:
راجع القائمة الكاملة لـ الحقول المدعومة بواسطة الكتالوج.
/{catalog_id}/items_batch
(ملاحظة: نوصي باستخدام نقطة النهاية هذه، نظرًا إلى أنها تدعم حالات استخدام أكثر وتتم صيانتها باستمرار.)
/{catalog_id}/batch
/{catalog_id}/check_batch_request_status
/{catalog_id}/localized_items_batch