Method: guaranteedOrders.list

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

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

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

پارامترها
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: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

طول این فیلد نباید بیشتر از ۵۰۰ نویسه باشد.

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

الزامی.

مشخص می‌کند که درخواست در کدام نهاد DV360 انجام می‌شود. درخواست LIST فقط نهادهای سفارش تضمینی را برمی‌گرداند که برای نهاد DV360 شناسایی‌شده در 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 Overview مراجعه کنید.