Method: sellers.adUnits.list

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

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

درخواست HTTP

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

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

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

پارامترها
parent

string

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

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

پارامترها
pageSize

integer

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

pageToken

string

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

filter

string

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

orderBy

string

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

showDeleted

boolean

آیا برای بازگرداندن واحدهای تبلیغاتی حذف شده نرم.

درخواست بدن

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

بدن پاسخگو

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

پیام پاسخ برای InventoryService.ListAdUnits.

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

object ( AdUnit )

لیست واحدهای تبلیغاتی

nextPageToken

string

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

محدوده مجوز

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

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

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