אשף התצוגה המקדימה

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


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

יצירת הקוד של התצוגה המקדימה

דוגמאות לתצוגות מקדימות שנוצרו

הדוגמאות הבאות נוצרו באמצעות אשף התצוגה המקדימה.

התאמה אישית של הקוד

בנוסף לשימוש באשף שלמעלה, ניתן להפעיל ישירות כמה פונקציות "עזרה" פשוטות של JavaScript. לשם כך, עליך לטעון תחילה את ספריית אשף התצוגה המקדימה. דרך אחת לעשות זאת היא להוסיף את התג הבא לקטע <head> בדף:

<script type="text/javascript" src="https://books.google.com/books/previewlib.js"></script>

אחרי שטענתם את ספריית התצוגה המקדימה, תוכלו להפעיל כל אחת מהפונקציות הבאות מתוך התגים <script> ב-<body> של המסמך. לדוגמה, אם רוצים להוסיף את הלחצן "תצוגה מקדימה של Google", צריך להוסיף את הקוד כדי לעשות זאת ברכיב <script> במיקום הרצוי ללחצן בתוך הדף.

GBS_setLanguage

GBS_setLanguage(languageCode)
    שינוי השפה של הלחצנים או הטקסט שנוספו אחרי הקריאה לפונקציה הזו. התוכן הזה כולל את השפה של הלחצן 'תצוגה מקדימה של Google', את שפת הממשק של התצוגה המקדימה המוטמעת וכו'.
    פרמטרים:
      string languageCode – קוד השפה הרצוי לפי RFC 3066 (ברירת המחדל היא 'en' לאנגלית). קודי השפות הנתמכים כרגע כוללים hy, bg, ca, zh-CN, zh-TW, hr, cs, da, nl, en, fil, fi, fr, de, el, hi, hu, is, id, in, it, ja, ko, lv, lt, no, pl, pt-BR, pt-rus, th.

GBS_setViewerOptions

GBS_setViewerOptions(optionObj)
    פרמטרים:
      Object optionsObj - קבוצה של צמדי מפתח-ערך שמועברים אל DefaultViewer API של ה-API להטמעת נתוני צפייה. בדרך כלל משתמשים בשיטה הזו כדי לבצע התאמות אישיות מתקדמות.

GBS_setCobrandName

GBS_setCobrandName(cobrandName)
    הפונקציה הזו מיועדת לשימוש על ידי מוציאים לאור בתוכנית השותפים. היא מגדירה את השימוש באתר חיפוש במיתוג משותף להזנה של קישורים לתצוגה מקדימה ל-Book Search. קריאה לפונקציה הזו לפני הוספת לחצן מבטיחה שהמשתמשים יראו את הלוגו של השותף מעל התצוגה המקדימה של חיפוש הספרים.
    פרמטרים:
      string cobrandName - השם של המותג המשותף שצריך להוסיף לכל כתובת URL של חיפוש בספרים. בדרך כלל זה מה שמופיע אחרי /p/ בכתובות URL קיימות של תצוגה מקדימה של 'חיפוש במיתוג משותף'.

      לדוגמה, אם מגדירים את הערך sup, המשתמש יועבר לקישורים כמו
      https://books.google.com/books/p/sup?id=Q8ysL64pM54C&printsec=frontcover
      במקום לברירת המחדל
      https://books.google.com/books?id=Q8ysL64pM54C&printsec=frontcover

GBS_insertEmbeddedViewer

GBS_insertEmbeddedViewer(identifier, opt_width, opt_height)
    הוספת תצוגה מקדימה של ספר מוטמע בכל מקום שבו מופעלת הפונקציה הזו. אם התצוגה המקדימה לא זמינה, לא מוצג אף צופה.
    פרמטרים:
      Number opt_width – הרוחב הרצוי של הצופה, בפיקסלים.
      Number opt_height – הגובה הרצוי של הצופה, בפיקסלים.

GBS_insertPreviewButtonPopup

GBS_insertPreviewButtonPopup(identifiers)
    אם התצוגה המקדימה של הספר זמינה, הפונקציה הזו כותבת לחצן 'תצוגה מקדימה של Google'. לחיצה על הלחצן הזה פותחת 'חלון תצוגה מקדימה צף' בחלק העליון של הדף. אם אין תצוגה מקדימה זמינה, הלחצן לא יוצג.

    מפתחים מתוחכמים יותר עשויים להתעניין ב-Embedded Viewer API, שהפונקציה הזו משתמשת בו באופן פנימי.

    פרמטרים:
      string, Array identifier – כתובת URL של תצוגה מקדימה או מזהה ספר, כמו מספר ISBN, OCLC או LCCN. למידע נוסף, כדאי לעיין בקטע פורמט הבקשות של קישורים דינמיים. אם אתם יודעים על כמה מזהים חלופיים של הספר, תוכלו להעביר מערך של המזהים האלה והלחצן יופיע אם יש תצוגה מקדימה זמינה לאחד מהם. 
GBS_insertPreviewButtonLink(identifiers, opt_options)
    אם התצוגה המקדימה של הספר זמינה, הפונקציה הזו כותבת לחצן 'תצוגה מקדימה של Google' שפשוט מקשר לדף תצוגה מקדימה של הספר. כברירת מחדל, הקטע הזה מקשר לתצוגה המקדימה ב-Google Books, אבל אפשר גם:
    • מקשרים לכתובת אתר באתר שלך (שצריכה, בתורה, להכיל מציג מוטמע). כדי לעשות זאת, מעבירים אפשרות של alternativeUrl אופציונלית.
    • מקשרים לגרסה במיתוג משותף של דף התצוגה המקדימה של הספר, אם בוצעה קריאה אל GBS_setCobrandName לפני הפונקציה הזו.
    אם אין תצוגה מקדימה זמינה למשתמש, שום לחצן לא יוצג בדף.
    פרמטרים:
      string, Array identifier – כתובת URL של תצוגה מקדימה או מזהה ספר, כמו מספר ISBN, OCLC או LCCN. למידע נוסף, כדאי לעיין בקטע פורמט הבקשות של קישורים דינמיים. אם אתם יודעים על כמה מזהים חלופיים של הספר, תוכלו להעביר מערך של המזהים האלה והלחצן יופיע אם יש תצוגה מקדימה זמינה לאחד מהם.
      Object opt_options – אופציונלי – מפה של ערך-שם שמשמשת להגדרת ההתנהגות של הלחצן. כרגע יש תמיכה באפשרות אחת: alternativeUrl. לדוגמה, כדי שלחצן התצוגה המקדימה של Google יקשר לדף תצוגה מקדימה מותאם אישית באתר, יש להעביר את הארגומנט הבא כארגומנט שני אל GBS_insertPreviewButtonLink:
           { 'alternativeUrl' : 'http://yoursite.com/your-preview-page' }