Method: advertisers.negativeKeywordLists.negativeKeywords.list

کلیدواژه‌های منفی را در فهرست کلیدواژه‌های منفی فهرست می‌کند.

درخواست HTTP

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords

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

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

پارامترها
advertiserId

string (int64 format)

الزامی. شناسه آگهی‌دهنده DV360 که فهرست کلیدواژه‌های منفی اصلی به آن تعلق دارد.
negativeKeywordListId

string (int64 format)

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

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

پارامترها
pageSize

integer

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

string

نشانه‌ای که صفحه‌ای از نتایج را که سرور باید برگرداند شناسایی می‌کند.

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

string

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

  • keywordValue (پیش‌فرض)

ترتیب مرتب‌سازی پیش‌فرض صعودی است. برای مشخص کردن ترتیب نزولی برای یک فیلد، باید پسوند « desc» به نام فیلد اضافه شود. مثال: keywordValue desc.
filter

string

فیلتر کردن براساس فیلدهای کلیدواژه منفی را مجاز می‌کند.

نحو پشتیبانی‌شده:

  • عبارت‌های فیلتر برای کلیدواژه‌های منفی فقط می‌توانند حداکثر یک محدودیت داشته باشند.
  • محدودیت به‌صورت {field} {operator} {value} است.
  • همه فیلدها باید از اپراتور HAS (:) استفاده کنند.

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

  • keywordValue

مثال‌ها:

  • همه کلیدواژه‌های منفی که مقدار کلیدواژه آن‌ها حاوی «google» است: keywordValue : "google"

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

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

متن درخواست

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

بدنه پاسخ

Response message for NegativeKeywordService.ListNegativeKeywords.

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

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

object (NegativeKeyword)

فهرست کلیدواژه‌های منفی.

اگر این فهرست خالی باشد، نمایش داده نخواهد شد.
nextPageToken

string

نشانه‌ای برای بازیابی صفحه بعدی نتایج.

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

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

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

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

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