Method: advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

گزینه‌های هدف‌گیری اختصاص داده شده به یک کمپین برای یک نوع هدف‌گیری مشخص را فهرست می‌کند.

درخواست HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
advertiserId

string ( int64 format)

الزامی. شناسه تبلیغ‌کننده‌ای که کمپین به آن تعلق دارد.

campaignId

string ( int64 format)

الزامی. شناسه کمپینی که گزینه‌های هدف‌گیری اختصاص داده شده برای آن فهرست می‌شود.

targetingType

enum ( TargetingType )

الزامی. نوع گزینه‌های هدف‌گیری اختصاص داده شده برای فهرست کردن را مشخص می‌کند.

انواع هدف‌گیری پشتیبانی‌شده:

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

پارامترها
pageSize

integer

اندازه صفحه درخواستی. باید بین 1 تا 5000 باشد. اگر مشخص نشود، پیش‌فرض 100 خواهد بود. اگر مقدار نامعتبر مشخص شود، کد خطای INVALID_ARGUMENT را برمی‌گرداند.

pageToken

string

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

orderBy

string

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

  • assignedTargetingOptionId (پیش‌فرض)

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

filter

string

امکان فیلتر کردن بر اساس فیلدهای گزینه هدف‌گیری اختصاص داده شده را فراهم می‌کند.

سینتکس پشتیبانی شده:

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

فیلدهای پشتیبانی شده:

  • assignedTargetingOptionId
  • inheritance

مثال‌ها:

  • منابع AssignedTargetingOption با شناسه ۱ یا ۲ assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • منابع AssignedTargetingOption با وضعیت ارث‌بری NOT_INHERITED یا INHERITED_FROM_PARTNER inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

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

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

درخواست بدنه

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

بدنه پاسخ

پیام پاسخ برای assignedTargetingOptions.list .

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "assignedTargetingOptions": [
    {
      object (AssignedTargetingOption)
    }
  ],
  "nextPageToken": string
}
فیلدها
assignedTargetingOptions[]

object ( AssignedTargetingOption )

فهرست گزینه‌های هدف‌گیری اختصاص داده شده.

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

nextPageToken

string

یک توکن که صفحه بعدی نتایج را مشخص می‌کند. این مقدار باید به عنوان pageToken در درخواست بعدی ListCampaignAssignedTargetingOptionsRequest برای واکشی صفحه بعدی نتایج مشخص شود. اگر هیچ assignedTargetingOptions دیگری برای برگرداندن وجود نداشته باشد، این توکن وجود نخواهد داشت.

دامنه‌های مجوز

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .