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

出力専用。広告申込情報が最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
partnerCosts[]

object (PartnerCost)

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

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

object (LineItemFlight)

必須。広告申込情報の配信期間の開始時間と終了時間。
budget

object (LineItemBudget)

必須。広告申込情報の予算割り当て設定。
pacing

object (Pacing)

必須。広告申込情報の予算消化ペースの設定。
frequencyCap

object (FrequencyCap)

必須。広告申込情報のインプレッションのフリークエンシー キャップ設定。

上限を設定する場合は、この設定オブジェクトの 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 とパートナーの広告申込情報固有の設定です。

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 (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 このバージョンでは、タイプ値が指定されていないか、不明です。
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 は、親広告掲載オーダーで予算の自動割り当てが有効になっている場合にのみ適用されます。
budgetUnit

enum (BudgetUnit)

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

string (int64 format)

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

budgetAllocationType が次の場合:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC: このフィールドは変更不可で、システムによって設定されます。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED（budgetUnit が以下の場合）: <ph type="x-smartling-placeholder">
      </ph>
    • BUDGET_UNIT_CURRENCY: このフィールドには、広告主の通貨でマイクロ単位の予算の上限額を指定します。たとえば、1500000 は、通貨の 1.5 標準単位を表します。
    • BUDGET_UNIT_IMPRESSIONS。このフィールドは、配信するインプレッションの最大数を表します。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED。このフィールドは適用されず、システムで無視されます。

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 (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
フィールド
markupType

enum (PartnerRevenueModelMarkupType)

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

string (int64 format)

必須。パートナー収益モデルの上乗せ額。0 以上で指定します。

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

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

string (int64 format)

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

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

object (TrackingFloodlightActivityConfig)

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

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

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 この広告申込情報の広告掲載オーダーの終了日が過去の日付に設定されています。広告申込情報は実行されません。
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

この広告申込情報では excludeFirstPartyAudience 設定を使用しますが、この設定はサポートが終了し、2023 年 3 月 25 日以降に廃止される予定です。

excludeFirstPartyAudience フィールドのサポート終了に備えて、2023 年 3 月 25 日までに API 統合を更新し、オーディエンス ターゲティングを使用してファースト パーティ オーディエンスを直接除外するようにしてください。

MobileApp

モバイルアプリ インストール広告申込情報によって宣伝されるモバイルアプリ。

JSON 表現 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
フィールド
appId

string

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

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

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

enum (Platform)

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

string

出力専用。アプリ名。
publisher

string

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

プラットフォーム

利用可能なモバイルアプリ プラットフォーム。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
IOS ダウンロードします
ANDROID Android プラットフォーム。

YoutubeAndPartnersSettings

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

JSON 表現 
{
  "biddingStrategy": {
    object (YoutubeAndPartnersBiddingStrategy)
  },
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementSettings": {
    object (YoutubeAndPartnersThirdPartyMeasurementSettings)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}
フィールド
biddingStrategy

object (YoutubeAndPartnersBiddingStrategy)

必須。YouTube とパートナー広告申込情報の入札戦略。
viewFrequencyCap

object (FrequencyCap)

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

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

object (YoutubeAndPartnersThirdPartyMeasurementSettings)

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

object (YoutubeAndPartnersInventorySourceConfig)

広告申込情報でターゲティングする YouTube とパートナーの広告枠を制御する設定。
contentCategory

enum (YoutubeAndPartnersContentCategory)

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

enum (YoutubeAndPartnersContentCategory)

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

object (TargetFrequency)

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

string (int64 format)

商品フィードの広告申込情報にリンクされている販売者の ID。
relatedVideoIds[]

string

動画の ID は、モバイル デバイスの YouTube アプリで広告が再生される際、メインの動画広告の下に表示されます。
leadFormId

string (int64 format)

見込み顧客を生成するためのフォームの ID。
videoAdSequenceSettings

object (VideoAdSequenceSettings)

VideoAdSequence に関連する設定。

YoutubeAndPartnersThirdPartyMeasurementSettings

特定の広告申込情報の指標をどの第三者ベンダーが測定するかを指定する設定。

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_ZERF
  • 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
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

ブランド効果測定を測定する第三者ベンダー。

該当するサードパーティ ベンダーは次のとおりです。

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR

ThirdPartyVendorConfig

サードパーティ測定ベンダーの設定方法を制御する設定。

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

enum (ThirdPartyVendor)

第三者測定ベンダー。
placementId

string

広告申込情報を識別するために第三者ベンダーのプラットフォームで使用される 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 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 表現 
{
  "includeYoutubeSearch": boolean,
  "includeYoutubeVideos": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
フィールド
includeYoutubeVideos

boolean

YouTube のチャンネルと動画の広告枠と、他のサイトに埋め込まれた 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
timeUnitCount

integer

フリークエンシー目標設定が有効な timeUnit の数。

timeUnit の値に基づいて、次の制限が適用されます。

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

VideoAdSequenceSettings

VideoAdSequence に関連する設定。

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

enum (VideoAdSequenceMinimumDuration)

同じユーザーがこのシーケンスを再度表示するまでの最小時間間隔。
steps[]

object (VideoAdSequenceStep)

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

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 (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 視聴者がすぐにはスキップせず、請求対象のイベントにも達しなかった広告インプレッション。

メソッド

bulkEditAssignedTargetingOptions

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

bulkListAssignedTargetingOptions

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

bulkUpdate

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

create

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

delete

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

duplicate

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

generateDefault

 広告掲載オーダーから継承した設定（ターゲティングを含む）と ENTITY_STATUS_DRAFT entity_status を使用して、新しい広告申込情報を作成します。

get

 項目を取得します。

list

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

patch

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