Method: advertisers.lineItems.list

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

ترتیب با پارامتر orderBy تعریف می شود. اگر filter توسط entityStatus مشخص نشده باشد، موارد خط دارای ENTITY_STATUS_ARCHIVED در نتایج لحاظ نمی‌شوند.

درخواست HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
advertiserId

string ( int64 format)

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

پارامترهای پرس و جو

مولفه های
pageSize

integer

اندازه صفحه درخواستی باید بین 1 تا 100 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT را برمی‌گرداند.

pageToken

string

نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به متد lineItems.list بازگردانده می شود. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد.

orderBy

string

فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از:

  • displayName (پیش‌فرض)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc .

filter

string

فیلتر کردن بر اساس ویژگی های مورد خط را امکان پذیر می کند.

نحو پشتیبانی شده:

  • عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
  • محدودیت ها را می توان با عملگرهای منطقی AND یا OR ترکیب کرد. دنباله ای از محدودیت ها به طور ضمنی از AND استفاده می کند.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • اپراتور مورد استفاده در flight.dateRange.endDate باید کمتر از (<) باشد.
  • اپراتور مورد استفاده در updateTime باید GREATER THAN OR EQUAL TO (>=) یا LESS THAN OR EQUAL TO (<=) باشد.
  • عملگر مورد استفاده در warningMessages باید HAS (:) باشد.
  • عملگرهای استفاده شده در تمام فیلدهای دیگر باید EQUALS (=) باشند.
  • ویژگی های پشتیبانی شده:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (ورودی با فرمت YYYY-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (ورودی در قالب ISO 8601 یا YYYY-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

مثال ها:

  • همه موارد خط تحت یک ترتیب درج: insertionOrderId="1234"
  • همه موارد ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED و LINE_ITEM_TYPE_DISPLAY_DEFAULT زیر یک تبلیغ‌کننده: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • همه موارد خطی که تاریخ پرواز آنها قبل از 28 مارس 2019 به پایان می رسد: flight.dateRange.endDate<"2019-03-28"
  • همه موارد خطی که NO_VALID_CREATIVE در warningMessages دارند: warningMessages:"NO_VALID_CREATIVE"
  • همه موارد خطی با زمان به‌روزرسانی کمتر یا مساوی 2020-11-04T18:54:47Z (format of ISO 8601) : updateTime<="2020-11-04T18:54:47Z"
  • همه موارد خطی با زمان به‌روزرسانی بیشتر یا مساوی 2020-11-04T18:54:47Z (format of ISO 8601) : updateTime>="2020-11-04T18:54:47Z"
  • همه موارد خطی که از کانال مشخص شده و لیست کلمات کلیدی منفی مشخص شده در هدف گیری خود استفاده می کنند: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

طول این فیلد نباید بیشتر از 500 کاراکتر باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
زمینه های
lineItems[]

object ( LineItem )

لیست موارد خط.

در صورت خالی بودن این لیست وجود نخواهد داشت.

nextPageToken

string

نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در فراخوانی بعدی به روش lineItems.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/display-video

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.