クリエイティブ VAST サービス
Creative Vast サービスを使用して、 ビデオ または オーディオ クリエイティブを Xandr に追加できます。 すべてのクリエイティブを広告主またはパブリッシャーにアタッチする必要があります。
- 広告主サービスを呼び出すことで 、広告主 ID を表示できます。
- パブリッシャー サービスを呼び出すことで、 発行元 ID を表示できます。
- クリエイティブをパブリッシャーにアタッチして、プレースメントの既定のクリエイティブとして使用できます。 その後、プレースメント サービスを使用して、その ID を使用してクリエイティブを プレースメントにアタッチします。
注:
video_attribute
は常に creative-vast
endpoint で必要です。
監査
Xandrは、ブランドと評判を深く気にするメンバーと協力しています。 そのため、システムを通過する広告(クリエイティブ)が全ての関係者に受け入れられるよう注意を払っています。 品質保証のため、サード パーティの広告枠で配信するすべてのクリエイティブは、クリエイティブ サービスを使用して事前に登録する必要があります。
- クリエイティブは、media_url (サードパーティの広告サーバー URL または Flash またはビデオ ファイルのコンテンツ配信ネットワーク URL) によって識別されます。
- Xandr は、定期的にmedia_urlsをチェックします。 ファイルが消えた場合、クリエイティブは監査されていないものとして扱われます。
- クリエイティブが Xandr 監査に合格すると、クリエイティブに特定の変更が加えられると、そのクリエイティブは監査のために再送信されます。 詳細については、以下の 「再監査の原因となる変更 」を参照してください。
- 監査の詳細については、「 クリエイティブスタンダードと監査」を参照してください。
REST API
注:
クリエイティブの最初と最後の配信日に基づいてフィルター処理できます。 これは、 オブジェクトの制限 に近づき、システムから削除できるクリエイティブを特定する必要がある場合に特に便利です。 詳細については、以下の 「最初の実行/最後の実行」を 参照してください。
ヒント
応答では、Xandr、Microsoft、Google の各監査ステータスを持つクリエイティブの数が示されます。 応答形式については、以下の 例を 参照してください。
メンバーまたはプレースメントの既定のクリエイティブとして使用されているクリエイティブは削除できません。 既定のクリエイティブは、プレースメントとの関連付けを解除した後に削除できます。
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
int | クリエイティブに関連付けられている内部 ID。 - デフォルト: 自動生成された数値。 - クエリ文字列で必要な On: PUT 。 |
code |
string (100) | クリエイティブのカスタム コード。 |
code2 |
string (100) | クリエイティブの追加のカスタム コード。 |
name |
string (100) | クリエイティブの名前。 |
type |
列挙 | クリエイティブの種類。 使用可能な値: - "standard" - "html" - "video" 注:アルファベータに関する通知 このフィールドまたは機能は、現在アルファフェーズまたはベータフェーズの機能の一部です。 そのため、変更される可能性があります。 読み取り専用。 |
advertiser_id |
int | クリエイティブがアタッチされている広告主の ID。 クリエイティブが広告主にアタッチされている場合は、クエリ文字列で[オン]:[ POST /PUT が必要です。 |
publisher_id |
int | クリエイティブがアタッチされている発行元/メディア購入の ID。 クリエイティブが広告主にアタッチされている場合は、クエリ文字列で[オン]:[ POST /PUT が必要です。 |
brand_id |
int | クリエイティブを宣伝する会社のブランドの ID。 含まれている場合は、Xandr 監査チームによって検証されます。 含まれていない場合は、監査チームによって割り当てられます。 ブランドの完全な一覧を取得するには、 ブランド サービスに関するページを参照してください。 |
state |
列挙 | クリエイティブの状態。 使用可能な値: "active" または "inactive" 。読み取り専用。 |
status |
object | クリエイティブが配信する準備ができているかどうかを説明するクリエイティブの状態。 詳細については、以下の 「状態 」を参照してください。 |
click_track_result |
列挙 | クリック トラック テストの結果。コンソール ユーザー インターフェイスでのみ使用できる機能です。 使用可能な値: "not_tested" 、 "passed" 、または "failed" 。クリエイティブがパブリッシャーにアタッチされている場合は、クエリ文字列で On: POST /PUT が必要です。 |
campaigns |
オブジェクトの配列 | クリエイティブが関連付けられているキャンペーンの一覧。 詳細については、以下 の「キャンペーン 」を参照してください。 先端: このフィールドは、クエリ文字列に advertiser_id が指定されている場合にのみ返されます。 |
template |
object | クリエイティブの形式とメディアの種類のクリエイティブ テンプレート (例: template_id 6439)。 テンプレートには、クリエイティブが Web ページでどのようにレンダリングされるかを制御するコードが含まれています。使用可能な値: - ビデオ クリエイティブ: 6439 - オーディオ クリエイティブ: 38745 必須: POST |
media_url |
string (1000) | クリエイティブの URL - フラッシュ、HTML、javascript を指定できます (形式を参照)。 URL は存在する必要があり、CDN でホストされる VAST XML ファイルを指している必要があります。 このフィールドは、サード パーティのクリエイティブにのみ適用されます。 デフォルト: "not_tested" |
media_url_secure |
string (1000) | セキュア (HTTPS) クリエイティブの URL - フラッシュ、HTML、javascript (形式を参照) して、セキュリティで保護された広告通話で配信できます。 URL は存在する必要があり、CDN でホストされる VAST XML ファイルを指している必要があります。 このフィールドは、サード パーティのクリエイティブにのみ適用されます。 |
click_url |
string (2000) | サード パーティ以外のイメージとフラッシュ クリエイティブの (省略可能) ランディング ページ URL。 手記: この値は、"http://" または "https://" で始まる必要があります コンテンツを使用していない場合は、On: POST 必須。 |
file_name |
string (1000) | このフィールドは、ホストされているビデオ クリエイティブには適用されません。 |
audit_status |
列挙 | クリエイティブの監査状態。 使用可能な値: "no_audit" 、 "pending" 、 "rejected" 、または "audited" 。注: - allow_audit が false されている場合は、このフィールドを "no_audit" する必要があります。- クリエイティブの有効期限が切れている場合は、このフィールドを変更して再アニメーション化できます。 "pending" に設定すると、監査のために再送信されます。 監査のためにクリエイティブを自動的に再送信する変更については、以下の「 再監査の原因となる変更 」を参照してください。テンプレートが "image" 形式の場合は、On:POST 必須。 |
audit_feedback |
string | クリエイティブ監査チームは、このフィールドでクリエイティブに関するメッセージを渡すことができます。 読み取り専用。 |
allow_audit |
ブール型 |
true 場合、クリエイティブは監査のために送信されます。
false 場合、クリエイティブは送信されません。 監査されていないクリエイティブは、ネットワークのマネージド インベントリでのみ実行できます。注: - audit_status が "no_audit" されている場合は、このフィールドを "false" する必要があります。- メンバーがまだアクティブでない場合は、クリエイティブを追加できますが、監査のために送信されることはありません ( allow_audit は false になります)。 メンバーがアクティブ化されたら、これらのクリエイティブを監査する場合は、クリエイティブを更新し、 allow_audit を true に設定する必要があります。デフォルト: "pending" |
ssl_status |
列挙 | クリエイティブの ssl (HTTPS) の状態。 ssl_status = 承認済みのクリエイティブのみが、安全な在庫で配信できます。 注: クリエイティブが ssl Sherlock 監査に失敗した場合は、このフィールドを "pending" に変更することで、(ダウンストリームのセキュリティで保護されていないコンテンツを修正したら) 再テスト用に送信できます。 有効な値は次のとおりです。- "disabled" - "pending" - "approved" - "failed" デフォルト: "disabled" |
allow_ssl_audit |
ブール型 |
true 場合、クリエイティブはセキュリティで保護された (HTTPS) 監査のために送信されます。
false 場合、クリエイティブは送信されません。
true 場合は、media_url_secure またはcontent_secure も必要です。デフォルト: "disabled" |
google_audit_status |
列挙 | 非推奨。 代わりに「 adx_audit 」を参照してください。 |
google_audit_feedback |
string | 非推奨。 代わりに「 adx_audit 」を参照してください。 |
msft_audit_status |
列挙 | 廃止。 |
msft_audit_feedback |
string | 廃止。 |
is_self_audited |
ブール型 |
true 場合、クリエイティブは自己監査されるため、プラットフォーム (Xandr) 監査は行われません。 クリエイティブは、自己分類クリエイティブを受け入れるインベントリ、または監査されていないクリエイティブを受け入れるインベントリでのみ配信できます。デフォルト: false |
is_expired |
ブール型 | クリエイティブ (1) が実行されておらず、(2) が 45 日以内に変更されていない場合、自動的に期限切れとマークされ、インベントリに配信されません。 - サード パーティのインベントリで実行するには、期限切れのクリエイティブを再監査する必要があります。 サード パーティのインベントリのクリエイティブの展開を解除するには、[ audit_status ] を [ "pending" ] に設定します。- 期限切れのクリエイティブは、直接在庫で実行するために再監査する必要はありません。 直接在庫のクリエイティブの展開を解除するには、 audit_status を [ "no_audit" ] に設定します。デフォルト: false 読み取り専用。 |
is_prohibited |
ブール型 | Sherlock は、マルウェアを持っているか、ブロックされたドメインを読み込むためのクリエイティブにフラグを設定する場合は、クリエイティブが配信されないように true に設定されます。 デフォルト: false 読み取り専用。 |
is_hosted |
ブール型 |
true 場合、クリエイティブは Xandr によってホストされます。読み取り専用。 |
lifetime_budget |
double | ドル単位の生涯予算。 注: このフィールドを GET 応答に含めるには、クエリ文字列に attributes=1 を渡します。デフォルト: false |
lifetime_budget_imps |
int | インプレッション数の有効期間制限。 注: このフィールドを GET 応答に含めるには、クエリ文字列に attributes=1 を渡します。デフォルト: unlimited |
daily_budget |
double | ドル単位の 1 日の予算。 注: このフィールドを GET 応答に含めるには、クエリ文字列に attributes=1 を渡します。デフォルト: unlimited |
daily_budget_imps |
int | インプレッション数の 1 日あたりの制限。 注: このフィールドを GET 応答に含めるには、クエリ文字列に attributes=1 を渡します。デフォルト: unlimited |
enable_pacing |
ブール型 |
true 場合、1 日の予算支出は 1 日を通じて均等に分散されます。手記: このフィールドを GET 応答に含めるには、クエリ文字列に attributes=1 を渡します。デフォルト: unlimited |
allow_safety_pacing |
ブール型 |
true 場合、1 分あたりの支出は、生涯予算の最大 1% と 1 日の予算の 5% に制限されます。管理者のみ。 |
profile_id |
int | 性別や地域などのターゲット設定をクリエイティブにアタッチするには、プロファイルを作成し、ここで関連付けます。 |
folder |
object | 便利なフォルダー (通常は UI) でクリエイティブを配置するには、 Creative Folder Service を使用してフォルダーを作成し、フォルダー ID またはクリエイティブ ID を使用してクリエイティブ フォルダー サービスに関連付けます。 出力が {"id": "41", "name": "MyFolder"} 。 |
line_items |
オブジェクトの配列 | クリエイティブに関連付けられている広告申込情報。 詳細については、以下の 「行項目 」を参照してください。 |
is_control |
ブール型 | これは、このクリエイティブを A/B テストのコントロール/テスト グループの一部としてマークするために使用されるフラグです。 詳細については、「 テストと制御のターゲット設定」を参照してください。 デフォルト: true |
segments |
配列 | このクリエイティブを表示またはクリックしたときにユーザーが追加するセグメントの一覧。 詳細については、セグメントと以下の例を参照してください。 |
created_on |
timestamp | このクリエイティブが作成された日時。 2010 年 1 月より前に作成された場合、これは 0 になります。 読み取り専用。 |
last_modified |
timestamp | クリエイティブが最後に変更された日時。 読み取り専用。 |
creative_upload_status |
列挙 | 廃止。 |
categories |
オブジェクトの配列 | クリエイティブとオファーの種類を表すカテゴリ。 注: GET 応答にカテゴリを含める場合は、クエリ文字列にattributes=1 を渡します。 カテゴリの完全な一覧を取得するには、 カテゴリ サービス と以下の 例 を参照してください。 |
adservers |
オブジェクトの配列 | クリエイティブを配信する広告サーバー、またはクリエイティブの配信中にデータ収集のために呼び出される広告サーバー。 注: GET 応答に adservers を含める場合は、クエリ文字列にattributes=1 を渡します。 広告サーバーの完全な一覧を取得するには、 Ad Server Service と以下の 例 を参照してください。読み取り専用。 |
technical_attributes |
オブジェクトの配列 |
"Expandable" や"Video" など、クリエイティブの技術的特性を表す属性。注: GET 応答に技術属性を含めるには、クエリ文字列にattributes=1 を渡します。 技術属性の完全な一覧を取得するには、 技術属性サービス と以下の 例 を参照してください。 |
language |
object | クリエイティブの言語。 言語の完全な一覧を取得するには、 言語サービス と以下の 例 を参照してください。 |
brand |
object | クリエイティブを宣伝する会社のブランドと、ブランドに関連するカテゴリ。 詳細については、以下の 「ブランド」 を参照してください。 読み取り専用。 |
sla |
int | [ 0 ] に設定されているクリエイティブは、標準 SLA で監査のために送信されます。注意: 0 以外の番号で送信されたクリエイティブは、優先監査 (有効な場合) と料金が発生します。 優先監査のために Xandr と補助サービス契約を結んだ場合は、このフィールドを 2 に設定することで、優先度監査 (営業時間中に 2 時間以内に監査) 用のクリエイティブを送信できます。 優先監査の詳細については、「 クリエイティブスタンダードと監査」を参照してください。 |
sla_eta |
timestamp | 優先度監査の完了の見積もり時間。 読み取り専用。 |
currency |
string | 広告主の主通貨 ( USD など) を定義するコード。 使用できる通貨の種類の詳細については、「 Currency Service」を参照してください。 デフォルト: メンバーの既定の通貨。 読み取り専用。 |
first_run |
timestamp | クリエイティブが最初に配信された日時を、1 時間ごとに更新します。 この値は UTC タイム ゾーンを反映します。 この情報を GET 応答に含めるには、クエリ文字列に flight_info=true を渡します。 クリエイティブの配信時期に基づいてクリエイティブをフィルター処理する方法の詳細については、以下の 「初回実行/最終実行 」を参照してください。読み取り専用。 |
last_run |
timestamp | クリエイティブが最後に配信された日時。1 時間ごとに更新されます。 この値は UTC タイム ゾーンを反映します。 この情報を GET 応答に含めるには、クエリ文字列に flight_info=true を渡します。 クリエイティブが最後に配信されたタイミングに基づく方法の詳細については、以下の 「初回実行/最終実行 」を参照してください。読み取り専用。 |
video_attribute |
object | サード パーティのインストリーム (VAST) およびホストされているビデオおよびオーディオ クリエイティブの属性。 詳細については、以下の 「ビデオ属性 」を参照してください。 デフォルト: メンバーの既定の通貨。 テンプレートが "Standard VAST" メディア サブタイプ用の場合は、On: POST 必須。 |
competitive_brands |
オブジェクトの配列 | この配列のブランドに関連付けられているクリエイティブは、 /mtj オークションでは一緒に配信されません。 競合ブランドの典型的な例は、コーラとペプシです。 以下 の「競合ブランド」を 参照してください。 システム内のブランドの詳細については、 ブランド サービスに関するページを参照してください。Default:N/A |
competitive_categories |
オブジェクトの配列 | この配列のカテゴリに関連付けられているクリエイティブは、 /mtj オークション (例: "デート" や "教育") で一緒に配信されることはありません。 以下の 「競合カテゴリ」を 参照してください。 クリエイティブ (およびブランド) に適用されるカテゴリの詳細については、 カテゴリ サービスに関するページを参照してください。Default:N/A |
adx_audit |
object | このオブジェクトには、クリエイティブの Google AdExchange 監査に関連する状態とフィードバックに関する情報が含まれています。 クリエイティブが承認されたかどうかに関する情報は、[ audit_status ] フィールドに返されます。読み取り専用。 |
member_id |
int | クリエイティブを所有するメンバーの ID。 |
media_assets |
オブジェクトの配列 | Xandr でホストされているファイルをクリエイティブに関連付けるために使用されます。 このフィールドは、API 経由でファイルをアップロードするときに自動的に設定されます。 例を参照してください。 注: creative_field VAST クリエイティブの場合は常に null にする必要があります。 |
ad_type |
string |
先端: このフィールドは、クリエイティブを 拡張広告申込情報に関連付ける場合にのみ適用されます。 使用されるクリエイティブの種類。 使用可能な値: - "banner" - "video" (オーディオ クリエイティブを含む)- "native" この値は、広告申込情報の購入戦略、支払い戦略、最適化オプション、クリエイティブの関連付け、ターゲット設定オプションのオークションアイテムの追跡方法を決定します。 注: 広告申込情報に関連付けられているすべてのクリエイティブは、広告の種類が同じである必要があります。これは、[広告申込情報サービス - ALI] で選択した ad_type と一致する必要があります。 |
segments
例
"segments":[
{"id":11111,
"action":"add_on_view"
},
{"id":22222,
"action":"add_on_click"
}
]
categories
例
"categories":[{"id":"13","name":"Online Games"}]
adservers
例
"adservers":[{"id":"1","use_type":"adserver","name":"24/7 Real Media"}]
technical_attributes
例
"technical_attributes":[{"id":"1","name":"Image"}]
language
例
"language":{"id":"1","name":"English"}
media_assets
例
"media_assets":[
{
"media_asset_id":22,
"creative_field":null
}
]
オーディオ
フィールド | 種類 | 説明 |
---|---|---|
click_target |
string | click_actionのターゲット。これは、クリエイティブがクリックされたときにデバイスが実行するアクションです。 監査チームがオーディオ クリエイティブのブランドと属性を確認するために使用できる URL を入力します。 URL が指すサイトがオーディオと同じ言語であることを確認します。 この URL は、監査目的でのみ使用されます。 注意: クリエイティブが監査に合格するには、監査可能な URL を指定する必要があります。 |
行項目
line_items
配列内の各オブジェクトには、次のフィールドが含まれます。
"id"
または"code"
フィールドの情報を取得するには、明細サービス - ALI を使用します。
フィールド | 型 (長さ) | 説明 |
---|---|---|
name |
string | 行項目の名前。 読み取り専用。 |
state |
列挙 | クリエイティブの状態。 使用可能な値: "active" または "inactive" 。読み取り専用。 |
id |
int | 明細の ID。 行項目の関連付けを更新する場合は、 "id" または "code" が必要です。必須: PUT |
code |
string | 行項目のカスタム コード。 行項目の関連付けを更新する場合は、 "id" または "code" が必要です。必須: PUT |
キャンペーン
campaigns
配列内の各オブジェクトには、次のフィールドが含まれます。
"id"
または"code"
フィールドの情報を取得するには、キャンペーン サービスを使用できます。
フィールド | 型 (長さ) | 説明 |
---|---|---|
id |
int | キャンペーンの ID。 キャンペーンの関連付けを更新する場合は、 "id" または "code" が必要です。必須: PUT |
campaign_id |
int | キャンペーンの ID。 |
creative_id |
int | クリエイティブの ID。 |
name |
string | キャンペーンの名前。 読み取り専用。 |
state |
列挙 | キャンペーンの状態。 使用可能な値: "active" 、 "inactive" 、または "parent_inactive" 。読み取り専用。 |
code |
string | キャンペーンのカスタム コード。 行項目の関連付けを更新する場合は、 "id" または "code" が必要です。必須: PUT |
状態
名前 | 種類 | 説明 |
---|---|---|
user_ready |
ブール値 | クリエイティブが配信の準備ができているかどうかを説明する、ユーザーが設定したクリエイティブの状態。 使用可能な値: "true" または "false" 。デフォルト: true |
hosted_assets_association_complete |
boolean/null | Xandr の内部システムによってアップロードされたクリエイティブの状態。 使用可能な値: ホストされているクリエイティブの "true" または "false" 、サード パーティのクリエイティブの場合は "null" です。読み取り専用。 |
競争力のあるブランド
ヒント
ブランドの詳細については、 ブランド サービスに関するページを参照してください。
名前 | 種類 | 説明 |
---|---|---|
id |
int | ブランドの ID。 デフォルト: N/A 必須: N/A |
name |
string | ブランドの名前。 デフォルト: N/A 必須: N/A |
Media-asset
media-asset
オブジェクトには、次のフィールドが含まれます。
名前 | 種類 | 説明 |
---|---|---|
id |
int | メディア資産の ID。 必須: POST |
parent_media_asset_id |
int | 親メディア資産の ID。 |
size_in_bytes |
int | サイズ (バイト数)。 |
cdn_uploaded_on |
int | CDN にアップロードされた日付。 |
cdn_url |
string | メディア資産へのセキュリティで保護されていない CDN URL。 |
cdn_secure_url |
string | メディア資産への CDN URL をセキュリティで保護します。 |
deleted |
ブール値 | メディア資産が削除されたかどうかを判断するブール値インジケーター。 |
mime_type |
列挙 | 資産の種類。 |
asset_type |
列挙 | 次のいずれかの資産の種類: - html5 -ビデオ -オーディオ -画像 |
duration |
double | ビデオ資産の期間 (ミリ秒単位)。 |
Media_asset_status
media_asset_status
オブジェクトには、次のフィールドが含まれます。
名前 | 種類 | 説明 |
---|---|---|
cdn_upload_attempt_count |
int | CDN へのアップロード中に行われた試行回数。 |
status |
列挙 | 資産の処理の段階を示します。 |
テンプレート
template
オブジェクトには、次のフィールドが含まれます。
名前 | 種類 | 説明 |
---|---|---|
id |
int | クリエイティブ テンプレートの ID。 |
name |
string | クリエイティブ テンプレートの名前。 読み取り専用。 |
media_subtype_id |
int | テンプレートに割り当てられたメディア サブタイプの ID。
Media サブタイプ サービスを使用すると、サポートされているすべてのメディア サブタイプを表示できます。 読み取り専用。 |
format_id |
string | テンプレートに割り当てられた形式の名前。
Creative Format Service を使用すると、サポートされているすべての形式を表示できます。 読み取り専用。 |
競合カテゴリ
ヒント
カテゴリの詳細については、 カテゴリ サービスに関するページを参照してください。
名前 | 種類 | 説明 |
---|---|---|
id |
int | カテゴリの ID。 デフォルト: N/A 必須: N/A |
name |
string | カテゴリの名前。 デフォルト: N/A 必須: N/A |
Video 属性
video_attribute
は、 creative-vast
エンドポイントのオーディオ クリエイティブとビデオ クリエイティブの両方に必要です。 テンプレート ID は次のとおりです。
- 6439 - ビデオ: Standard VAST
- 38745 - オーディオ: Standard VAST
video_attribute
オブジェクトには、次のフィールドが含まれます。
フィールド | 種類 | 説明 |
---|---|---|
is_skippable |
ブール値 | 非推奨。 Xandr は、入稿されたすべての VAST クリエイティブにスキップ トラッカーを自動的に追加します。 |
duration_ms |
double | インストリーム (VAST) ビデオまたはオーディオ クリエイティブの期間 (ミリ秒単位)。 これは 0 より大きくする必要があります。必須 On: POST 、 PUT 。 |
wrapper |
object |
elements 配列とtrackers 配列を含む VAST ドキュメント ラッパー。 詳細については、以下の 「ビデオ属性ラッパー」 を参照してください。必須:ラッパーまたはインライン オブジェクトは、 PUT POST に必要です。 |
inline |
object | インライン VAST ドキュメント。 詳細については、以下の 「Video Attribute Inline 」を参照してください。 必須:ラッパーまたはインライン オブジェクトは、 PUT POST に必要です。 |
注:
クリエイティブコールで wrapper
または inline
オブジェクトを指定できます。 これらは相互に排他的です。
Video Attribute Wrapper
wrapper
オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
url |
string | VAST ドキュメントの URL。 必須 On: POST 、 PUT 。 |
secure_url |
string | VAST ドキュメントのセキュリティで保護された URL。 |
elements |
配列 | VAST ラッパーの要素。 必須 On: POST 、 PUT 。 |
Video 属性ラッパー要素
elements
配列には、次のフィールドが含まれています。
注:
少なくとも 1 つの要素を指定する必要があります。
フィールド | 種類 | 説明 |
---|---|---|
vast_element_type_id |
int | VAST 要素 ID。 使用可能な値:1 :リニア |
type |
string | 要素の型。 使用可能な値: "linear" 読み取り専用。 |
trackers |
配列 | VAST イベント トラッカー。 |
media_files |
配列 | VAST ラッパー内のメディア ファイル。 |
ビデオ ラッパー イベント トラッカー
レポートで追跡するすべてのイベントにピクセルをドロップできます (以下の vast_event_type_id
参照)。 クリエイティブにピクセルを trackers
として追加します。
trackers
配列には、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
name |
string | イベント トラッカーの名前。 |
vast_event_type_id |
int | VAST イベントの ID。 使用可能な値: - 2 :始める- 3 :スキップ- 4 :エラー- 5 : first_quartile- 6 :中央- 7 : third_quartile- 8 :完了- 9 :印象- 10 :クリック |
url |
string | イベント トラッカーの URL。 |
secure_url |
string | イベント トラッカーのセキュリティで保護された URL。 |
event_type |
string |
vast_event_type_id に対応するイベントの種類。読み取り専用。 |
ビデオ ラッパー メディア ファイル
フィールド | 種類 | 説明 |
---|---|---|
maintain_aspect_ratio |
string | 異なるサイズのメディア ファイルのサイズ間の比率。 読み取り専用。 |
scalable |
string | メディア ファイルはスケーラブルです。 読み取り専用。 |
media_asset |
string | 値は、ビデオまたはオーディオ アップロード アプリから派生します。 読み取り専用。 |
Video Attribute Inline
フィールド | 種類 | 説明 |
---|---|---|
ad_title |
string | 広告のタイトル。 必須 On: POST 、 PUT 。 |
ad_description |
string | 省略可能。 広告の説明。 |
linear |
object | コンテンツの中断前、後、中断中に表示される広告。 |
companion_ads |
オブジェクトの配列 | 付属のビデオまたはオーディオと同じページのバナー配置に表示されるコンパニオン バナー広告 (下記の 「インラインコンパニオン広告オブジェクト 」を参照)。 |
インライン線形オブジェクト
フィールド | 種類 | 説明 |
---|---|---|
trackers |
配列 | インライン 線形トラッカー。 |
media_files |
配列 | インライン線形メディア ファイル。 |
skipoffset_seconds |
int | ビデオをスキップするまでの再生が許可される秒数。 既定値は null です。注: このフィールドは、同じメンバーが広告をプレースメントに配信している場合にのみ使用できます。 |
インライン 線形トラッカー
フィールド | 種類 | 説明 |
---|---|---|
vast_event_type |
string | 追跡イベントの種類。 使用可能な値: - start - skip - error - first_quartile - completion - impression - click 必須 On: POST 、 PUT 。 |
name |
string | トラッカーの名前。 |
url |
string | インライン リニア イベント トラッカーの URL。 必須 On: POST 、 PUT 。 |
secure_url |
string | インライン リニア イベント トラッカーのセキュリティで保護された URL。 |
インライン 線形メディア ファイル
フィールド | 種類 | 説明 |
---|---|---|
maintain_aspect_ratio |
string | 異なるサイズのメディア ファイルのサイズ間の比率。 読み取り専用。 |
scalable |
string | メディア ファイルはスケーラブルです。 読み取り専用。 |
media_assets |
string | 値は、ビデオ アップロード アプリから派生します。 読み取り専用。 |
インライン コンパニオン広告オブジェクト
フィールド | 種類 | 説明 |
---|---|---|
trackers |
オブジェクトの配列 | インラインコンパニオン広告トラッカー。 |
companion_creative_id |
int | コンパニオン広告の ID。 |
セグメント
これらのフィールドは、Segments 配列に含まれます。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | セグメントの ID。 必須 On: POST 、 PUT 。 |
segment_id |
int | セグメントの ID。 このフィールドには、 id フィールドと同じ情報が含まれています。 |
action |
列挙 | ユーザーがセグメントに追加するアクション。 使用可能な値: "add on view" または "add on click" 。必須 On: POST 、 PUT 。 |
name |
string | セグメントの名前。 |
ブランド
brand
オブジェクトには、次のフィールドが含まれています。
ヒント
このオブジェクトは 読み取り専用です。 クリエイティブのブランドを設定するには、このオブジェクトの外部にある [ brand_id
] フィールドを使用します。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | クリエイティブを宣伝する会社のブランドの ID。 読み取り専用。 |
name |
string | クリエイティブを宣伝する会社のブランドの名前。 読み取り専用。 |
category_id |
int | ブランドに関連付けられているカテゴリの ID。 読み取り専用。 |
category_name |
string | ブランドに関連付けられているカテゴリの名前。 注: category_name フィールドは、呼び出しのクエリ文字列にshow_category_name=true を渡した場合にのみ返されます。 |
最初の実行/最後の実行
GET
応答にfirst_run
フィールドとlast_run
フィールドを含める場合は、クエリ文字列にflight_info=true
を渡します。 クリエイティブの最初と最後の配信時間に基づいて、次のようにフィルター処理することもできます。
配信したことがないクリエイティブのみを取得する
クエリ文字列に never_run=true
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&never_run=true'
ヒント
never_run=true
は他のフィルターと組み合わせて使用できますが、常に OR リレーションシップであることに注意してください。 たとえば、クエリ文字列に never_run=true
と min_first_run=2012-01-01 00:00:00
の両方を渡すと、2012-01-01 以降に配信された広告申込情報や広告申込情報を配信したことがないクリエイティブが検索されます。
特定の日付以降に配信されたクリエイティブのみを取得する
クエリ文字列に min_first_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'
特定の日付以前に配信されたクリエイティブのみを取得する
クエリ文字列に max_first_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'
特定の日付範囲内で最初に配信されたクリエイティブのみを取得する
クエリ文字列に min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'
特定の日付以降に最後に配信されたクリエイティブのみを取得する
クエリ文字列に min_last_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'
特定の日付以前に最後に配信されたクリエイティブのみを取得する
クエリ文字列に max_last_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'
特定の日付範囲内で最後に配信されたクリエイティブのみを取得する
クエリ文字列に min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS
を渡します。
curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'
再監査の原因となる変更
クリエイティブが Xandr 監査に合格すると (audit_status
が "audited"
)、次のいずれかのフィールドを変更すると、クリエイティブは監査のために再送信されます (allow_audit
は "pending"
に設定されます)。
media_url
click_url
language
categories
technical_attributes
brand_id
pixel_url
video_attribute
media_assets
また、 audit_status
が "no_audit"
されている場合、 allow_audit
を "false"
から "true"
に変更すると、クリエイティブが Xandr 監査のために再送信されます。
例
ビデオまたはオーディオ クリエイティブをアップロードする
Xandr を使用してホスティング用のクリエイティブをアップロードする場合:
手順 1: クリエイティブ アップロード サービスにアセットを アップロードします。
curl -X POST -H "Authorization: hbapi:139072:5761726637ada:nym2" --form "type=video" --form "file=@./Xandr_30_1280_720_2500k.mp4" "https://api.appnexus.com/creative-upload?member_id=123"
media_asset_idが返されます。
{
"response":
"status": "OK",
"count": 0,
"start_element": 0,
"num_elements": 0,
"media-asset": [
{
"id": 54621,
"parent_media_asset_id": null,
"member_id": 123,
"advertiser_id": null,
"publisher_id": null,
"file_name": "Xandr_30_1280_720_2500k.mp4",
"size_in_bytes": 8358845,
"cdn_uploaded_on": null,
"cdn_url": null,
"cdn_secure_url": null,
"created_on": "2016-06-15 15:33:17",
"last_modified": "2016-06-15 15:33:17",
"deleted": false,
"media_asset_status": [
{
"id": 54621,
"media_asset_id": 54621,
"error_message": null,
"local_path": "03/36/2e/66/03362e66-674a-41b3-9477-fcd979cdbf0b/03362e66-674a-41b3-9477-fcd979cdbf0b.mp4",
"cdn_upload_attempt_count": 0,
"created_on": "2016-06-15 15:33:17",
"last_modified": "2016-06-15 15:33:17",
"deleted": false,
"status": "on_shared_storage"
}
],
"media_asset_video": null,
"media_asset_html5": null,
"asset_type": "video",
"mime_type": "video/mp4",
"duration": "32000"
}
]
}
手順 2:クリエイティブをアップロードするmedia_asset_id
を使用します。
$ cat creative_video
{
"creative-vast": {
"name": "upload hosted video",
"media_assets": [
{
"media_asset_id": 54621
}
],
"click_url": "https://appnexus.com",
"video_attribute": {
"inline": {
"ad_title": "hosting test",
"linear": {
"trackers": []
}
},
"is_skippable": true,
"duration_ms": "57000"
},
"template": {
"id": 6439
},
"advertiser_id": 164979,
"segments": null,
"allow_audit": true,
"is_self_audited": false,
"sla": 0
}
}
{
"response": {
"status": "OK",
"count": 1,
"id": 12345678,
"start_element": 0,
"num_elements": 100,
"creative-vast": {
"name": "hosted creative video",
"brand_id": 1,
"media_url": "http://appnexus.com",
"id": 12345678,
...
"track_clicks": true,
"audit_status": "pending",
...
"media_url_secure": "https://appnexus.com",
...
"is_hosted": true,
...
"language": {
"id": 1,
"name": "English"
},
...
},
"template": {
"id": 6439,
"name": "Standard",
"media_subtype_id": 64,
"format_id": 10
},
...
"video_attribute": {
"is_skippable": true,
"duration_ms": 57000,
"inline": {
"ad_title": "hosted video creative",
"ad_description": null,
"linear": {
"trackers": null,
"media_files": null
}
},
"video_frameworks": null
},
"media_assets": [
{
"media_asset_id": 54621
}
],
...
"currency": "USD",
"type": "video"
},
...
}
}
ラッパーの例を含む video_attribute
オブジェクト
{
"creative-vast": {
"id": 145,
...
"template_id": 6439,
"video_attribute": {
"is_skippable": true,
"duration_ms": 21000,
"wrapper": {
"url": "http://www.doubleclick.net/...",
"secure_url": "https://www.doubleclick.net/...",
"elements": [
{
"vast_element_type_id": 1,
"name": "linear",
"trackers": [
{
"name": "startTracker",
"vast_event_type": "impression",
"url": "http://tracker.com/...",
"secure_url": "https://tracker.com/...",
}
{
"name": "completionTracker",
"vast_event_type_id": 8,
"url": "http://tracker.com/...",
"secure_url": "https://tracker.com/...",
"event_type": "completion"
}
]
}
]
}
}
}
}
インライン VAST の例を含む video_attribute
オブジェクト
{
"creative-vast": {
"name": "John-Doe test",
"member_id": 1111,
"advertiser_id": 2474202,
"template": {
"id": 6439
},
"video_attribute": {
"duration_ms": 10000,
"inline": {
"ad_title": "John-Doe test",
"linear": {
"trackers": []
}
}
},
"media_assets": [
{
"media_asset_id": 5375731,
"creative_field": null
}
]
}
}