Method: googleAdsFields.search

همه فیلدهایی که با عبارت جستجو مطابقت دارند را برمی گرداند.

لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError HeaderError داخلی خطا QueryError QuotaError RequestError

درخواست HTTP

POST https://googleads.googleapis.com/v16/googleAdsFields:search

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

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "query": string,
  "pageToken": string,
  "pageSize": integer
}
زمینه های
query

string

ضروری. رشته پرس و جو.

pageToken

string

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

pageSize

integer

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

بدن پاسخگو

پیام پاسخ برای GoogleAdsFieldService.SearchGoogleAdsFields .

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

نمایندگی JSON
{
  "results": [
    {
      object (GoogleAdsField)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string
}
زمینه های
results[]

object ( GoogleAdsField )

لیست فیلدهایی که با پرس و جو مطابقت دارند.

nextPageToken

string

نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج استفاده می شود. محتوای این رشته را به عنوان صفت pageToken درخواست بعدی ارسال کنید. nextPageToken برای صفحه آخر بازگردانده نمی شود.

totalResultsCount

string ( int64 format)

تعداد کل نتایجی که با پرس و جو مطابقت دارند و بند LIMIT را نادیده می گیرند.

محدوده مجوز

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

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

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