REST Resource: adUnits

منبع: AdUnit

یک واحد تبلیغاتی

نمایندگی 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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

فقط خروجی آخرین مهر زمانی به روز شده برای واحد تبلیغات.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

state

enum ( AdUnitState )

فقط خروجی وضعیت واحد تبلیغات. اگر AD_UNIT_STATE_REJECTED RejectedReason حاوی دلیل است.

rejectedReason

string

فقط خروجی اگر تأیید_وضعیت AD_UNIT_APPROVAL_STATUS_REJECTED باشد، این قسمت حاوی دلیل است.

location

object ( LatLng )

مورد نیاز. تغییرناپذیر. طول و عرض جغرافیایی واحد تبلیغاتی در قالب درجه امضا شده.

directionSet

boolean

مورد نیاز. اگر جهت تنظیم شود درست است.

direction

integer

اختیاری. تغییرناپذیر. جهت اصلی در درجه با شمال نشان دهنده 0. [0-360).

elevationMetersSet

boolean

مورد نیاز. اگر elevationMeters تنظیم شده باشد درست است.

elevationMeters

number

اختیاری. تغییرناپذیر. فاصله پایین واحد آگهی تا زمین بر حسب متر.

physicalWidthMetersSet

boolean

مورد نیاز. درست است اگرphysicalWidthMeters تنظیم شده باشد.

physicalWidthMeters

number

اختیاری. تغییرناپذیر. عرض فیزیکی واحد تبلیغات بر حسب متر.

physicalHeightMetersSet

boolean

مورد نیاز. درست است اگرphysicalHeightMeters تنظیم شده باشد.

physicalHeightMeters

number

اختیاری. تغییرناپذیر. ارتفاع فیزیکی واحد تبلیغاتی بر حسب متر.

venue

enum ( OutOfHomeVenue )

اختیاری. نوع محل برگزاری خارج از منزل بر اساس استانداردهای DPAA. این یک زمینه اطلاعاتی است که می تواند به تبلیغ کنندگان ارائه شود و همچنین می توان از آن برای فیلتر کردن واحدهای تبلیغاتی استفاده کرد.

fixedLocation

boolean

اختیاری. خواه تبلیغ در مکان ثابت (بیلبورد) باشد یا در حال حرکت (تاکسی).

indoors

boolean

مورد نیاز. این که آیا واحد تبلیغات در داخل ساختمان است.

impressionDataRanges[]

object ( ImpressionDataRange )

مورد نیاز. محدوده داده‌های نمایش مرتبط با این واحد تبلیغاتی. انتظار نمی رود محدوده تاریخ با هم تداخل داشته باشد. برای اینکه واحد تبلیغاتی واجد شرایط خرید باشد، داده‌های نمایش مورد نیاز است.

photoUrls[]

string

اختیاری. نشانی‌های اینترنتی عکس واحد تبلیغات.

products[]

string

مورد نیاز. نام منابع محصولات مرتبط با این واحد تبلیغاتی در قالب: products/{id} . به عنوان مثال products/product123 .

AdUnitAttribute

ویژگی های احتمالی مورد استفاده برای تعریف بیشتر واحد تبلیغات.

Enums
AD_UNIT_ATTRIBUTE_UNSPECIFIED مقدار پیش‌فرض زمانی که ویژگی واحد آگهی در این نسخه مشخص نشده است یا ناشناخته است.
AD_UNIT_ATTRIBUTE_ILLUMINATED آیا واحد تبلیغات در دنیای فیزیکی در تاریکی قابل مشاهده است؟
AD_UNIT_ATTRIBUTE_DIGITAL یک واحد تبلیغات دیجیتال، اگر شامل فیزیکی کلاسیک نباشد، ضمنی است.
AD_UNIT_ATTRIBUTE_PHYSICAL واحد تبلیغات به عنوان یک شی در دنیای فیزیکی وجود دارد.

AdUnitState

وضعیت یک واحد تبلیغاتی از دیدگاه فروشنده.

Enums
AD_UNIT_STATE_UNSPECIFIED مقدار پیش‌فرض زمانی که وضعیت واحد آگهی در این نسخه مشخص نشده است یا ناشناخته است.
AD_UNIT_STATE_PENDING واحد تبلیغات در انتظار تأیید است.
AD_UNIT_STATE_APPROVED واحد تبلیغات تایید شده است.
AD_UNIT_STATE_REJECTED واحد تبلیغات رد می شود.
AD_UNIT_STATE_DELETED واحد تبلیغات حذف شده است.

OutOfHomeVenue

فهرست انواع مکان های خارج از خانه بر اساس استانداردهای DPAA.

Enums
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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

impressionDataEndTime

string ( Timestamp format)

مورد نیاز. پایان فاصله زمانی که داده‌های نمایش معتبر هستند (انحصاری).

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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

 یک واحد تبلیغات موجود را به روز می کند.