בחירת שדות להחזרה

כשמבצעים קריאה ל-method ComputeRoutes(), צריך לציין אילו שדות רוצים להחזיר בתגובה. כדי לעשות זאת, משתמשים במסכה של שדה תגובה שמספקים עם הפרמטר $fields או fields של כתובת ה-URL, או באמצעות הכותרת X-Goog-FieldMask של HTTP/gRPC. למידע נוסף קראו את המאמר פרמטרים של מערכת.

אנונימיזציה של שדות

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

topLevelField[.secondLevelField][.thirdLevelField][...]

אנונימיזציה של שדות במקרים מיוחדים היא תו כללי לחיפוש '*', שבוחר את כל השדות ברמה הבסיסית (root).

דוגמאות

הדוגמה הבאה ממחישה איך להגדיר מסכות של שדות ל-method ComputeRoutes().

דוגמה 1

אנונימיזציה של כל השדות הזמינים (לבדיקה ידנית).

X-Goog-FieldMask: *

דוגמה 2

אנונימיזציה של השדות לפי משך המסלול, המרחק והקו פוליגוני (דוגמה להגדרה של סביבת ייצור).

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

לא מומלץ להשתמש במסכה של שדה התגובה עם תווים כלליים לחיפוש (*) או לציין את מסכת השדה ברמה העליונה (מסלולים) בסביבת הייצור. בוחרים רק את השדות הנדרשים:

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

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

  • תגובה קטנה יותר, שמובילה לתפוקת רשת גבוהה יותר.

למידע נוסף על בניית נתיבי שדות, ראו field_mask.proto.