REST Resource: spreadsheets.developerMetadata

منبع: DeveloperMetadata

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

نمایندگی 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 )

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

DeveloperMetadataLocation

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

نمایندگی 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 )

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

location میدان اتحادیه مکانی که ابرداده در آن مرتبط است. location فقط می تواند یکی از موارد زیر باشد:
spreadsheet

boolean

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

sheetId

integer

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

dimensionRange

object ( DimensionRange )

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

DeveloperMetadataLocationType

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

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

DeveloperMetadataVisibility

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

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

مواد و روش ها

get

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