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 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。廣告單元上次更新的時間戳記。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："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。[0-360])。
elevationMetersSet

boolean

必要欄位。如果設定了 elevationMeters，則為 true。
elevationMeters

number

選用設定。不可變動。廣告單元底部與地面之間的距離 (以公尺為單位)。
physicalWidthMetersSet

boolean

必要欄位。如果設定 entityWidthMeters，則為 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 Venue 值，或此版本的值不明時的預設值。
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 歸類為超級男裝的戶外場地。
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 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
impressionDataEndTime

string (Timestamp format)

必要欄位。曝光資料有效時時間間隔的結束時間 (不含)。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："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

 更新現有廣告單元。