REST Resource: advertisers.creatives

{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}

string

出力専用。クリエイティブのリソース名。

string (int64 format)

出力専用。クリエイティブが属する広告主の一意の ID。

string (int64 format)

出力専用。クリエイティブの一意の ID です。システムによって割り当てられます。

string (int64 format)

出力専用。クリエイティブに関連付けられているキャンペーン マネージャー 360 プレースメントの一意の ID。このフィールドは、キャンペーン マネージャーから同期されたクリエイティブにのみ適用されます。

string

必須。クリエイティブの表示名。

UTF-8 でエンコードし、最大サイズは 240 バイトにする必要があります。

enum (EntityStatus)

必須。クリエイティブを配信できるかどうかを制御します。

次の値が利用できます。

• ENTITY_STATUS_ACTIVE
• ENTITY_STATUS_ARCHIVED
• ENTITY_STATUS_PAUSED

string (Timestamp format)

出力専用。ユーザーまたはシステム（クリエイティブの審査など）によってクリエイティブが最後に更新されたときのタイムスタンプです。システムによって割り当てられます。

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

string (Timestamp format)

出力専用。クリエイティブが作成されたときのタイムスタンプ。システムによって割り当てられます。

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

enum (CreativeType)

必須。変更不可。クリエイティブのタイプ。

enum (HostingSource)

必須。クリエイティブがホストされている場所を示します。

boolean

出力専用。クリエイティブが動的かどうかを示します。

object (Dimensions)

必須。クリエイティブのメイン ディメンション。すべてのクリエイティブ タイプで有効です。creativeType が次のいずれかの場合、widthPixels と heightPixels の値はデフォルトで 0 になります。

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO

object (Dimensions)

その他のディメンション。creativeType が次のいずれかの場合に有効です。

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE
• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_LIGHTBOX
• CREATIVE_TYPE_PUBLISHER_HOSTED

このフィールドを指定する場合は、widthPixels と heightPixels の両方が必須で、0 以上である必要があります。

string (Duration format)

出力専用。クリエイティブのメディア再生時間。creativeType が次のいずれかの場合に有効です。

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_PUBLISHER_HOSTED

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

enum (CreativeAttribute)

出力専用。システムによって生成されたクリエイティブの属性のリスト。

object (ReviewStatusInfo)

出力専用。クリエイティブの審査プロセスの現在のステータス。

object (AssetAssociation)

必須。このクリエイティブに関連付けられているアセット。

object (ExitEvent)

必須。このクリエイティブの終了イベントです。exit（クリックタグとも呼ばれます）とはクリエイティブ内の任意の領域で、ユーザーがクリックまたはタップすると広告主のランディング ページが開かれます。どのクリエイティブにも、少なくとも 1 つの exit を含める必要があります。exit は、次のいずれかの方法でクリエイティブに追加できます。

• Google Web Designer のタップ領域を使用する
• 「logcat」という JavaScript 変数を定義します。
• リッチメディア フォーマットで exit をトラッキングするには、イネーブラー（enable.exit()）を使用します。

object (TimerEvent)

リッチメディア クリエイティブのタイマー カスタム イベント。タイマーは、ユーザーがリッチメディア クリエイティブの特定の部分を表示して操作した時間をトラッキングします。1 つのクリエイティブに複数のタイマー イベントを組み込んで、個々に時間を測定することもできます。画像アセットのみを含むクリエイティブの場合は、空白のままにするか、設定しないでください。

object (CounterEvent)

リッチメディア クリエイティブのカウンタ イベントです。カウンタは、ユーザーがリッチメディア クリエイティブの任意の部分で特定の操作（マウスオーバー、マウスアウト、クリック、タップ、データの読み込み、キーボード入力など）を行った回数をトラッキングします。クリエイティブでキャプチャできるイベントであればカウンタで記録できます。画像アセットのみを含むクリエイティブの場合は、空白のままにするか、設定しないでください。

string

クリエイティブ タグに追加する第三者の HTML トラッキング タグ。

string

このクリエイティブを外部システムにリンクするために使用される ID 情報。UTF-8 でエンコードし、長さは 10,000 文字以下にする必要があります。

string

このクリエイティブに関するユーザーのメモ。UTF-8 でエンコードし、長さは 20,000 文字以下にする必要があります。

boolean

Integral Ad Science（IAS）のキャンペーン モニタリングが有効かどうかを示します。クリエイティブでこの機能を有効にするには、Advertiser.creative_config.ias_client_id が IAS クライアント ID に設定されていることを確認してください。

string (int64 format)

動画クリエイティブのコンパニオン クリエイティブの ID。

既存のディスプレイ クリエイティブ（画像または HTML5 アセット）を、サイト運営者の動画プレーヤーの周囲に表示するクリエイティブとして割り当てることができます。コンパニオンは動画の再生中は動画プレーヤーの周囲に表示され、動画の終了後もそのまま表示されます。

クリエイティブに additional dimensions が含まれていると、コンパニオン クリエイティブにはできません。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

ユーザーが動画クリエイティブをスキップできるかどうか。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

動画を再生してからスキップボタンを表示するまでの時間。

skippable が true の場合、このフィールドは必須です。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

動画の再生を開始してから再生回数をカウントするまでの時間です。

skippable が true の場合、このフィールドは必須です。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO

object (UniversalAdId)

省略可。レジストリによって提供される任意のクリエイティブ ID。すべてのプラットフォームで一意です。

ユニバーサル広告 ID は VAST 4.0 標準の一部です。クリエイティブの作成後に変更できます。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO

object (ThirdPartyUrl)

動画クリエイティブに対するインタラクションをトラッキングするための、第三者からの URL のトラッキング。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO

object (Transcode)

出力専用。音声 / 動画のコード変換。

ディスプレイ &ビデオ 360 では、メインアセットを複数の代替バージョンにコード変換されます。代替バージョンは、ファイル形式やプロパティ（解像度、音声ビットレート、動画ビットレート）の異なる複数の代替バージョンです。それぞれが特定の動画プレーヤーや帯域幅向けに設計されています。

複数のトランスコードがあることで、サイト運営者のシステムがインプレッションごとに動画のアセットを選択する際の選択肢が増え、閲覧者の接続速度や画面サイズに合わせて適切なファイルを配信できるようになります。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_AUDIO

string

データ分析プロバイダまたは第三者広告技術ベンダーのトラッキング URL。

URL は https で始まる必要があります（SSL 準拠が不要な広告枠を除く）。URL でマクロを使用する場合は、ディスプレイ＆ビデオ 360 でサポートされているマクロのみを使用してください。

指定できるのは標準の URL のみで、IMG タグや SCRIPT タグは使用できません。

このフィールドは、次の creativeType でのみ書き込み可能です。

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

string

対応している第三者ベリフィケーション プロバイダ（ComScore、DoubleVerify、IAS、Moat）の JavaScript 測定 URL。HTML スクリプトタグはサポートされていません。

このフィールドは、次の creativeType でのみ書き込み可能です。

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

object (CmTrackingAd)

クリエイティブに関連付けられているキャンペーン マネージャー 360 のトラッキング広告。

キャンペーン マネージャー 360 と第三者広告配信の両方を使用する広告主が作成した場合、次の creativeType では省略可:

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE

他のケースでは出力のみ。

object (ObaIcon)

動画クリエイティブの OBA アイコンを指定します。

このフィールドは、次の creativeType でのみサポートされています。

• CREATIVE_TYPE_VIDEO

string

省略可。クリエイティブに使用された元の第三者タグ。

必須で、第三者タグのクリエイティブに対してのみ有効です。

第三者タグ クリエイティブは、次の hostingSource を使用するクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせる:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

省略可。クリエイティブに MRAID（Mobile Rich Media Ad Interface Definitions システム）が必要であることを示します。

スワイプやタップなどのモバイル操作に反応するクリエイティブの場合は、この値を設定します。

省略可。第三者タグ クリエイティブでのみ有効です。

第三者タグ クリエイティブは、次の hostingSource を使用するクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

省略可。クリエイティブを正しくレンダリングするために HTML5 に依存していることを示します。

省略可。第三者タグ クリエイティブでのみ有効です。第三者タグ クリエイティブは、次の hostingSource を含むクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

省略可。アトリビューションの返信ピングの到着をクリエイティブが待機することを示します。

第三者広告サーバー パラメータと ${DC_DBM_TOKEN} マクロを含むキャンペーン マネージャー 360 トラッキング広告を使用している場合にのみ有効です。

（省略可）第三者タグ クリエイティブまたは第三者 VAST タグ クリエイティブにのみ有効です。

第三者タグ クリエイティブは、次の hostingSource を含むクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

第三者 VAST タグ クリエイティブは、次の hostingSource を含むクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

enum (ExpandingDirection)

省略可。クリエイティブの展開方向を指定します。

必須で、第三者の拡大表示クリエイティブにのみ有効です。

第三者エキスパンド クリエイティブは、次のホスト元のクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_EXPANDABLE

boolean

省略可。ホバーするとクリエイティブが自動的に展開されることを示します。

省略可。サードパーティの展開可能なクリエイティブでのみ有効です。第三者エキスパンド クリエイティブは、次のホスト元のクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせる:

• CREATIVE_TYPE_EXPANDABLE

string

省略可。第三者 VAST タグ クリエイティブの VAST タグの URL。

必須で、第三者 VAST タグ クリエイティブでのみ有効です。

第三者 VAST タグ クリエイティブは、次の hostingSource を含むクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

出力専用。第三者 VAST タグ クリエイティブに VPAID（Digital Video Player-Ad Interface）が必要であることを示します。

出力専用で、第三者の VAST タグ クリエイティブに対してのみ有効です。

第三者 VAST タグ クリエイティブは、次の hostingSource を含むクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせる:

• CREATIVE_TYPE_VIDEO

boolean

出力専用。第三者 VAST タグ クリエイティブで HTML5 動画のサポートが必須であることを示します。

出力専用で、第三者 VAST タグ クリエイティブでのみ有効です。

第三者 VAST タグ クリエイティブは、次の hostingSource を使用するクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_VIDEO

string (int64 format)

出力専用。このクリエイティブが関連付けられている広告申込情報の ID。

クリエイティブを広告申込情報に関連付けるには、代わりに LineItem.creative_ids を使用します。

boolean

出力専用。第三者オーディオ クリエイティブが MP3 に対応していることを示します。

出力専用。サードパーティのオーディオ クリエイティブでのみ有効です。

第三者オーディオ クリエイティブは、次の hostingSource を使用するクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_AUDIO

boolean

出力専用。サードパーティのオーディオ クリエイティブが OGG に対応していることを示します。

出力専用。サードパーティのオーディオ クリエイティブでのみ有効です。

第三者オーディオ クリエイティブは、次の hostingSource を持つクリエイティブです。

• HOSTING_SOURCE_THIRD_PARTY

次の creativeType と組み合わせます。

• CREATIVE_TYPE_AUDIO

{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}

enum (ApprovalStatus)

クリエイティブの配信開始に必要とされる基本的な承認についての状況を表します。creativeAndLandingPageReviewStatus と contentAndPolicyReviewStatus の概要。

enum (ReviewStatus)

クリエイティブとランディング ページの審査ステータス。

enum (ReviewStatus)

クリエイティブのコンテンツとポリシーの審査ステータス。

object (ExchangeReviewStatus)

クリエイティブのエクスチェンジの審査ステータス。

object (PublisherReviewStatus)

クリエイティブのパブリッシャー審査のステータス。

{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}

enum (Exchange)

クリエイティブを審査しているエクスチェンジ。

enum (ReviewStatus)

交換審査のステータス。

{
  "publisherName": string,
  "status": enum (ReviewStatus)
}

string

クリエイティブを審査するパブリッシャー。

enum (ReviewStatus)

パブリッシャーの審査のステータス。

{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}

object (Asset)

関連アセット。

enum (AssetRole)

クリエイティブにおけるこのアセットの役割。

{
  "mediaId": string,
  "content": string
}

string (int64 format)

アップロードされたアセットのメディア ID。これはアセットの一意の識別子です。この ID は、creatives.create などの他の API 呼び出しに渡して、アセットをクリエイティブに関連付けることができます。

メディア ID 空間は 2023 年 4 月 5 日に更新されました。2023 年 4 月 5 日より前にキャッシュに保存されたメディア ID を更新するには、関連するクリエイティブ リソースから新しいメディア ID を取得するか、アセットを再アップロードします。

string

アセットのコンテンツ。アップロードされたアセットの場合、コンテンツは配信パスです。

{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}

enum (ExitEventType)

必須。終了イベントのタイプ。

string

必須。exit イベントのリンク先 URL。これは、type が次のいずれかの場合に必要です。

• EXIT_EVENT_TYPE_DEFAULT
• EXIT_EVENT_TYPE_BACKUP

string

終了イベントのクリックタグの名前。

名前は 1 つのクリエイティブ内で一意である必要があります。

画像アセットのみを含むクリエイティブの場合は、空白のままにするか、設定しないでください。

string

レポートでこのイベントを識別するために使用する名前。画像アセットのみを含むクリエイティブの場合は、空のままにするか未設定のままにしてください。

{
  "name": string,
  "reportingName": string
}

string

必須。タイマー イベントの名前。

string

必須。レポートでこのタイマー イベントを識別するために使用される名前。

{
  "name": string,
  "reportingName": string
}

string

必須。カウンタ イベントの名前。

string

必須。レポートでこのカウンタ イベントを識別するために使用される名前。

{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}

string (int64 format)

音声または動画の長さに対するオフセット（パーセンテージ）。

string (int64 format)

音声または動画の開始からのオフセット（秒単位）。

{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}

string

一意のクリエイティブ ID。

enum (UniversalAdRegistry)

レジストリは、一意のクリエイティブ ID を提供します。

{
  "type": enum (ThirdPartyUrlType),
  "url": string
}

enum (ThirdPartyUrlType)

インタラクションの種類は、トラッキング URL でトラッキングする必要があります

string

インタラクションをトラッキングするために使用されるトラッキング URL。

https: で始まるパスまたはクエリ文字列を含む URL を指定します。例: https://www.example.com/path

{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}

string

トランスコードされたファイルの名前。

string

コード変換されたファイルの MIME タイプ。

boolean

コード変換が成功したかどうかを示します。

object (Dimensions)

コード変換された動画のサイズ。

string (int64 format)

コード変換された動画のコード変換ビットレート（kb/秒）。

number

トランスコードされた動画のフレームレート（フレーム / 秒）。

string (int64 format)

コード変換された動画の音声ストリームのビットレート、またはコード変換された音声のビットレート（kb/秒）。

string (int64 format)

トランスコードされた動画の音声ストリームのサンプルレート、またはトランスコードされた音声のサンプルレート（ヘルツ単位）。

string (int64 format)

トランスコードされたファイルのサイズ（バイト単位）。

{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}

string (int64 format)

キャンペーン マネージャー 360 のトラッキング広告のプレースメント ID。

string (int64 format)

キャンペーン マネージャー 360 のトラッキング広告のクリエイティブ ID。

string (int64 format)

キャンペーン マネージャー 360 のトラッキング広告の広告 ID。

{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}

string

OBA アイコン リソースの URL。

string

OBA アイコン リソースの MIME タイプ。

enum (ObaIconPosition)

クリエイティブ上の OBA アイコンの位置。

object (Dimensions)

OBA アイコンのサイズ。

string

OBA アイコンのプログラムです。（例:「AdChoices」）。

string

必須。OBA アイコンのランディング ページ URL。

次のドメインの URL のみが許可されます。

• https://info.evidon.com
• https://l.betrad.com

string

必須。OBA アイコンのクリック トラッキング URL です。

次のドメインの URL のみが許可されます。

• https://info.evidon.com
• https://l.betrad.com

string

必須。OBA アイコンのビュー トラッキング URL です。

次のドメインの URL のみが許可されます。

• https://info.evidon.com
• https://l.betrad.com