REST Resource: advertisers.creatives

リソース: Creative

単一のクリエイティブ。

JSON 表現 
{
  "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
}
フィールド
name

string

出力のみ。クリエイティブのリソース名。
advertiserId

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (EntityStatus)

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

次の値が利用できます。

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

enum (CreativeType)

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

enum (HostingSource)

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

boolean

出力のみ。クリエイティブがダイナミックかどうかを示します。
dimensions

object (Dimensions)

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

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

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 以上である必要があります。
mediaDuration

string (Duration format)

出力のみ。クリエイティブのメディア再生時間。creativeType が次のいずれかの場合に適用されます。

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

enum (CreativeAttribute)

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

object (ReviewStatusInfo)

出力のみ。クリエイティブの審査プロセスの現在のステータス。
assets[]

object (AssetAssociation)

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

object (ExitEvent)

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

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

object (TimerEvent)

リッチメディア クリエイティブのタイマー カスタム イベント。タイマーは、ユーザーがリッチメディア クリエイティブの特定部分を表示して操作した時間をトラッキングします。1 つのクリエイティブに複数のタイマー イベントを含めることができ、イベントはそれぞれ独立して計時されます。画像アセットのみを含むクリエイティブの場合は、空欄にするか未設定のままにしてください。
counterEvents[]

object (CounterEvent)

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

string

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

string

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

string

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

boolean

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

string (int64 format)

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

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

additional dimensions を含むクリエイティブは、コンパニオン クリエイティブにできません。

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

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

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

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

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

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

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

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

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

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

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

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

（省略可）すべてのプラットフォームにわたって一意の、レジストリにより指定されるクリエイティブ ID（省略可）。

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

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

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

第三者からのトラッキング URL。動画クリエイティブとのインタラクションをトラッキングします。

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

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

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

このようなコード変換により、パブリッシャーのシステムでは動画のインプレッションごとに多くの選択肢から選択できるようになり、視聴者の接続や画面サイズに応じて適切なファイルを確実に配信できるようになります。

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

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

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

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

標準の URL のみを使用できます。IMG タグや SCRIPT タグは使用できません。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

サポートされている第三者検証プロバイダ（ComScore、DoubleVerify、IAS、Moat）から提供された JavaScript 測定 URL。HTML スクリプトタグはサポートされていません。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

出力は他のケースのみが対象です。
obaIcon

object (ObaIcon)

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

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

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

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

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

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

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

クリエイティブがインタラクティビティ（スワイプやタップなど）にモバイル操作に依存している場合は、この設定を設定します。

オプションで、第三者タグのクリエイティブでのみ有効です。

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

（省略可）クリエイティブを正しく表示するために HTML5 を使用することを示します。

オプションで、第三者タグのクリエイティブでのみ有効です。第三者タグのクリエイティブは、次の hostingSource を持つクリエイティブです。

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

（省略可）クリエイティブがアトリビューション用の ping を返すのを待つことを示します。

第三者広告サーバー パラメータと ${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
expandingDirection

enum (ExpandingDirection)

（省略可）クリエイティブのエキスパンド方向を指定します。

第三者のエキスパンド クリエイティブでのみ必須です。

第三者のエキスパンド クリエイティブは、次のホスティング ソースを使用するクリエイティブです。

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

（省略可）カーソルを合わせるとクリエイティブが自動的に拡張されることを示します。

オプションで、第三者のエキスパンド クリエイティブでのみ有効です。第三者のエキスパンド クリエイティブは、次のホスティング ソースを使用するクリエイティブです。

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

（省略可）第三者 VAST タグのクリエイティブで使用する VAST タグの URL。

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

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

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

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

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

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

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

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

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

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

boolean

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

出力のみで、第三者のオーディオ クリエイティブでのみ有効です。

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

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

出力のみで、第三者のオーディオ クリエイティブでのみ有効です。

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

  • HOSTING_SOURCE_THIRD_PARTY

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

  • CREATIVE_TYPE_AUDIO

HostingSource

クリエイティブのホスト元となる候補。クリエイティブが作成されホストされる場所を示します。

列挙型
HOSTING_SOURCE_UNSPECIFIED このバージョンではホスティング ソースが指定されていないか、不明です。
HOSTING_SOURCE_CM

キャンペーン マネージャー 360 から同期されたクリエイティブ。

作成メソッドと更新メソッドは、このホスティング タイプではサポートされていません。
HOSTING_SOURCE_THIRD_PARTY

第三者広告サーバー（3PAS）でホストされるクリエイティブ。

creativeType が次のいずれかである場合、このホスティング タイプでは create メソッドと update メソッドがサポートされます。

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

ディスプレイ&ビデオ 360 で作成され、キャンペーン マネージャー 360 でホストされるクリエイティブ。

creativeType が次のいずれかである場合、このホスティング タイプでは create メソッドと update メソッドがサポートされます。

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

スタジオで作成され、キャンペーン マネージャー 360 でホストされるリッチメディア クリエイティブ。

作成メソッドと更新メソッドは、このホスティング タイプではサポートされていません。

CreativeAttribute

クリエイティブの属性。

列挙型
CREATIVE_ATTRIBUTE_UNSPECIFIED このバージョンではクリエイティブ属性が指定されていないか、不明です。
CREATIVE_ATTRIBUTE_VAST クリエイティブが VAST クリエイティブである。
CREATIVE_ATTRIBUTE_VPAID_LINEAR クリエイティブがリニア VPAID クリエイティブである。
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR クリエイティブがノンリニア VPAID クリエイティブである。

ReviewStatusInfo

クリエイティブのステータスを確認します。

JSON 表現 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
フィールド
approvalStatus

enum (ApprovalStatus)

クリエイティブの配信を開始するために必要な基本的な承認を表します。creativeAndLandingPageReviewStatus と contentAndPolicyReviewStatus の概要
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

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

enum (ReviewStatus)

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

object (ExchangeReviewStatus)

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

object (PublisherReviewStatus)

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

ApprovalStatus

承認ステータスの種類。creativeAndLandingPageReviewStatus と contentAndPolicyReviewStatus のまとめです。

列挙型
APPROVAL_STATUS_UNSPECIFIED このバージョンではタイプの値が指定されていないか、不明です。
APPROVAL_STATUS_PENDING_NOT_SERVABLE クリエイティブはまだ審査中のため、配信できません。
APPROVAL_STATUS_PENDING_SERVABLE クリエイティブはクリエイティブとランディング ページの審査に合格し、配信可能ですが、コンテンツとポリシーに関する追加の審査待ちの状態です。
APPROVAL_STATUS_APPROVED_SERVABLE クリエイティブとランディング ページの審査と、コンテンツとポリシーの審査の両方が承認されます。クリエイティブが配信可能であること。
APPROVAL_STATUS_REJECTED_NOT_SERVABLE クリエイティブに問題があるため、配信する前に修正する必要があります。

ReviewStatus

審査ステータスの種類。

列挙型
REVIEW_STATUS_UNSPECIFIED このバージョンではタイプの値が指定されていないか、不明です。
REVIEW_STATUS_APPROVED クリエイティブは承認済みです。
REVIEW_STATUS_REJECTED クリエイティブが不承認となりました。
REVIEW_STATUS_PENDING クリエイティブは審査待ちです。

ExchangeReviewStatus

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

JSON 表現 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
フィールド
exchange

enum (Exchange)

クリエイティブをレビューしているエクスチェンジ。
status

enum (ReviewStatus)

エクスチェンジの審査のステータス。

PublisherReviewStatus

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

JSON 表現 
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
フィールド
publisherName

string

パブリッシャーがクリエイティブを確認している。
status

enum (ReviewStatus)

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

AssetAssociation

クリエイティブのアセットの関連付け。

JSON 表現 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
フィールド
asset

object (Asset)

関連付けられたアセット。
role

enum (AssetRole)

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

アセット

単一のアセット。

JSON 表現 
{
  "mediaId": string,
  "content": string
}
フィールド
mediaId

string (int64 format)

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

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

string

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

AssetRole

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

列挙型
ASSET_ROLE_UNSPECIFIED このバージョンではアセットの役割が指定されていないか、不明です。
ASSET_ROLE_MAIN アセットはクリエイティブのメインアセットです。
ASSET_ROLE_BACKUP このアセットはクリエイティブの代替アセットです。
ASSET_ROLE_POLITE_LOAD このアセットは、クリエイティブのポライトロード アセットです。
ASSET_ROLE_HEADLINE

ネイティブ クリエイティブの見出しです。

content は、長さが 25 文字以下の UTF-8 でエンコードされている必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

ネイティブ クリエイティブの長い広告見出し。

content は、50 文字以下の UTF-8 でエンコードする必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

ネイティブ クリエイティブの本文。

content は、UTF-8 でエンコードされ、長さが 90 文字以下にする必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

ネイティブ クリエイティブの長い本文。

content は UTF-8 でエンコードされ、長さは 150 文字以下にする必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

クリエイティブに表示する、短くわかりやすいランディング ページ URL。この URL は、クリエイティブをクリックしたときに表示されるページの URL です。

content は、30 文字以下の UTF-8 でエンコードする必要があります。

たとえば、ランディング ページ URL が「http://www.example.com/page」の場合、キャプション URL を「example.com」にできます。プロトコル（http://）は省略可能ですが、URL にスペースや特殊文字を含めることはできません。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

ネイティブ クリエイティブの行動を促すフレーズのボタンで使用するテキストです。

content は、長さが 15 文字以下の UTF-8 でエンコードされている必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

広告主名またはブランド名を識別するテキスト。

content は、長さが 25 文字以下の UTF-8 でエンコードされている必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

Google Play ストアまたは iOS アプリストアでのアプリの購入価格（例: $5.99）。

この値は、ストアに表示される実際の値とは自動的に同期されません。クリエイティブを保存する際に、常に指定したものになります。

content は、長さが 15 文字以下の UTF-8 でエンコードされている必要があります。

このロールのアセットは読み取り専用です。
ASSET_ROLE_ANDROID_APP_ID

Google Play ストアにおける Android アプリの ID。

この ID は、アプリの Google Play ストアの URL の「id」の後に表示されます。たとえば、https://play.google.com/store/apps/details?id=com.company.appname の場合、この ID は com.company.appname です。

このロールのアセットは読み取り専用です。
ASSET_ROLE_IOS_APP_ID

Apple App Store の iOS アプリの ID。

この ID 番号は、Apple App Store の URL で「id」の直後にある数字の文字列として表示されています。たとえば、https://apps.apple.com/us/app/gmail-email-by-google/id422689480 の場合、ID は 422689480 です。

このロールのアセットは読み取り専用です。
ASSET_ROLE_RATING

Google Play ストアや iOS アプリストアでのアプリの評価です。

なお、この値はストアでの実際の評価と自動的に同期されません。クリエイティブを保存する際に、常に指定したものになります。

このロールのアセットは読み取り専用です。
ASSET_ROLE_ICON

クリエイティブのアイコン。

このロールは、次の creativeType でのみサポートされ、必須です。

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

ネイティブ動画クリエイティブのカバー画像。

このロールは、次の creativeType でのみサポートされ、必須です。

  • CREATIVE_TYPE_VIDEO

ExitEvent

クリエイティブの exit イベント。

JSON 表現 
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
フィールド
type

enum (ExitEventType)

必須。exit イベントのタイプ。
url

string

必須。exit イベントのリンク先 URL。type が次の場合は必須です。

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

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

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

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

string

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

ExitEventType

exit イベントのタイプ。

列挙型
EXIT_EVENT_TYPE_UNSPECIFIED このバージョンでは exit イベントのタイプが指定されていないか、不明です。
EXIT_EVENT_TYPE_DEFAULT デフォルトのイベントは exit イベントです。
EXIT_EVENT_TYPE_BACKUP exit イベントは代替の exit イベントです。1 つのクリエイティブに複数の代替 exit イベントが存在する場合があります。

TimerEvent

クリエイティブのタイマー イベント。

JSON 表現 
{
  "name": string,
  "reportingName": string
}
フィールド
name

string

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

string

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

CounterEvent

クリエイティブのカウンタ イベント。

JSON 表現 
{
  "name": string,
  "reportingName": string
}
フィールド
name

string

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

string

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

AudioVideoOffset

音声または動画が再生された時間の長さ。

JSON 表現 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
フィールド
共用体フィールド offset。オフセットの値。offset は次のいずれかになります。
percentage

string (int64 format)

音声または動画の再生時間に対する割合（%）のオフセット。
seconds

string (int64 format)

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

UniversalAdId

レジストリによって提供されるクリエイティブ ID で、すべてのプラットフォーム間で一意です。これは VAST 4.0 標準の一部です。

JSON 表現 
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
フィールド
id

string

固有のクリエイティブ ID。
registry

enum (UniversalAdRegistry)

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

UniversalAdRegistry

レジストリは、ユニバーサル広告 ID で一意のクリエイティブ ID を提供します。

列挙型
UNIVERSAL_AD_REGISTRY_UNSPECIFIED このバージョンではユニバーサル広告レジストリが指定されていないか、不明です。
UNIVERSAL_AD_REGISTRY_OTHER ユニバーサル広告 ID の指定にはカスタム プロバイダを使用します。
UNIVERSAL_AD_REGISTRY_AD_ID 広告 ID を使用してユニバーサル広告 ID を指定します。
UNIVERSAL_AD_REGISTRY_CLEARCAST Clearcast.co.uk を使用してユニバーサル広告 ID を指定してください。
UNIVERSAL_AD_REGISTRY_DV360 ディスプレイ &ビデオ 360 を使用してユニバーサル広告 ID を指定します。
UNIVERSAL_AD_REGISTRY_CM キャンペーン マネージャー 360 を使ってユニバーサル広告 ID を指定してください。

ThirdPartyUrl

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

JSON 表現 
{
  "type": enum (ThirdPartyUrlType),
  "url": string
}
フィールド
type

enum (ThirdPartyUrlType)

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

string

操作のトラッキングに使用されるトラッキング URL。

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

ThirdPartyUrlType

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

列挙型
THIRD_PARTY_URL_TYPE_UNSPECIFIED このバージョンでは第三者 URL のタイプが指定されていないか、不明です。
THIRD_PARTY_URL_TYPE_IMPRESSION 音声または動画のバッファリングが完了した後のクリエイティブのインプレッションをカウントするために使用されます。
THIRD_PARTY_URL_TYPE_CLICK_TRACKING 音声または動画のユーザーのクリックをトラッキングするために使用します。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START ユーザーが音声または動画を開始した回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE 音声または動画が長さの 25% まで再生された回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT 音声または動画が長さの 50% まで再生された回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE 音声または動画が長さの 75% まで再生された回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE 音声または動画が最後まで再生された回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE ユーザーが音声または動画をミュートした回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE ユーザーが音声または動画を一時停止した回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND ユーザーが音声または動画をリプレイした回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN ユーザーがプレーヤーを全画面サイズに展開した回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP ユーザーが音声または動画を停止した回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM 動画のホット スポットをクリックするなど、ユーザーがカスタム クリックを行った回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP 音声または動画がスキップされた回数をトラッキングするために使用されます。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS progressOffset で決定されるオフセットまで音声または動画が再生された回数をトラッキングするために使用されます。

コード変換

コード変換された音声ファイルまたは動画ファイルに関する情報を表します。

JSON 表現 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
フィールド
name

string

コード変換されたファイルの名前。
mimeType

string

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

boolean

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

object (Dimensions)

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

string (int64 format)

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

number

コード変換された動画のフレームレート（フレーム/秒）。
audioBitRateKbps

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

CmTrackingAd

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

JSON 表現 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
フィールド
cmPlacementId

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

ObaIcon

クリエイティブの OBA アイコン

JSON 表現 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
フィールド
resourceUrl

string

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

string

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

enum (ObaIconPosition)

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

object (Dimensions)

OBA アイコンのサイズ。
program

string

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

string

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

次のドメインの URL のみを使用できます。
clickTrackingUrl

string

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

次のドメインの URL のみを使用できます。
viewTrackingUrl

string

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

次のドメインの URL のみを使用できます。

ObaIconPosition

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

列挙型
OBA_ICON_POSITION_UNSPECIFIED OBA アイコンの位置が指定されていません。
OBA_ICON_POSITION_UPPER_RIGHT クリエイティブの右上。
OBA_ICON_POSITION_UPPER_LEFT クリエイティブの左上
OBA_ICON_POSITION_LOWER_RIGHT クリエイティブの右下。
OBA_ICON_POSITION_LOWER_LEFT クリエイティブの左下。

ExpandingDirection

第三者のエキスパンド クリエイティブの展開方向。

列挙型
EXPANDING_DIRECTION_UNSPECIFIED 展開方向が指定されていません。
EXPANDING_DIRECTION_NONE どの方向にも拡張しません。
EXPANDING_DIRECTION_UP 展開する。
EXPANDING_DIRECTION_DOWN 下に展開。
EXPANDING_DIRECTION_LEFT 左に展開。
EXPANDING_DIRECTION_RIGHT 右に拡張。
EXPANDING_DIRECTION_UP_AND_LEFT 左上に展開します。
EXPANDING_DIRECTION_UP_AND_RIGHT 上方向に拡張します。
EXPANDING_DIRECTION_DOWN_AND_LEFT 下と左側に展開します。
EXPANDING_DIRECTION_DOWN_AND_RIGHT 下と右側に展開します。
EXPANDING_DIRECTION_UP_OR_DOWN 上または下に展開します。
EXPANDING_DIRECTION_LEFT_OR_RIGHT 左側または右側に展開します。
EXPANDING_DIRECTION_ANY_DIAGONAL 任意の対角方向に拡張できます。

Methods

create

 新しいクリエイティブを作成します。

delete

 クリエイティブを削除します。

get

 クリエイティブを取得します。

list

 広告主のクリエイティブを一覧表示します。

patch

 既存のクリエイティブを更新します。