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 باشد، حداکثر 10000 واحد تبلیغاتی برگردانده می شود. حداکثر مقدار 20000 است. مقادیر بالای 20000 به 20000 اجباری می شود.

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

AdFormat واحد تبلیغات. مقادیر ممکن به شرح زیر است:

"APP_OPEN" - قالب تبلیغ باز برنامه. "BANNER" - قالب تبلیغات بنری. "BANNER_INTERSTITIAL" - قالب قدیمی که می تواند به عنوان بنر یا بینابینی استفاده شود. این قالب دیگر نمی تواند ایجاد شود، اما می تواند توسط گروه های میانجی هدف قرار گیرد. "INTERSTITIAL" - یک تبلیغ تمام صفحه. انواع تبلیغات پشتیبانی شده «RICH_MEDIA» و «VIDEO» هستند. "NATIVE" - قالب تبلیغات بومی. "پاداش" - تبلیغی که پس از مشاهده، یک تماس برای تایید نما دریافت می کند تا بتوان به کاربر جایزه داد. انواع تبلیغات پشتیبانی شده «RICH_MEDIA» (تعاملی) و ویدیویی است که نمی‌توان ویدیو را حذف کرد. "REWARDED_INTERSTITIAL" - قالب تبلیغات بین‌المللی با پاداش. فقط از نوع تبلیغ ویدیویی پشتیبانی می کند. به https://support.google.com/admob/answer/9884467 مراجعه کنید.

adTypes[]

string

نوع رسانه تبلیغاتی که توسط این واحد تبلیغاتی پشتیبانی می‌شود. مقادیر ممکن به شرح زیر است:

"RICH_MEDIA" - متن، تصویر و سایر رسانه‌های غیر ویدئویی. "VIDEO" - رسانه تصویری.