Method: guaranteedOrders.list

سفارشات تضمین شده را که برای کاربر فعلی قابل دسترسی است فهرست می کند.

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v3/guaranteedOrders

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

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

پارامترها
pageSize

integer

اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود.

pageToken

string

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

orderBy

string

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

  • displayName (پیش‌فرض)

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

filter

string

فیلتر کردن بر اساس فیلدهای سفارش تضمین شده را می دهد.

  • عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
  • محدودیت ها را می توان با عملگرهای منطقی AND یا OR ترکیب کرد. دنباله ای از محدودیت ها به طور ضمنی از AND استفاده می کند.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • همه فیلدها باید از عملگر EQUALS (=) استفاده کنند.

فیلدهای پشتیبانی شده: * guaranteedOrderId * exchange * displayName * status.entityStatus

مثال ها:

  • همه سفارشات تضمین شده فعال: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • سفارشات تضمین شده متعلق به Google Ad Manager یا Rubicon Exchanges: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

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

accessor پارامتر اتحادیه مورد نیاز.

مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیت‌های سفارش تضمین‌شده‌ای را برمی‌گرداند که برای موجودیت DV360 شناسایی‌شده در accessor قابل دسترسی هستند. accessor می تواند تنها یکی از موارد زیر باشد:

partnerId

string ( int64 format)

شناسه شریکی که به سفارش تضمین شده دسترسی دارد.

advertiserId

string ( int64 format)

شناسه آگهی دهنده ای که به سفارش تضمین شده دسترسی دارد.

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
فیلدها
guaranteedOrders[]

object ( GuaranteedOrder )

لیست سفارشات تضمینی

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

nextPageToken

string

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

محدوده مجوز

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

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

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