Class DeveloperMetadata

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

دسترسی و تغییر متادیتای توسعه‌دهنده. برای ایجاد متادیتای توسعه‌دهنده جدید از Range.addDeveloperMetadata(key) ، Sheet.addDeveloperMetadata(key) یا Spreadsheet.addDeveloperMetadata(key) استفاده کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
get Id() Integer شناسه منحصر به فرد مرتبط با این ابرداده توسعه‌دهنده را برمی‌گرداند.
get Key() String کلید مرتبط با این ابرداده توسعه‌دهنده را برمی‌گرداند.
get Location() Developer Metadata Location مکان این ابرداده توسعه‌دهنده را برمی‌گرداند.
get Value() String مقدار مرتبط با این فراداده‌ی توسعه‌دهنده را برمی‌گرداند، یا اگر این فراداده هیچ مقداری نداشته باشد null برمی‌گرداند.
get Visibility() Developer Metadata Visibility میزان دیده شدن این فراداده‌ی توسعه‌دهنده را برمی‌گرداند.
move To Column(column) Developer Metadata این فراداده توسعه‌دهنده را به ستون مشخص‌شده منتقل می‌کند.
move To Row(row) Developer Metadata این فراداده توسعه‌دهنده را به ردیف مشخص‌شده منتقل می‌کند.
move To Sheet(sheet) Developer Metadata این فراداده توسعه‌دهنده را به برگه مشخص‌شده منتقل می‌کند.
move To Spreadsheet() Developer Metadata این فراداده توسعه‌دهنده را به صفحه‌گسترده سطح بالا منتقل می‌کند.
remove() void این متادیتا را حذف می‌کند.
set Key(key) Developer Metadata کلید این فراداده‌ی توسعه‌دهنده را روی مقدار مشخص‌شده تنظیم می‌کند.
set Value(value) Developer Metadata مقدار مرتبط با این فراداده‌ی توسعه‌دهنده را روی مقدار مشخص‌شده تنظیم می‌کند.
set Visibility(visibility) Developer Metadata قابلیت مشاهده‌ی این فراداده‌ی توسعه‌دهنده را روی قابلیت مشاهده‌ی مشخص‌شده تنظیم می‌کند.

مستندات دقیق

getId()

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

بازگشت

Integer - شناسه منحصر به فرد مرتبط با این فراداده توسعه‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getKey()

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

بازگشت

String - کلید مرتبط با این فراداده توسعه‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLocation()

مکان این ابرداده توسعه‌دهنده را برمی‌گرداند.

بازگشت

DeveloperMetadataLocation — محل قرارگیری این متادیتای توسعه‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValue()

مقدار مرتبط با این فراداده‌ی توسعه‌دهنده را برمی‌گرداند، یا اگر این فراداده هیچ مقداری نداشته باشد null برمی‌گرداند.

بازگشت

String - مقداری که به این فراداده‌ی توسعه‌دهنده مرتبط است، یا اگر این فراداده مقداری نداشته باشد، null .

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVisibility()

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

بازگشت

DeveloperMetadataVisibility — قابلیت مشاهده این متادیتای توسعه‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToColumn(column)

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

پارامترها

نام نوع توضیحات
column Range محدوده‌ای که نشان‌دهنده‌ی ستونی است که مکان جدید برای این فراداده‌ی توسعه‌دهنده است.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToRow(row)

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

پارامترها

نام نوع توضیحات
row Range محدوده‌ای که نشان‌دهنده‌ی ردیفی است که مکان جدید برای این فراداده‌ی توسعه‌دهنده است.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSheet(sheet)

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

پارامترها

نام نوع توضیحات
sheet Sheet برگه‌ای که محل جدید این متاتای توسعه‌دهنده است.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSpreadsheet()

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

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

این متادیتا را حذف می‌کند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setKey(key)

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

پارامترها

نام نوع توضیحات
key String کلید جدیدی که باید برای این فراداده تنظیم شود.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

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

پارامترها

نام نوع توضیحات
value String مقدار جدیدی که باید برای این فراداده تنظیم شود.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVisibility(visibility)

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

پارامترها

نام نوع توضیحات
visibility Developer Metadata Visibility قابلیت مشاهده‌ی جدیدی که باید برای این فراداده تنظیم شود.

بازگشت

DeveloperMetadata — متادیتای توسعه‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets