Method: accounts.adUnits.list

واحدهای تبلیغاتی را در حساب AdMob مشخص شده فهرست کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. نام منبع حسابی که واحدهای تبلیغاتی برای آن فهرست می‌شوند. مثال: accounts/pub-9876543210987654

پارامترهای پرس و جو

پارامترها
pageSize

integer

حداکثر تعداد واحدهای تبلیغاتی که باید بازگردانده شوند. اگر مشخص نشود یا ۰ باشد، حداکثر ۱۰۰۰۰ واحد تبلیغاتی بازگردانده خواهد شد. حداکثر مقدار ۲۰۰۰۰ است؛ مقادیر بالاتر از ۲۰۰۰۰ به ۲۰۰۰۰ کاهش می‌یابد.

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 .

واحد تبلیغات

یک واحد تبلیغاتی 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 نشان داده شده است، توسط کاربر ارائه می‌شود. حداکثر طول مجاز ۸۰ کاراکتر است.

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

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

«رسانه‌های غنی» - متن، تصویر و سایر رسانه‌های غیر ویدیویی. «ویدئو» - رسانه‌های ویدیویی.