- リソース: 広告ユニット
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- AdUnitAttribute
- AdUnitState
- OutOfHomeVenue
- ImpressionDataRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ImpressionDataUnit
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- メソッド
リソース: namespace
単一の広告ユニット。
| JSON 表現 |
|---|
{ "name": string, "externalId": string, "displayName": string, "description": string, "labels": { string: string, ... }, "attributes": [ enum ( |
| フィールド | |
|---|---|
name |
広告ユニットのリソース名。形式は |
externalId |
省略可。販売者が管理する ID。おそらく独自のシステムにある。一度設定したら変更される可能性は低いです。内部で使用するべきではなく、制約は適用されません。 |
displayName |
必須。広告ユニットの表示名。 UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。 |
description |
省略可。広告ユニットの説明に使用する追加の自由形式フィールド。 |
labels |
省略可。この広告ユニットを説明する自由形式のラベルのセット。
|
attributes[] |
省略可。この広告ユニットをさらに定義するための属性。 |
creatives[] |
省略可。この広告ユニットで配信できるクリエイティブのリストです。これは商品レベルでも定義できます。 |
createTime |
出力専用。広告ユニットの作成タイムスタンプ。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
updateTime |
出力専用。広告ユニットの最終更新日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
state |
出力専用。広告ユニットの状態。AD_UNIT_STATE_REJECTED の場合、rejectReason に理由が含まれます。 |
rejectedReason |
出力専用。承認ステータスが AD_UNIT_APPROVAL_STATUS_REJECTED の場合、このフィールドには理由が含まれます。 |
location |
必須。変更不可。広告ユニットの緯度と経度(符号付き度数形式)。 |
directionSet |
必須。方向が設定されている場合は true。 |
direction |
省略可。変更不可。度数で示される基本方位。北は 0 を表します。[0 ~ 360)。 |
elevationMetersSet |
必須。ElevationMeters が設定されている場合は true を返します。 |
elevationMeters |
省略可。変更不可。広告ユニットの下部から地面までの距離(メートル単位)。 |
physicalWidthMetersSet |
必須。PhysicalWidthMeters が設定されている場合は true になります。 |
physicalWidthMeters |
省略可。変更不可。広告ユニットの物理的な幅(メートル単位)。 |
physicalHeightMetersSet |
必須。basicHeightMeters が設定されている場合は true にします。 |
physicalHeightMeters |
省略可。変更不可。広告ユニットの物理的な高さ(メートル単位)。 |
venue |
省略可。DPAA 標準に基づく屋外会場タイプ。これは広告主に表示される情報フィールドで、広告ユニットのフィルタにも使用できます。 |
fixedLocation |
省略可。広告が固定位置にあるか(看板)、移動している(タクシー)か。 |
indoors |
必須。広告ユニットが屋内にあるかどうか。 |
impressionDataRanges[] |
必須。この広告ユニットに関連付けられているインプレッション データの範囲。期間が重複することは想定されていません。広告ユニットを購入できるようにするには、インプレッション データが必要です。 |
photoUrls[] |
省略可。広告ユニットの写真の URL。 |
products[] |
必須。この広告ユニットに関連付けられている商品のリソース名。形式は |
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 |
屋外施設が「その他」に分類されます。 |
ImpressionDataRange
特定の期間のインプレッション データ。
| JSON 表現 |
|---|
{
"impressionDataStartTime": string,
"impressionDataEndTime": string,
"impressionDataUnits": [
{
object ( |
| フィールド | |
|---|---|
impressionDataStartTime |
必須。インプレッション データが有効である期間の開始点(この値を含む)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
impressionDataEndTime |
必須。インプレッション データが有効である期間(その値を含まない)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
impressionDataUnits[] |
必須。指定した期間のインプレッション データ。 |
ImpressionDataUnit
特定の曜日と時間帯のインプレッション データ。
| JSON 表現 |
|---|
{
"dayOfWeek": enum ( |
| フィールド | |
|---|---|
dayOfWeek |
必須。インプレッション データの曜日。 |
hourOfDay |
必須。インプレッション データが 24 時間形式で表される時間帯。0 ~ 23 の範囲で指定してください。 |
impressions |
必須。指定した曜日の、指定した時間帯のインプレッション数。 |
メソッド |
|
|---|---|
|
新しい広告ユニットを作成します。 |
|
既存の広告ユニットを削除します。 |
|
個々の広告ユニットを取得します。 |
|
広告ユニットを一覧表示します。 |
|
既存の広告ユニットを更新します。 |