REST Resource: advertisers.creatives

リソース: クリエイティブ

単一のクリエイティブ。

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

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

object (TimerEvent)

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

object (CounterEvent)

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

string

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

string

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

string

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

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

メイン アセットを複数の代替バージョンにトランスコードします。これにより、各種の動画プレーヤーや帯域幅に対応した、ファイル形式やプロパティ（解像度、オーディオ ビットレート、動画ビットレート）の異なる複数の代替バージョンが生成されます。

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

このフィールドは、次の 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

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

第三者広告サーバー パラメータと ${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（デジタル動画プレーヤーと広告インターフェース）が必要であることを示します。

出力専用で、第三者 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 が次のいずれかである場合、このホスティング タイプでメソッドの作成と更新がサポートされます。

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

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

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

  • 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[]
(deprecated)

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 は UTF-8 でエンコードし、25 文字以下にする必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

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

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

このロールは、次の 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 から判断できるようにします。

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

たとえば、ランディング ページの 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 は UTF-8 でエンコードし、長さを 15 文字以下にする必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

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

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

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

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

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

このロールのアセットは読み取り専用です。
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 の場合、識別子は com.company.appname です。

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

Apple アプリストア内の iOS アプリの ID。

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

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

Google Play ストアまたは iOS App Store でのアプリの評価です。

この値は、ストアの実際の評価と自動的に同期されません。クリエイティブの保存時に指定した値が常に使用されます。

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

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

このロールは、次の creativeType でのみサポートされ、必要となります。

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

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

このロールは、次の creativeType でのみサポートされ、必要となります。

  • CREATIVE_TYPE_VIDEO

ExitEvent

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

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

enum (ExitEventType)

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

string

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

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

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

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

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

string

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

ExitEventType

終了イベントのタイプ。

列挙型
EXIT_EVENT_TYPE_UNSPECIFIED Exit イベントのタイプが指定されていないか、このバージョンでは不明です。
EXIT_EVENT_TYPE_DEFAULT 終了イベントはデフォルトのイベントです。
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 Ad-ID を使用してユニバーサル広告 ID を指定します。
UNIVERSAL_AD_REGISTRY_CLEARCAST ユニバーサル広告 ID を指定するには、clearcast.co.uk を使用してください。
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)

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

number

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

string (int64 format)

コード変換された動画の音声ストリームのビットレート、またはコード変換された音声のビットレート（kb/秒）。
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 任意の斜め方向に拡張できます。

メソッド

create

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

delete

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

get

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

list

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

patch

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