Method: sellers.orders.list

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

  • به عنوان مثال GET /v1/sellers/321/orders
  • فهرستی از سفارشات و رمزی را برای بازیابی صفحه بعدی در صورت موفقیت برمی گرداند.
  • اگر کاربر به فروشنده دسترسی نداشته باشد یا شناسه فروشنده وجود نداشته باشد، کد خطا PERMISSION_DENIED را برمی گرداند.
  • اگر فروشندگان اندازه صفحه یا نشانه صفحه نامعتبر ارائه دهند، کد خطا را INVALID_ARGUMENT برمی گرداند.

درخواست HTTP

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/orders

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

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

پارامترها
parent

string

مورد نیاز. والدینی که مالک این مجموعه سفارشات هستند. قالب: فروشندگان/{فروشنده}

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

پارامترها
pageSize

integer

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

pageToken

string

مقدار nextPageToken از یک درخواست لیست قبلی، در صورت وجود، برگردانده شده است.

filter

string

فیلتر لیست در حال حاضر از ID خارجی و فیلتر حالت پشتیبانی می کند، با نحو: "externalId = [EXTERNAL_ID]" و "state = [STATE]". عملگرهای منطقی AND و OR را می توان برای زنجیره زدن فیلترها استفاده کرد.

orderBy

string

ترتیب رشته ای که برای تعیین ترتیب مرتب سازی نتایج استفاده می شود. در حال حاضر از سفارش‌دهی براساس updateTime پشتیبانی می‌کند، «updateTime» را برای مرتب‌سازی نتایج بر اساس updateTime به ترتیب صعودی یا «updateTime desc» برای ترتیب نزولی ارائه دهید.

درخواست بدن

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

بدن پاسخگو

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

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

object ( Order )

لیست سفارشات

nextPageToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/doubleclickbidmanager

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