Method: spreadsheets.developerMetadata.search

تمام متادیتای توسعه‌دهنده که با DataFilter مشخص‌شده مطابقت دارند را برمی‌گرداند. برای اطلاعات بیشتر، به بخش خواندن، نوشتن و جستجوی متادیتا مراجعه کنید.

اگر DataFilter ارائه شده نشان دهنده یک شیء DeveloperMetadataLookup باشد، این تابع تمام ورودی‌های DeveloperMetadata انتخاب شده توسط آن را برمی‌گرداند. اگر DataFilter نشان دهنده مکانی در یک صفحه گسترده باشد، این تابع تمام متادیتای توسعه‌دهنده مرتبط با مکان‌های متقاطع با آن منطقه را برمی‌گرداند.

درخواست HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search

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

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

پارامترها
spreadsheetId

string

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

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
فیلدها
dataFilters[]

object ( DataFilter )

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

بدنه پاسخ

پاسخی به درخواست جستجوی فراداده توسعه‌دهنده.

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

نمایش JSON
{
  "matchedDeveloperMetadata": [
    {
      object (MatchedDeveloperMetadata)
    }
  ]
}
فیلدها
matchedDeveloperMetadata[]

object ( MatchedDeveloperMetadata )

فراداده‌ای که با معیارهای درخواست جستجو مطابقت دارد.

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

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

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

متادیتای توسعه‌دهنده‌ی منطبق

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

نمایش JSON
{
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
فیلدها
developerMetadata

object ( DeveloperMetadata )

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

dataFilters[]

object ( DataFilter )

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