CreativeAssets

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

CreativeAssets には、これからアップロードされる、またはすでにアップロードされているクリエイティブ アセット ファイルのプロパティが含まれます。アセットをアップロードしてクリエイティブを挿入する方法については、クリエイティブのサンプルコードをご覧ください。

{
  "kind": "dfareporting#creativeAssetMetadata",
  "assetIdentifier": {
    "type": string,
    "name": string
  },
  "detectedFeatures": [
    string
  ],
  "warnedValidationRules": [
    string
  ],
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "richMedia": boolean,
  "counterCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "exitCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "timerCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ]
}
プロパティ名 説明 メモ
assetIdentifier nested object クリエイティブ アセットの ID。必須のフィールドです。
assetIdentifier.name string クリエイティブ アセットの名前。アセットを挿入する際には必須のフィールドです。挿入後、この assetIdentifier はアップロードされたアセットの識別に使用されます。名前に使用できるのは英数字と「.-_ 」のいずれかです。空白文字は使用できます。
assetIdentifier.type string アップロードするアセットのタイプです。必須のフィールドです。新しいアップロードでは、FLASHIMAGE がサポート対象外になりました。画像アセットには HTML_IMAGE を使用してください。

設定可能な値は次のとおりです。
  • "AUDIO"
  • "FLASH"
  • "HTML"
  • "HTML_IMAGE"
  • "IMAGE"
  • "VIDEO"
clickTags[] list アセットで検出されたクリックタグのリスト。自動生成される読み取り専用のフィールドです。リッチメディア アセットの場合は空です。
clickTags[].clickThroughUrl nested object 指定したクリックタグのパラメータ値。リンク先 URL が含まれます。
clickTags[].clickThroughUrl.computedClickThroughUrl string このクリックスルーに使用される実際の URL を表す読み取り専用のフィールドです(利便性のために用意されています)。この URL は次のように決定されます。
  • landingPageId が指定されている場合、そのランディング ページの URL となります。
  • それ以外の場合、customClickThroughUrl となります。
clickTags[].clickThroughUrl.customClickThroughUrl string カスタムのリンク先 URL。landingPageId フィールドが未設定の場合に有効です。
clickTags[].clickThroughUrl.landingPageId long リンク先 URL のランディング ページの ID。
clickTags[].eventName string クリックタグに関連付けられた広告主のイベントの名前。DISPLAY_IMAGE_GALLERY クリエイティブと HTML5_BANNER のクリエイティブで使用されます。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
clickTags[].name string 指定したクリックタグのパラメータ名。DISPLAY_IMAGE_GALLERY クリエイティブ アセットの場合、クリエイティブ アセットの creativeAssetId.name フィールドの値と一致する必要があります。
counterCustomEvents[] list アセットに設定されているカウンタ イベントのリスト。自動生成される読み取り専用のフィールドです。リッチメディア アセットでのみ有効です。
counterCustomEvents[].advertiserCustomEventId long Reporting と Data Transfer が使用する、このイベントの一意の ID。読み取り専用のフィールドです。
counterCustomEvents[].advertiserCustomEventName string ユーザーが入力したイベントの名前。
counterCustomEvents[].advertiserCustomEventType string イベントのタイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
counterCustomEvents[].artworkLabel string アートワーク ラベル列。キャンペーン マネージャーのイベントをスタジオのイベントにリンクするために使用します。必須のフィールドです。挿入後に変更しないでください。
counterCustomEvents[].artworkType string クリエイティブで使用されるアートワーク タイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
counterCustomEvents[].exitClickThroughUrl nested object Exit イベントのリンク先 URL。Exit イベントにのみ使用されます。
counterCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string このクリックスルーに使用される実際の URL を表す読み取り専用のフィールド(利便性のために用意されています)。この URL は次のように決定されます。
  • landingPageId が指定されている場合、そのランディング ページの URL となります。
  • それ以外の場合、customClickThroughUrl となります。
counterCustomEvents[].exitClickThroughUrl.customClickThroughUrl string カスタムのリンク先 URL。landingPageId フィールドが未設定の場合に有効です。
counterCustomEvents[].exitClickThroughUrl.landingPageId long リンク先 URL のランディング ページの ID。
counterCustomEvents[].id long このイベントの ID。必須のフィールドです。挿入後に変更しないでください。
counterCustomEvents[].popupWindowProperties nested object リッチメディアのポップアップ ウィンドウのプロパティ。Exit イベントにのみ使用されます。
counterCustomEvents[].popupWindowProperties.dimension nested object クリエイティブのポップアップのディメンション。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
counterCustomEvents[].popupWindowProperties.offset nested object ポップアップ ウィンドウの左上隅の座標。positionTypeCOORDINATES の場合に有効です。
counterCustomEvents[].popupWindowProperties.offset.left integer アセットまたはウィンドウの左端からのオフセット距離。
counterCustomEvents[].popupWindowProperties.offset.top integer アセットまたはウィンドウの上端からのオフセット距離。
counterCustomEvents[].popupWindowProperties.positionType string ポップアップ ウィンドウの位置(中央または特定の座標)。

設定可能な値は次のとおりです。
  • "CENTER"
  • "COORDINATES"
counterCustomEvents[].popupWindowProperties.showAddressBar boolean ブラウザのアドレスバーを表示するかどうか。
counterCustomEvents[].popupWindowProperties.showMenuBar boolean ブラウザのメニューバーを表示するかどうか。
counterCustomEvents[].popupWindowProperties.showScrollBar boolean ブラウザのスクロールバーを表示するかどうか。
counterCustomEvents[].popupWindowProperties.showStatusBar boolean ブラウザのステータスバーを表示するかどうか。
counterCustomEvents[].popupWindowProperties.showToolBar boolean ブラウザのツールバーを表示するかどうか。
counterCustomEvents[].popupWindowProperties.title string ポップアップ ウィンドウのタイトル。
counterCustomEvents[].targetType string イベントで使用されるターゲット タイプ。

設定可能な値は次のとおりです。
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
counterCustomEvents[].videoReportingId string 動画レポート ID。1 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
detectedFeatures[] list キャンペーン マネージャーで検出されるクリエイティブ アセットの機能の依存関係のリスト。機能の依存関係とは、HTML5 クリエイティブを正常に表示するためにブラウザがサポートしている必要がある機能のことです。自動生成される読み取り専用のフィールドです。
exitCustomEvents[] list アセットに設定されている Exit イベントのリスト。自動生成される読み取り専用のフィールドです。リッチメディア アセットでのみ有効です。
exitCustomEvents[].advertiserCustomEventId long Reporting と Data Transfer が使用する、このイベントの一意の ID。読み取り専用のフィールドです。
exitCustomEvents[].advertiserCustomEventName string ユーザーが入力したイベントの名前。
exitCustomEvents[].advertiserCustomEventType string イベントのタイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
exitCustomEvents[].artworkLabel string アートワーク ラベル列。キャンペーン マネージャーのイベントをスタジオのイベントにリンクするために使用します。必須のフィールドです。挿入後に変更しないでください。
exitCustomEvents[].artworkType string クリエイティブで使用されるアートワーク タイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
exitCustomEvents[].exitClickThroughUrl nested object Exit イベントのリンク先 URL。Exit イベントにのみ使用されます。
exitCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string このクリックスルーに使用される実際の URL を表す読み取り専用のフィールド(利便性のために用意されています)。この URL は次のように決定されます。
  • landingPageId が指定されている場合、そのランディング ページの URL となります。
  • それ以外の場合、customClickThroughUrl となります。
exitCustomEvents[].exitClickThroughUrl.customClickThroughUrl string カスタムのリンク先 URL。landingPageId フィールドが未設定の場合に有効です。
exitCustomEvents[].exitClickThroughUrl.landingPageId long リンク先 URL のランディング ページの ID。
exitCustomEvents[].id long このイベントの ID。必須のフィールドです。挿入後に変更しないでください。
exitCustomEvents[].popupWindowProperties nested object リッチメディアのポップアップ ウィンドウのプロパティ。Exit イベントにのみ使用されます。
exitCustomEvents[].popupWindowProperties.dimension nested object クリエイティブのポップアップのディメンション。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
exitCustomEvents[].popupWindowProperties.offset nested object ポップアップ ウィンドウの左上隅の座標。positionTypeCOORDINATES の場合に有効です。
exitCustomEvents[].popupWindowProperties.offset.left integer アセットまたはウィンドウの左端からのオフセット距離。
exitCustomEvents[].popupWindowProperties.offset.top integer アセットまたはウィンドウの上端からのオフセット距離。
exitCustomEvents[].popupWindowProperties.positionType string ポップアップ ウィンドウの位置(中央または特定の座標)。

設定可能な値は次のとおりです。
  • "CENTER"
  • "COORDINATES"
exitCustomEvents[].popupWindowProperties.showAddressBar boolean ブラウザのアドレスバーを表示するかどうか。
exitCustomEvents[].popupWindowProperties.showMenuBar boolean ブラウザのメニューバーを表示するかどうか。
exitCustomEvents[].popupWindowProperties.showScrollBar boolean ブラウザのスクロールバーを表示するかどうか。
exitCustomEvents[].popupWindowProperties.showStatusBar boolean ブラウザのステータスバーを表示するかどうか。
exitCustomEvents[].popupWindowProperties.showToolBar boolean ブラウザのツールバーを表示するかどうか。
exitCustomEvents[].popupWindowProperties.title string ポップアップ ウィンドウのタイトル。
exitCustomEvents[].targetType string イベントで使用されるターゲット タイプ。

設定可能な値は次のとおりです。
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
exitCustomEvents[].videoReportingId string 動画レポート ID。1 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
id long アセットの数値 ID。自動生成される読み取り専用のフィールドです。
idDimensionValue nested object アセットの数値 ID のディメンション値。自動生成される読み取り専用のフィールドです。
kind string リソースの種類を識別します。値: 固定文字列 "dfareporting#creativeAssetMetadata"
richMedia boolean アップロードされたアセットがリッチメディア アセットの場合は true。自動生成される読み取り専用のフィールドです。
timerCustomEvents[] list アセットに設定されているタイマー イベントのリスト。自動生成される読み取り専用のフィールドです。リッチメディア アセットでのみ有効です。
timerCustomEvents[].advertiserCustomEventId long Reporting と Data Transfer が使用する、このイベントの一意の ID。読み取り専用のフィールドです。
timerCustomEvents[].advertiserCustomEventName string ユーザーが入力したイベントの名前。
timerCustomEvents[].advertiserCustomEventType string イベントのタイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
timerCustomEvents[].artworkLabel string アートワーク ラベル列。キャンペーン マネージャーのイベントをスタジオのイベントにリンクするために使用します。必須のフィールドです。挿入後に変更しないでください。
timerCustomEvents[].artworkType string クリエイティブで使用されるアートワーク タイプ。読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
timerCustomEvents[].exitClickThroughUrl nested object Exit イベントのリンク先 URL。Exit イベントにのみ使用されます。
timerCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string このクリックスルーに使用される実際の URL を表す読み取り専用のフィールド(利便性のために用意されています)。この URL は次のように決定されます。
  • landingPageId が指定されている場合、そのランディング ページの URL となります。
  • それ以外の場合、customClickThroughUrl となります。
timerCustomEvents[].exitClickThroughUrl.customClickThroughUrl string カスタムのリンク先 URL。landingPageId フィールドが未設定の場合に有効です。
timerCustomEvents[].exitClickThroughUrl.landingPageId long リンク先 URL のランディング ページの ID。
timerCustomEvents[].id long このイベントの ID。必須のフィールドです。挿入後に変更しないでください。
timerCustomEvents[].popupWindowProperties nested object リッチメディアのポップアップ ウィンドウのプロパティ。Exit イベントにのみ使用されます。
timerCustomEvents[].popupWindowProperties.dimension nested object クリエイティブのポップアップのディメンション。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
timerCustomEvents[].popupWindowProperties.offset nested object ポップアップ ウィンドウの左上隅の座標。positionTypeCOORDINATES の場合に有効です。
timerCustomEvents[].popupWindowProperties.offset.left integer アセットまたはウィンドウの左端からのオフセット距離。
timerCustomEvents[].popupWindowProperties.offset.top integer アセットまたはウィンドウの上端からのオフセット距離。
timerCustomEvents[].popupWindowProperties.positionType string ポップアップ ウィンドウの位置(中央または特定の座標)。

設定可能な値は次のとおりです。
  • "CENTER"
  • "COORDINATES"
timerCustomEvents[].popupWindowProperties.showAddressBar boolean ブラウザのアドレスバーを表示するかどうか。
timerCustomEvents[].popupWindowProperties.showMenuBar boolean ブラウザのメニューバーを表示するかどうか。
timerCustomEvents[].popupWindowProperties.showScrollBar boolean ブラウザのスクロールバーを表示するかどうか。
timerCustomEvents[].popupWindowProperties.showStatusBar boolean ブラウザのステータスバーを表示するかどうか。
timerCustomEvents[].popupWindowProperties.showToolBar boolean ブラウザのツールバーを表示するかどうか。
timerCustomEvents[].popupWindowProperties.title string ポップアップ ウィンドウのタイトル。
timerCustomEvents[].targetType string イベントで使用されるターゲット タイプ。

設定可能な値は次のとおりです。
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
timerCustomEvents[].videoReportingId string 動画レポート ID。1 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
warnedValidationRules[] list コード生成中の検証で警告が発生したルール。自動生成される読み取り専用のフィールドです。

設定される可能性のある値は次のとおりです。
  • "ADMOB_REFERENCED"
  • "ASSET_FORMAT_UNSUPPORTED_DCM"
  • "ASSET_INVALID"
  • "CLICK_TAG_HARD_CODED"
  • "CLICK_TAG_INVALID"
  • "CLICK_TAG_IN_GWD"
  • "CLICK_TAG_MISSING"
  • "CLICK_TAG_MORE_THAN_ONE"
  • "CLICK_TAG_NON_TOP_LEVEL"
  • "COMPONENT_UNSUPPORTED_DCM"
  • "ENABLER_UNSUPPORTED_METHOD_DCM"
  • "EXTERNAL_FILE_REFERENCED"
  • "FILE_DETAIL_EMPTY"
  • "FILE_TYPE_INVALID"
  • "GWD_PROPERTIES_INVALID"
  • "HTML5_FEATURE_UNSUPPORTED"
  • "LINKED_FILE_NOT_FOUND"
  • "MAX_FLASH_VERSION_11"
  • "MRAID_REFERENCED"
  • "NOT_SSL_COMPLIANT"
  • "ORPHANED_ASSET"
  • "PRIMARY_HTML_MISSING"
  • "SVG_INVALID"
  • "ZIP_INVALID"

メソッド

insert
新しいクリエイティブ アセットを挿入します。