Method: indexing.datasources.items.list

همه یا زیر مجموعه ای از Item resources را فهرست می کند.

این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.

درخواست HTTP

GET https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items

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

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

پارامترها
name

string

نام منبع داده برای فهرست موارد. قالب: منابع داده/{sourceId}

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

پارامترها
connectorName

string

نام رابطی که این تماس را برقرار می کند.

قالب: منابع داده/{sourceId}/connectors/{ID}

brief

boolean

وقتی روی true تنظیم شود، سیستم نمایه سازی فقط فیلدهای زیر را پر می کند: name ، version ، queue . metadata.hash , metadata.title , metadata.sourceRepositoryURL , metadata.objectType , metadata.createTime , metadata.updateTime , metadata.contentLanguage , metadata.mimeType , structuredData.hash , content.hash itemType ، itemStatus.code itemStatus.processingError.code , itemStatus.repositoryError.type ,

اگر این مقدار نادرست باشد، تمام فیلدها در Item پر می شوند.

pageToken

string

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

pageSize

integer

حداکثر تعداد موارد برای واکشی در یک درخواست. حداکثر مقدار 1000 است که مختصر درست باشد. حداکثر مقدار 10 است اگر مختصر نادرست باشد.

مقدار پیش فرض 10 است

debugOptions

object ( DebugOptions )

گزینه های رایج اشکال زدایی

درخواست بدن

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

بدن پاسخگو

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

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

object ( Item )

nextPageToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

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