REST Resource: spreadsheets.developerMetadata

منبع: DeveloperMetadata

فراداده‌های توسعه‌دهنده مرتبط با یک مکان یا شیء در یک صفحه‌گسترده. برای اطلاعات بیشتر، به «خواندن، نوشتن و جستجوی فراداده» مراجعه کنید.

فراداده‌های توسعه‌دهنده ممکن است برای مرتبط کردن داده‌های دلخواه با بخش‌های مختلف یک صفحه‌گسترده استفاده شوند و با جابجایی داده‌ها و ویرایش صفحه‌گسترده، در آن مکان‌ها مرتبط باقی می‌مانند. به عنوان مثال، اگر فراداده‌های توسعه‌دهنده با ردیف ۵ مرتبط باشند و ردیف دیگری متعاقباً بالای ردیف ۵ درج شود، آن فراداده اصلی هنوز با ردیفی که ابتدا با آن مرتبط بوده است (که اکنون ردیف ۶ است) مرتبط است. اگر شیء مرتبط حذف شود، فراداده آن نیز حذف می‌شود.

نمایش JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
فیلدها
metadataId

integer

شناسه منحصر به فردِ محدوده صفحه‌گسترده که فراداده را مشخص می‌کند. شناسه‌ها ممکن است هنگام ایجاد فراداده مشخص شوند، در غیر این صورت یکی به صورت تصادفی تولید و اختصاص داده می‌شود. باید مثبت باشد.

metadataKey

string

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

metadataValue

string

داده‌های مرتبط با کلید فراداده.

location

object ( DeveloperMetadataLocation )

مکانی که فراداده‌ها به آن مرتبط هستند.

visibility

enum ( DeveloperMetadataVisibility )

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

توسعه‌دهندهفرادادهموقعیت مکانی

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

نمایش JSON 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
فیلدها
locationType

enum ( DeveloperMetadataLocationType )

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

فیلد Union، location . مکانی که فراداده (metadata) به آن مرتبط است. location می‌تواند فقط یکی از موارد زیر باشد:
spreadsheet

boolean

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

sheetId

integer

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

dimensionRange

object ( DimensionRange )

وقتی فراداده با یک بُعد مرتبط باشد، نشان‌دهنده‌ی سطر یا ستون است. DimensionRange مشخص‌شده باید نشان‌دهنده‌ی یک سطر یا ستون باشد. نمی‌تواند نامحدود باشد یا چندین سطر یا ستون را در بر بگیرد.

توسعه‌دهندهفرادادهنوع مکان

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

انوم‌ها
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED مقدار پیش‌فرض.
ROW فراداده‌های توسعه‌دهنده مرتبط با کل بُعد یک ردیف.
COLUMN فراداده‌های توسعه‌دهنده مرتبط با کل بُعد ستون.
SHEET فراداده‌های توسعه‌دهنده مرتبط با کل یک برگه.
SPREADSHEET فراداده‌های توسعه‌دهنده مرتبط با کل صفحه‌گسترده.

توسعه‌دهندهفرادادهقابلیت مشاهده

شمارشی از موارد ممکن برای مشاهده فراداده.

انوم‌ها
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED مقدار پیش‌فرض.
DOCUMENT فراداده‌های قابل مشاهده در سند از هر پروژه توسعه‌دهنده‌ای که به سند دسترسی داشته باشد، قابل دسترسی هستند.
PROJECT فراداده‌های قابل مشاهده در پروژه، فقط توسط توسعه‌دهنده‌ی پروژه‌ای که فراداده را ایجاد کرده است، قابل مشاهده و دسترسی هستند.

روش‌ها

get

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