REST Resource: advertisers.lineItems

منبع: LineItem

یک مورد تک خطی

نمایندگی 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)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
زمینه های
name

string

فقط خروجی The resource name of the line item.

advertiserId

string ( int64 format)

فقط خروجی شناسه منحصربه‌فرد تبلیغ‌کننده‌ای که مورد خط به آن تعلق دارد.

campaignId

string ( int64 format)

فقط خروجی The unique ID of the campaign that the line item belongs to.

insertionOrderId

string ( int64 format)

ضروری. تغییرناپذیر. شناسه منحصر به فرد سفارش درج که مورد خط به آن تعلق دارد.

lineItemId

string ( int64 format)

فقط خروجی شناسه منحصر به فرد مورد خط. توسط سیستم تعیین شده است.

displayName

string

ضروری. نام نمایشی مورد خط.

باید UTF-8 با حداکثر اندازه 240 بایت کدگذاری شود.

lineItemType

enum ( LineItemType )

ضروری. تغییرناپذیر. نوع آیتم خط.

entityStatus

enum ( EntityStatus )

ضروری. Controls whether or not the line item can spend its budget and bid on inventory.

  • For lineItems.create method, only ENTITY_STATUS_DRAFT is allowed. To activate a line item, use lineItems.patch method and update the status to ENTITY_STATUS_ACTIVE after creation.
  • A line item cannot be changed back to ENTITY_STATUS_DRAFT status from any other status.
  • If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE .
updateTime

string ( Timestamp format)

فقط خروجی The timestamp when the line item was last updated. توسط سیستم تعیین شده است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

partnerCosts[]

object ( PartnerCost )

The partner costs associated with the line item.

If absent or empty in lineItems.create method, the newly created line item will inherit partner costs from its parent insertion order.

flight

object ( LineItemFlight )

ضروری. زمان شروع و پایان پرواز خط مورد.

budget

object ( LineItemBudget )

ضروری. The budget allocation setting of the line item.

pacing

object ( Pacing )

ضروری. تنظیم سرعت هزینه بودجه آیتم خط.

frequencyCap

object ( FrequencyCap )

ضروری. تنظیمات درب فرکانس نمایش مورد خط.

فیلد maxImpressions در این شی تنظیمات باید در صورت اختصاص یک سرپوش محدود استفاده شود.

partnerRevenueModel

object ( PartnerRevenueModel )

ضروری. تنظیم مدل درآمد شریک مورد خط.

conversionCounting

object ( ConversionCountingConfig )

تنظیم ردیابی تبدیل مورد خط.

creativeIds[]

string ( int64 format)

شناسه‌های خلاقیت‌های مرتبط با مورد خط.

bidStrategy

object ( BiddingStrategy )

ضروری. The bidding strategy of the line item.

integrationDetails

object ( IntegrationDetails )

Integration details of the line item.

inventorySourceIds[]

string ( int64 format)

شناسه منابع موجودی خصوصی اختصاص داده شده به آیتم خط.

targetingExpansion

object ( TargetingExpansionConfig )

تنظیمات هدف گذاری بهینه مورد خط.

این پیکربندی فقط برای موارد صفحه نمایش، ویدیو یا صوتی که از مناقصه خودکار استفاده می‌کنند و فهرست‌های مخاطبان واجد شرایط را هدف قرار می‌دهند، قابل اجرا است.

warningMessages[]

enum ( LineItemWarningMessage )

فقط خروجی The warning messages generated by the line item. این اخطارها ذخیره آیتم خط را مسدود نمی کنند، اما برخی ممکن است اجرای آیتم خط را مسدود کنند.

mobileApp

object ( MobileApp )

برنامه تلفن همراه که توسط مورد خط تبلیغ می شود.

این فقط زمانی قابل اعمال است که نوع lineItemType LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL یا LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL باشد.

reservationType

enum ( ReservationType )

فقط خروجی The reservation type of the line item.

excludeNewExchanges

boolean

آیا مبادلات جدید از هدف قرار گرفتن خودکار توسط آیتم خط حذف می شوند یا خیر. This field is false by default.

LineItemType

انواع احتمالی یک آیتم خط.

نوع آیتم خط تعیین می‌کند که کدام تنظیمات و گزینه‌ها قابل اجرا هستند، مانند قالب تبلیغات یا گزینه‌های هدف.

Enums
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 قابل استفاده است.

LineItemFlight

تنظیماتی که مدت زمان فعال یک مورد خط را کنترل می کند.

نمایندگی JSON
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
زمینه های
flightDateType

enum ( LineItemFlightDateType )

ضروری. نوع تاریخ پرواز مورد خط.

dateRange

object ( DateRange )

تاریخ شروع و پایان پرواز مورد خط. آنها نسبت به منطقه زمانی تبلیغ کننده اصلی حل می شوند.

  • زمانی که flightDateType LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM باشد، الزامی است. خروجی فقط در غیر این صورت.
  • هنگام ایجاد یک پرواز جدید، هر دو startDate و endDate باید در آینده باشند.
  • پرواز موجود با startDate در گذشته دارای endDate قابل تغییر است اما startDate غیرقابل تغییر دارد.
  • endDate باید startDate یا بالاتر باشد، هر دو قبل از سال 2037.
triggerId

string ( int64 format)

شناسه راه‌انداز دستی مرتبط با مورد خط.

  • زمانی که flightDateType LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER باشد الزامی است. در غیر این صورت نباید تنظیم شود.
  • در صورت تنظیم، تاریخ پرواز مورد خط از ترتیب درج والد آن به ارث می رسد.
  • زمانی که محرک انتخابی در تاریخ پرواز سفارش درج والد فعال شود، موارد خط فعال هزینه می‌شوند.

هشدار: موارد خطی که از محرک‌های دستی استفاده می‌کنند، دیگر در Display & Video 360 استفاده نمی‌شوند. این فیلد در 1 اوت 2023 غروب می‌کند. برای اطلاعات بیشتر اعلامیه لغو ویژگی ما را بخوانید.

LineItemFlightDateType

انواع احتمالی تاریخ پرواز یک آیتم خط.

Enums
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED مقدار نوع در این نسخه مشخص نشده است یا ناشناخته است.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED تاریخ پرواز مورد خط از ترتیب درج والد آن به ارث می رسد.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM مورد خط از تاریخ پرواز سفارشی خود استفاده می کند.
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

مورد خط از یک ماشه استفاده می کند.

هشدار: موارد خطی که از محرک‌های دستی استفاده می‌کنند دیگر در Display & Video 360 استفاده نمی‌شوند. این مقدار در 1 اوت 2023 غروب می‌کند. برای اطلاعات بیشتر اعلامیه لغو ویژگی ما را بخوانید.

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 :
    • BUDGET_UNIT_CURRENCY ، این فیلد حداکثر مقدار بودجه برای خرج کردن را در میکرو واحد پول تبلیغ‌کننده نشان می‌دهد. به عنوان مثال، 1500000 نشان دهنده 1.5 واحد استاندارد واحد پول است.
    • BUDGET_UNIT_IMPRESSIONS ، این فیلد نشان دهنده حداکثر تعداد نمایش برای ارائه است.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED ، این فیلد قابل اجرا نیست و توسط سیستم نادیده گرفته خواهد شد.

LineItemBudgetAllocationType

انواع احتمالی تخصیص بودجه

Enums
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٪ (اعشاری 0.001) است.
  • زمانی که markupType روی PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP تنظیم شده است، این فیلد کل درصد نشانه گذاری هزینه رسانه را به میلی نشان می دهد. به عنوان مثال، 100 نشان دهنده 0.1٪ (اعشاری 0.001) است.

PartnerRevenueModelMarkupType

انواع نشانه‌گذاری احتمالی مدل درآمد شریک.

Enums
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)

The percentage of post-view conversions to count, in millis (1/1000 of a percent). باید بین 0 تا 100000 باشد.

به عنوان مثال، برای ردیابی 50٪ از تبدیل های پس از کلیک، مقدار 50000 را تعیین کنید.

floodlightActivityConfigs[]

object ( TrackingFloodlightActivityConfig )

تنظیمات فعالیت Floodlight که برای ردیابی تبدیل ها استفاده می شود.

تعداد تبدیل‌های شمارش‌شده، مجموع همه تبدیل‌های شمارش‌شده توسط همه شناسه‌های فعالیت Floodlight مشخص‌شده در این فیلد است.

TrackingFloodlightActivityConfig

Settings that control the behavior of a single Floodlight activity config.

نمایندگی JSON
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
زمینه های
floodlightActivityId

string ( int64 format)

ضروری. The ID of the Floodlight activity.

postClickLookbackWindowDays

integer

ضروری. تعداد روزهایی که پس از کلیک روی یک تبلیغ ممکن است در آن تبدیل حساب شود. Must be between 0 and 90 inclusive.

postViewLookbackWindowDays

integer

ضروری. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.

TargetingExpansionConfig

تنظیماتی که تنظیمات هدف‌یابی بهینه مورد خط را کنترل می‌کنند.

نمایندگی JSON
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
زمینه های
targetingExpansionLevel

enum ( TargetingExpansionLevel )

ضروری. آیا هدف‌یابی بهینه‌سازی شده روشن است یا خیر.

این فیلد از مقادیر زیر پشتیبانی می کند:

  • NO_EXPANSION : هدف‌گیری بهینه خاموش است
  • LEAST_EXPANSION : هدف‌گیری بهینه روشن است

اگر این فیلد روی مقدار دیگری تنظیم شود، به طور خودکار روی LEAST_EXPANSION تنظیم می شود.

NO_EXPANSION مقدار پیش‌فرض فیلد خواهد بود و اگر فیلد را تنظیم نکنید، به‌طور خودکار به آن اختصاص داده می‌شود.

excludeFirstPartyAudience
(deprecated)

boolean

آیا برای حذف مخاطبان شخص اول از استفاده در توسعه هدف.

این فیلد با راه‌اندازی هدف‌یابی بهینه منسوخ شد.

این فیلد روی false تنظیم می شود. اگر این فیلد در هنگام منسوخ شدن روی true تنظیم شود، همه هدف‌یابی مخاطبان شخص اول مثبت اختصاص داده شده به این مورد با هدف‌گیری منفی همان مخاطبان شخص اول جایگزین می‌شود تا از مستثنی ماندن مستمر آن مخاطبان اطمینان حاصل شود.

TargetingExpansionLevel

تنظیمات هدف گیری بهینه

Enums
TARGETING_EXPANSION_LEVEL_UNSPECIFIED تنظیم هدف بهینه شده در این نسخه مشخص نشده یا ناشناخته است.
NO_EXPANSION هدف گیری بهینه خاموش است.
LEAST_EXPANSION هدف‌گیری بهینه روشن است.
SOME_EXPANSION

در صورت استفاده، به طور خودکار روی LEAST_EXPANSION تنظیم می شود.

BALANCED_EXPANSION

در صورت استفاده، به طور خودکار روی LEAST_EXPANSION تنظیم می شود.

MORE_EXPANSION

در صورت استفاده، به طور خودکار روی LEAST_EXPANSION تنظیم می شود.

MOST_EXPANSION

در صورت استفاده، به طور خودکار روی LEAST_EXPANSION تنظیم می شود.

LineItemWarningMessage

پیام های هشدار تولید شده توسط یک آیتم خط. These types of warnings do not block saving a line item, but may block a line item from running.

Enums
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED مشخص نشده یا ناشناخته است.
INVALID_FLIGHT_DATES This line item has invalid flight dates. The line item will not run.
EXPIRED تاریخ پایان این مورد خط در گذشته است.
PENDING_FLIGHT This line item will begin running in the future.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED همه صرافی های فعال شریک به طور منفی هدف قرار می گیرند. مورد خط اجرا نمی شود.
INVALID_INVENTORY_SOURCE No active inventory sources are being targeted. The line item will not run.
APP_INVENTORY_INVALID_SITE_TARGETING هدف‌گیری برنامه‌ها و نشانی‌های وب این مورد خطی شامل هیچ برنامه تلفن همراه نمی‌شود. This line item's type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run.
APP_INVENTORY_INVALID_AUDIENCE_LISTS This line item isn't targeting any mobile users. This line item's type requires you to target a user list with mobile users. The line item will not run.
NO_VALID_CREATIVE This line item does not contain any valid creative. The line item will not run.
PARENT_INSERTION_ORDER_PAUSED The insertion order of this line item is paused. The line item will not run.
PARENT_INSERTION_ORDER_EXPIRED The insertion order of this line item has its end date set in the past. The line item will not run.
NO_POSITIVE_AUDIENCE_LIST_TARGETED این مورد هیچ لیست مخاطبی را هدف قرار نمی دهد، که ممکن است باعث شود بودجه شما خیلی سریع خرج شود.
APP_INSTALL_NO_CONVERSION_PIXEL This app install line item does not have any conversion pixel set up.
TARGETING_REVOKED_OR_CLOSED_USER_LIST This line item targets one or more user lists that are no longer available. In the future, this will prevent the line item from serving, so consider removing these lists from your targeting.
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY این مورد خط نصب برنامه استراتژی پیشنهاد قیمت بهینه ندارد.
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS Deals targeted by this line item accept creative sizes which are not in use. This may limit the line item's delivery or performance.
NO_CREATIVE_FOR_TARGETED_DEALS This line item does not contain any creative for the targeted deals.
TARGETING_DEPRECATED_GEO_TARGET This line item targets a geo target that is deprecated.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

This line item uses the excludeFirstPartyAudience setting, which is deprecated and scheduled to sunset after March 25, 2023 .

یکپارچه‌سازی API خود را به‌روزرسانی کنید تا مستقیماً مخاطبان شخص اول را با استفاده از هدف‌یابی مخاطب قبل از ۲۵ مارس ۲۰۲۳ حذف کنید تا غروب قسمت excludeFirstPartyAudience را در نظر بگیرید.

اپلیکیشن موبایل

A mobile app promoted by a mobile app install line item.

نمایندگی JSON
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
زمینه های
appId

string

ضروری. The ID of the app provided by the platform store.

Android apps are identified by the bundle ID used by Android's Play store, such as com.google.android.gm .

iOS apps are identified by a nine-digit app ID used by Apple's App store, such as 422689480 .

platform

enum ( Platform )

فقط خروجی The app platform.

displayName

string

فقط خروجی The app name.

publisher

string

فقط خروجی The app publisher.

سکو

Possible mobile app platforms.

Enums
PLATFORM_UNSPECIFIED Platform is not specified.
IOS iOS platform.
ANDROID Android platform.

مواد و روش ها

bulkEditLineItemAssignedTargetingOptions

 انبوه گزینه های هدف را در زیر یک مورد خط ویرایش می کند.

bulkListLineItemAssignedTargetingOptions

 گزینه های هدف گذاری اختصاص داده شده برای یک مورد خط را در بین انواع هدف فهرست می کند.

create

 یک آیتم خط جدید ایجاد می کند.

delete

 یک مورد خطی را حذف می کند.

generateDefault

 Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status .

get

 یک مورد خطی دریافت می کند.

list

 Lists line items in an advertiser.

patch

 یک مورد خط موجود را به روز می کند.