REST Resource: advertisers.creatives

リソース: Creative

1 つのクリエイティブ。

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,
  "syntheticContentAttestationStatus": enum (SyntheticContentAttestationStatus)
}
フィールド
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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
createTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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 を含める必要があります。クリエイティブにイグジットを追加するには、次のいずれかの方法を使用します。

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

object (TimerEvent)

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

object (CounterEvent)

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

string

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

string

省略可。このクリエイティブを外部システムにリンクするために使用される ID 情報。長さが 10,000 文字以下の UTF-8 でエンコードされた文字列にする必要があります。
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 は 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（モバイル リッチメディア広告インターフェース定義システム）が必要であることを示します。

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

省略可。サードパーティ タグ クリエイティブでのみ有効です。

第三者タグ クリエイティブは、次の 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
syntheticContentAttestationStatus

enum (SyntheticContentAttestationStatus)

省略可。地域の AI ラベル付け規制が適用される地域でクリエイティブが配信される場合に、AI を使用して作成または編集されたものとしてクリエイティブにラベルを付けるかどうか。

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)
    }
  ]
}
フィールド
approvalStatus

enum (ApprovalStatus)

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

enum (ReviewStatus)

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

enum (ReviewStatus)

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

object (ExchangeReviewStatus)

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

ApprovalStatus

承認状況の種類。creativeAndLandingPageReviewStatus と contentAndPolicyReviewStatus の概要です。

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

ReviewStatus

審査ステータスの種類。

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

ExchangeReviewStatus

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

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

enum (Exchange)

クリエイティブを審査しているエクスチェンジ。
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 は、長さが 150 文字以内の UTF-8 でエンコードされている必要があります。

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_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 App Store でのアプリの購入価格（例: $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 の場合、識別子は 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 App Store でのアプリの評価。

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

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

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

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

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

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

クリエイティブで使用するメインカラー。

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

クリエイティブで使用するアクセント カラー。

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

クリエイティブで画像アセットを使用する必要があるかどうか。

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

アセットの調整機能をクリエイティブに適用できるかどうか。

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

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 イベントである。クリエイティブに複数のバックアップ Exit イベントを設定できます。

TimerEvent

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

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

string

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

string

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

CounterEvent

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

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

string

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

string

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

AudioVideoOffset

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

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "percentage": string,
  "seconds": string
  // End of mutually exclusive fields.
}
フィールド
オフセットの値。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
percentage

string (int64 format)

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

string (int64 format)

省略可。音声または動画の開始からのオフセット（秒単位）。
相互に排他的なフィールドの終わり。

UniversalAdId

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

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

string

省略可。クリエイティブの一意の識別子。
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 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 のみが許可されます。

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

string

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

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

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

string

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

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

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

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

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