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

Необходимый. Истинно, если направление установлено.

direction

integer

Необязательный. Неизменяемый. Кардинальное направление в градусах, где север соответствует 0. [0–360).

elevationMetersSet

boolean

Необходимый. Истинно, если установлен ElevationMeters.

elevationMeters

number

Необязательный. Неизменяемый. Расстояние от нижней части рекламного блока до земли в метрах.

physicalWidthMetersSet

boolean

Необходимый. Истинно, если установлен физический WidthMeters.

physicalWidthMeters

number

Необязательный. Неизменяемый. Физическая ширина рекламного блока в метрах.

physicalHeightMetersSet

boolean

Необходимый. Истинно, если установлен физическийHeightMeters.

physicalHeightMeters

number

Необязательный. Неизменяемый. Физическая высота рекламного блока в метрах.

venue

enum ( OutOfHomeVenue )

Необязательный. Тип заведения вне дома, основанный на стандартах DPAA. Это информационное поле, которое может быть представлено рекламодателям, а также использовано для фильтрации рекламных блоков.

fixedLocation

boolean

Необязательный. Независимо от того, находится ли реклама в фиксированном месте (рекламный щит) или в движении (такси).

indoors

boolean

Необходимый. Находится ли рекламный блок в помещении.

impressionDataRanges[]

object ( ImpressionDataRange )

Необходимый. Диапазоны данных о показах, связанных с этим рекламным блоком. Диапазоны дат не должны пересекаться. Данные о показах необходимы для того, чтобы рекламный блок мог быть доступен для покупки.

photoUrls[]

string

Необязательный. URL-адреса фотографий рекламного блока.

products[]

string

Необходимый. Названия ресурсов продуктов, связанных с этим рекламным блоком, в формате: products/{id} . Например products/product123 .

Адюнитаттрибуте

Возможные атрибуты, используемые для дальнейшего определения рекламного блока.

Перечисления
AD_UNIT_ATTRIBUTE_UNSPECIFIED Значение по умолчанию, если атрибут рекламного блока не указан или неизвестен в этой версии.
AD_UNIT_ATTRIBUTE_ILLUMINATED Виден ли рекламный блок в темноте, если он находится в физическом мире?
AD_UNIT_ATTRIBUTE_DIGITAL Цифровой рекламный блок, если он не включен, подразумевается классический физический.
AD_UNIT_ATTRIBUTE_PHYSICAL Рекламный блок существует как объект в физическом мире.

АдЮнитстате

Состояние рекламного блока с точки зрения продавца.

Перечисления
AD_UNIT_STATE_UNSPECIFIED Значение по умолчанию, если состояние рекламного блока не указано или неизвестно в этой версии.
AD_UNIT_STATE_PENDING Рекламный блок ожидает одобрения.
AD_UNIT_STATE_APPROVED Рекламный блок одобрен.
AD_UNIT_STATE_REJECTED Рекламный блок отклонен.
AD_UNIT_STATE_DELETED Рекламный блок удален.

ВнеДомаМесто проведения

Список типов заведений вне дома, основанный на стандартах DPAA.

Перечисления
OOH_VENUE_UNSPECIFIED Значение по умолчанию, если место проведения наружной рекламы не указано или неизвестно в этой версии.
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 Выездное заведение отнесено к категории «прочие».

Диапазон данных показов

Данные о показах за диапазон дат.

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 )

Необходимый. Данные о показах за указанный диапазон дат.

ЕдиницаДанных Показов

Данные о показах за определенный день недели и часы суток.

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

 Обновляет существующий рекламный блок.