Method: advertisers.campaigns.list

تعرض هذه الطريقة قائمة بالحملات في حساب أحد المعلِنين.

يتم تحديد الترتيب من خلال المَعلمة orderBy. في حال عدم تحديد filter في entityStatus، لن يتم تضمين الحملات التي تتضمّن ENTITY_STATUS_ARCHIVED في النتائج.

طلب HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

يستخدِم عنوان URL بنية تحويل الترميز gRPC.

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

المعلمات
advertiserId

string (int64 format)

رقم تعريف المعلِن الذي سيتم عرض حملاته.

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

المعلمات
pageSize

integer

حجم الصفحة المطلوب يجب أن تتراوح القيمة بين 1 و200. إذا لم يتم تحديدها، سيتم ضبط القيمة التلقائية على 100.
pageToken

string

رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً، تكون هذه القيمة هي قيمة nextPageToken التي تم عرضها من الطلب السابق إلى طريقة campaigns.list. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.
orderBy

string

الحقل الذي سيتم ترتيب القائمة حسبه القيم المقبولة هي:

  • displayName (تلقائي)
  • entityStatus
  • updateTime

يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد ترتيب تنازلي لحقل معيّن، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: displayName desc
filter

string

تسمح بالتصفية حسب حقول الحملة.

بنية الجملة المتوافقة:

  • تتكوّن عبارات الفلتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عوامل التشغيل المنطقية AND أو OR. يستخدم تسلسل القيود AND ضمنيًا.
  • يكون الحظر على شكل {field} {operator} {value}.
  • يجب أن يستخدم الحقل updateTime عامل التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
  • يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).

الحقول المتاحة:

  • campaignId
  • displayName
  • entityStatus
  • ‫updateTime (الإدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

أمثلة:

  • جميع حملات ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED ضمن حساب أحد المعلِنين: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • جميع الحملات التي يكون وقت تعديلها أقل من أو يساوي ‎2020-11-04T18:54:47Z (تنسيق ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • جميع الحملات التي يكون وقت تعديلها أكبر من أو يساوي ‎2020-11-04T18:54:47Z (تنسيق ISO 8601): updateTime>="2020-11-04T18:54:47Z"

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يُرجى الرجوع إلى دليل طلبات LISTالفلترة للحصول على مزيد من المعلومات.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
الحقول
campaigns[]

object (Campaign)

قائمة الحملات

لن تظهر هذه القائمة إذا كانت فارغة.
nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الطلب اللاحق إلى الطريقة campaigns.list لاسترداد الصفحة التالية من النتائج.

نطاقات التفويض

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.