סכימת XML

בקטע הזה מוסבר על סכימת ה-XML שמשמשת לפיד נתוני הביקורות על מוכרים.

רכיב ברמה העליונה: <feed>

תיאור

רכיב המאגר ברמה העליונה שמכיל את כל שאר הרכיבים בפיד.

מאפיינים

שם פורמט מופעים תיאור
xmlns xs:string חובה (1) צריך להגדיר את הערך הבא כקבוע (hardcode):
http://schemas.google.com/merchant_reviews/5.0
xmlns:xsi xs:string חובה (1) צריך להגדיר את הערך הבא כקבוע:
http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation xs:string חובה (1) צריך להזין את הערך הבא בקידוד קשיח, ולהשאיר רווח אחד בין כתובות ה-URL:
http://schemas.google.com/merchant_reviews/5.0 http://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd

דוגמה

<feed xmlns="http://schemas.google.com/merchant_reviews/5.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://schemas.google.com/merchant_reviews/5.0 https://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd">

מכיל

שם פורמט מופעים תיאור
merchants       -- אופציונלי (0-1) רכיב מאגר לרכיבי <merchant>.
deleted_merchants       -- אופציונלי (0-1) רכיב מאגר לרכיבי <deleted_merchant>.
reviews       -- אופציונלי (0-1) רכיב מאגר לרכיבי <review>.
deleted_reviews       -- אופציונלי (0-1) רכיב מאגר לרכיבי <deleted_review>.

<merchants>

תיאור

קונטיינר של רכיבי <merchant>.

מכיל

שם פורמט מופעים תיאור
merchant       -- חובה (1 עד n) האלמנט חוזר על עצמו לכל מוכר.

<merchant>

תיאור

כל רכיב <merchant> מכיל מידע וביקורות על מוכר אחד.

מאפיינים

שם פורמט מופעים תיאור
id Id חובה (1) המזהה צריך להיות ייחודי ויציב בכל הפידים. במילים אחרות, אם פיד שמועלה היום ופיד שהועלה לפני 90 ימים מתייחסים לאותו מוֹכר, המזהה שלהם חייב להיות זהה.

דוגמה

<merchant id="2739">

מכיל

צריך לכלול את הרכיבים הבאים ברכיב merchant.

שם פורמט מופעים תיאור
name NonEmptyString חובה (1) השם המוצג של המוכר, בפורמט שקריא לבני אדם.
merchant_url ‫xs:anyURI חובה (1) כתובת ה-URL של האתר הראשי של המוֹכר.
אין להשתמש בכתובת אתר להפניה אוטומטית עבור הערך הזה. במילים אחרות, הערך צריך להפנות ישירות לאתר של המוכר.

דוגמה: 

<merchant_url>
  http://store.google.com
</merchant_url>

rating_url ‫xs:anyURI חובה (1) כתובת ה-URL של דף הנחיתה שבו מתארחות הביקורות על המוכר הזה.
אין להשתמש בכתובת URL להפניה אוטומטית.

דוגמה: 

<rating_url>
  http://merchant_url.com/reviews/
</rating_url>

create_timestamp DateTimeWithTimeZone חובה (1) השעה והתאריך שבהם נוצר החשבון של המוכר. הערך הזה חייב להישאר קבוע.
last_update_timestamp DateTimeWithTimeZone חובה (1) התאריך והשעה שבהם המוכר עודכן לאחרונה. אם מעדכנים שדות ברכיב <merchant> של מזהה מוֹכר מסוים, צריך לשנות גם את הערך הזה.

<deleted_merchants>

תיאור

קונטיינר של מוֹכרים שנמחקו.

מכיל

שם פורמט מופעים תיאור
deleted_merchant       -- חובה (1 עד n) מכיל רכיבים שקשורים למוֹכר יחיד שנמחק.

<deleted_merchant>

תיאור

המוֹכר שנמחק.

מאפיינים

שם פורמט מופעים תיאור
id Id חובה (1) מציין את המזהה של מוֹכר שצריך למחוק מהפיד. המזהה צריך להיות זהה למאפיין id של רכיב <merchant> בקובץ פיד קודם.

מכיל

שם פורמט מופעים תיאור
last_update_timestamp DateTimeWithTimeZone חובה (1) השעה והתאריך שבהם מוכר הוסר מהמערכת.

דוגמה: 

<last_update_timestamp>
  2016-04-03T18:37:32Z
</last_update_timestamp>

דוגמה

<deleted_merchant id="10">
  <last_update_timestamp>2014-07-12T07:55:06Z</last_update_timestamp>
</deleted_merchant>

<reviews>

תיאור

קונטיינר של רכיבי <review>.

מכיל

שם פורמט מופעים תיאור
review       -- חובה (1 עד n) האלמנט חוזר על עצמו לכל ביקורת.

<review>

תיאור

קונטיינר לפרטים שקשורים לביקורת.

מאפיינים

שם פורמט מופעים תיאור
id Id חובה (1) המזהה של ביקורת במערכת שלכם. המזהה צריך להיות ייחודי ויציב בכל הפידים.

דוגמה: 

<review id=132739 mid=1234>

mid Id חובה (1) המזהה של המוכר שעליו נכתבה הביקורת.

מכיל

חשוב לכלול את האלמנטים הבאים בתוך אלמנט הביקורת.

שם פורמט מופעים תיאור
reviewer_name NonEmptyString אופציונלי (0-1) השם המוצג של מחבר הביקורת, אם הביקורת צריכה לכלול שם של מחבר. ביקורות אנונימיות לא צריכות לכלול את השדה הזה.

דוגמה: 

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp DateTimeWithTimeZone חובה (1) השעה והתאריך שבהם המשתמש שלח את הביקורת. הערך הזה חייב להישאר קבוע.

דוגמה: 

<create_timestamp>
  2016-04-03T18:37:32Z
</create_timestamp>

last_update_timestamp DateTimeWithTimeZone חובה (1) התאריך והשעה שבהם המידע ברכיב <review> השתנה בפעם האחרונה. אם מעדכנים שדות כלשהם ברכיב <review> של מזהה ביקורת מסוים, צריך לשנות גם את הערך הזה.

דוגמה: 

<last_update_timestamp>
  2016-04-03T18:37:32Z
</last_update_timestamp>

country_code CountryCode חובה (1) המדינה של כותב הביקורת. אם המידע הזה זמין, הוא צריך להיות המדינה שאליה המוצר נשלח, או המקום שבו השירות ניתן. אפשרות אחרת היא לציין את ערך המדינה שבה היה כותב הביקורת בזמן כתיבת הביקורת. קוד המדינה צריך להיות בפורמט ISO 3166-1 alpha-2.

דוגמה: 

  <country_code>
    US
  </country_code>

title xs:string אופציונלי (0-1) הכותרת של הביקורת. שם הפריט צריך להיות טקסט פשוט ללא תגי HTML.

דוגמה: 

  <title>
    Great prices
  </title>

content xs:string חובה (1) התוכן של הביקורת. זה צריך להיות טקסט חופשי שהמשתמש מספק, ולא יכול להיות שהוא ייחתך. התוכן צריך להיות טקסט פשוט ללא תגי HTML. לדוגמה מעבר שורה צריך להיות מיוצג על ידי תו הזנת שורה, ולא על ידי תג <br>. אם מספקים כמה תשובות לשאלות שונות, צריך לכלול את כל התשובות, עם ההקשר המינימלי כדי שהתשובות יהיו מובנות. אם יש שאלות שלא נענו, אל תספקו הקשר.

דוגמה: 

  <content>
    I like this store!
    My order arrived on time and I got
    a great price.
  </content>

דוגמה: 

  <content>
    Positives: Great prices.
    Suggestions: Selection could be better.
  </content>
ratings           -- חובה (1) רכיב מאגר לדירוגים של המוכר שניתנו על ידי המבקר. אם אין דירוג זמין לרכיב <overall>, צריך להחריג מהפיד את הביקורת כולה שמשויכת לרכיב הזה, כי הרכיב <overall> הוא חובה והביקורת לא תתקבל בלעדיו.
collection_method CollectionMethodType חובה (1) השיטה שבה נאספה הביקורת. הערך חייב להיות אחד מהערכים הבאים:
  • לא מוזמנת: המשתמש לא הגיב לבקשה ספציפית כששלח את הביקורת.
  • point_of_sale: המשתמש שלח את הביקורת בתגובה לבקשה שנשלחה אליו כשהוא ביצע הזמנה.
  • after_fulfillment: המשתמש שלח את הביקורת בתגובה לבקשה אחרי שההזמנה שלו סופקה.

דוגמה: 

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

תיאור

הדירוגים של כותב הביקורת לגבי המוכר. אם אין דירוג זמין לרכיב <overall>, צריך להחריג מהפיד את הביקורת כולה שמשויכת לרכיב הזה, כי הרכיב <overall> הוא חובה והביקורת לא תתקבל בלעדיו.

מכיל

צריך לכלול את הרכיבים הבאים ברכיב הדירוגים.

שם פורמט מופעים תיאור
overall RatingRange חובה (1) הדירוג הכולל של המוכר שניתן על ידי כותב הביקורת.

דוגמה: 

  <overall min="1" max="10">9</overall>

customer_service RatingRange אופציונלי (0-1) הדירוג של איכות שירות הלקוחות של המוכר הזה שניתן על ידי המבקר.

דוגמה: 

  <customer_service min="1" max="5">3</customer_service>

<deleted_reviews>

תיאור

מאגר לביקורות שנמחקו.

מכיל

שם פורמט מופעים תיאור
deleted_review       -- חובה (1 עד n) מכיל רכיבים שקשורים לביקורת יחידה שנמחקה.

<deleted_review>

תיאור

ביקורת שנמחקה.

מאפיינים

שם פורמט מופעים תיאור
id Id חובה (1) מציין את המזהה של ביקורת שצריך למחוק מהפיד. המזהה צריך להיות זהה למזהה שמופיע במאפיין id של רכיב <review> בקובץ פיד כלשהו.

מכיל

שם פורמט מופעים תיאור
last_update_timestamp DateTimeWithTimeZone חובה (1) השעה שבה הביקורת הוסרה מהמערכת.

דוגמה: 

  <last_update_timestamp>
    2016-04-03T18:37:32Z
  </last_update_timestamp>

דוגמה

<deleted_review id="10">
  <last_update_timestamp>2014-07-12T07:55:06Z<last_update_timestamp>
</deleted_review>