הגדרה של User Messaging Platform SDK

בחירת פלטפורמה: Android iOS Unity Flutter Android (Legacy)

‫Google User Messaging Platform (UMP) SDK הוא כלי לניהול פרטיות והודעות שיעזור לכם לנהל את העדפות הפרטיות של משתמשים באתר. מידע נוסף זמין במאמר מידע על הכלי 'פרטיות והודעות'.

יצירת סוג הודעה

יוצרים הודעות למשתמשים באמצעות אחד מהסוגים הזמינים של הודעות למשתמשים בכרטיסייה פרטיות והודעות בחשבון Ad Manager. ‫UMP SDK מנסה להציג הודעה בנושא פרטיות שנוצרה ממזהה האפליקציה ב-Ad Manager שהוגדר בפרויקט.

פרטים נוספים זמינים במאמר מידע על הכלי 'פרטיות והודעות'.

צריך לבקש עדכון של פרטי ההסכמה של המשתמש בכל הפעלה של האפליקציה באמצעות Update(). הבקשה הזו בודקת את הדברים הבאים:

  • האם נדרשת הסכמה. לדוגמה, נדרשת הסכמה בפעם הראשונה, או שההחלטה הקודמת לגבי הסכמה פגה.
  • האם נדרשת נקודת כניסה לאפשרויות הפרטיות. חלק מההודעות בנושא פרטיות מחייבות את האפליקציות לאפשר למשתמשים לשנות את אפשרויות הפרטיות שלהם בכל שלב.
void Start()
{
    // Create a ConsentRequestParameters object.
    ConsentRequestParameters requestParameters = new ConsentRequestParameters();

    // Request an update of the user's consent information.
    ConsentInformation.Update(requestParameters, OnConsentInfoUpdated);
}

טעינה והצגה של טופס הודעת הפרטיות

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

ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
    if (formError != null)
    {
        // Consent gathering failed.
        Debug.LogError("Error loading/showing consent form: " + formError.Message);
    }

    // ...
});

אפשרויות פרטיות

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

איך בודקים אם נדרשת נקודת כניסה לאפשרויות הפרטיות

אחרי שקוראים ל-Update(), בודקים את PrivacyOptionsRequirementStatus כדי לקבוע אם נדרשת נקודת כניסה לאפשרויות הפרטיות באפליקציה. אם נדרשת נקודת כניסה, מוסיפים לאפליקציה רכיב בממשק המשתמש שגלוי למשתמשים ואפשר לקיים איתו אינטראקציה, ושדרכו אפשר להציג את טופס אפשרויות הפרטיות. אם לא נדרשת נקודת כניסה להגדרות הפרטיות, צריך להגדיר את רכיב ממשק המשתמש כך שלא יהיה גלוי ולא תהיה אפשרות ליצור איתו אינטראקציה.

void UpdatePrivacyButton()
{
    if (_privacyButton != null)
    {
        // Enable the button only if a privacy options entry point is required.
        _privacyButton.interactable =
            ConsentInformation.PrivacyOptionsRequirementStatus == PrivacyOptionsRequirementStatus.Required;
    }
}

רשימה מלאה של סטטוסי הדרישות של אפשרויות הפרטיות זמינה במאמר בנושא ConsentInformation.PrivacyOptionsRequirementStatus.

הצגת טופס אפשרויות הפרטיות

כשהמשתמש מקיים אינטראקציה עם האלמנט, מציגים לו את טופס אפשרויות הפרטיות:

public void ShowPrivacyOptionsForm()
{
    ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
    {
        if (showError != null)
        {
            Debug.LogError("Error showing privacy options form: " + showError.Message);
        }
    });
}

בקשת מודעות עם הסכמה מהמשתמש

לפני ששולחים בקשות להצגת מודעות, צריך להשתמש ב- CanRequestAds() כדי לבדוק אם קיבלתם הסכמה מהמשתמש:

ConsentInformation.CanRequestAds()

אלה המקומות שבהם אפשר לבדוק אם אפשר לבקש הצגת מודעות בזמן איסוף הסכמה:

  • אחרי ש-UMP SDK אוסף הסכמה בסשן הנוכחי.
  • מיד אחרי שמפעילים את Update(). יכול להיות ש-UMP SDK קיבל הסכמה בסשן הקודם באפליקציה.

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

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

כשבודקים את CanRequestAds() אחרי קבלת הסכמה ואחרי הקריאה ל-Update(), חשוב לוודא שהלוגיקה מונעת בקשות מיותרות להצגת מודעות, שעלולות לגרום לכך ששתי הבדיקות יחזירו את הערך true. לדוגמה, עם משתנה בוליאני.

בדיקה

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

  1. התקשרו אל Update().

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

    Android

    Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")
to set this as a debug device.

    iOS

    <UMP SDK>To enable debug mode for this device,
set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]

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

  4. משנים את הקוד כדי לקרוא ל-DebugGeography.TestDeviceHashedIds ולהעביר רשימה של מזהי מכשירי הבדיקה.

    void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        TestDeviceHashedIds =
        new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

הגדרת מיקום גיאוגרפי באופן ידני

‫UMP SDK מספק דרך לבדוק את התנהגות האפליקציה כאילו המכשיר ממוקם באזורים שונים, כמו האזור הכלכלי האירופי (EEA), בריטניה ושווייץ, באמצעות DebugGeography. הערה: הגדרות ניפוי הבאגים פועלות רק במכשירי בדיקה.

void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        // Geography appears as in EEA for debug devices.
        DebugGeography = DebugGeography.EEA,
        TestDeviceHashedIds = new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

כשבודקים את האפליקציה באמצעות UMP SDK, יכול להיות שיהיה שימושי לאפס את מצב ה-SDK כדי לדמות את חוויית ההתקנה הראשונה של המשתמש. ערכת ה-SDK מספקת את ה-method‏ Reset() כדי לבצע את הפעולה הזו.

ConsentInformation.Reset();

דוגמאות ב-GitHub

דוגמה מלאה לשילוב של UMP SDK שמוסבר בדף הזה מופיעה ב-HelloWorld.