Package google.mybusiness.placeactions.v1

אינדקס

• PlaceActions (ממשק)
• CreatePlaceActionLinkRequest (מֶסֶר)
• DeletePlaceActionLinkRequest (מֶסֶר)
• ErrorCode (טיפוסים בני מנייה)
• GetPlaceActionLinkRequest (מֶסֶר)
• ListPlaceActionLinksRequest (מֶסֶר)
• ListPlaceActionLinksResponse (מֶסֶר)
• ListPlaceActionTypeMetadataRequest (מֶסֶר)
• ListPlaceActionTypeMetadataResponse (מֶסֶר)
• PlaceActionLink (מֶסֶר)
• PlaceActionLink.ProviderType (טיפוסים בני מנייה)
• PlaceActionType (טיפוסים בני מנייה)
• PlaceActionTypeMetadata (מֶסֶר)
• UpdatePlaceActionLinkRequest (מֶסֶר)

PlaceActions

ה-API הזה מאפשר לנהל קישורי PlaceAction של מיקומי העסק.

CreatePlaceActionLink
rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) יוצרת קישור לפעולת מקום שמשויך למיקום שצוין ומחזירה אותו. הבקשה נחשבת כעותק משוכפל אם parent, place_action_link.uri ו-place_action_link.place_action_type זהים לבקשה קודמת. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) מחיקת קישור לפעולת מקום מהמיקום שצוין. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) הפונקציה מקבלת את הקישור שצוין לפעולת המקום. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) בתיבת הדו-שיח הזו מוצגים הקישורים לפעולות לגבי המקום במיקום שצוין. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) מחזירה רשימה של הסוגים הזמינים של פעולות לגבי מקום עבור מיקום או מדינה. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) עדכון הקישור שצוין לגבי הפעולה לגבי המקום ומחזיר אותו. היקפי הרשאות נדרש היקף OAuth הבא: https://www.googleapis.com/auth/business.manage למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

CreatePlaceActionLinkRequest

הודעת בקשה ל-PlaceActions.CreatePlaceActionLink.

שדות
parent	string חובה. שם המשאב של המיקום שבו יוצרים את הקישור של הפעולה לגבי המקום. locations/{location_id}.
place_action_link	PlaceActionLink חובה. הקישור לפעולה לגבי המקום שיש ליצור.

DeletePlaceActionLinkRequest

בקשה להודעה עבור PlaceActions.DeletePlaceActionLink.

שדות
name	string חובה. שם המשאב של הקישור לפעולה לגבי המקום שיש להסיר מהמיקום.

ErrorCode

קודי שגיאה לכשלים פנימיים.

טיפוסים בני מנייה (enums)
ERROR_CODE_UNSPECIFIED	קוד שגיאה לא מזוהה.
UNVERIFIED_LOCATION	המיקום לא מאומת.
INVALID_LOCATION_CATEGORY	קטגוריית המיקום לא מתאימה לסוג הפעולה לגבי המקום. הסוג של פעולת המקום שגורם לשגיאה יוחזר במטא-נתונים, כשהמפתח יהיה המחרוזת 'place_action_type' והערך PlaceActionType הוא מחרוזת של ערך 'טיפוסים בני מנייה (enum)'.
INVALID_URL	תבנית שגויה/לא חוקית. כתובת ה-URL של פעולת המקום שאינה חוקית תוחזר במטא-נתונים, כאשר המחרוזת "url" היא המפתח וכתובת ה-URL היא הערך.
URL_PROVIDER_NOT_ALLOWED	כתובת ה-URL כוללת ספק שאינו מורשה. כתובת ה-URL של הפעולה האסורה תוחזר במטא-נתונים, כאשר המחרוזת 'url' היא המפתח וכתובת ה-URL היא הערך.
TOO_MANY_VALUES	הוגדרו יותר מדי ערכים לסוג פעולת המקום. הסוג שעבורו הגעת למגבלה יוחזר במטא-נתונים, עם המחרוזת "place_action_type" כמפתח ומחרוזת הערך PlaceActionType של טיפוסים בני מנייה (enum) כערך.
DELETED_LINK	הקישור המבוקש של הפעולה לגבי המקום נמחק. כתובת ה-URL המתאימה תוחזר במטא-נתונים, כשהמחרוזת 'url' היא המפתח וכתובת ה-URL היא הערך.
LINK_ALREADY_EXISTS	אנחנו מבקשים לעדכן אותך שצריך להמיר קישור של פעולה לגבי מקום לקישור שכבר קיים, עם אותו URI ואותו סוג במיקום שצוין.
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	כבר נעשה שימוש בדומיין שהקישור מכיל, וקיימת מגבלה של קישור אחד לכל דומיין על כל PlaceActionType.
LINK_DOES_NOT_EXIST	צוין קישור שלא נמצא במסד הנתונים.

GetPlaceActionLinkRequest

בקשה להודעה עבור PlaceActions.GetPlaceActionLink.

שדות
name	string חובה. השם של הקישור לפעולת המקום שיש לאחזר.

ListPlaceActionLinksRequest

בקשה להודעה עבור PlaceActions.ListPlaceActionLinks. הפעולה הזו תציג קישורים לפעולות לגבי המקום, ללא סדר ספציפי. יכול להיות שהפעולה הזו לא תחזיר קישורים שנוצרו לאחרונה (ב-24 השעות האחרונות) בפלטפורמות אחרות, למשל האתר 'Google לעסק שלי'. כל קישור שנוצר לפני יותר מ-24 שעות יופיע באמצעות ה-API הזה.

שדות
parent	string חובה. שם המיקום שהקישורים לפעולות לגבי המקום שלו יופיעו. locations/{location_id}.
filter	string אפשרות. מסנן שמגביל את החזרה של קישורים לפעולה לגבי המקום. התשובה כוללת ערכים שתואמים למסנן. אנחנו תומכים במסנן הבא בלבד: 1. Place_action_type=XYZ כאשר XYZ הוא PlaceActionType חוקי.
page_size	int32 אפשרות. כמה קישורים לפעולות לגבי המקום צריך להחזיר בכל דף. ברירת המחדל היא 10. ערך המינימום הוא 1.
page_token	string אפשרות. אם צוין, הפונקציה מחזירה את הדף הבא של קישורים לפעולות לגבי המקום.

ListPlaceActionLinksResponse

הודעת תגובה ל-PlaceActions.ListPlaceActionLinks.

שדות
place_action_links[]	PlaceActionLink רשימה שהוחזרה של קישורים לפעולות לגבי המקום.
next_page_token	string אם יש יותר קישורים לפעולות לגבי המקום מאשר גודל הדף המבוקש, השדה הזה יאוכלס באסימון לאחזור דף התוצאות הבא.

ListPlaceActionTypeMetadataRequest

הודעת בקשה עבור PlaceActions.ListPlaceActionTypeMetadata. התוצאות יוחזרו לפי סדר מסוים.

שדות
language_code	string אפשרות. קוד השפה IETF BCP-47 שבו יש להזין את השמות לתצוגה. אם השפה הזו לא זמינה, המידע יסופק באנגלית.
page_size	int32 אפשרות. כמה סוגי פעולות יש לכלול בכל דף. ברירת המחדל היא 10, המינימום הוא 1.
page_token	string אפשרות. אם צוין, הדף הבא של המטא-נתונים של סוג הפעולה לגבי המקום יאוחזר. הערך pageToken מוחזר כאשר קריאה ל-placeActionTypeMetadata.list מחזירה יותר תוצאות ממה שיכול להתאים לגודל הדף המבוקש.
filter	string אפשרות. מסנן שמגביל את סוגי הפעולות לגבי מקומות שיש להחזיר מטא-נתונים עבורם. התשובה כוללת ערכים שתואמים למסנן. אנחנו תומכים במסננים הבאים בלבד: 1. location=XYZ כאשר XYZ הוא מחרוזת שמציינת את שם המשאב של מיקום, בפורמט locations/{location_id}. 2. region_code=XYZ, כאשר XYZ הוא קוד אזור בפורמט Unicode CLDR, שמאפשר לחפש את סוגי הפעולות הזמינים. אם לא תספקו מסנן, כל סוגי הפעולות לגבי מקומות יוחזרו.

ListPlaceActionTypeMetadataResponse

הודעת תגובה ל-PlaceActions.ListPlaceActionTypeMetadata.

שדות
place_action_type_metadata[]	PlaceActionTypeMetadata אוסף של מטא-נתונים לסוגים הזמינים של פעולות לגבי מקומות.
next_page_token	string אם מספר סוגי הפעולות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון לאחזור הדף הבא בקריאה הבאה אל placeActionTypeMetadata.list. אם אין תוצאות נוספות, השדה הזה לא יופיע בתשובה.

PlaceActionLink

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

שדות
name	string אפשרות. שם המשאב, בפורמט locations/{location_id}/placeActionLinks/{place_action_link_id}. שדה השם ייכלל רק בבקשות UpdatePlaceActionLink ו-DeletePlaceActionLink לעדכון ולמחיקה של קישורים, בהתאמה. עם זאת, המערכת תתעלם ממנה בבקשת CreatePlaceActionLink, שבה השרת יקצה את place_action_link_id אחרי יצירת קישור חדש, ויוחזר כחלק מהתגובה.
provider_type	ProviderType פלט בלבד. מציין את סוג הספק.
is_editable	bool פלט בלבד. מציין אם הלקוח יכול לערוך את הקישור.
uri	string חובה. ה-URI של הקישור. אפשר להשתמש באותו URI לסוגים שונים של פעולות במיקומים שונים. עם זאת, אפשר להשתמש רק בקישור אחד לפעולת מקום לכל שילוב ייחודי של (URI, סוג פעולה של מקום, מיקום).
place_action_type	PlaceActionType חובה. הסוג של פעולת המקום שאפשר לבצע באמצעות הקישור הזה.
is_preferred	bool אפשרות. האם הקישור הזה מועדף על ידי המוכר. אפשר לסמן קישור אחד בלבד כמועדף לכל סוג פעולה לגבי מקום במיקום מסוים. אם בקשה עתידית מסמנת קישור אחר כמועדף לאותו סוג פעולה לגבי מקום, הקישור המועדף הנוכחי (אם קיים) יאבד את ההעדפה שלו.
create_time	Timestamp פלט בלבד. השעה שבה נוצר הקישור לפעולה לגבי המקום.
update_time	Timestamp פלט בלבד. שעת השינוי האחרון של הקישור לפעולת המקום.

ProviderType

הסוג של ספק הקישור – ניתן לקריאה בלבד.

טיפוסים בני מנייה (enums)
PROVIDER_TYPE_UNSPECIFIED	לא צוין.
MERCHANT	ספק מאינטראקציה ישירה, כמו מוכר או סוכנות בשם מוכר.
AGGREGATOR_3P	אתר אגרגטור של צד שלישי, כמו שותף Reserve with Google.

PlaceActionType

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

טיפוסים בני מנייה (enums)
PLACE_ACTION_TYPE_UNSPECIFIED	לא צוין.
APPOINTMENT	סוג הפעולה הוא קביעת פגישה.
ONLINE_APPOINTMENT	סוג הפעולה הוא קביעת פגישה אונליין.
DINING_RESERVATION	סוג הפעולה הוא הזמנת מקום במסעדה.
FOOD_ORDERING	סוג הפעולה הוא הזמנת אוכל במשלוח ו/או טייק אוויי.
FOOD_DELIVERY	סוג הפעולה הוא הזמנת אוכל למשלוח.
FOOD_TAKEOUT	סוג הפעולה הוא הזמנת אוכל לאיסוף עצמי.
SHOP_ONLINE	סוג הפעולה הוא 'שופינג', שיכול להיות משלוח ו/או איסוף.

PlaceActionTypeMetadata

מטא-נתונים לסוגים נתמכים של פעולות על מקום.

שדות
place_action_type	PlaceActionType סוג הפעולה לגבי המקום.
display_name	string שם התצוגה המותאם לשוק המקומי של המאפיין, אם הוא זמין. אחרת, השם המוצג באנגלית.

UpdatePlaceActionLinkRequest

בקשה להודעה ל-PlaceActions.UpdatePlaceActionLink.

שדות
place_action_link	PlaceActionLink חובה. הקישור המעודכן של הפעולה לגבי המקום.
update_mask	FieldMask חובה. השדות הספציפיים לעדכון. השדות היחידים שניתן לערוך הם uri, place_action_type ו-is_preferred. אם הקישור המעודכן כבר קיים באותו מיקום עם אותם place_action_type ו-uri, תיכשל השגיאה ALREADY_EXISTS.