נתוני מודעות

public final class AdData
extends Object implements Parcelable

java.lang.Object
↳ android.adservices.common.AdData

מייצג נתונים ספציפיים למודעה, שנדרשים לצורך בחירה והצגה של מודעה.

סיכום

מחלקות מקוננות

class AdData.Builder

Builder ל-AdData אובייקטים. 

קבועים שעברו בירושה

int CONTENTS_FILE_DESCRIPTOR

ביט מתאר שנעשה בו שימוש עם describeContents(): מציין הייצוג הקבוע של האובייקט Parcelable כולל מתאר קובץ.

int PARCELABLE_WRITE_RETURN_VALUE

סימון לשימוש עם writeToParcel(Parcel, int): האובייקט שנכתב הוא ערך מוחזר, כלומר תוצאה של פונקציה כמו "Parcelable someFunction()", "void someFunction(out Parcelable)", או "void someFunction(inout Parcelable)".

שדות

public static final Creator<AdData> CREATOR

שיטות ציבוריות

boolean equals(Object o)

הפונקציה בודקת אם שני אובייקטים מסוג AdData מכילים את אותו מידע.

Set<Integer> getAdCounterKeys()

הפונקציה מקבלת את קבוצת המפתחות שמשמשת לספירת אירועים.

AdFilters getAdFilters()

הפונקציה מקבלת את כל ה-AdFilters שמשויכים למודעה.

String getAdRenderId()

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

String getMetadata()

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

Uri getRenderUri()

הפונקציה מקבלת את ה-URI שמפנה לנכסי העיבוד של המודעה.

int hashCode()

מחזירה את הגיבוב של נתוני האובייקט AdData.

String toString()

מחזירה ייצוג במחרוזת של האובייקט.

void writeToParcel(Parcel dest, int flags)

יש לשטח את האובייקט ל-Parcel

שיטות שעברו בירושה

Object clone()

יצירה ומחזירה של עותק של האובייקט הזה.

boolean equals(Object obj)

מציין אם אובייקט אחר הוא "שווה ל" הזה.

void finalize()

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

final Class<?> getClass()

הפונקציה מחזירה את המחלקה של סביבת זמן הריצה של Object.

int hashCode()

מחזירה ערך גיבוב (hash) של האובייקט.

final void notify()

הוצאת שרשור יחיד שממתין לאובייקט מעקב.

final void notifyAll()

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

String toString()

מחזירה ייצוג במחרוזת של האובייקט.

final void wait(long timeoutMillis, int nanos)

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

final void wait(long timeoutMillis)

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

final void wait()

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

abstract int describeContents()

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

abstract void writeToParcel(Parcel dest, int flags)

יש לשטח את האובייקט ל-Parcel

שדות

CREATOR

נוסף ברמת API 34
זמין גם בתוספים 4 לשירותי מודעות 
public static final Creator<AdData> CREATOR

שיטות ציבוריות

שווה ל-

נוסף ברמת API 34 
public boolean equals (Object o)

הפונקציה בודקת אם שני אובייקטים מסוג AdData מכילים את אותו מידע.

פרמטרים
o Object: אובייקט ההפניה שאליו תשוו.
החזרות
boolean true אם האובייקט הזה זהה ל-obj ארגומנט; אחרת, false.

getAdCounterKeys

public Set<Integer> getAdCounterKeys ()

הפונקציה מקבלת את קבוצת המפתחות שמשמשת לספירת אירועים.

אסור לשייך למודעה יותר מ-10 מפתחות מונה של מודעות.

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

שימו לב שאפשר להחליף את המפתחות האלה יחד עם המודעות ונתוני בידינג אחרים קהל בהתאמה אישית במהלך העדכון היומי של הקהל בהתאמה אישית.

החזרות
Set<Integer> הערך הזה לא יכול להיות null.

getAdFilters

public AdFilters getAdFilters ()

הפונקציה מקבלת את כל ה-AdFilters שמשויכים למודעה.

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

החזרות
AdFilters

getAdRenderId

public String getAdRenderId ()

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

המזהה של עיבוד המודעה נאסף עבור כל AdData כאשר מתקבלת בקשה למכרז של השרת.

כל AdData ללא מזהה עיבוד המודעה לא יהיה כשיר למכרז בצד השרת.

החזרות
String הערך הזה יכול להיות null.

getMetadata

public String getMetadata ()

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

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

אם המטא-נתונים הם לא אובייקט JSON חוקי שאפשר להשתמש בו על ידי ה-JS של הקונה, המודעה לא יוכלו לבחור מודעות.

החזרות
String הערך הזה לא יכול להיות null.

getRenderUri

public Uri getRenderUri ()

הפונקציה מקבלת את ה-URI שמפנה לנכסי העיבוד של המודעה. ה-URI חייב להשתמש ב-HTTPS.

החזרות
Uri הערך הזה לא יכול להיות null.

קוד גיבוב (hashCode)

נוסף ברמת API 34 
public int hashCode ()

מחזירה את הגיבוב של נתוני האובייקט AdData.

החזרות
int ערך קוד גיבוב (hash) של האובייקט הזה.

toString (מחרוזת)

נוסף ברמת API 34 
public String toString ()

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

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

 getClass().getName() + '@' + Integer.toHexString(hashCode())

החזרות
String ייצוג במחרוזת של האובייקט.

WriteToParcel

נוסף ברמת API 34 
public void writeToParcel (Parcel dest, 
                int flags)

יש לשטח את האובייקט ל-Parcel

פרמטרים
dest Parcel: הערך הזה לא יכול להיות null.
flags int: דגלים נוספים לגבי אופן הכתיבה של האובייקט. יכול להיות 0 או Parcelable.PARCELABLE_WRITE_RETURN_VALUE. הערך הוא 0 או שילוב של Parcelable.PARCELABLE_WRITE_RETURN_VALUE, עם android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES