Creatives

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

リソース表現

クリエイティブのプロパティが含まれます。

{
  "kind": "dfareporting#creative",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "renderingIdDimensionValue": dimensionValues Resource,
  "name": string,
  "renderingId": long,
  "advertiserId": long,
  "accountId": long,
  "subaccountId": long,
  "active": boolean,
  "archived": boolean,
  "version": integer,
  "size": sizes Resource,
  "additionalSizes": [
    sizes Resource
  ],
  "creativeFieldAssignments": [
    {
      "creativeFieldId": long,
      "creativeFieldValueId": long
    }
  ],
  "lastModifiedInfo": {
    "time": long
  },
  "sslCompliant": boolean,
  "compatibility": [
    string
  ],
  "type": string,
  "creativeAssets": [
    {
      "id": long,
      "assetIdentifier": {
        "type": string,
        "name": string
      },
      "sslCompliant": boolean,
      "size": sizes Resource,
      "additionalSizes": [
        sizes Resource
      ],
      "fileSize": long,
      "flashVersion": integer,
      "actionScript3": boolean,
      "zipFilename": string,
      "zipFilesize": string,
      "detectedFeatures": [
        string
      ],
      "displayType": string,
      "artworkType": string,
      "collapsedSize": sizes Resource,
      "offset": {
        "top": integer,
        "left": integer
      },
      "zIndex": integer,
      "windowMode": string,
      "transparency": boolean,
      "pushdown": boolean,
      "pushdownDuration": float,
      "position": {
        "top": integer,
        "left": integer
      },
      "positionTopUnit": string,
      "positionLeftUnit": string,
      "verticallyLocked": boolean,
      "horizontallyLocked": boolean,
      "startTimeType": string,
      "customStartTimeValue": integer,
      "durationType": string,
      "duration": integer,
      "hideFlashObjects": boolean,
      "hideSelectionBoxes": boolean,
      "alignment": string,
      "childAssetType": string,
      "originalBackup": boolean,
      "bitRate": integer,
      "mimeType": string,
      "active": boolean,
      "progressiveServingUrl": string,
      "streamingServingUrl": string,
      "mediaDuration": float,
      "expandedDimension": sizes Resource,
      "role": string,
      "backupImageExit": {
        "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
        }
      },
      "companionCreativeIds": [
        long
      ],
      "idDimensionValue": dimensionValues Resource,
      "orientation": string,
      "audioBitRate": integer,
      "audioSampleRate": integer,
      "frameRate": float,
      "politeLoad": boolean
    }
  ],
  "redirectUrl": string,
  "htmlCode": string,
  "htmlCodeLocked": boolean,
  "backgroundColor": string,
  "allowScriptAccess": boolean,
  "fsCommand": {
    "positionOption": string,
    "top": integer,
    "left": integer,
    "windowWidth": integer,
    "windowHeight": integer
  },
  "backupImageClickThroughUrl": {
    "landingPageId": long,
    "customClickThroughUrl": string,
    "computedClickThroughUrl": string
  },
  "backupImageTargetWindow": {
    "targetWindowOption": string,
    "customHtml": string
  },
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "backupImageFeatures": [
    string
  ],
  "authoringTool": string,
  "requiredFlashPluginVersion": string,
  "adTagKeys": [
    string
  ],
  "customKeyValues": [
    string
  ],
  "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
      }
    }
  ],
  "artworkType": string,
  "requiredFlashVersion": integer,
  "thirdPartyBackupImageImpressionsUrl": string,
  "thirdPartyRichMediaImpressionsUrl": string,
  "totalFileSize": long,
  "mediaDuration": float,
  "commercialId": string,
  "companionCreatives": [
    long
  ],
  "mediaDescription": string,
  "skippable": boolean,
  "thirdPartyUrls": [
    {
      "thirdPartyUrlType": string,
      "url": string
    }
  ],
  "adParameters": string,
  "overrideCss": string,
  "studioCreativeId": long,
  "studioTraffickedCreativeId": long,
  "latestTraffickedCreativeId": long,
  "studioAdvertiserId": long,
  "autoAdvanceImages": boolean,
  "backupImageReportingLabel": string,
  "convertFlashToHtml5": boolean,
  "sslOverride": boolean,
  "skipOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "progressOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "obaIcon": {
    "resourceUrl": string,
    "xPosition": string,
    "yPosition": string,
    "size": sizes Resource,
    "program": string,
    "iconClickThroughUrl": string,
    "iconClickTrackingUrl": string,
    "iconViewTrackingUrl": string
  },
  "authoringSource": string,
  "dynamicAssetSelection": boolean,
  "creativeAssetSelection": {
    "rules": [
      {
        "name": string,
        "assetId": long,
        "targetingTemplateId": long
      }
    ],
    "defaultAssetId": long
  },
  "universalAdId": {
    "registry": string,
    "value": string
  }
}
プロパティ名 説明 備考
accountId long このクリエイティブのアカウント ID です。未設定の場合、挿入と更新の両方のオペレーションで自動生成されます。すべてのクリエイティブ タイプで有効です。
active boolean クリエイティブがアクティブかどうかを示します。すべてのクリエイティブ タイプで有効です。
adParameters string VPAID クリエイティブで使用される広告パラメータです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての VPAID
adTagKeys[] list リッチメディア クリエイティブのキーワードです。キーワードを使用すると、広告主に問い合わせることなく、サイトに掲載されるリッチメディア広告のクリエイティブ設定をカスタマイズできます。クリエイティブの外観や機能を動的に変更することもできます。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
additionalSizes[] list レスポンシブ クリエイティブに関連付けられた追加のサイズです。クリエイティブを挿入または更新するときに、サイズ ID フィールドまたはサイズの幅と高さのフィールドを使用できます。メインアセットのタイプが HTML_IMAGE の場合、DISPLAY クリエイティブで有効です。
advertiserId long このクリエイティブの広告主 ID です。必須のフィールドです。すべてのクリエイティブ タイプで有効です。
allowScriptAccess boolean このクリエイティブでスクリプト アクセスを許可するかどうかを示します。サポートが終了した読み取り専用のフィールドです。更新時には自動的に true に設定されます。次のクリエイティブ タイプで有効です: FLASH_INPAGE
archived boolean クリエイティブがアーカイブされているかどうかを示します。すべてのクリエイティブ タイプで有効です。
artworkType string クリエイティブに使用するアートワークのタイプです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID

設定可能な値は次のとおりです。
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
authoringSource string クリエイティブが作成されたソース アプリケーションです。現在、DBM で作成されたクリエイティブでのみ設定されます。すべてのクリエイティブ タイプで有効です。

設定可能な値は次のとおりです。
  • "CREATIVE_AUTHORING_SOURCE_DBM"
  • "CREATIVE_AUTHORING_SOURCE_DCM"
  • "CREATIVE_AUTHORING_SOURCE_GWD"
  • "CREATIVE_AUTHORING_SOURCE_STUDIO"
authoringTool string HTML5 バナー クリエイティブの作成ツールです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: HTML5_BANNER

設定可能な値は次のとおりです。
  • "NINJA"
  • "SWIFFY"
autoAdvanceImages boolean 画像ギャラリー クリエイティブで画像を自動的に進めるかどうかを示します。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERY
backgroundColor string Flash ファイルが表示されるウィンドウ領域の背景に使用する色を表す、「#」で始まる 6 文字の HTML カラーコードです。デフォルトは白です。次のクリエイティブ タイプで有効です: FLASH_INPAGE
backupImageClickThroughUrl nested object 代替画像のリンク先 URL です。メインアセットのタイプが HTML_IMAGE でない場合、ENHANCED_BANNER で有効です。
backupImageClickThroughUrl.computedClickThroughUrl string このクリックスルーに使用される実際の URL を表す読み取り専用のフィールドです(利便性のために用意されています)。この URL は次のように決定されます。
  • landingPageId が指定されている場合、そのランディング ページの URL となります。
  • それ以外の場合、customClickThroughUrl となります。
backupImageClickThroughUrl.customClickThroughUrl string カスタムのリンク先 URL。landingPageId フィールドが未設定の場合に有効です。
backupImageClickThroughUrl.landingPageId long リンク先 URL のランディング ページの ID です。
backupImageFeatures[] list 広告を配信するブラウザがサポートしていない場合に代替画像が配信される機能の依存関係のリストです。機能の依存関係とは、HTML5 クリエイティブ アセットを正常に表示するためにブラウザがサポートする必要のある機能のことです。このフィールドは、キャンペーン マネージャーによってこのクリエイティブのすべてのアセットから検出された機能がすべて含まれるように、最初に自動生成されます。その後、クライアントが変更できます。このフィールドをリセットするには、creativeAssets で検出されたすべての機能をコピーしてください。次のクリエイティブ タイプで有効です: HTML5_BANNER。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
backupImageReportingLabel string HTML5 バナーの代替画像に使用するレポートラベルです。次のクリエイティブ タイプで有効です: DISPLAY(メインアセットのタイプが HTML_IMAGE でない場合)。
backupImageTargetWindow nested object 代替画像のターゲット ウィンドウです。次のクリエイティブ タイプで有効です: FLASH_INPAGEHTML5_BANNER。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
backupImageTargetWindow.customHtml string ユーザーが入力した値です。
backupImageTargetWindow.targetWindowOption string Flash クリエイティブの代替画像を表示できるブラウザ ウィンドウのタイプです。

設定可能な値は次のとおりです。
  • "CURRENT_WINDOW"
  • "CUSTOM"
  • "NEW_WINDOW"
clickTags[] list クリエイティブのクリックタグです。DISPLAY クリエイティブ、FLASH_INPAGE クリエイティブ、HTML5_BANNER クリエイティブの場合は、このクリエイティブに関連付けられているアセットで検出されたクリックタグのサブセットです。Flash アセットを作成すると、検出されたクリックタグが creativeAssetMetadata に返されます。クリエイティブを挿入するときは、creativeAssetMetadata.clickTags フィールドを使用してクリエイティブの clickTags フィールドを設定します。DISPLAY_IMAGE_GALLERY クリエイティブの場合は、このリストには必ずイメージ クリエイティブ アセットごとにエントリが 1 つだけあります。クリックタグは、clickTag.name フィールドと creativeAsset.assetIdentifier.name フィールドを照合することで、対応するクリエイティブ アセットと照合されます。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNER。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
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 フィールドの値と一致する必要があります。
commercialId string リーチとフリークエンシーを測定するためにクリエイティブに割り当てられた業界標準 ID です。INSTREAM_VIDEO_REDIRECT クリエイティブで有効です。
companionCreatives[] list インストリーム動画クリエイティブに割り当てられているコンパニオン クリエイティブのリストです。設定可能な値には、既存の Flash クリエイティブとイメージ クリエイティブの ID が含まれます。次のクリエイティブ タイプで有効です: すべての VPAID、すべての INSTREAM_AUDIOdynamicAssetSelection が false に設定されたすべての INSTREAM_VIDEO
compatibility[] list このクリエイティブに関連付けられている互換性です。読み取り専用のフィールドです。DISPLAYDISPLAY_INTERSTITIAL は、パソコン、モバイル デバイス、モバイルアプリでの、通常の広告とインタースティシャル広告のレンダリングをそれぞれ表します。APPAPP_INTERSTITIAL は、モバイルアプリでのレンダリングに使用します。これらの互換性を持つのは、既存のクリエイティブのみです。新しいクリエイティブには DISPLAY または DISPLAY_INTERSTITIAL のいずれかが割り当てられます。IN_STREAM_VIDEO は、VAST 規格で開発されたインストリーム動画広告でのレンダリングを表します。IN_STREAM_AUDIO は、VAST 規格で開発されたインストリーム オーディオ広告でのレンダリングを表します。すべてのクリエイティブ タイプで有効です。

設定可能な値は次のとおりです。
  • "APP"
  • "APP_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
  • "IN_STREAM_AUDIO"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
convertFlashToHtml5 boolean クリエイティブに関連付けられている Flash アセットを自動的に HTML5 に変換する必要があるかどうかを示します。このフラグはデフォルトで有効になっていますが、このクリエイティブで HTML5 アセットをシステムに生成、使用させたくない場合は無効にできます。次のクリエイティブ タイプで有効です: FLASH_INPAGE。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
counterCustomEvents[] list クリエイティブに設定されているカウンタ イベントのリストです。DISPLAY_IMAGE_GALLERY クリエイティブの場合は、読み取り専用で、clickTags から自動生成されます。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERY、すべての RICH_MEDIA、すべての VPAID
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 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
creativeAssetSelection nested object dynamicAssetSelection が true の場合は必須です。
creativeAssetSelection.defaultAssetId long creativeAssets[].id です。必ずこのクリエイティブの親アセットの 1 つを参照し、どのルールにも一致しない場合に配信されます。必須のフィールドです。
creativeAssetSelection.rules[] list どのアセットを閲覧者に配信するかを決めるルールです。ルールの評価は、このリストに保存されている順序で行われます。少なくとも 1 つのルールが含まれている必要があります。INSTREAM_VIDEO クリエイティブで有効です。
creativeAssetSelection.rules[].assetId long creativeAssets[].id です。このクリエイティブの親アセットの 1 つを参照します。必須のフィールドです。
creativeAssetSelection.rules[].name string このルールのわかりやすい名前です。必須のフィールドです。
creativeAssetSelection.rules[].targetingTemplateId long ターゲティング テンプレート ID です。ターゲティング テンプレートのターゲティングを使用して、このアセットを配信するかどうかが決定されます。必須のフィールドです。
creativeAssets[] list クリエイティブに関連付けられているアセットです。次にあげる以外のクリエイティブ タイプで有効です: INTERNAL_REDIRECTINTERSTITIAL_INTERNAL_REDIRECTREDIRECT
creativeAssets[].actionScript3 boolean ActionScript3 が Flash アセットに対して有効になっているかどうかを示します。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: FLASH_INPAGE。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
creativeAssets[].active boolean 動画アセットまたは音声アセットがアクティブかどうかを示します。VPAID_NON_LINEAR_VIDEO アセット用の読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].additionalSizes[] list このクリエイティブ アセットに関連付けられている追加のサイズです。GWD などの互換性のあるソフトウェアで生成された HTML5 アセットでは、このクリエイティブ アセットのレンダリングで、より多くのサイズがサポートされます。
creativeAssets[].alignment string アセットの可能な配置です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL

設定可能な値は次のとおりです。
  • "ALIGNMENT_BOTTOM"
  • "ALIGNMENT_LEFT"
  • "ALIGNMENT_RIGHT"
  • "ALIGNMENT_TOP"
creativeAssets[].artworkType string リッチメディア クリエイティブのアートワーク タイプです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
creativeAssets[].assetIdentifier nested object このアセットの ID です。クリエイティブ アセットの挿入オペレーション中に返される ID と同じです。必須のフィールドです。次にあげる以外のクリエイティブ タイプで有効です: すべての REDIRECTTRACKING_TEXT
creativeAssets[].assetIdentifier.name string クリエイティブ アセットの名前です。アセットを挿入する際には必須のフィールドです。挿入後、この assetIdentifier はアップロードされたアセットの識別に使用されます。名前に使用できるのは英数字と「.-_ 」のいずれかです。空白文字は使用できます。
creativeAssets[].assetIdentifier.type string アップロードするアセットのタイプです。必須のフィールドです。新しいアップロードでは、FLASHIMAGE がサポート対象外になりました。画像アセットには HTML_IMAGE を使用してください。

設定可能な値は次のとおりです。
  • "AUDIO"
  • "FLASH"
  • "HTML"
  • "HTML_IMAGE"
  • "IMAGE"
  • "VIDEO"
creativeAssets[].audioBitRate integer 音声ストリームのビットレート(kbps)です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].audioSampleRate integer 音声のサンプル ビットレート(ヘルツ)です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].backupImageExit nested object 代替画像に設定された Exit イベントです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].backupImageExit.advertiserCustomEventId long Reporting と Data Transfer が使用する、このイベントの一意の ID です。読み取り専用のフィールドです。
creativeAssets[].backupImageExit.advertiserCustomEventName string ユーザーが入力したイベントの名前です。
creativeAssets[].backupImageExit.advertiserCustomEventType string イベントのタイプ。読み取り専用のフィールドです。

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

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

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

設定可能な値は次のとおりです。
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
creativeAssets[].backupImageExit.videoReportingId string 動画レポート ID。1 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
creativeAssets[].bitRate integer 検出された音声アセットまたは動画アセットのビットレートです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].childAssetType string リッチメディアの子アセットのタイプです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての VPAID

設定可能な値は次のとおりです。
  • "CHILD_ASSET_TYPE_DATA"
  • "CHILD_ASSET_TYPE_FLASH"
  • "CHILD_ASSET_TYPE_IMAGE"
  • "CHILD_ASSET_TYPE_VIDEO"
creativeAssets[].collapsedSize nested object 折りたたまれたときのアセットのサイズです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID。また、displayTypeASSET_DISPLAY_TYPE_EXPANDING または ASSET_DISPLAY_TYPE_PEEL_DOWN であるアセットで有効です。
creativeAssets[].companionCreativeIds[] list インストリーム動画クリエイティブ アセットに割り当てられているコンパニオン クリエイティブのリストです。設定可能な値には、既存の Flash クリエイティブとイメージ クリエイティブの ID が含まれます。dynamicAssetSelection が true に設定された INSTREAM_VIDEO クリエイティブ タイプで有効です。
creativeAssets[].customStartTimeValue integer アセットを表示するカスタムの開始時間(秒単位)です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA0 以上の値を指定する必要があります。
creativeAssets[].detectedFeatures[] list キャンペーン マネージャーで検出されるクリエイティブ アセットの機能の依存関係のリスト。機能の依存関係とは、HTML5 クリエイティブを正常に表示するためにブラウザがサポートしている必要がある機能のことです。自動生成される読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: HTML5_BANNER。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
creativeAssets[].displayType string リッチメディア アセットのタイプです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "ASSET_DISPLAY_TYPE_BACKDROP"
  • "ASSET_DISPLAY_TYPE_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLOATING"
  • "ASSET_DISPLAY_TYPE_INPAGE"
  • "ASSET_DISPLAY_TYPE_OVERLAY"
  • "ASSET_DISPLAY_TYPE_PEEL_DOWN"
  • "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
  • "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
creativeAssets[].duration integer アセットが表示される長さ(秒)です。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEOVPAID_LINEAR_VIDEO1 以上の値を指定する必要があります。
creativeAssets[].durationType string アセットが表示される時間のタイプです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "ASSET_DURATION_TYPE_AUTO"
  • "ASSET_DURATION_TYPE_CUSTOM"
  • "ASSET_DURATION_TYPE_NONE"
creativeAssets[].expandedDimension nested object 検出された動画アセットのエキスパンド サイズです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_VIDEO、すべての VPAID
creativeAssets[].fileSize long このクリエイティブ アセットに関連付けられているファイルサイズです。読み取り専用のフィールドです。次にあげる以外のクリエイティブ タイプで有効です: すべての REDIRECTTRACKING_TEXT
creativeAssets[].flashVersion integer アセットの Flash バージョンです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: FLASH_INPAGE、すべての RICH_MEDIA、すべての VPAID。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
creativeAssets[].frameRate float 動画アセットの動画フレームレート(フレーム/秒)です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_VIDEO、すべての VPAID
creativeAssets[].hideFlashObjects boolean アセットの Flash オブジェクト フラグを非表示にするかどうかを示します。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].hideSelectionBoxes boolean アセットの選択ボックスのフラグを非表示にするかどうかを示します。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].horizontallyLocked boolean アセットが水平方向にロックされているかどうかを示します。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].id long このクリエイティブ アセットの数値 ID です。必須フィールドです。変更しないでください。次にあげる以外のクリエイティブ タイプで有効です: すべての REDIRECTTRACKING_TEXT
creativeAssets[].idDimensionValue nested object アセットの ID のディメンション値です。自動生成される読み取り専用のフィールドです。
creativeAssets[].mediaDuration float 検出された音声アセットまたは動画アセットの長さです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].mimeType string 検出された音声アセットまたは動画アセットの MIME タイプです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEO、すべての VPAID
creativeAssets[].offset nested object 折りたたみモードになっているアセットのオフセット位置です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID。また、displayTypeASSET_DISPLAY_TYPE_EXPANDING または ASSET_DISPLAY_TYPE_PEEL_DOWN であるアセットでのみ有効です。
creativeAssets[].offset.left integer アセットまたはウィンドウの左端からのオフセット距離です。
creativeAssets[].offset.top integer アセットまたはウィンドウの上端からのオフセット距離です。
creativeAssets[].orientation string 動画アセットの向きです。自動生成される読み取り専用のフィールドです。

設定可能な値は次のとおりです。
  • "LANDSCAPE"
  • "PORTRAIT"
  • "SQUARE"
creativeAssets[].originalBackup boolean 代替アセットが元からのものか、キャンペーン マネージャーでユーザーが変更したものかを示します。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].politeLoad boolean このアセットがポライトロード アセットとして使用されるかどうかを示します。
creativeAssets[].position nested object アセットのオフセット位置です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].position.left integer アセットまたはウィンドウの左端からのオフセット距離です。
creativeAssets[].position.top integer アセットまたはウィンドウの上端からのオフセット距離です。
creativeAssets[].positionLeftUnit string アセットの左オフセットの単位です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
creativeAssets[].positionTopUnit string アセットの上オフセットの単位です。アセット displayTypeASSET_DISPLAY_TYPE_OVERLAY の場合、読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
creativeAssets[].progressiveServingUrl string 動画アセットのプログレッシブ URL です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_VIDEO、すべての VPAID
creativeAssets[].pushdown boolean アセットが他のコンテンツをプッシュダウンするかどうかを示します。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA。また、アセット オフセットが 0 で、collapsedSize.widthsize.width と一致し、collapsedSize.heightsize.height より小さい場合にのみ有効です。
creativeAssets[].pushdownDuration float アセットのプッシュダウン時間(秒)です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA。また、アセットの pushdown フィールドが true で、オフセットが 0、collapsedSize.widthsize.width と一致し、collapsedSize.heightsize.height より小さい場合にのみ有効です。設定可能な値は 09.99 です。
creativeAssets[].role string クリエイティブに関連したアセットの役割です。次にあげる以外のクリエイティブ タイプで有効です: すべての REDIRECTTRACKING_TEXT。必須のフィールドです。

PRIMARY は、DISPLAYFLASH_INPAGEHTML5_BANNERIMAGEDISPLAY_IMAGE_GALLERY、すべての RICH_MEDIA(複数のメインアセットを含む場合があります)、すべての VPAID のクリエイティブで有効です。

BACKUP_IMAGE は、FLASH_INPAGEHTML5_BANNERall RICH_MEDIA、すべての VPAID のクリエイティブで有効です。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。

ADDITIONAL_IMAGEADDITIONAL_FLASH は、FLASH_INPAGE クリエイティブで有効です。

OTHER は、スタジオがアップロードしたアセットなど、キャンペーン マネージャー以外のソースからのアセットを表します。すべての RICH_MEDIA クリエイティブ、すべての VPAID クリエイティブで有効です。

PARENT_VIDEO は、キャンペーン マネージャーでユーザーがアップロードした動画を表します。INSTREAM_VIDEO クリエイティブと VPAID_LINEAR_VIDEO クリエイティブで有効です。

TRANSCODED_VIDEO は、キャンペーン マネージャーが PARENT_VIDEO アセットからコード変換した動画を表します。INSTREAM_VIDEO クリエイティブと VPAID_LINEAR_VIDEO クリエイティブで有効です。

ALTERNATE_VIDEO は、スタジオからの子アセット動画のキャンペーン マネージャーでの表現を表します。VPAID_LINEAR_VIDEO クリエイティブで有効です。これらをキャンペーン マネージャー内で追加、削除することはできません。

VPAID_LINEAR_VIDEO クリエイティブの場合、active のマークが付いた PARENT_VIDEO アセット、TRANSCODED_VIDEO アセット、ALTERNATE_VIDEO アセットが、VPAID クリエイティブを配信できない場合の代替となります。INSTREAM_VIDEO クリエイティブまたは VPAID_LINEAR_VIDEO クリエイティブの場合に追加、削除できるのは PARENT_VIDEO アセットのみです。

PARENT_AUDIO は、キャンペーン マネージャーでユーザーがアップロードした音声を表します。INSTREAM_AUDIO クリエイティブで有効です。

TRANSCODED_AUDIO は、キャンペーン マネージャーが PARENT_AUDIO アセットからコード変換した音声を表します。INSTREAM_AUDIO クリエイティブで有効です。



設定可能な値は次のとおりです。
  • "ADDITIONAL_FLASH"
  • "ADDITIONAL_IMAGE"
  • "ALTERNATE_VIDEO"
  • "BACKUP_IMAGE"
  • "OTHER"
  • "PARENT_AUDIO"
  • "PARENT_VIDEO"
  • "PRIMARY"
  • "TRANSCODED_AUDIO"
  • "TRANSCODED_VIDEO"
creativeAssets[].size nested object このクリエイティブ アセットに関連付けられているサイズです。有効な場合は必須のフィールドです。ただし、IMAGE クリエイティブと FLASH_INPAGE クリエイティブの場合、空白にすると関連付けられた画像アセットの実際のサイズが自動的に設定されます。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNERIMAGE、すべての RICH_MEDIA。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
creativeAssets[].sslCompliant boolean アセットが SSL 対応かどうかを示します。読み取り専用のフィールドです。次にあげる以外のクリエイティブ タイプで有効です: すべての REDIRECTTRACKING_TEXT
creativeAssets[].startTimeType string アセットが表示されるまでの最初の待機時間のタイプです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA

設定可能な値は次のとおりです。
  • "ASSET_START_TIME_TYPE_CUSTOM"
  • "ASSET_START_TIME_TYPE_NONE"
creativeAssets[].streamingServingUrl string 動画アセットのストリーミング URL です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_VIDEO、すべての VPAID
creativeAssets[].transparency boolean アセットが透明かどうかを示します。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA。また、HTML5 アセットでのみ有効です。
creativeAssets[].verticallyLocked boolean アセットが垂直方向にロックされているかどうかを示します。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
creativeAssets[].windowMode string Flash アセットのウィンドウ モード オプションです。次のクリエイティブ タイプで有効です: FLASH_INPAGERICH_MEDIA_DISPLAY_EXPANDINGRICH_MEDIA_IM_EXPANDRICH_MEDIA_DISPLAY_BANNERRICH_MEDIA_INPAGE_FLOATING

設定可能な値は次のとおりです。
  • "OPAQUE"
  • "TRANSPARENT"
  • "WINDOW"
creativeAssets[].zIndex integer アセットの zIndex 値です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA。また、displayTypeASSET_DISPLAY_TYPE_INPAGE または ASSET_DISPLAY_TYPE_OVERLAY「以外」であるアセットでのみ有効です。設定可能な値は -999999999999999999 です。
creativeAssets[].zipFilename string zip ファイルのファイル名です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: HTML5_BANNER
creativeAssets[].zipFilesize string zip ファイルのサイズです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: HTML5_BANNER
creativeFieldAssignments[] list このクリエイティブのクリエイティブ フィールドの割り当てです。すべてのクリエイティブ タイプで有効です。
creativeFieldAssignments[].creativeFieldId long クリエイティブ フィールドの ID です。
creativeFieldAssignments[].creativeFieldValueId long クリエイティブ フィールド値の ID です。
customKeyValues[] list リッチメディア クリエイティブのカスタムの Key-Value です。Key-Value を使用すると、広告主に問い合わせることなく、サイトに掲載されるリッチメディア広告のクリエイティブ設定をカスタマイズできます。クリエイティブの外観や機能を動的に変更することもできます。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
dynamicAssetSelection boolean これを true に設定すると、ルールを使用してこのクリエイティブの個々のアセットをターゲットとできます。true に設定した場合、creativeAssetSelection を設定する必要があります。これはアセットレベルのコンパニオンも管理します。これが true の場合、コンパニオン クリエイティブをクリエイティブ アセットに割り当てる必要があります。詳しくはこちらをご覧くださいINSTREAM_VIDEO クリエイティブで有効です。
exitCustomEvents[] list クリエイティブに設定されている Exit イベントのリストです。DISPLAY クリエイティブと DISPLAY_IMAGE_GALLERY クリエイティブの場合、読み取り専用で、clickTags から自動生成されます。DISPLAY の場合、backupImageReportingLabel からイベントも作成されます。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERY、すべての RICH_MEDIA、すべての VPAID。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
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 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
fsCommand nested object このクリエイティブの OpenWindow FSCommand です。これにより、SWF ファイルが Flash Player または Flash Player をホストするプログラム(ウェブブラウザなど)とやり取りできるようになります。これは、allowScriptAccess フィールドが true の場合にのみトリガーされます。次のクリエイティブ タイプで有効です: FLASH_INPAGE
fsCommand.left integer ブラウザの左端からの距離です。positionOption が DISTANCE_FROM_TOP_LEFT_CORNER の場合に有効です。
fsCommand.positionOption string ウィンドウが開くブラウザ内での位置です。

設定可能な値は次のとおりです。
  • "CENTERED"
  • "DISTANCE_FROM_TOP_LEFT_CORNER"
fsCommand.top integer ブラウザの上端からの距離です。positionOption が DISTANCE_FROM_TOP_LEFT_CORNER の場合に有効です。
fsCommand.windowHeight integer ウィンドウの高さです。
fsCommand.windowWidth integer ウィンドウの幅です。
htmlCode string クリエイティブの HTML コードです。有効な場合は必須のフィールドです。htmlCodeLocked が true の場合は無視されます。次のクリエイティブ タイプで有効です: すべての CUSTOMFLASH_INPAGEHTML5_BANNER、すべての RICH_MEDIA
htmlCodeLocked boolean HTML コードがキャンペーン マネージャーによって生成されたか、手動で入力されたかを示します。true に設定すると、htmlCode への変更が無視されます。次のクリエイティブ タイプで有効です: FLASH_INPAGEHTML5_BANNER
id long このクリエイティブの ID です。自動生成される読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
idDimensionValue nested object このクリエイティブの ID のディメンション値です。読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
kind string リソースの種類を示します。値は固定文字列 "dfareporting#creative" です。
lastModifiedInfo nested object クリエイティブの最終変更情報です。読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
lastModifiedInfo.time long 最終変更のタイムスタンプです(エポックからのミリ秒)。
latestTraffickedCreativeId long リッチメディア クリエイティブと VPAID クリエイティブに関連付けられている、スタジオで入稿された最新のクリエイティブ ID です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
mediaDescription string オーディオ広告または動画広告の説明です。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEOINSTREAM_AUDIO、すべての VPAID
mediaDuration float クリエイティブの音声または動画の長さです(秒単位)。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: INSTREAM_VIDEOINSTREAM_AUDIO、すべての RICH_MEDIA、すべての VPAID
name string クリエイティブの名前です。必須のフィールドです。256 文字未満で指定してください。すべてのクリエイティブ タイプで有効です。
obaIcon nested object クリエイティブに追加するオンライン行動ターゲティング広告アイコンです。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEO
obaIcon.iconClickThroughUrl string OBA アイコンがクリックされたときにリダイレクトされる URL です。
obaIcon.iconClickTrackingUrl string OBA アイコンがクリックされたときにクリックをトラッキングする URL。
obaIcon.iconViewTrackingUrl string OBA アイコンがクリックされたときにビューをトラッキングする URL。
obaIcon.program string アイコンがサポートする業界プログラムを識別します(AdChoices など)。
obaIcon.resourceUrl string OBA アイコンのリソース URL。キャンペーン マネージャーでは、画像と JavaScript のアイコンのみをサポートしています。詳しくはこちらのリンクをご覧ください
obaIcon.size nested object OBA アイコンのサイズ。
obaIcon.xPosition string OBA アイコンの x 座標の位置。設定可能な値は left または right です。
obaIcon.yPosition string OBA アイコンの y 座標の位置。設定可能な値は top または bottom です。
overrideCss string リッチメディア クリエイティブの CSS 値をオーバーライドします。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
progressOffset nested object 動画の再生を開始してから再生回数をカウントするまでの時間です。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEO
progressOffset.offsetPercentage integer 再生時間(動画の長さに対する割合)です。offsetSeconds を設定した場合は設定しないでください。設定可能な値は 0100 です。
progressOffset.offsetSeconds integer 再生秒数。offsetPercentage を設定した場合は設定しないでください。設定可能な値は 086399 です。
redirectUrl string ホストされる画像、ホストされる動画、または別の広告タグの URL です。INSTREAM_VIDEO_REDIRECT クリエイティブの場合、インストリーム動画のリダイレクト URL です。VAST(Video Ad Serving Template)広告レスポンスの規格では、別の VAST 2.0 または 3.0 呼び出しへのリダイレクト リンクを使用できます。有効な場合は必須のフィールドです。次のクリエイティブ タイプで有効です: DISPLAY_REDIRECTINTERNAL_REDIRECTINTERSTITIAL_INTERNAL_REDIRECTINSTREAM_VIDEO_REDIRECT
renderingId long 現在のレンダリング バージョンの ID です。読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
renderingIdDimensionValue nested object このクリエイティブのレンダリング ID のディメンション値です。読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
requiredFlashPluginVersion string このクリエイティブに必要な Flash プラグインの最小バージョンです。たとえば、11.2.202.235 などです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
requiredFlashVersion integer スタジオが算出した、このクリエイティブの内部 Flash バージョンです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: FLASH_INPAGE、すべての RICH_MEDIA、すべての VPAID。メインアセットのタイプが HTML_IMAGE でない場合、DISPLAY で有効です。
size nested object このクリエイティブに関連付けられているサイズです。クリエイティブを挿入または更新するときに、サイズ ID フィールドまたはサイズの幅と高さのフィールドを使用できます。有効な場合は必須のフィールドです。ただし、IMAGE クリエイティブ、FLASH_INPAGE クリエイティブ、メインアセットのタイプが HTML_IMAGEDISPLAY クリエイティブの場合は、空白にすると関連付けられた画像アセットの実際のサイズが自動的に設定されます。次のクリエイティブ タイプで有効です: DISPLAYDISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNERIMAGE、すべての RICH_MEDIA
skipOffset nested object 動画の再生を開始してからスキップボタンを表示するまでの時間です。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEO
skipOffset.offsetPercentage integer 再生時間(動画の長さに対する割合)です。offsetSeconds を設定した場合は設定しないでください。設定可能な値は 0100 です。
skipOffset.offsetSeconds integer 再生秒数。offsetPercentage を設定した場合は設定しないでください。設定可能な値は 086399 です。
skippable boolean ユーザーがクリエイティブをスキップできるかどうかを示します。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEO、すべての VPAID
sslCompliant boolean クリエイティブが SSL 対応かどうかを示します。読み取り専用のフィールドです。すべてのクリエイティブ タイプで有効です。
sslOverride boolean システム スキャンでクリエイティブが SSL 非対応とされた場合でも、SSL 対応として扱うかどうかを示します。すべてのクリエイティブ タイプで有効です。
studioAdvertiserId long リッチメディア クリエイティブと VPAID クリエイティブに関連付けられている、スタジオの広告主 ID です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
studioCreativeId long リッチメディア クリエイティブと VPAID クリエイティブに関連付けられている、スタジオのクリエイティブ ID です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
studioTraffickedCreativeId long リッチメディア クリエイティブと VPAID クリエイティブに関連付けられている、スタジオで入稿されたクリエイティブ ID です。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
subaccountId long このクリエイティブのサブアカウント ID です。未設定の場合、挿入と更新の両方のオペレーションで自動生成されます。すべてのクリエイティブ タイプで有効です。
thirdPartyBackupImageImpressionsUrl string 代替画像のインプレッションの記録に使用する第三者 URL です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
thirdPartyRichMediaImpressionsUrl string リッチメディアのインプレッションの記録に使用する第三者 URL です。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA
thirdPartyUrls[] list インストリーム クリエイティブ イベントをトラッキングするための第三者 URL です。次のクリエイティブ タイプで有効です: すべての INSTREAM_VIDEO、すべての INSTREAM_AUDIO、すべての VPAID
thirdPartyUrls[].thirdPartyUrlType string インストリーム動画クリエイティブとインストリーム オーディオ クリエイティブの第三者 URL タイプです。

設定可能な値は次のとおりです。
  • "CLICK_TRACKING"
  • "IMPRESSION"
  • "RICH_MEDIA_BACKUP_IMPRESSION"
  • "RICH_MEDIA_IMPRESSION"
  • "RICH_MEDIA_RM_IMPRESSION"
  • "SURVEY"
  • "VIDEO_COMPLETE"
  • "VIDEO_CUSTOM"
  • "VIDEO_FIRST_QUARTILE"
  • "VIDEO_FULLSCREEN"
  • "VIDEO_MIDPOINT"
  • "VIDEO_MUTE"
  • "VIDEO_PAUSE"
  • "VIDEO_PROGRESS"
  • "VIDEO_REWIND"
  • "VIDEO_SKIP"
  • "VIDEO_START"
  • "VIDEO_STOP"
  • "VIDEO_THIRD_QUARTILE"
thirdPartyUrls[].url string 指定した第三者 URL タイプの URL です。
timerCustomEvents[] list クリエイティブに設定されているタイマー イベントのリストです。DISPLAY_IMAGE_GALLERY クリエイティブの場合は、読み取り専用で、clickTags から自動生成されます。次のクリエイティブ タイプで有効です: DISPLAY_IMAGE_GALLERY、すべての RICH_MEDIA、すべての VPAID。メインアセットが HTML_IMAGE でない場合、DISPLAY で有効です。
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 つのクリエイティブ内の複数の動画を区別するために使用されます。読み取り専用のフィールドです。
totalFileSize long すべてのクリエイティブ アセットの合計サイズです。読み取り専用のフィールドです。次のクリエイティブ タイプで有効です: すべての RICH_MEDIA、すべての VPAID
type string このクリエイティブのタイプです。必須のフィールドです。すべてのクリエイティブ タイプで有効です。

注: FLASH_INPAGEHTML5_BANNERIMAGE は既存のクリエイティブでのみ使用されます。新しいクリエイティブでは、これらのタイプの代わりに DISPLAY を使用してください。

設定可能な値は次のとおりです。
  • "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
  • "CUSTOM_DISPLAY"
  • "CUSTOM_DISPLAY_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_IMAGE_GALLERY"
  • "DISPLAY_REDIRECT"
  • "FLASH_INPAGE"
  • "HTML5_BANNER"
  • "IMAGE"
  • "INSTREAM_AUDIO"
  • "INSTREAM_VIDEO"
  • "INSTREAM_VIDEO_REDIRECT"
  • "INTERNAL_REDIRECT"
  • "INTERSTITIAL_INTERNAL_REDIRECT"
  • "RICH_MEDIA_DISPLAY_BANNER"
  • "RICH_MEDIA_DISPLAY_EXPANDING"
  • "RICH_MEDIA_DISPLAY_INTERSTITIAL"
  • "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL"
  • "RICH_MEDIA_IM_EXPAND"
  • "RICH_MEDIA_INPAGE_FLOATING"
  • "RICH_MEDIA_MOBILE_IN_APP"
  • "RICH_MEDIA_PEEL_DOWN"
  • "TRACKING_TEXT"
  • "VPAID_LINEAR_VIDEO"
  • "VPAID_NON_LINEAR_VIDEO"
universalAdId nested object VAST 4.0 仕様のユニバーサル広告 ID です。次のクリエイティブ タイプで有効です: INSTREAM_AUDIOINSTREAM_VIDEOVPAID
universalAdId.registry string 広告 ID 値に使用されるレジストリです。

設定可能な値は次のとおりです。
  • "AD_ID.ORG"
  • "CLEARCAST"
  • "DCM"
  • "OTHER"
universalAdId.value string このクリエイティブの ID 値です。英数字と次の記号のみが有効です: 「_/\-」。最大 64 文字です。registryDCM の場合、読み取り専用です。
version integer バージョン番号は、クリエイティブのさまざまなバージョンを区別してレポートに記録する場合に役に立ちます。バージョン番号は、挿入オペレーション中に自動生成され、常に 1 から始まります。トラッキング クリエイティブの場合、バージョンを進めることはできず、常に 1 となります。他のクリエイティブ タイプの場合、更新オペレーション中にバージョンを 1 つだけ進めることができます。また、リッチメディア クリエイティブ統合が行われると、バージョンが自動的に 1 つ進みます。すべてのクリエイティブ タイプで有効です。

メソッド

get
ID により、1 つのクリエイティブを取得します。
insert
新しいクリエイティブを挿入します。
list
クリエイティブのリストを取得します。結果をフィルタできます。このメソッドはページングをサポートします。
patch
既存のクリエイティブを更新します。このメソッドはパッチのセマンティクスをサポートしています。
update
既存のクリエイティブを更新します。