Package google.shopping.merchant.reviews.v1beta

אינדקס

MerchantReviewsService

שירות לניהול ביקורות על מוכרים.

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

מחיקת ביקורת על מוכר.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

מקבל ביקורת על מוכר.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

הוספת בדיקה לחשבון Merchant Center. אם הבדיקה כבר קיימת, היא מוחלפת במופע החדש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

הצגת ביקורות על מוכרים.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.

ProductReviewsService

שירות לניהול ביקורות על מוצרים.

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

מחיקת ביקורת על מוצר.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

הפונקציה מקבלת ביקורת על מוצר.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

הוספה של ביקורת על מוצר.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.
ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

רשימת ביקורות על מוצרים.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/content

מידע נוסף זמין בOAuth 2.0 Overview.

DeleteMerchantReviewRequest

הודעת הבקשה של השיטה DeleteMerchantReview.

שדות
name

string

חובה. המזהה של הביקורת על המוכר. פורמט: accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

הודעת הבקשה של השיטה DeleteProductReview.

שדות
name

string

חובה. המזהה של הביקורת על המוצר. פורמט: accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

הודעת הבקשה של השיטה GetMerchantReview.

שדות
name

string

חובה. המזהה של הביקורת על המוכר. פורמט: accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

הודעת הבקשה לשיטה GetProductReview.

שדות
name

string

חובה. המזהה של הביקורת על המוכר. פורמט: accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

הודעת הבקשה של השיטה InsertMerchantReview.

שדות
parent

string

חובה. החשבון שאליו תתווסף הביקורת על המוכר. פורמט: accounts/{account}
merchant_review

MerchantReview

חובה. הביקורת על המוכר שרוצים להוסיף.
data_source

string

חובה. מקור הנתונים של הפורמט merchantreview: accounts/{account}/dataSources/{datasource}.

InsertProductReviewRequest

הודעת הבקשה של השיטה InsertProductReview.

שדות
parent

string

חובה. החשבון שאליו תתווסף הביקורת על המוצר. פורמט: accounts/{account}
product_review

ProductReview

חובה. הביקורת על המוצר שרוצים להוסיף.
data_source

string

חובה. פורמט: accounts/{account}/dataSources/{datasource}

ListMerchantReviewsRequest

הודעת הבקשה של השיטה ListMerchantsReview.

שדות
parent

string

חובה. החשבון שבו רוצים להציג ביקורות על מוכרים. פורמט: accounts/{account}
page_size

int32

אופציונלי. המספר המקסימלי של ביקורות על מוכרים שיוחזר. השירות יכול להחזיר פחות מהערך הזה. הערך המקסימלי הוא 1,000. ערכים מעל 1,000 מוגדרים כ-1,000. אם לא מצוין, יוצג המספר המקסימלי של הביקורות.
page_token

string

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

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListMerchantReviews חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListMerchantReviewsResponse

הודעת התגובה של השיטה ListMerchantsReview.

שדות
merchant_reviews[]

MerchantReview

הביקורת על המוֹכר.
next_page_token

string

האסימון לאחזור של דף התוצאות הבא.

ListProductReviewsRequest

הודעת הבקשה של שיטת ListProductReviews.

שדות
parent

string

חובה. החשבון שבו רוצים להציג את הביקורות על המוצרים. פורמט: accounts/{account}
page_size

int32

אופציונלי. המספר המקסימלי של מוצרים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה.
page_token

string

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

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListProductReviews חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListProductReviewsResponse

הודעת התגובה של השיטה ListProductReviews.

שדות
product_reviews[]

ProductReview

הביקורת על המוצר.
next_page_token

string

אסימון שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

MerchantReview

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

שדות
name

string

מזהה. השם של הביקורת על המוכר. פורמט: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"
merchant_review_id

string

חובה. המשתמש סיפק את מזהה הביקורת של המוכר כדי לזהות באופן ייחודי את הביקורת של המוכר.
attributes

MerchantReviewAttributes

אופציונלי. רשימה של מאפיינים של ביקורות על מוכרים.
custom_attributes[]

CustomAttribute

חובה. רשימה של מאפיינים מותאמים אישית (שסופקו על ידי המוכר). אפשר להשתמש בו גם כדי לשלוח כל מאפיין של מפרט הנתונים בצורתו הגנרית (לדוגמה, { "name": "size type", "value": "regular" }). האפשרות הזו שימושית לשליחת מאפיינים שלא נחשפו במפורש על ידי ה-API, כמו מאפיינים ניסיוניים. מספר התווים המקסימלי לכל מאפיין מותאם אישית הוא 10,240 (הוא מייצג את הסכום של התווים בשם ובערך). אפשר להגדיר עד 2,500 מאפיינים מותאמים אישית לכל מוצר, בגודל כולל של 102.4KB. קווים תחתונים בשמות של מאפיינים מותאמים אישית מוחלפים ברווחים בזמן ההוספה.
data_source

string

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

MerchantReviewStatus

פלט בלבד. הסטטוס של בדיקת המוכר, בעיות באימות הנתונים, כלומר מידע על בדיקת המוכר שמחושב באופן אסינכרוני.

MerchantReviewAttributes

מאפיינים.

שדות
merchant_id

string

חובה. המזהה חייב להיות ייחודי וקבוע בכל הבקשות. במילים אחרות, אם בקשה שהוגשה היום ובקשה אחרת שהוגשה לפני 90 יום מתייחסות לאותו מוכר, הן צריכות להיות בעלות אותו מזהה.
merchant_display_name

string

אופציונלי. השם המוצג של המוכר, שקריא לבני אדם.
min_rating

int64

אופציונלי. המספר המינימלי האפשרי לדירוג. זה צריך להיות הדירוג הנמוך ביותר האפשרי, ולא ערך של 'ללא דירוג'.
max_rating

int64

אופציונלי. המספר המקסימלי האפשרי לדירוג. הערך של הדירוג המקסימלי חייב להיות גדול מהערך של הדירוג המינימלי.
rating

double

אופציונלי. הדירוג הכולל של המוכר על ידי הבודק.
title

string

אופציונלי. כותרת הביקורת.
content

string

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

string

אופציונלי. מזהה ייחודי וקבוע של מחבר הביקורת במערכת של בעל התוכן הדיגיטלי.
reviewer_username

string

אופציונלי. השם המוצג של כותב הביקורת.
is_anonymous

bool

אופציונלי. מגדירים את הערך כ-true אם כותב הביקורת צריך להישאר בעילום שם.
collection_method

CollectionMethod

אופציונלי. השיטה שבה השתמשו כדי לאסוף את הביקורת.
review_time

Timestamp

חובה. חותמת הזמן שמציינת מתי הביקורת נכתבה.
review_language

string

חובה. השפה של הביקורת, לפי קוד השפה BCP-47.
review_country

string

אופציונלי. המדינה שבה מבצע הבדיקה ביצע את ההזמנה, לפי קוד המדינה לפי תקן ISO 3166-1 Alpha-2.

CollectionMethod

השיטה שבה השתמשו כדי לאסוף את הביקורת.

טיפוסים בני מנייה (enum)
COLLECTION_METHOD_UNSPECIFIED שיטת האיסוף לא צוינה.
MERCHANT_UNSOLICITED המשתמש לא השיב לבקשת תגובה ספציפית כששלח את הביקורת.
POINT_OF_SALE המשתמש שלח את הביקורת בתגובה לבקשת משוב כשביצע הזמנה.
AFTER_FULFILLMENT המשתמש שלח את הביקורת בתגובה לבקשת תגובה לאחר שההזמנה שלו בוצעה.

MerchantReviewStatus

הסטטוס של בדיקת המוכר, בעיות באימות הנתונים, כלומר מידע על בדיקת המוכר שמחושב באופן אסינכרוני.

שדות
destination_statuses[]

MerchantReviewDestinationStatus

פלט בלבד. היעדים המיועדים לבדיקת המוכר.
item_level_issues[]

MerchantReviewItemLevelIssue

פלט בלבד. רשימה של כל הבעיות שמשויכות לבדיקה של המוכר.
create_time

Timestamp

פלט בלבד. התאריך שבו הפריט נוצר, בפורמט ISO 8601.
last_update_time

Timestamp

פלט בלבד. התאריך שבו הפריט עודכן לאחרונה, בפורמט ISO 8601.

MerchantReviewDestinationStatus

סטטוס היעד של סטטוס הבדיקה של המוכר.

שדות
reporting_context

ReportingContextEnum

פלט בלבד. השם של ההקשר של הדיווח.

MerchantReviewItemLevelIssue

הסטטוס של בדיקת המוכר ב-ItemLevelIssue.

שדות
code

string

פלט בלבד. קוד השגיאה של הבעיה.
severity

Severity

פלט בלבד. איך הבעיה הזו משפיעה על הצגת הביקורת על המוכר.
resolution

string

פלט בלבד. אם המוכר יכול לפתור את הבעיה.
attribute

string

פלט בלבד. שם המאפיין, אם הבעיה נגרמת על ידי מאפיין יחיד.
reporting_context

ReportingContextEnum

פלט בלבד. ההקשר של הדיווח שאליו הבעיה רלוונטית.
description

string

פלט בלבד. תיאור קצר של הבעיה באנגלית.
detail

string

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

string

פלט בלבד. כתובת ה-URL של דף אינטרנט שיעזור לנו לפתור את הבעיה.

מידת החומרה

איך הבעיה משפיעה על הצגת הביקורת על המוכר.

טיפוסים בני מנייה (enum)
SEVERITY_UNSPECIFIED לא צוין.
NOT_IMPACTED הבעיה הזו מייצגת אזהרה ואין לה השפעה ישירה על בדיקת המוכר.
DISAPPROVED הבעיה גורמת לדחיית הביקורת על המוכר.

ProductReview

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

שדות
name

string

מזהה. השם של הביקורת על המוצר. פורמט: "{productreview.name=accounts/{account}/productReviews/{productReview}}"
product_review_id

string

חובה. המזהה הקבוע והייחודי של הביקורת על המוצר במערכת של בעל התוכן הדיגיטלי.
attributes

ProductReviewAttributes

אופציונלי. רשימה של מאפיינים של ביקורות על מוצרים.
custom_attributes[]

CustomAttribute

אופציונלי. רשימה של מאפיינים מותאמים אישית (שסופקו על ידי המוכר).
data_source

string

פלט בלבד. מקור הנתונים הראשי של הביקורת על המוצר.
product_review_status

ProductReviewStatus

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

ProductReviewAttributes

מאפיינים.

שדות
review_time

Timestamp

חובה. חותמת הזמן שמציינת מתי הביקורת נכתבה.
pros[]

string

אופציונלי. מכיל את היתרונות על סמך דעת הבודק. מומלץ להשמיט טקסט סטנדרטי כמו 'יתרון:', אלא אם הוא נכתב על ידי מבקר/ת.
cons[]

string

אופציונלי. כאן מפורטים החסרונות לפי דעת כותב הביקורת. מומלץ להשמיט טקסט סטנדרטי כמו 'con:‎', אלא אם הוא נכתב על ידי הבודק.
product_names[]

string

אופציונלי. שם תיאורי של מוצר.
asins[]

string

אופציונלי. מכיל מספרי ASIN (מספרים סטנדרטיים מזהים של Amazon) שמשויכים למוצר.
gtins[]

string

אופציונלי. מכיל מספרי GTIN (מספרים של פריטים מסחריים גלובליים) שמשויכים למוצר. יש תמיכה בסוגי משנה של GTIN (למשל UPC, ‏ EAN, ‏ ISBN, ‏ JAN).
mpns[]

string

אופציונלי. מכיל קודי MPN (מספרי חלק של יצרן) שמשויכים למוצר.
skus[]

string

אופציונלי. מכיל מק"טים (מספרים קטלוגיים) שמשויכים למוצר. לרוב, המזהה הזה תואם למזהה המבצע של המוצר בפיד המוצרים.
brands[]

string

אופציונלי. מכיל שמות של מותגים שמשויכים למוצר.
collection_method

CollectionMethod

אופציונלי. השיטה שבה השתמשו כדי לאסוף את הביקורת.
transaction_id

string

אופציונלי. מזהה ייחודי וקבוע של העסקה שמשויכת לביקורת במערכת של בעל התוכן הדיגיטלי. אפשר להשתמש במזהה הזה כדי לציין שכמה ביקורות משויכות לאותה עסקה.
aggregator_name

string

אופציונלי. השם של הכלי לאיסוף הביקורות על המוצרים.

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

string

אופציונלי. השם של לקוח המשנה של הביקורות על המוצרים.

לקוח המשנה הוא מזהה של מקור הביקורות על המוצר. הוא צריך להיות זהה לספרייה שצוינה בנתיב של מקור הנתונים בקובץ.
publisher_name

string

אופציונלי. השם של המוציא לאור של הביקורות על המוצרים.

המידע על בעל התוכן הדיגיטלי, שיכול להיות קמעונאי, יצרן, חברת שירותי ביקורות או כל ישות שמפרסמת ביקורות על מוצרים.
publisher_favicon

string

אופציונלי. קישור לסמליל החברה של בעל התוכן הדיגיטלי. מידות התמונה צריכות להיות בגודל של סמל favicon: 16x16 פיקסלים. פורמט התמונה צריך להיות GIF, ‏ JPG או PNG.
reviewer_id

string

אופציונלי. המחבר של הביקורת על המוצר.

מזהה ייחודי וקבוע של מחבר הביקורת במערכת של בעל התוכן הדיגיטלי.
reviewer_is_anonymous

bool

אופציונלי. מגדירים את הערך כ-true אם כותב הביקורת צריך להישאר בעילום שם.
reviewer_username

string

אופציונלי. השם של כותב הביקורת על המוצר.
review_language

string

אופציונלי. השפה של הביקורת, מוגדרת לפי קוד השפה BCP-47.
review_country

string

אופציונלי. המדינה של הבדיקה, לפי קוד המדינה בפורמט ISO 3166-1 Alpha-2.
title

string

אופציונלי. כותרת הביקורת.
content

string

חובה. התוכן של הביקורת.
min_rating

int64

אופציונלי. מכיל את הדירוגים המשויכים לביקורת. המספר המינימלי האפשרי לדירוג. זה צריך להיות הדירוג הנמוך ביותר האפשרי, ולא ערך של 'ללא דירוג'.
max_rating

int64

אופציונלי. המספר המקסימלי האפשרי לדירוג. הערך של הדירוג המקסימלי חייב להיות גדול מהערך של המאפיין המינימלי.
rating

double

אופציונלי. הדירוג הכולל של המוצר על ידי מבקר/ת.
is_spam

bool

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

CollectionMethod

השיטה שבה השתמשו כדי לאסוף את הביקורת.

טיפוסים בני מנייה (enum)
COLLECTION_METHOD_UNSPECIFIED שיטת האיסוף לא צוינה.
UNSOLICITED המשתמש לא השיב לבקשת תגובה ספציפית כששלח את הביקורת.
POST_FULFILLMENT המשתמש שלח את הביקורת בתגובה לבקשת תגובה לאחר שההזמנה שלו בוצעה.

סוג

הסוג של ה-URI של הבדיקה.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין.
SINGLETON דף הביקורות מכיל רק את הביקורת הזו.
GROUP דף הביקורות מכיל קבוצה של ביקורות, כולל הביקורת הזו.

ProductReviewStatus

סטטוס בדיקת המוצר.

שדות
destination_statuses[]

ProductReviewDestinationStatus

פלט בלבד. היעדים המיועדים של הביקורת על המוצר.
item_level_issues[]

ProductReviewItemLevelIssue

פלט בלבד. רשימה של כל הבעיות שמשויכות לבדיקה של המוצר.
create_time

Timestamp

פלט בלבד. התאריך שבו הפריט נוצר, בפורמט ISO 8601.
last_update_time

Timestamp

פלט בלבד. התאריך שבו הפריט עודכן לאחרונה, בפורמט ISO 8601.

ProductReviewDestinationStatus

סטטוס היעד של סטטוס בדיקת המוצר.

שדות
reporting_context

ReportingContextEnum

פלט בלבד. השם של ההקשר של הדיווח.

ProductReviewItemLevelIssue

הבעיה ברמת הפריט בסטטוס הבדיקה של המוצר.

שדות
code

string

פלט בלבד. קוד השגיאה של הבעיה.
severity

Severity

פלט בלבד. איך הבעיה הזו משפיעה על הצגת הביקורת על המוצר.
resolution

string

פלט בלבד. אם המוכר יכול לפתור את הבעיה.
attribute

string

פלט בלבד. שם המאפיין, אם הבעיה נגרמת על ידי מאפיין יחיד.
reporting_context

ReportingContextEnum

פלט בלבד. ההקשר של הדיווח שאליו הבעיה רלוונטית.
description

string

פלט בלבד. תיאור קצר של הבעיה באנגלית.
detail

string

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

string

פלט בלבד. כתובת ה-URL של דף אינטרנט שיעזור לנו לפתור את הבעיה.

מידת החומרה

איך הבעיה משפיעה על הצגת הביקורת על המוצר.

טיפוסים בני מנייה (enum)
SEVERITY_UNSPECIFIED לא צוין.
NOT_IMPACTED הבעיה הזו מייצגת אזהרה ואין לה השפעה ישירה על הביקורת על המוצר.
DISAPPROVED הבעיה גורמת לפסילה של בדיקת המוצר.