Method: accounts.adUnits.list

أدرِج الوحدات الإعلانية ضمن حساب AdMob المحدّد.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC TransEncoding.

معلمات المسار

المعلَمات
parent

string

مطلوب. اسم مورد الحساب لإدراج الوحدات الإعلانية له. مثال: accounts/pub-9876543210987654

معامِلات طلب البحث

المعلَمات
pageSize

integer

الحد الأقصى لعدد الوحدات الإعلانية المطلوب عرضها. وإذا لم يتم تحديدها أو كانت صفرًا، سيتم عرض 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.

الوحدة الإعلانية

تصف هذه الوحدة الإعلانية في AdMob.

تمثيل JSON
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
الحقول
name

string

اسم المورد لهذه الوحدة الإعلانية. الشكل هو الحسابات/{publisherId}/adUnits/{ad_unit_id_fragment} مثال: 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

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

"BANNER" - تنسيق إعلان البانر. "BANNER_INTERSTITIAL" - التنسيق القديم الذي يمكن استخدامه كبانر أو إعلان بيني. لم يعد من الممكن إنشاء هذا الشكل ولكن يمكن استهدافه بواسطة مجموعات التوسط. "INTERSTITIAL" - إعلان بملء الشاشة. أنواع الإعلانات المتوافقة هي &"RICH_MEDIA" &"VIDEO". "NATIVE" - شكل الإعلان المدمج مع المحتوى. "REWARDED&}{;; أنواع الإعلانات المسموح بها هي "RICH_MEDIA" (تفاعلية) وفيديو لا يمكن فيه استبعاد الفيديو.

adTypes[]

string

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

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