Method: accounts.adUnits.list

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
parent

string

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

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

פרמטרים
pageSize

integer

המספר המקסימלי של יחידות המודעות שיוחזרו. אם לא מציינים ערך או מציינים 0, יוחזרו לכל היותר 10,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 Overview.

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 – מודעה במסך מלא. סוגי המודעות הנתמכים הם RICH_MEDIA ו-VIDEO. ‫'NATIVE' – פורמט של מודעה מותאמת. ‫'REWARDED' – מודעה שכשמשתמש צופה בה, מתקבלת קריאה חוזרת שמאמתת את הצפייה כדי שאפשר יהיה לתת תגמול למשתמש. סוגי המודעות הנתמכים הם RICH_MEDIA (אינטראקטיביות) ומודעות וידאו שאי אפשר להחריג. ‫'REWARDED_INTERSTITIAL' – פורמט של מודעת מעברון מתגמלת. יש תמיכה רק במודעות וידאו. מידע נוסף זמין בכתובת https://support.google.com/admob/answer/9884467.
adTypes[]

string

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

‫'RICH_MEDIA' – טקסט, תמונה ומדיה אחרת שאינה סרטון. ‫VIDEO – מדיה של סרטונים.