Method: advertisers.insertionOrders.list
سفارشهای درج را در یک تبلیغکننده فهرست میکند.
ترتیب با پارامتر orderBy
تعریف می شود. اگر filter
توسط entityStatus
مشخص نشده باشد، دستورهای درج با ENTITY_STATUS_ARCHIVED
در نتایج گنجانده نخواهد شد.
درخواست HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
advertiserId | string ( int64 format) مورد نیاز. شناسه تبلیغکننده برای فهرست سفارشهای درج. |
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer اندازه صفحه درخواستی باید بین 1 تا 100 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT را برمیگرداند. |
pageToken | string نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به روش insertionOrders.list برگردانده می شود. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. |
orderBy | string فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از: - "displayName" (پیشفرض)
- "EnityStatus"
- "updateTime"
ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc . |
filter | string فیلتر کردن با فیلدهای ترتیب درج را می دهد. نحو پشتیبانی شده: - عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
- محدودیت ها را می توان با عملگرهای منطقی
AND یا OR ترکیب کرد. دنباله ای از محدودیت ها به طور ضمنی از AND استفاده می کند. - یک محدودیت به شکل
{field} {operator} {value} است. - فیلد
updateTime باید از عملگرهای GREATER THAN OR EQUAL TO (>=) یا LESS THAN OR EQUAL TO (<=) استفاده کند. - تمام فیلدهای دیگر باید از عملگر
EQUALS (=) استفاده کنند.
زمینه های پشتیبانی شده: -
campaignId -
displayName -
entityStatus -
updateTime (ورودی در قالب ISO 8601 یا YYYY-MM-DDTHH:MM:SSZ )
مثال ها: - همه سفارشهای درج تحت یک کمپین:
campaignId="1234" - همه سفارشهای درج
ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED تحت یک تبلیغکننده: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") - همه سفارشهای درج با زمان بهروزرسانی کمتر یا مساوی 2020-11-04T18:54:47Z (قالب ISO 8601):
updateTime<="2020-11-04T18:54:47Z" - همه سفارشهای درج با زمان بهروزرسانی بیشتر یا مساوی 2020-11-04T18:54:47Z (قالب ISO 8601):
updateTime>="2020-11-04T18:54:47Z"
طول این فیلد نباید بیشتر از 500 کاراکتر باشد. برای اطلاعات بیشتر به راهنمای درخواست های LIST فیلتر ما مراجعه کنید. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"insertionOrders": [
{
object (InsertionOrder )
}
],
"nextPageToken": string
} |
فیلدها |
---|
insertionOrders[] | object ( InsertionOrder ) لیست سفارشات درج. در صورت خالی بودن این لیست وجود نخواهد داشت. |
nextPageToken | string نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در فراخوانی بعدی به روش insertionOrders.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/display-video
برای اطلاعات بیشتر، بهOAuth 2.0 Overview .
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-02-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-02-25 بهوقت ساعت هماهنگ جهانی."],[[["Lists insertion orders, filterable by campaign ID, display name, entity status, and update time, within a specified advertiser."],["Supports pagination to retrieve large result sets via `pageToken` and `pageSize` parameters."],["Allows sorting results by display name, entity status, or update time, with optional descending order."],["Response provides a list of insertion orders and a token for fetching the next page if available."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],["This API endpoint lists insertion orders for a specified advertiser using a GET request. You must provide the `advertiserId` as a path parameter. You can filter the results using the `filter` query parameter, sort them using `orderBy`, and control pagination with `pageSize` and `pageToken`. The response includes a list of `insertionOrders` and a `nextPageToken` for pagination. Filtering allows for logical operators and various fields, including `entityStatus` and `updateTime`. The request body must be empty.\n"]]