REST Resource: sellers.adUnits

リソース: namespace

単一の広告ユニット。

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,
  "photoUris": [
    string
  ],
  "products": [
    string
  ]
}
フィールド
name

string

広告ユニットのリソース名。形式は sellers/{seller}/adUnits/{adUnit} です。例: sellers/seller321/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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。広告ユニットの最終更新日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
state

enum (AdUnitState)

出力専用。広告ユニットの状態。AD_UNIT_STATE_REJECTED の場合、rejectReason に理由が含まれます。
rejectedReason

string

出力専用。承認ステータスが AD_UNIT_APPROVAL_STATUS_REJECTED の場合、このフィールドには理由が含まれます。
location

object (LatLng)

必須。変更不可。広告ユニットの緯度と経度（符号付き度数形式）。
directionSet

boolean

true の場合、direction フィールドには方向の値が含まれます。false の場合、方向はゼロになります。
direction

integer

変更不可。度数で示される基本方位。北は 0 を表します。[0 ～ 360）。
elevationMetersSet

boolean

true の場合、Elevation フィールドには高度がメートル単位で含まれます。false の場合、高度は 0 になります。
elevationMeters

number

変更不可。広告ユニットの下部から地面までの距離（メートル単位）。
physicalWidthMetersSet

boolean

true の場合、PhysicalWidthMeters フィールドに物理的な幅がメートル単位で格納されます。false の場合、PhysicalWidthMeters は 0 になります。
physicalWidthMeters

number

変更不可。広告ユニットの物理的な幅（メートル単位）。
physicalHeightMetersSet

boolean

true の場合、PhysicalHeightMeters フィールドに物理的な高さ（メートル単位）が含まれます。false の場合、PhysicalHeightMeters は 0 になります。
physicalHeightMeters

number

変更不可。広告ユニットの物理的な高さ（メートル単位）。
venue

enum (OutOfHomeVenue)

DPAA 標準に基づく屋外会場タイプ。これは広告主に表示される情報フィールドで、広告ユニットのフィルタにも使用できます。
fixedLocation

boolean

広告が固定位置にあるか（看板）、移動している（タクシー）か。
indoors

boolean

必須。広告ユニットが屋内にあるかどうか。
photoUris[]

string

広告ユニットの写真の URI。
products[]

string

必須。この広告ユニットに関連付けられている商品のリソース名。形式は sellers/{seller}/products/{product} です。例: sellers/seller111/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 「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 屋外施設が「その他」に分類されます。

メソッド

create

 新しい広告ユニットを作成します。

delete

 既存の広告ユニットを削除します。

get

 個々の広告ユニットを取得します。

list

 広告ユニットを一覧表示します。

patch

 既存の広告ユニットを更新します。