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

تعداد لأنواع المواقع الجغرافية التي يمكن ربط البيانات الوصفية للمطوّر بها.

عمليات التعداد
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED القيمة التلقائية
ROW بيانات وصفية للمطوّر مرتبطة بسمة صف كامل
COLUMN البيانات الوصفية للمطوّر المرتبطة بسمة عمود كامل
SHEET بيانات وصفية للمطوّر مرتبطة بورقة كاملة
SPREADSHEET البيانات الوصفية للمطوّر المرتبطة بجدول البيانات بأكمله

DeveloperMetadataVisibility

تعداد لمستويات رؤية البيانات الوصفية المحتملة.

عمليات التعداد
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED القيمة التلقائية
DOCUMENT يمكن الوصول إلى البيانات الوصفية المرئية في المستند من أي مشروع مطوّر لديه إذن الوصول إلى المستند.
PROJECT لا يمكن رؤية البيانات الوصفية المرئية للمشروع أو الوصول إليها إلا من خلال مشروع المطوّر الذي أنشأ البيانات الوصفية.

الطُرق

get

تعرض هذه الطريقة بيانات المطوّر الوصفية التي تحمل رقم التعريف المحدّد.
تعرض هذه الطريقة جميع البيانات الوصفية للمطوّرين التي تتطابق مع DataFilter المحدّد.