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

可选。可能是卖家在他们自己的系统中管理的 ID。一旦设置，不太可能改变。它不应在内部使用，也不会强制执行限制条件。
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 将包含原因。
rejectedReason

string

仅限输出。如果 approval_status 为 AD_UNIT_APPROVAL_STATUS_REJECTED，则此字段将包含原因。
location

object (LatLng)

必需。不可变。广告单元的纬度和经度（采用带符号的度数格式）。
directionSet

boolean

必需。如果设置了方向，则为 true。
direction

integer

可选。不可变。基本方向（以度为单位），北方代表 0。[0-360]）。
elevationMetersSet

boolean

必需。如果设置了 heightMeters，则为 true。
elevationMeters

number

可选。不可变。广告单元底部到地面的距离（以米为单位）。
physicalWidthMetersSet

boolean

必需。如果设置了 PhysicalWidthMeters，则为 true。
physicalWidthMeters

number

可选。不可变。广告单元的实际宽度（以米为单位）。
physicalHeightMetersSet

boolean

必需。如果设置了 PhysicalHeightMeters，则为 true。
physicalHeightMeters

number

可选。不可变。广告单元的实际高度（以米为单位）。
venue

enum (OutOfHomeVenue)

可选。基于 DPAA 标准的户外场地类型。此字段是一个提供信息的字段，可向广告客户显示，还可用于过滤广告单元。
fixedLocation

boolean

可选。广告是在固定位置（广告牌）还是搬迁（出租车）。
indoors

boolean

必需。广告单元是否在室内。
impressionDataRanges[]

object (ImpressionDataRange)

必需。与此广告单元相关联的展示数据范围。日期范围预计不会重叠。广告单元必须有展示次数数据，才符合购买条件。
photoUrls[]

string

可选。广告单元的照片网址。
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 归类为 ATM 的户外场所。
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

 更新现有广告单元。