Method: accounts.adUnits.list

יש להציג רשימה של יחידות המודעות בחשבון AdMob שצוין.

בקשת HTTP

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של החשבון שעבורו יש לרשום יחידות מודעות. לדוגמה: accounts/pub-9876543210987654

פרמטרים של שאילתה

פרמטרים
pageSize

integer

המספר המקסימלי של יחידות מודעות שיש להחזיר. אם לא צוין 0, או שיוחזרו עד 10,000 יחידות מודעות. הערך המקסימלי הוא 20,000. ערכים מעל 20,000 ישתנו ל-20,000.
pageToken

string

הערך שהוחזר על ידי ListAdUnitsResponse האחרון; מציין כי זהו המשך של קריאה קודמת ל-adUnits.list, ושהמערכת צריכה להחזיר את דף הנתונים הבא.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

תגובה לבקשה של רשימת יחידות המודעות.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
שדות
adUnits[]

object (AdUnit)

יחידות המודעות שהתקבלו בחשבון המבוקש.
nextPageToken

string

אם השדה לא ריק, המשמעות היא שייתכן שיש יותר יחידות מודעות עבור הבקשה. יש להעביר את הערך הזה ב-ListAdUnitsRequest חדש.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/admob.readonly

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

AdUnit

מתאר יחידת מודעות ב-AdMob.

ייצוג JSON 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
שדות
name

string

שם המשאב של יחידת המודעות הזו. הפורמט הוא accounts/{publisherId}/adUnits/{ad_unit_id_fragment} דוגמה: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

המזהה הגלוי החיצוני של יחידת המודעות, שניתן להשתמש בו לשילוב עם AdMob SDK. זהו מאפיין לקריאה בלבד. לדוגמה: ca-app-pub-9876543210987654/0123456789
appId

string

המזהה הגלוי החיצוני של האפליקציה שאליה יחידת המודעות הזו משויכת. לדוגמה: ca-app-pub-9876543210987654~0123456789
displayName

string

השם המוצג של יחידת המודעות, כפי שמוצג בממשק המשתמש של AdMob שהמשתמש מספק. האורך המקסימלי המותר הוא 80 תווים.
adFormat

string

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

"APP_OPEN" - פורמט מודעה בפתיחת אפליקציה. "BANNER" - הפורמט של מודעת באנר. "BANNER_INTERSTITIAL" – פורמט מדור קודם שיכול לשמש כמודעת באנר או כמודעת מעברון. לא ניתן יותר ליצור את הפורמט הזה, אבל קבוצות לבחירת רשת יכולות לטרגט אותו. "INTERSTITIAL" - מודעה במסך מלא. סוגי המודעות הנתמכים הם 'richH_MEDIA' ו-'VIDEO'. "NATIVE" - פורמט מודעה מותאמת. 'מתגמלת' - מודעה לאחר הצפייה, היא מקבלת קריאה חוזרת (callback) המאמתת את התצוגה כדי להעניק תגמול למשתמש. סוגי המודעות הנתמכים הם 'ricH_MEDIA' (אינטראקטיבית) ומודעות וידאו שאי אפשר להחריג מהם סרטונים. "REWARDED_INTERSTITIAL" - פורמט של מודעת מעברון מתגמלת. התכונה תומכת רק במודעות וידאו. פרטים נוספים זמינים בכתובת https://support.google.com/admob/answer/9884467.
adTypes[]

string

סוג המדיה של המודעה שנתמך על ידי יחידת המודעות הזו. ערכים אפשריים:

"ricH_MEDIA" - טקסט, תמונה ומדיה אחרת שאינה וידאו. "VIDEO" – מדיה בווידאו.