REST Resource: adUnits

المرجع: الوحدة الإعلانية

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

تمثيل JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": [
    enum (AdUnitAttribute)
  ],
  "creatives": [
    {
      object (CreativeSpecification)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (AdUnitState),
  "rejectedReason": string,
  "location": {
    object (LatLng)
  },
  "directionSet": boolean,
  "direction": integer,
  "elevationMetersSet": boolean,
  "elevationMeters": number,
  "physicalWidthMetersSet": boolean,
  "physicalWidthMeters": number,
  "physicalHeightMetersSet": boolean,
  "physicalHeightMeters": number,
  "venue": enum (OutOfHomeVenue),
  "fixedLocation": boolean,
  "indoors": boolean,
  "impressionDataRanges": [
    {
      object (ImpressionDataRange)
    }
  ],
  "photoUrls": [
    string
  ],
  "products": [
    string
  ]
}
الحقول
name

string

اسم المورد للوحدة الإعلانية بالتنسيق: adUnits/{id}. على سبيل المثال: adUnits/adUnit123.
externalId

string

اختياريّ. من المفترض أن يكون المعرّف الذي يديره البائع في نظامه الخاص. من غير المرجّح أن تتغيّر حالته. ويجب عدم استخدامه داخليًا ولا يتم فرض القيود.
displayName

string

مطلوب. الاسم المعروض للوحدة الإعلانية.

يجب أن يكون بترميز UTF-8 بحيث لا يزيد حجمه عن 240 بايت.
description

string

اختياريّ. حقل إضافي حر لوصف الوحدة الإعلانية
labels

map (key: string, value: string)

اختياريّ. مجموعة التصنيفات الحرة لوصف هذه الوحدة الإعلانية.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
attributes[]

enum (AdUnitAttribute)

اختياريّ. سمات لتعريف هذه الوحدة الإعلانية بشكل أفضل.
creatives[]

object (CreativeSpecification)

اختياريّ. قائمة بتصاميم الإعلانات المسموح بها التي يمكن عرضها لهذه الوحدة الإعلانية. يمكن تحديد ذلك أيضًا على مستوى المنتج.
createTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لإنشاء الوحدة الإعلانية

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

النتائج فقط. آخر تحديث للطابع الزمني للوحدة الإعلانية.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

النتائج فقط. حالة الوحدة الإعلانية. في حال AD_UNIT_state_REJECTED، سيتم عرض السبب مرفوضًا.
rejectedReason

string

النتائج فقط. إذا كانت حالة الموافقة: AD_UNIT_APPROVAL_STATUS_REJECTED في هذا الحقل، سيحتوي هذا الحقل على السبب.
location

object (LatLng)

مطلوب. غير قابل للتغيير. خط العرض وخط الطول للوحدة الإعلانية بتنسيق درجات موقّعة.
directionSet

boolean

مطلوب. True إذا تم تعيين الاتجاه.
direction

integer

اختياريّ. غير قابل للتغيير. الاتجاه الأساسي بالدرجات مع اتجاه الشمال يساوي 0. [ 360-0).
elevationMetersSet

boolean

مطلوب. True إذا تم تعيين elbationMeters.
elevationMeters

number

اختياريّ. غير قابل للتغيير. المسافة من أسفل الوحدة الإعلانية إلى الأرض بالأمتار.
physicalWidthMetersSet

boolean

مطلوب. True إذا تم تعيينفعلwidthMeters.
physicalWidthMeters

number

اختياريّ. غير قابل للتغيير. العرض الفعلي للوحدة الإعلانية بالمتر.
physicalHeightMetersSet

boolean

مطلوب. True إذا تم تعيينphyHeightMeters.
physicalHeightMeters

number

اختياريّ. غير قابل للتغيير. تمثّل هذه السمة الارتفاع الفعلي للوحدة الإعلانية بالمتر.
venue

enum (OutOfHomeVenue)

اختياريّ. نوع المكان "خارج المنزل" استنادًا إلى معايير DPAA. هذا حقل معلوماتي يمكن عرضه للمعلنين، ويمكن استخدامه أيضًا لفلترة الوحدات الإعلانية.
fixedLocation

boolean

اختياريّ. ما إذا كان الإعلان في موقع جغرافي ثابت (لوحة الإعلانات) أو متحرّك (سيارة أجرة).
indoors

boolean

مطلوب. ما إذا كانت الوحدة الإعلانية داخلية
impressionDataRanges[]

object (ImpressionDataRange)

مطلوب. نطاقات بيانات مرات الظهور المرتبطة بهذه الوحدة الإعلانية. من غير المتوقع أن تتداخل النطاقات الزمنية. يجب إدخال بيانات مرات الظهور حتى تكون الوحدة الإعلانية مؤهَّلة للشراء.
photoUrls[]

string

اختياريّ. عناوين URL لصور الوحدة الإعلانية.
products[]

string

مطلوب. أسماء موارد المنتجات المرتبطة بهذه الوحدة الإعلانية بالتنسيق: products/{id}. على سبيل المثال: products/product123.

AdUnitAttribute

السمات المحتملة المستخدمة لتعريف الوحدة الإعلانية بصورةٍ أكبر.

عمليات التعداد
AD_UNIT_ATTRIBUTE_UNSPECIFIED القيمة التلقائية عند عدم تحديد سمة الوحدة الإعلانية أو عندما تكون غير معروفة في هذا الإصدار
AD_UNIT_ATTRIBUTE_ILLUMINATED هل يمكن رؤية الوحدة الإعلانية في الظلام إذا كانت في الواقع؟
AD_UNIT_ATTRIBUTE_DIGITAL وحدة إعلانية رقمية، إذا لم يتم تضمينها مادية كلاسيكية.
AD_UNIT_ATTRIBUTE_PHYSICAL وجود الوحدة الإعلانية ككائن في العالم الفعلي.

AdUnitState

حالة الوحدة الإعلانية من منظور البائع.

عمليات التعداد
AD_UNIT_STATE_UNSPECIFIED القيمة التلقائية عندما تكون حالة الوحدة الإعلانية غير محدّدة أو تكون غير معروفة في هذا الإصدار.
AD_UNIT_STATE_PENDING الوحدة الإعلانية في انتظار الموافقة.
AD_UNIT_STATE_APPROVED تمت الموافقة على الوحدة الإعلانية.
AD_UNIT_STATE_REJECTED تم رفض الوحدة الإعلانية.
AD_UNIT_STATE_DELETED تم حذف الوحدة الإعلانية.

OutOfHomeVenue

قائمة بأنواع الأماكن الخارجية استنادًا إلى معايير DPAA

عمليات التعداد
OOH_VENUE_UNSPECIFIED القيمة التلقائية عند عدم تحديد مكان OOH أو عندما تكون غير معروفة في هذا الإصدار
OOH_VENUE_AIRBORNE مكان خارج المنزل مصنّف على أنّه محمول جوًا
OOH_VENUE_AIRPORTS_GENERAL الموقع الجغرافي خارج المنزل مصنّف على أنّه مطارات عامة
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM الموقع الجغرافي خارج المنزل مصنّف ضمن فئة استلام الحقائب في المطار
OOH_VENUE_AIRPORTS_TERMINAL مكان خارج المنزل مصنّف على أنّه مبنى مطار
OOH_VENUE_AIRPORTS_LOUNGES الموقع الجغرافي خارج المنزل مصنّف على أنّه صالات استقبال في المطارات.
OOH_VENUE_ATMS المكان خارج المنزل مصنّف على أنّه أجهزة صرّاف آلي.
OOH_VENUE_BACKLIGHTS مكان خارج المنزل مصنّف على أنّه إضاءة خلفية
OOH_VENUE_BARS وجهة خارج المنزل مصنّفة على أنّها بارات
OOH_VENUE_BENCHES مكان خارج المنزل مصنّف على أنّه مقاعد
OOH_VENUE_BIKE_RACKS مكان خارج المنزل مصنّف على أنّه رفوف للدراجات
OOH_VENUE_BULLETINS مكان خارج المنزل مصنّف على أنّه نشرات
OOH_VENUE_BUSES مكان خارج المنزل مصنّف على أنّه حافلات
OOH_VENUE_CAFES وجهة خارج المنزل مصنّفة على أنّها مقاهٍ
OOH_VENUE_CASUAL_DINING_RESTAURANTS وجهة خارج المنزل مصنّفة على أنّها مطاعم مريحة لتناول الطعام
OOH_VENUE_CHILD_CARE مكان خارج المنزل مصنّف على أنّه رعاية للأطفال.
OOH_VENUE_CINEMA مكان خارج المنزل مصنّف على أنّه سينما
OOH_VENUE_CITY_INFORMATION_PANELS مكان خارج المنزل مصنّف على أنّه لوحات معلومات في المدينة
OOH_VENUE_CONVENIENCE_STORES المكان خارج المنزل مصنّف على أنّه متاجر بقالة
OOH_VENUE_DEDICATED_WILD_POSTING الموقع الجغرافي خارج المنزل مصنّف على أنّه إعلان جامح مخصّص
OOH_VENUE_DOCTORS_OFFICES_GENERAL مكان خارج المنزل مصنّف على أنّه مكاتب أطباء عامة.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS مكان خارج المنزل مصنّف على أنّه مكاتب أطباء وتوليد
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS المكان خارج المنزل مصنّف على أنّه ضمن مكاتب أطباء أطفال.
OOH_VENUE_FAMILY_ENTERTAINMENT مكان خارج المنزل مصنّف على أنّه ترفيه عائلي
OOH_VENUE_FERRIES وجهة خارج المنزل مصنّفة على أنّها عبّارات
OOH_VENUE_FINANCIAL_SERVICES مكان خارج المنزل مصنّف على أنّه خدمات مالية
OOH_VENUE_GAS_STATIONS مكان خارج المنزل مصنّف على أنّه محطات وقود
OOH_VENUE_GOLF_COURSES مكان خارج المنزل مصنّف على أنّه ملاعب غولف
OOH_VENUE_GYMS مكان خارج المنزل مصنّف على أنّه صالات رياضية
OOH_VENUE_HOSPITALS الأماكن خارج المنزل مصنّفة على أنّها مستشفيات
OOH_VENUE_HOTELS المكان خارج المنزل مصنّف على أنّه فنادق.
OOH_VENUE_JUNIOR_POSTERS المكان خارج المنزل مصنّف على أنه ملصقات للمبتدئين.
OOH_VENUE_KIOSKS خارج المنزل مصنّفة على أنّها أكشاك
OOH_VENUE_MALLS_GENERAL مكان خارج المنزل مصنّف على أنّه مراكز تسوّق عامة
OOH_VENUE_MALLS_FOOD_COURTS مكان خارج المنزل مصنّف على أنّه صالات طعام في مراكز التسوق
OOH_VENUE_MARINE مكان خارج المنزل مصنّف على أنّه بحري
OOH_VENUE_MOBILE_BILLBOARDS مكان خارج المنزل مصنف على أنه لوحات إعلانية متنقلة.
OOH_VENUE_MOVIE_THEATER_LOBBIES مكان خارج المنزل مصنّف على أنّه ردهات سينمائية
OOH_VENUE_NEWSSTANDS مكان خارج المنزل مصنّف على أنّه صحف ومجلات
OOH_VENUE_OFFICE_BUILDINGS مكان خارج المنزل مصنّف على أنّه مباني مكاتب
OOH_VENUE_PHONE_KIOSKS مكان خارج المنزل مصنّف على أنّه أكشاك هواتف
OOH_VENUE_POSTERS المكان خارج المنزل مصنّف على أنّه ملصقات
OOH_VENUE_QSR المكان "خارج المنزل" مصنّف على أنه qsr.
OOH_VENUE_RAIL مكان خارج المنزل مصنّف على أنّه سكة حديدية
OOH_VENUE_RECEPTACLES مكان خارج المنزل مصنّف على أنّه أوعية
OOH_VENUE_RESORTS المكان خارج المنزل مصنّف على أنّه منتجعات.
OOH_VENUE_RETAIL المكان خارج المنزل مصنّف على أنه بيع بالتجزئة.
OOH_VENUE_SALONS مكان خارج المنزل مصنّف على أنّه صالونات
OOH_VENUE_SHELTERS مكان خارج المنزل مصنّف على أنّه ملاجئ
OOH_VENUE_SPORTS_ARENAS مكان خارج المنزل مصنّف على أنّه ملاعب رياضية
OOH_VENUE_SUBWAY مكان خارج المنزل مصنّف على أنّه مترو أنفاق
OOH_VENUE_TAXIS مكان خارج المنزل مصنّف على أنّه سيارات أجرة
OOH_VENUE_TRUCKSIDE مكان خارج المنزل مصنّف على أنّه بجانب شاحنة
OOH_VENUE_UNIVERSITIES مكان خارج المنزل مصنّف على أنّه جامعات
OOH_VENUE_URBAN_PANELS مكان خارج المنزل مصنّف على أنّه لوحات حضرية
OOH_VENUE_VETERINARIAN_OFFICES مكان خارج المنزل مصنّف على أنّه مكاتب بيطرية
OOH_VENUE_WALLS مكان خارج المنزل مصنّف على أنّه جدران
OOH_VENUE_OTHER المكان "خارج المنزل" مصنّف ضمن فئة "غير ذلك"

ImpressionDataRange

بيانات مرات الظهور لنطاق زمني

تمثيل JSON 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
الحقول
impressionDataStartTime

string (Timestamp format)

مطلوب. بداية الفاصل الزمني الذي تكون فيه بيانات مرات الظهور صالحة (شاملة).

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
impressionDataEndTime

string (Timestamp format)

مطلوب. نهاية الفاصل الزمني عندما تكون بيانات الظهور صالحة (حصرية)

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
impressionDataUnits[]

object (ImpressionDataUnit)

مطلوب. بيانات مرات الظهور للنطاق الزمني المحدّد

ImpressionDataUnit

بيانات الظهور ليوم معيّن من الأسبوع وساعات معينة من اليوم.

تمثيل JSON 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
الحقول
dayOfWeek

enum (DayOfWeek)

مطلوب. يوم من الأسبوع الذي تمثله بيانات مرات الظهور.
hourOfDay

integer

مطلوب. الساعات من اليوم التي تمثلها بيانات مرات الظهور بتنسيق 24 ساعة. يجب أن تتراوح القيمة بين 0 و23.
impressions

string (int64 format)

مطلوب. عدد مرات الظهور في يوم محدد من الأسبوع في ساعات اليوم المحدّدة.

الطُرق

create

 تُنشئ وحدة إعلانية جديدة.

delete

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

get

 لاسترداد وحدة إعلانية فردية.

list

 يسرد الوحدات الإعلانية.

patch

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