הנחיות בנושא נתוני מפתחים

מידע על הצבעה

הממשק Civic Information API של Google מחזיר למשתמשים מידע ציבורי, כמו מיקום הקלפי, מיקום ההצבעה המוקדמת, פרטים ליצירת קשר עם רשויות הבחירות המקומיות ומידע על פתקי ההצבעה, לגבי בחירות שנתמכות על ידי Voting Information Project.

זמינות הנתונים

הנחיות למפתחים

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

  • פועלים בהתאם לתנאים ולהגבלות של ממשקי ה-API.
  • השימוש ב-API מבטא הסכמה של המפתחים לציית לכל כותרת של בקרת מטמון, אם יש כזו. ללא כותרות של בקרת מטמון, המפתחים מסכימים לא לשמור במטמון מידע על מיקומי הצבעה ומידע על תחרויות למשך יותר מ-24 שעות, ומידע על נבחרי ציבור ועל מחוזות למשך יותר מ-30 ימים.
  • מפתחים שמשתמשים ב-API צריכים לעשות כמיטב יכולתם כדי להבטיח שכל המשתמשים ייהנו מאותה חוויה. אסור להשתמש בהחזקות, בבדיקות A/B או בניסויים דומים.

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

    הערה: תהליך האישור נמשך חודש עד חודשיים.כדאי לתכנן את בקשות הגדלת המכסות בהתאם. כדי להתכונן להגדלת המכסות לקראת הבחירות לנשיאות ב-2024,יש לשלוח בקשות להגדלת המכסות עד אוגוסט.

  • המכסה הנוספת ל-Civic Info API מיועדת רק לתמיכה בתרחישי שימוש שמיועדים למשתמשים. בקשות להגדלת מכסות לא יאושרו בתרחישי שימוש אחרים.

הנחיות נוספות בנושא נתונים

קשה במיוחד לעבוד עם הנתונים האלה. חשוב לזכור את הנקודות הבאות.

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

שיוך (Attribution)

השיוך ל-Civic Information API הוא אופציונלי. אם מפתחים בוחרים לשייך את הנתונים שלהם ל-Civic Information API ולקשר משתמשים למידע נוסף על Civic Information API, אנחנו דורשים מהם להשתמש באחת מהאפשרויות הבאות של שפת שיוך ובדף האינטרנט המקושר שבהמשך:

  • "התכונה הזו מבוססת על Civic Information API"
  • "מידע על הצבעה שמבוסס על Civic Information API"
  • "מידע על פתקי ההצבעה שמבוסס על Civic Information API"
  • 'מידע נוסף'

קודי סטטוס

קריאות ל-voterInfoQuery כוללות את השדה status שמוגדר כ-success כשכתובת מסוימת מאושרת. במקרים אחרים, יוחזר קוד שגיאה. בהמשך מופיעים הסברים נפוצים על קודי שגיאה. שימו לב: יכול להיות שהמידע יוחזר גם אם מופיע קוד שגיאה.

סטטוס הסבר
success ממשק ה-API מזהה את הכתובת המבוקשת ככתובת תקינה.
noStreetSegmentFound נכון לעכשיו, ב-API אין מידע על התחום הגיאוגרפי או על המחוז הבחירות שאליהם שייכת הכתובת הזו. יכול להיות שאנחנו עדיין אוספים או מעבדים נתונים חדשים, או שאין בוחרים שנרשמו להצביע בכתובת הזו.
addressUnparseable הפורמט של הכתובת המבוקשת שגוי או שלא ניתן לבצע לה גיאוקוד (כלומר, ל-Google Maps API אין מידע על הכתובת הזו).
noAddressParameter לא סופקה כתובת.
multipleStreetSegmentsFound ה-API לא יכול למצוא מידע על הכתובת שצוינה, אבל יש לו מידע על כתובות בסביבה. על המשתמש לפנות לגורם האחראי בבחירות לקבלת מידע נוסף.
electionOver הבחירות המבוקשות הסתיימו. תוצאות ה-API של הבחירות כבר לא זמינות. יוצרים electionQuery כדי למצוא מזהה של בחירות קרובות.
electionUnknown מזהה הבחירות המבוקש לא תקין. יוצרים electionQuery כדי למצוא מזהה תקף.
internalLookupFailure אירעה שגיאה לא מזוהה בעיבוד הבקשה.