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

string

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

'RICH_MEDIA' - טקסט, תמונה ומדיה אחרת שאינה וידאו. 'VIDEO' - מדיה בווידאו.