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_segment} مثال: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

رقم التعريف الظاهر خارجيًا للوحدة الإعلانية الذي يمكن استخدامه للتكامل مع حزمة تطوير البرامج (SDK) في AdMob. هذه خاصية للقراءة فقط. مثال: ca-app-pub-9876543210987654/0123456789
appId

string

رقم التعريف الظاهر خارجيًا للتطبيق المرتبط به هذه الوحدة الإعلانية. مثال: ca-app-pub-9876543210987654~0123456789
displayName

string

الاسم المعروض للوحدة الإعلانية كما هو موضّح في واجهة مستخدم AdMob، والذي يقدّمه المستخدم. الحد الأقصى للطول المسموح به هو 80 حرفًا.
adFormat

string

شكل الإعلان للوحدة الإعلانية في ما يلي القيم المحتمَلة:

"APP_OPEN" - شكل الإعلان على شاشة فتح التطبيق. "BANNER" - شكل إعلان البانر "BANNER_INTERSTITIAL" - تنسيق قديم يمكن استخدامه كإعلان بانر أو بيني. لم يعُد من الممكن إنشاء هذا الشكل، ولكن يمكن استهدافه من خلال مجموعات التوسّط. "بيني" - إعلان بملء الشاشة. أنواع الإعلانات المتوفرة هي "RICH_MEDIA" و "VIDEO". "NATIVE" - شكل إعلان مدمج مع المحتوى. "مكافأة" - الإعلان الذي يتلقى بعد مشاهدته معاودة الاتصال للتحقق من المشاهدة حتى يمكن منح مكافأة للمستخدم. أنواع الإعلانات المعتمدة هي "RICH_MEDIA" (تفاعلي) وإعلانات الفيديو التي لا يمكن استبعاد الفيديو فيها. "REWARDED_INTERSTITIAL" - شكل الإعلان البيني الذي يضم مكافأة لا تدعم سوى نوع إعلان الفيديو. اطّلع على https://support.google.com/admob/answer/9884467.
adTypes[]

string

نوع وسائط الإعلانات التي تتوافق معها هذه الوحدة الإعلانية القيم المتاحة على النحو التالي:

"RICH_MEDIA" - النصية والصورية والوسائط الأخرى غير الفيديو. "VIDEO" - وسائط الفيديو