REST Resource: advertisers.lineItems

リソース: LineItem

1 つの広告申込情報。

JSON 表現 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean,
  "youtubeAndPartnersSettings": {
    object (YoutubeAndPartnersSettings)
  },
  "demandGenSettings": {
    object (DemandGenSettings)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus),
  "optimizeFixedBidding": boolean
}
フィールド
name

string

出力専用。広告申込情報のリソース名。
advertiserId

string (int64 format)

出力専用。広告申込情報が属する広告主の一意の ID。
campaignId

string (int64 format)

出力専用。広告申込情報が属するキャンペーンの一意の ID。
insertionOrderId

string (int64 format)

必須。変更不可。広告申込情報が属する広告掲載オーダーの一意の ID。
lineItemId

string (int64 format)

出力専用。広告申込情報の一意の ID。システムによって割り当てられます。
displayName

string

必須。広告申込情報の表示名。

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

enum (LineItemType)

必須。変更不可。広告申込情報のタイプ。
entityStatus

enum (EntityStatus)

必須。広告申込情報で予算を消化して広告枠に入札できるかどうかを制御します。

  • lineItems.create メソッドの場合、ENTITY_STATUS_DRAFT のみが許可されます。広告申込情報を有効にするには、lineItems.patch メソッドを使用し、作成後にステータスを ENTITY_STATUS_ACTIVE に更新します。
  • 広告申込情報を他のステータスから ENTITY_STATUS_DRAFT ステータスに戻すことはできません。
  • 広告申込情報の親広告掲載オーダーが有効でない場合、広告申込情報のステータスが ENTITY_STATUS_ACTIVE であっても、広告申込情報の予算は使用されません。
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"。
partnerCosts[]

object (PartnerCost)

広告申込情報に関連付けられているパートナー費用。

lineItems.create メソッドで指定されていないか空の場合、新しく作成された広告申込情報は、親広告掲載オーダーからパートナー費用を継承します。
flight

object (LineItemFlight)

必須。広告申込情報の掲載期間の開始日時と終了日時。
budget

object (LineItemBudget)

必須。広告申込情報の予算配分の設定。
pacing

object (Pacing)

必須。広告申込情報の予算消化速度の設定。
frequencyCap

object (FrequencyCap)

省略可。広告申込情報タイプが LINE_ITEM_TYPE_DEMAND_GEN でない場合は必須です。広告申込情報のインプレッション フリークエンシー キャップの設定。

制限付きの上限を割り当てる場合は、この設定オブジェクトの maxImpressions フィールドを使用する必要があります。
partnerRevenueModel

object (PartnerRevenueModel)

必須。広告申込情報のパートナーの収益モデルの設定。
conversionCounting

object (ConversionCountingConfig)

広告申込情報のコンバージョン トラッキング設定。
creativeIds[]

string (int64 format)

広告申込情報に関連付けられたクリエイティブの ID。
bidStrategy

object (BiddingStrategy)

必須。広告申込情報の入札戦略。
integrationDetails

object (IntegrationDetails)

広告申込情報の統合の詳細。
targetingExpansion

object (TargetingExpansionConfig)

広告申込情報の最適化されたターゲティングの設定。

この設定は、自動入札を使用し、対象となるオーディエンス リストをターゲット設定しているディスプレイ、動画、オーディオの広告申込情報にのみ適用されます。
warningMessages[]

enum (LineItemWarningMessage)

出力専用。広告申込情報によって生成された警告メッセージ。これらの警告が表示されても広告申込情報を保存することはできますが、広告申込情報の配信がブロックされる場合があります。
mobileApp

object (MobileApp)

広告申込情報で宣伝するモバイルアプリ。

これは、lineItemType が LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL または LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL の場合にのみ適用されます。
reservationType

enum (ReservationType)

出力専用。広告申込情報の予約タイプ。
excludeNewExchanges

boolean

新しいエクスチェンジを広告申込情報の自動ターゲティングから除外するかどうか。このフィールドはデフォルトで false です。
youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

省略可。YouTube とパートナーの広告申込情報に固有の設定。
demandGenSettings

object (DemandGenSettings)

省略可。デマンド ジェネレーション広告申込情報に固有の設定。

デマンド ジェネレーション広告申込情報にのみ適用されます。
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

この広告申込情報で EU における政治広告を配信するかどうか。

親広告主で containsEuPoliticalAds が DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING に設定されている場合、特に指定がない限り、このフィールドには DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING が割り当てられます。このフィールドは、UI、API、または構造化データファイルを使用して更新できます。

このフィールドは、新しい広告申込情報を作成するときに割り当てる必要があります。それ以外の場合、advertisers.lineItems.create リクエストは失敗します。
optimizeFixedBidding

boolean

省略可。固定単価入札の広告申込情報に対してディスプレイ＆ビデオ 360 の入札単価の最適化を有効にするかどうか。

ディスプレイ＆ビデオ 360 では、デフォルトで固定単価入札が最適化され、成果が低いと見込まれるインプレッションの入札単価が自動的に引き下げられます。この最適化はデフォルトで有効になっています（値は true）。

このフィールドが false に設定されている場合、この最適化は無効になり、入札単価が引き下げられることはありません。

この設定は、FIXED_BID タイプの biddingStrategy を含む広告申込情報にのみ適用されます。

LineItemType

広告申込情報のタイプ。

広告申込情報のタイプによって、適用される設定やオプション（広告のフォーマットやターゲティング オプションなど）が決まります。

列挙型
LINE_ITEM_TYPE_UNSPECIFIED

このバージョンでは、Type 値が指定されていないか、不明です。

このタイプの広告申込情報とそのターゲティングは、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 を使用して作成または更新することはできません。
LINE_ITEM_TYPE_DEMAND_GEN デマンド ジェネレーション広告

LineItemFlight

広告申込情報のアクティブ期間を制御する設定。

JSON 表現 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}
フィールド
flightDateType

enum (LineItemFlightDateType)

必須。広告申込情報の掲載期間のタイプ。
dateRange

object (DateRange)

広告申込情報の掲載期間の開始日と終了日。これらは、親広告主のタイムゾーンを基準として解決されます。

  • flightDateType が LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM の場合は必須。それ以外の場合は出力専用。
  • 新しいフライトを作成する場合、startDate と endDate の両方が将来の日付である必要があります。
  • 過去の startDate を含む既存のフライトでは、endDate は変更可能ですが、startDate は変更できません。
  • endDate は startDate 以降の日付を指定してください。どちらも 2037 年より前の日付を指定してください。

LineItemFlightDateType

広告申込情報の掲載期間のタイプ。

列挙型
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED このバージョンでは、Type 値が指定されていないか、不明です。
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED 広告申込情報の掲載期間は、親の広告掲載オーダーから継承されます。
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM 広告申込情報で独自のカスタム掲載期間を使用している。

LineItemBudget

予算の割り当て方法を管理する設定。

JSON 表現 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
フィールド
budgetAllocationType

enum (LineItemBudgetAllocationType)

必須。予算配分のタイプ。

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC は、親広告掲載オーダーで予算の自動割り当てが有効になっている場合にのみ適用されます。

デマンド ジェネレーション広告申込情報の場合、このフィールドは LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED に設定する必要があります。
budgetUnit

enum (BudgetUnit)

出力専用。予算単位では、予算が通貨ベースかインプレッション ベースかを指定します。この値は、親広告掲載オーダーから継承されます。
maxAmount

string (int64 format)

広告申込情報で使用する最大予算額。0 より大きくする必要があります。

budgetAllocationType が次の値の場合:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC。このフィールドは変更不可で、システムによって設定されます。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED（budgetUnit が以下の場合）:
    • BUDGET_UNIT_CURRENCY の場合、このフィールドは、使用する最大予算額を広告主の通貨のマイクロ単位で表します。たとえば、1500000 は、通貨の 1.5 標準単位を表します。
    • BUDGET_UNIT_IMPRESSIONS: このフィールドは、配信するインプレッションの最大数を表します。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED の場合、このフィールドは該当なしであり、システムによって無視されます。

LineItemBudgetAllocationType

予算配分のタイプ。

列挙型
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED このバージョンでは、Type 値が指定されていないか、不明です。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC 広告申込情報で予算の自動割り当てが有効になっている。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED 広告申込情報に固定の最大予算額が割り当てられている。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED 広告申込情報に予算制限が適用されていません。

PartnerRevenueModel

パートナーの収益の計算方法を制御する設定。

JSON 表現 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
フィールド
markupType

enum (PartnerRevenueModelMarkupType)

必須。パートナーの収益モデルのマークアップ タイプ。

デマンド ジェネレーション広告申込情報の場合、このフィールドは PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP に設定する必要があります。
markupAmount

string (int64 format)

必須。パートナーの収益モデルのマークアップ額。0 以上で指定します。

  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM に設定されている場合、このフィールドは広告主の通貨のマイクロ単位でのインプレッション単価マークアップを表します。たとえば、1500000 は、通貨の 1.5 標準単位を表します。
  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP に設定されている場合、このフィールドはメディア費用のマークアップ率をミリ単位で表します。たとえば、100 は 0.1%（小数 0.001）を表します。
  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP に設定されている場合、このフィールドは合計メディア費用のマークアップ率（ミリ単位）を表します。たとえば、100 は 0.1%（小数 0.001）を表します。

PartnerRevenueModelMarkupType

パートナーの収益モデルで使用できるマークアップ タイプ。

列挙型
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED このバージョンでは、Type 値が指定されていないか、不明です。
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 (TrackingFloodlightActivityConfig)
    }
  ],
  "primaryAttributionModelId": string
}
フィールド
postViewCountPercentageMillis

string (int64 format)

カウントするポストビュー コンバージョンの割合（1/1, 000 パーセント単位）。0 ～ 100,000 にする必要があります（両端を含む）。

たとえば、ポストクリック コンバージョンの 50% をトラッキングするには、50000 の値を設定します。
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

コンバージョンのトラッキングに使用される Floodlight アクティビティの設定。

コンバージョン数は、このフィールドで指定されたすべての Floodlight アクティビティ ID でカウントされたすべてのコンバージョンの合計です。

広告申込情報にカスタム入札アルゴリズムが割り当てられている場合、このフィールドは更新できません。このフィールドを設定し、同じリクエストでカスタム入札アルゴリズムを割り当てる場合、Floodlight アクティビティはカスタム入札アルゴリズムで使用されるものと一致する必要があります。
primaryAttributionModelId

string (int64 format)

省略可。コンバージョンの測定に使用するアトリビューション モデル。このアトリビューション モデルによって、コンバージョンのカウント方法が決まります。メインモデルは、Floodlight 設定またはグループに対して設定できます。詳しくはこちらをご覧ください。

デマンド ジェネレーション広告申込情報にのみ適用されます。

TrackingFloodlightActivityConfig

1 つの Floodlight アクティビティ構成の動作を制御する設定。

JSON 表現 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
フィールド
floodlightActivityId

string (int64 format)

必須。Floodlight アクティビティの ID。
postClickLookbackWindowDays

integer

必須。広告がクリックされてからコンバージョンがカウントされるまでの日数。0 ～ 90 の範囲で指定してください。
postViewLookbackWindowDays

integer

必須。広告が視聴されてからコンバージョンがカウントされるまでの日数。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 (Platform),
  "displayName": string,
  "publisher": string
}
フィールド
appId

string

必須。プラットフォーム ストアから提供されたアプリの ID。

Android アプリは、Android の Google Play ストアで使用されるバンドル ID（com.google.android.gm など）で識別されます。

iOS アプリは、Apple のアプリストアで使用される 9 桁のアプリ ID（422689480 など）で識別されます。
platform

enum (Platform)

出力専用。アプリのプラットフォーム。
displayName

string

出力専用。アプリ名。
publisher

string

出力専用。アプリのパブリッシャー。

プラットフォーム

モバイルアプリのプラットフォーム。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
IOS iOS プラットフォーム。
ANDROID Android プラットフォーム。

YoutubeAndPartnersSettings

YouTube とパートナーの広告申込情報の設定。

JSON 表現 
{
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideos": [
    {
      object (RelatedVideo)
    }
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  },
  "videoAdInventoryControl": {
    object (VideoAdInventoryControl)
  }
}
フィールド
viewFrequencyCap

object (FrequencyCap)

広告申込情報の視聴フリークエンシー キャップの設定。

制限付きの上限を割り当てる場合は、この設定オブジェクトの maxViews フィールドを使用する必要があります。
thirdPartyMeasurementConfigs

object (ThirdPartyMeasurementConfigs)

省略可。広告申込情報の第三者による測定の設定。
inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

広告申込情報のターゲットとなる YouTube とパートナーの広告在庫を管理する設定。
contentCategory

enum (YoutubeAndPartnersContentCategory)

出力専用。YouTube とパートナーの広告が表示されるコンテンツの種類。
effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

出力専用。広告申込情報の配信時に有効になるコンテンツ カテゴリ。広告申込情報と広告主の両方でコンテンツ カテゴリが設定されている場合、広告申込情報の配信時には、より厳格なカテゴリが適用されます。

新しい広告申込情報は、広告主レベルの設定のみを継承します。
targetFrequency

object (TargetFrequency)

省略可。この広告申込情報の広告を一定期間内に同じユーザーに表示する平均回数です。
linkedMerchantId

string (int64 format)

省略可。商品フィードの提供に使用される Merchant Center アカウントの ID。

この Merchant Center アカウントは、すでに広告主にリンクされている必要があります。
relatedVideos[]

object (RelatedVideo)

省略可。広告申込情報の関連動画。これらの動画は、モバイル デバイスの YouTube アプリで広告が再生される際、メインの動画広告の下に表示されます。
leadFormId

string (int64 format)

省略可。見込み顧客を発掘するフォームの ID。
videoAdSequenceSettings

object (VideoAdSequenceSettings)

省略可。動画広告シーケンスに関連する設定。
videoAdInventoryControl

object (VideoAdInventoryControl)

省略可。この広告申込情報で使用できる広告枠を管理するための設定。

ThirdPartyMeasurementConfigs

特定の広告申込情報の指標を測定するサードパーティ ベンダーを管理する設定。

JSON 表現 
{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}
フィールド
viewabilityVendorConfigs[]

object (ThirdPartyVendorConfig)

省略可。視認性を測定するサードパーティ ベンダー。

次のサードパーティ ベンダーが対象となります。

  • THIRD_PARTY_VENDOR_MOAT
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_TELEMETRY
  • THIRD_PARTY_VENDOR_MEETRICS
brandSafetyVendorConfigs[]

object (ThirdPartyVendorConfig)

省略可。ブランド保護を測定するサードパーティ ベンダー。

次のサードパーティ ベンダーが対象となります。

  • THIRD_PARTY_VENDOR_ZEFR
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

省略可。リーチを測定するサードパーティ ベンダー。

以下のサードパーティ ベンダーが対象となります。

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_VIDEO_RESEARCH
  • THIRD_PARTY_VENDOR_MEDIA_SCOPE
  • THIRD_PARTY_VENDOR_AUDIENCE_PROJECT
  • THIRD_PARTY_VENDOR_VIDEO_AMP
  • THIRD_PARTY_VENDOR_ISPOT_TV
  • THIRD_PARTY_VENDOR_GEMIUS
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

省略可。ブランド効果測定を行うサードパーティ ベンダー。

以下のサードパーティ ベンダーが対象となります。

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR
  • THIRD_PARTY_VENDOR_INTAGE
  • THIRD_PARTY_VENDOR_MACROMILL

ThirdPartyVendorConfig

第三者による測定ベンダーの設定を管理する設定。

JSON 表現 
{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}
フィールド
vendor

enum (ThirdPartyVendor)

第三者による測定ベンダー。
placementId

string

サードパーティ ベンダーのプラットフォームで広告申込情報を識別するために使用される ID。

ThirdPartyVendor

第三者による測定を行うベンダー。

列挙型
THIRD_PARTY_VENDOR_UNSPECIFIED 不明なサードパーティ ベンダー。
THIRD_PARTY_VENDOR_MOAT 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 Meetrics。
THIRD_PARTY_VENDOR_ZEFR ZEFR。
THIRD_PARTY_VENDOR_NIELSEN Nielsen。
THIRD_PARTY_VENDOR_KANTAR Kantar。
THIRD_PARTY_VENDOR_DYNATA Dynata。
THIRD_PARTY_VENDOR_TRANSUNION Transunion。
THIRD_PARTY_VENDOR_ORIGIN 生成元に帰属するものとして扱うことを可能にする技術です。
THIRD_PARTY_VENDOR_GEMIUS Gemius。
THIRD_PARTY_VENDOR_MEDIA_SCOPE MediaScope。
THIRD_PARTY_VENDOR_AUDIENCE_PROJECT Audience Project。
THIRD_PARTY_VENDOR_VIDEO_AMP Video Amp。
THIRD_PARTY_VENDOR_ISPOT_TV Ispot テレビ。
THIRD_PARTY_VENDOR_INTAGE インテージ
THIRD_PARTY_VENDOR_MACROMILL Macromill。
THIRD_PARTY_VENDOR_VIDEO_RESEARCH Video Research。
THIRD_PARTY_VENDOR_AQUILA Aquila。

YoutubeAndPartnersInventorySourceConfig

YouTube とパートナーの広告申込情報のターゲティング対象となる YouTube 関連の広告枠を管理する設定。

JSON 表現 
{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
フィールド
includeYoutube

boolean

省略可。YouTube の広告枠をターゲットに設定するかどうか。これには、検索、チャンネル、動画の両方が含まれます。
includeGoogleTv

boolean

省略可。Google TV で利用可能な動画アプリの広告枠をターゲットに設定するかどうか。
includeYoutubeVideoPartners

boolean

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 (TimeUnit),
  "timeUnitCount": integer
}
フィールド
targetCount

string (int64 format)

timeUnit と timeUnitCount で指定されたタイムスパン内に、同じユーザーに広告が表示される平均回数の目標値。
timeUnit

enum (TimeUnit)

フリークエンシー目標設定が適用される期間の単位。

次の時間単位が適用されます。

  • TIME_UNIT_WEEKS
  • TIME_UNIT_MONTHS
timeUnitCount

integer

フリークエンシー目標設定が継続するtimeUnitの数。

timeUnit の値に応じて、次の制限が適用されます。

  • TIME_UNIT_WEEKS - 1 にする必要があります。
  • TIME_UNIT_MONTHS - 1 にする必要があります

RelatedVideo

関連動画のエントリを表します。

JSON 表現 
{
  "videoId": string,
  "videoAssetId": string
}
フィールド
videoId

string

出力専用。関連動画の YouTube 動画 ID。
videoAssetId

string (int64 format)

必須。YouTube 動画の AdAsset リソースの adAssetId。

VideoAdSequenceSettings

動画広告シーケンスに関連する設定。

JSON 表現 
{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}
フィールド
minimumDuration

enum (VideoAdSequenceMinimumDuration)

同じユーザーにこのシーケンスが再び表示されるまでの最小時間間隔。
steps[]

object (VideoAdSequenceStep)

シーケンスを構成するステップ。

VideoAdSequenceMinimumDuration

同じユーザーに動画広告シーケンスが再び表示されるまでの最小間隔時間の列挙型。

列挙型
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED 未指定または不明。
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 日。
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 日

VideoAdSequenceStep

動画広告シーケンスの 1 つのステップの詳細。

JSON 表現 
{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}
フィールド
stepId

string (int64 format)

ステップの ID。
adGroupId

string (int64 format)

ステップに対応する広告グループの ID。
previousStepId

string (int64 format)

前のステップの ID。最初のステップには前のステップがありません。
interactionType

enum (InteractionType)

視聴者をこのステップに誘導する、前のステップでのインタラクション。最初のステップには interactionType がありません。

InteractionType

ステップでのインタラクションのタイプ。

列挙型
INTERACTION_TYPE_UNSPECIFIED 未指定または不明
INTERACTION_TYPE_PAID_VIEW 有償動画広告の視聴。
INTERACTION_TYPE_SKIP 視聴者によってスキップされた。
INTERACTION_TYPE_IMPRESSION （視聴された）広告インプレッション。
INTERACTION_TYPE_ENGAGED_IMPRESSION 視聴者がすぐにスキップしなかったものの、課金対象イベントにも至らなかった広告のインプレッション。

VideoAdInventoryControl

特定の YouTube 広告申込情報タイプで使用される動画広告枠の管理機能。

JSON 表現 
{
  "allowInStream": boolean,
  "allowInFeed": boolean,
  "allowShorts": boolean,
  "allowNonSkippableInStream": boolean
}
フィールド
allowInStream

boolean

省略可。広告をインストリーム フォーマットで配信できるかどうか。
allowInFeed

boolean

省略可。広告をインフィード フォーマットで配信できるかどうか。
allowShorts

boolean

省略可。広告をショート動画フォーマットとして配信できるかどうか。
allowNonSkippableInStream

boolean

省略可。広告をスキップ不可のインストリーム フォーマットで配信できるかどうかを示します。

DemandGenSettings

デマンド ジェネレーション広告申込情報の設定。

JSON 表現 
{
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "linkedMerchantId": string,
  "geoLanguageTargetingEnabled": boolean
}
フィールド
thirdPartyMeasurementConfigs

object (ThirdPartyMeasurementConfigs)

省略可。デマンド ジェネレーション広告申込情報の第三者による測定の設定。
linkedMerchantId

string (int64 format)

省略可。商品フィードの提供に使用される Merchant Center アカウントの ID。

この Merchant Center アカウントは、すでに広告主にリンクされている必要があります。
geoLanguageTargetingEnabled

boolean

省略可。変更不可。地域と言語のターゲティングを広告申込情報単位で設定できるかどうか。それ以外の場合は、関連するターゲティング タイプを広告グループに直接割り当てる必要があります。

メソッド

bulkEditAssignedTargetingOptions

 複数の広告申込情報でターゲティング オプションを一括編集します。

bulkListAssignedTargetingOptions

 複数の広告申込情報に割り当てられているターゲティング オプションを、ターゲティング タイプをまたいで一覧表示します。

bulkUpdate

 複数の広告申込情報を更新します。

create

 新しい広告申込情報を作成します。

delete

 広告申込情報を削除します。

duplicate

 広告申込情報を複製します。

get

 広告申込情報を取得します。

list

 広告主の広告申込情報を一覧表示します。

patch

 既存の広告申込情報を更新します。