REST Resource: advertisers.lineItems

{
  "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)
  }
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (LineItemType)

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

enum (EntityStatus)

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

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

string (Timestamp format)

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

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

object (PartnerCost)

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

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

object (LineItemFlight)

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

object (LineItemBudget)

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

object (Pacing)

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

object (FrequencyCap)

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

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

object (PartnerRevenueModel)

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

object (ConversionCountingConfig)

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

string (int64 format)

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

object (BiddingStrategy)

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

object (IntegrationDetails)

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

object (TargetingExpansionConfig)

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

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

enum (LineItemWarningMessage)

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

object (MobileApp)

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

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

enum (ReservationType)

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

boolean

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

object (YoutubeAndPartnersSettings)

出力専用。YouTube とパートナーの広告申込情報固有の設定です。

{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}

enum (LineItemFlightDateType)

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

object (DateRange)

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

• flightDateType が LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM の場合は必須です。それ以外の場合は出力のみ。
• 新しい掲載期間を作成する際は、startDate と endDate の両方を将来の日付にする必要があります。
• 過去の startDate が設定された既存のフライトの endDate は変更可能ですが、startDate は不変です。
• endDate は startDate 以降で、どちらも 2037 年より前の日付にする必要があります。

{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}

enum (LineItemBudgetAllocationType)

必須。予算割り当てのタイプ。

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

enum (BudgetUnit)

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

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。このフィールドは適用されず、システムで無視されます。

{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}

enum (PartnerRevenueModelMarkupType)

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

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）を表します。

{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}

string (int64 format)

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

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

object (TrackingFloodlightActivityConfig)

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

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

{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}

string (int64 format)

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

integer

必須。広告がクリックされてからコンバージョンをカウントできる日数です。0 ～ 90 の値にする必要があります。

integer

必須。広告が視聴されてから、コンバージョンがカウントされるまでの日数。0 ～ 90 の値にする必要があります。

{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}

string

必須。プラットフォーム ストアが提供するアプリの ID。

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

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

enum (Platform)

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

string

出力専用。アプリ名。

string

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

{
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}

object (FrequencyCap)

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

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

object (ThirdPartyMeasurementConfigs)

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

object (YoutubeAndPartnersInventorySourceConfig)

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

enum (YoutubeAndPartnersContentCategory)

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

enum (YoutubeAndPartnersContentCategory)

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

object (TargetFrequency)

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

string (int64 format)

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

string

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

string (int64 format)

見込み顧客を発掘するためのフォームの ID。

object (VideoAdSequenceSettings)

VideoAdSequence に関連する設定。

{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}

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

object (ThirdPartyVendorConfig)

省略可。ブランド保護を測定する第三者ベンダー。

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

• THIRD_PARTY_VENDOR_ZERF
• THIRD_PARTY_VENDOR_DOUBLE_VERIFY
• THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE

object (ThirdPartyVendorConfig)

省略可。リーチを測定する第三者ベンダー。

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

• THIRD_PARTY_VENDOR_NIELSEN
• THIRD_PARTY_VENDOR_COMSCORE
• THIRD_PARTY_VENDOR_KANTAR

object (ThirdPartyVendorConfig)

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

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

• THIRD_PARTY_VENDOR_DYNATA
• THIRD_PARTY_VENDOR_KANTAR

{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}

enum (ThirdPartyVendor)

第三者測定ベンダー。

string

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

{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}

boolean

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

boolean

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

boolean

YouTube と同じブランド保護基準に準拠している一連のパートナー サイトやアプリの広告枠をターゲットに設定するかどうかを指定します。

{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}

string (int64 format)

timeUnit と timeUnitCount で指定された期間内に、同じユーザーに広告が表示される平均回数の目標値です。

enum (TimeUnit)

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

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

• TIME_UNIT_WEEKS

integer

フリークエンシー目標設定を維持できる timeUnit の数です。

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

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

{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}

enum (VideoAdSequenceMinimumDuration)

同じユーザーにこのシーケンスが再度表示されるまでの最小期間。

object (VideoAdSequenceStep)

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

{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}

string (int64 format)

ステップの ID。

string (int64 format)

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

string (int64 format)

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

enum (InteractionType)

閲覧者をこのステップに導く、前のステップのインタラクション。最初のステップに InteractionType がありません。