- リソース: LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- Platform
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStep
- InteractionType
- メソッド
リソース: LineItem
単一の広告申込情報。
JSON 表現 |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "lineItemId": string, "displayName": string, "lineItemType": enum ( |
フィールド | |
---|---|
name |
出力専用。項目のリソース名。 |
advertiser |
出力専用。広告申込情報が属する広告主の一意の ID。 |
campaign |
出力専用。広告申込情報が属するキャンペーンの一意の ID。 |
insertion |
必須。変更不可。広告申込情報が属する広告掲載オーダーの一意の ID。 |
line |
出力専用。広告申込情報の一意の ID。システムによって割り当てられます。 |
display |
必須。広告申込情報の表示名。 UTF-8 でエンコードし、最大サイズは 240 バイトにする必要があります。 |
line |
必須。変更不可。広告申込情報のタイプ。 |
entity |
必須。広告申込情報で予算を消化して広告枠に入札できるかどうかを制御します。
|
update |
出力専用。項目が最後に更新されたときのタイムスタンプ。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
partner |
項目に関連付けられているパートナー費用。
|
flight |
必須。広告申込情報の配信期間の開始時間と終了時間。 |
budget |
必須。広告申込情報の予算割り当て設定。 |
pacing |
必須。広告申込情報の予算消化ペースの設定。 |
frequency |
必須。広告申込情報のインプレッションのフリークエンシー キャップの設定。 上限を設定する場合は、この設定オブジェクトの |
partner |
必須。広告申込情報のパートナーの収益モデルの設定。 |
conversion |
広告申込情報のコンバージョン トラッキング設定。 |
creative |
広告申込情報に関連付けられているクリエイティブの ID。 |
bid |
必須。広告申込情報の入札戦略。 |
integration |
広告申込情報の統合の詳細。 |
targeting |
広告申込情報の最適化されたターゲティングの設定。 この設定は、自動入札を使用し、対象となるオーディエンス リストをターゲット設定するディスプレイ、動画、オーディオの広告申込情報にのみ適用されます。 |
warning |
出力専用。広告申込情報によって生成された警告メッセージ。この警告によって広告申込情報の保存が妨げられることはありませんが、広告申込情報の配信がブロックされる場合があります。 |
mobile |
広告申込情報で宣伝するモバイルアプリ。 これは、 |
reservation |
出力専用。広告申込情報の予約タイプ。 |
exclude |
新しいエクスチェンジを広告申込情報の自動ターゲティングから除外するかどうか。このフィールドはデフォルトで false です。 |
youtube |
出力専用。YouTube とパートナーの広告申込情報に固有の設定。 |
LineItemType
広告申込情報のタイプ。
広告申込情報の種類によって、適用できる設定やオプション(広告のフォーマットやターゲティング オプションなど)が決まります。
列挙型 | |
---|---|
LINE_ITEM_TYPE_UNSPECIFIED |
このバージョンでは、タイプ値が指定されていないか不明です。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_DISPLAY_DEFAULT |
イメージ広告、HTML5 広告、ネイティブ広告、リッチメディア広告。 |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL |
アプリのインストールを促進するディスプレイ広告。 |
LINE_ITEM_TYPE_VIDEO_DEFAULT |
さまざまな環境向けに CPM ベースで販売される動画広告。 |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL |
アプリのインストールを促す動画広告。 |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY |
モバイルアプリ広告枠に配信されるディスプレイ広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY |
モバイルアプリ広告枠に配信される動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_AUDIO_DEFAULT |
さまざまな環境向けに販売される RTB オーディオ広告。 |
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP |
OTT 広告掲載オーダーに含まれるオーバー ザ トップ広告。このタイプは、広告掲載オーダーが insertionOrderType OVER_THE_TOP の広告申込情報にのみ適用されます。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION |
コンバージョンを促進する YouTube 動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE |
スキップできない YouTube 動画広告(最長 15 秒)。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE |
さまざまなフォーマットを組み合わせて、ストーリーを特定の順序で表示する YouTube 動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO |
YouTube オーディオ広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH |
費用を抑えながらより多くのユニーク ユーザーにリーチできるよう最適化された YouTube 動画広告。バンパー広告、スキップ可能なインストリーム広告、またはこれらの組み合わせを含めることができます。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE |
デフォルトの YouTube 動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP |
スキップできないコネクテッド テレビ YouTube 動画広告(最大 15 秒)。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP |
コネクテッド テレビの YouTube 動画広告: 費用を抑えながらより多くのユニーク ユーザーにリーチできるよう最適化されます。バンパー広告、スキップ可能なインストリーム広告、またはこれらの組み合わせを含めることができます。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP |
コネクテッド テレビのデフォルトの YouTube 動画広告。インストリーム広告フォーマットのみを含めます。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY |
この広告申込情報タイプの目的は、一定期間内に同じユーザーに YouTube 広告のターゲットを何回も表示することです。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW |
さまざまな広告フォーマットで視聴回数の増加を目指す YouTube 動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME |
デジタル屋外広告枠に配信されるディスプレイ広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME |
デジタル屋外広告枠に配信される動画広告。 このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。 |
LineItemFlight
広告申込情報の有効期間を管理する設定。
JSON 表現 |
---|
{ "flightDateType": enum ( |
フィールド | |
---|---|
flight |
必須。広告申込情報の掲載期間のタイプ。 |
date |
広告申込情報の掲載期間の開始日と終了日。親広告主のタイムゾーンを基準に解決されます。
|
LineItemFlightDateType
広告申込情報の掲載期間の種類。
列挙型 | |
---|---|
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED |
このバージョンでタイプ値が指定されていないか、不明です。 |
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED |
広告申込情報の掲載期間は、親の広告掲載オーダーから継承されます。 |
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM |
広告申込情報で独自のカスタム掲載期間が使用されている。 |
LineItemBudget
予算の割り当て方法を制御する設定。
JSON 表現 |
---|
{ "budgetAllocationType": enum ( |
フィールド | |
---|---|
budget |
必須。予算の割り当てのタイプ。
|
budget |
出力専用。予算単位は、予算が通貨ベースかインプレッション数ベースかを示します。この値は親の広告掲載オーダーから継承されます。 |
max |
広告申込情報で使用される最大予算額。0 より大きくする必要があります。
|
LineItemBudgetAllocationType
予算割り当ての種類。
列挙型 | |
---|---|
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED |
このバージョンでは、タイプ値が指定されていないか不明です。 |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC |
広告申込情報で予算の自動割り当てが有効になっています。 |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED |
広告申込情報に固定の最大予算額が割り当てられます。 |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED |
広告申込情報に予算制限が適用されていない。 |
PartnerRevenueModel
パートナーの収益の計算方法を制御する設定。
JSON 表現 |
---|
{
"markupType": enum ( |
フィールド | |
---|---|
markup |
必須。パートナー収益モデルのマークアップ タイプ。 |
markup |
必須。パートナーの収益モデルのマークアップ額。0 以上で指定します。
|
PartnerRevenueModelMarkupType
パートナーの収益モデルで使用できるマークアップ タイプ。
列挙型 | |
---|---|
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED |
このバージョンでは、タイプ値が指定されていないか不明です。 |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM |
固定の CPM に基づいてパートナー収益を計算します。 |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP |
メディア費用の追加料金の割合に基づいてパートナーの収益を計算します。 |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP |
すべてのパートナー費用とデータ費用を含む合計メディア費用の割増料金(%)に基づいて、パートナー収益を計算します。 |
ConversionCountingConfig
コンバージョンのカウント方法を制御する設定。
ポストクリック コンバージョンはすべてカウントされます。ポストビュー コンバージョンのカウントには、パーセンテージ値を設定できます。
JSON 表現 |
---|
{
"postViewCountPercentageMillis": string,
"floodlightActivityConfigs": [
{
object ( |
フィールド | |
---|---|
post |
カウントするポストビュー コンバージョンの割合(ミリ秒単位(1/1,000 パーセント))。0~100000 にする必要があります(両端を含む)。 たとえば、ポストクリック コンバージョンの 50% をトラッキングするには、値を 50000 に設定します。 |
floodlight |
コンバージョンのトラッキングに使用される Floodlight アクティビティの設定。 カウントされるコンバージョン数は、このフィールドに指定されたすべての Floodlight アクティビティ ID でカウントされたコンバージョンの合計数です。 |
TrackingFloodlightActivityConfig
1 つの Floodlight アクティビティ設定の動作を制御する設定です。
JSON 表現 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
フィールド | |
---|---|
floodlight |
必須。Floodlight アクティビティの ID。 |
post |
必須。広告がクリックされてからコンバージョンをカウントできる日数です。0 ~ 90 の値にする必要があります。 |
post |
必須。広告の視聴後にコンバージョンがカウントされる期間(日数)。0~90 の範囲で指定してください。 |
LineItemWarningMessage
広告申込情報によって生成された警告メッセージ。このような警告により、広告申込情報の保存が妨げられることはありませんが、広告申込情報の配信がブロックされる場合があります。
列挙型 | |
---|---|
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED |
指定されていないか不明。 |
INVALID_FLIGHT_DATES |
この広告申込情報には無効な掲載期間が指定されています。この広告申込情報は配信されません。 |
EXPIRED |
この広告申込情報の終了日が過去の日付です。 |
PENDING_FLIGHT |
この広告申込情報は今後配信を開始する予定です。 |
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED |
パートナーが有効にしたエクスチェンジはすべてターゲットから除外されます。この広告申込情報は配信されません。 |
INVALID_INVENTORY_SOURCE |
有効な広告枠ソースがターゲットに設定されていません。広告申込情報は実行されません。 |
APP_INVENTORY_INVALID_SITE_TARGETING |
この広告申込情報のアプリと URL のターゲティングにはモバイルアプリが含まれていません。この広告申込情報のタイプでは、チャネル、サイトリスト、またはアプリ ターゲティングにモバイルアプリを含める必要があります。広告申込情報は実行されません。 |
APP_INVENTORY_INVALID_AUDIENCE_LISTS |
この広告申込情報はモバイル ユーザーをターゲットに設定していません。この広告申込情報のタイプでは、モバイル ユーザーを含むユーザーリストをターゲットに設定する必要があります。広告申込情報は実行されません。 |
NO_VALID_CREATIVE |
この広告申込情報には有効なクリエイティブが含まれていません。広告申込情報は実行されません。 |
PARENT_INSERTION_ORDER_PAUSED |
この広告申込情報の広告掲載オーダーは一時停止しています。広告申込情報は実行されません。 |
PARENT_INSERTION_ORDER_EXPIRED |
この広告申込情報の広告掲載オーダーの終了日が過去の日付に設定されています。広告申込情報は実行されません。 |
MobileApp
モバイルアプリ インストール広告申込情報によって宣伝されるモバイルアプリ。
JSON 表現 |
---|
{
"appId": string,
"platform": enum ( |
フィールド | |
---|---|
app |
必須。プラットフォーム ストアが提供するアプリの ID。 Android アプリは、Android の Play ストアで使用されるバンドル ID( iOS アプリは、Apple の App Store で使用される 9 桁のアプリ ID( |
platform |
出力専用。アプリ プラットフォーム。 |
display |
出力専用。アプリの名前。 |
publisher |
出力専用。アプリ パブリッシャー。 |
プラットフォーム
利用可能なモバイルアプリ プラットフォーム。
列挙型 | |
---|---|
PLATFORM_UNSPECIFIED |
プラットフォームが指定されていません。 |
IOS |
iOS プラットフォーム。 |
ANDROID |
Android プラットフォーム。 |
YoutubeAndPartnersSettings
YouTube とパートナーの広告申込情報の設定。
JSON 表現 |
---|
{ "viewFrequencyCap": { object ( |
フィールド | |
---|---|
view |
広告申込情報のフリークエンシー キャップの設定。 上限を設定する場合は、この設定オブジェクトの |
third |
省略可。広告申込情報の第三者測定の設定。 |
inventory |
広告申込情報でターゲティングする YouTube とパートナーの広告枠を制御する設定。 |
content |
YouTube とパートナーの広告が表示されるコンテンツの種類。 |
effective |
出力専用。広告申込情報の配信時に適用されるコンテンツ カテゴリ。広告申込情報と広告主の両方でコンテンツ カテゴリが設定されている場合、広告申込情報の配信時は、より厳しいコンテンツ カテゴリが適用されます。 |
target |
省略可。この広告申込情報の広告を一定の期間に同じユーザーに表示する平均回数。 |
linked |
省略可。商品フィードの項目にリンクされている販売者の ID。 |
related |
省略可。動画の ID は、モバイル デバイスの YouTube アプリで広告が再生される際、メインの動画広告の下に表示されます。 |
lead |
省略可。見込み顧客を発掘するためのフォームの ID。 |
video |
省略可。VideoAdSequence に関連する設定。 |
ThirdPartyMeasurementConfigs
特定の広告申込情報の指標をどの第三者ベンダーが測定するかを指定する設定。
JSON 表現 |
---|
{ "viewabilityVendorConfigs": [ { object ( |
フィールド | |
---|---|
viewability |
省略可。視認性を測定する第三者ベンダー。 該当するサードパーティ ベンダーは次のとおりです。
|
brand |
省略可。ブランド保護を測定する第三者ベンダー。 対象となるサードパーティ ベンダーは次のとおりです。
|
reach |
省略可。リーチを測定する第三者ベンダー。 対象となるサードパーティ ベンダーは次のとおりです。
|
brand |
省略可。ブランド効果を測定する第三者ベンダー。 該当するサードパーティ ベンダーは次のとおりです。
|
ThirdPartyVendorConfig
第三者測定ベンダーの設定方法を管理する設定です。
JSON 表現 |
---|
{
"vendor": enum ( |
フィールド | |
---|---|
vendor |
第三者測定ベンダー。 |
placement |
第三者ベンダーのプラットフォームで広告申込情報を識別するために使用される ID。 |
ThirdPartyVendor
第三者測定を行うベンダー。
列挙型 | |
---|---|
THIRD_PARTY_VENDOR_UNSPECIFIED |
不明な第三者ベンダー。 |
THIRD_PARTY_VENDOR_MOAT |
堀。 |
THIRD_PARTY_VENDOR_DOUBLE_VERIFY |
DoubleVerify |
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE |
Integral Ad Science。 |
THIRD_PARTY_VENDOR_COMSCORE |
Comscore |
THIRD_PARTY_VENDOR_TELEMETRY |
テレメトリー。 |
THIRD_PARTY_VENDOR_MEETRICS |
指標。 |
THIRD_PARTY_VENDOR_ZEFR |
ZEFR |
THIRD_PARTY_VENDOR_NIELSEN |
Nielsen の |
THIRD_PARTY_VENDOR_KANTAR |
Kantar、 |
THIRD_PARTY_VENDOR_DYNATA |
Dynata |
YoutubeAndPartnersInventorySourceConfig
YouTube とパートナーの広告申込情報でターゲティングする YouTube 関連の広告枠を制御する設定。
JSON 表現 |
---|
{ "includeYoutube": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
フィールド | |
---|---|
include |
省略可。YouTube の広告枠をターゲットに設定するかどうか。これには、検索、チャンネル、動画の両方が含まれます。 |
include |
省略可。Google TV で利用可能な動画アプリの広告枠をターゲットに設定するかどうか。 |
include |
YouTube と同じブランド保護基準に準拠しているパートナー サイトやアプリの広告枠をターゲットに設定するかどうか。 |
YoutubeAndPartnersContentCategory
YouTube とパートナーのコンテンツのブランド保護カテゴリ。
列挙型 | |
---|---|
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED |
このバージョンではコンテンツ カテゴリが指定されていないか、不明です。 |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD |
ほとんどのブランドに適した幅広いコンテンツで構成されるカテゴリ。コンテンツは YouTube の広告掲載に適したコンテンツのガイドラインに基づいています。 |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED |
YouTube と動画パートナーのすべてのコンテンツが含まれるカテゴリ。収益化の基準を満たしています。 |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED |
特に不適切な表現や性的描写に関する厳しい要件を満たしているコンテンツに限られるカテゴリです。 |
TargetFrequency
特定の期間内に同じユーザーに広告を表示する平均回数を制御する設定。
JSON 表現 |
---|
{
"targetCount": string,
"timeUnit": enum ( |
フィールド | |
---|---|
target |
|
time |
フリークエンシー目標設定が適用される時間の単位。 適用される時間単位は次のとおりです。
|
time |
フリークエンシー目標設定が有効な
|
VideoAdSequenceSettings
VideoAdSequence に関連する設定。
JSON 表現 |
---|
{ "minimumDuration": enum ( |
フィールド | |
---|---|
minimum |
同じユーザーがこのシーケンスを再度表示するまでの最小時間間隔。 |
steps[] |
シーケンスを構成するステップ。 |
VideoAdSequenceMinimumDuration
同じユーザーが VideoAdSequence を再度表示するまでの最小間隔の列挙型。
列挙型 | |
---|---|
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED |
未指定または不明。 |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK |
7 日。 |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH |
30 日間。 |
VideoAdSequenceStep
VideoAdSequence 内の 1 つのステップの詳細。
JSON 表現 |
---|
{
"stepId": string,
"adGroupId": string,
"previousStepId": string,
"interactionType": enum ( |
フィールド | |
---|---|
step |
ステップの ID。 |
ad |
ステップに対応する広告グループの ID。 |
previous |
前のステップの ID。最初のステップには前のステップがありません。 |
interaction |
ユーザーが前のステップからこのステップに進むためのインタラクション。最初のステップに InteractionType がありません。 |
InteractionType
ステップでのインタラクションの種類。
列挙型 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
不明または不明 |
INTERACTION_TYPE_PAID_VIEW |
有償動画広告の視聴。 |
INTERACTION_TYPE_SKIP |
視聴者がスキップした。 |
INTERACTION_TYPE_IMPRESSION |
(視聴された)広告のインプレッション。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
視聴者がすぐにスキップしなかった広告インプレッションで、課金対象イベントにも達しなかったもの。 |
メソッド |
|
---|---|
|
複数の広告申込情報のターゲティング オプションを一括編集します。 |
|
ターゲティング タイプにわたる複数の広告申込情報に割り当てられているターゲティング オプションを一覧表示します。 |
|
複数の広告申込情報を更新します。 |
|
新しい広告申込情報を作成します。 |
|
広告申込情報を削除します。 |
|
広告申込情報を複製します。 |
|
広告掲載オーダーと ENTITY_STATUS_DRAFT entity_status から継承された設定(ターゲティングを含む)を持つ新しい広告申込情報を作成します。 |
|
広告申込情報を取得します。 |
|
広告主の広告申込情報を一覧表示します。 |
|
既存の広告申込情報の更新。 |