במסמך הזה מפורט מידע טכני על השימוש ב-Play Install Referrer API. Play Install Referrer API הוא ממשק שירות AIDL שמשמש בעיקר מפתחים שאינם משתמשים ב-Java.
הערה: Play Install Referrer Library היא ספרייה שמכילה את Play Install Referrer API, והיא נועדה לעזור למפתחי Java להשתמש ב-API.
השיטה getInstallReferrer()
השיטה הזו מחזירה את פרטי המקור להפניה של התקנת האפליקציה שתואם לשם החבילה שצוין, שנשלח דרך Bundle (מפתח שממופה בטבלה 1). בתגובה Bundle שנשלחת על ידי Google Play, פרטי ההפניה מאוחסנים בשדות שממופים למפתחות שמפורטים בטבלה 2.
טבלה 1. בקשה לנתוני חבילת getInstallReferrer().
| פרמטר | סוג | תיאור |
|---|---|---|
package_name
|
String
|
שם החבילה של מבצע הקריאה החוזרת, המשמש לצורך הסרת עמימות. |
טבלה 2. נתוני התגובה מבקשת getInstallReferrer().
| מפתח | סוג | תיאור |
|---|---|---|
install_referrer
|
String
|
כתובת ה-URL של מקור ההפניה (referrer) של החבילה שהותקנה. |
referrer_click_timestamp_seconds
|
long
|
חותמת הזמן מצד הלקוח, בשניות, שבה התרחש הקליק של מקור ההפניה. |
install_begin_timestamp_seconds
|
long
|
חותמת הזמן בצד הלקוח, בשניות, שבה התחילה התקנת האפליקציה. |
referrer_click_timestamp_server_seconds
|
long
|
חותמת הזמן בצד השרת, בשניות, שבה התרחש הקליק של מקור ההפניה. |
install_begin_timestamp_server_seconds
|
long
|
חותמת הזמן בצד השרת, בשניות, שבה התחילה התקנת האפליקציה. |
install_version
|
string
|
גרסת האפליקציה בזמן ההתקנה הראשונה שלה. |
google_play_instant
|
boolean
|
מציין אם חוויית השימוש המיידית של האפליקציה הושקתה ב-7 הימים האחרונים. |
זהירות: פרטי המקור להפניה להתקנה יהיו זמינים למשך 90 יום, ולא ישתנו אלא אם האפליקציה תותקן מחדש. כדי להימנע מבקשות מיותרות ל-API באפליקציה, צריך להפעיל את ה-API רק פעם אחת במהלך ההפעלה הראשונה אחרי ההתקנה.