REST Resource: labels

منبع: برچسب

یک برچسب، طبقه‌بندی را تعریف می‌کند که می‌تواند به موارد Drive اعمال شود تا بین موارد سازماندهی و جستجو شود. برچسب‌ها می‌توانند رشته‌های ساده باشند یا می‌توانند حاوی فیلدهایی باشند که ابرداده‌های اضافی را توصیف می‌کنند که می‌توانند بیشتر برای سازماندهی و جستجوی موارد Drive استفاده شوند.

نمایندگی JSON
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  }
}
زمینه های
name

string

فقط خروجی نام منبع برچسب بسته به درخواست به شکل زیر خواهد بود: labels/{id} یا labels/{id}@{revisionId} . id و revisionId در زیر ببینید.

id

string

فقط خروجی شناسه منحصر به فرد جهانی این برچسب. ID بخشی از name برچسب را تشکیل می دهد، اما بر خلاف name ، ID بین ویرایش ها سازگار است. با regex مطابقت دارد: ([a-zA-Z0-9])+

revisionId

string

فقط خروجی شناسه بازبینی برچسب. شناسه بازبینی بسته به درخواست صادر شده ممکن است بخشی از name برچسب باشد. هر زمان که ویژگی های تجدید نظر شده یک برچسب تغییر کند، یک ویرایش جدید ایجاد می شود. با regex مطابقت دارد: ([a-zA-Z0-9])+

labelType

enum ( LabelType )

ضروری. نوع برچسب.

creator

object ( UserInfo )

فقط خروجی کاربری که این برچسب را ایجاد کرده است.

createTime

string ( Timestamp format)

فقط خروجی زمانی که این برچسب ایجاد شد.

revisionCreator

object ( UserInfo )

فقط خروجی کاربری که این ویرایش برچسب را ایجاد کرده است.

revisionCreateTime

string ( Timestamp format)

فقط خروجی زمانی که این ویرایش برچسب ایجاد شد.

publisher

object ( UserInfo )

فقط خروجی کاربری که این برچسب را منتشر کرده است. وقتی برچسب منتشر نمی شود، این مقدار معنایی ندارد.

publishTime

string ( Timestamp format)

فقط خروجی زمانی که این برچسب منتشر شد. وقتی برچسب منتشر نمی شود، این مقدار معنایی ندارد.

disabler

object ( UserInfo )

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

disableTime

string ( Timestamp format)

فقط خروجی زمانی که این برچسب غیرفعال شد. وقتی برچسب غیرفعال نباشد این مقدار معنی ندارد.

customer

string

فقط خروجی مشتری این برچسب متعلق به آن است. به عنوان مثال: "customers/123abc789."

properties

object ( Properties )

ضروری. ویژگی های اساسی برچسب

lifecycle

object ( Lifecycle )

فقط خروجی وضعیت چرخه عمر برچسب از جمله اینکه آیا منتشر شده است، منسوخ شده است و تغییرات پیش‌نویس دارد.

displayHints

object ( DisplayHints )

فقط خروجی نکات نمایش UI برای ارائه برچسب.

appliedCapabilities

object ( AppliedCapabilities )

فقط خروجی قابلیت های مربوط به این برچسب روی ابرداده های کاربردی.

schemaCapabilities

object ( SchemaCapabilities )

فقط خروجی قابلیت هایی که کاربر روی این برچسب دارد.

appliedLabelPolicy

object ( AppliedLabelPolicy )

فقط خروجی رفتار این برچسب وقتی روی موارد Drive اعمال می‌شود.

fields[]

object ( Field )

فهرست فیلدها به ترتیب اولویت نزولی.

learnMoreUri

string

نشانی اینترنتی سفارشی برای ارائه به کاربران تا به آنها اجازه دهد درباره این برچسب و نحوه استفاده از آن بیشتر بیاموزند.

lockStatus

object ( LockStatus )

فقط خروجی وضعیت LockStatus این برچسب.

نوع برچسب

نوع این برچسب.

Enums
LABEL_TYPE_UNSPECIFIED نوع برچسب نامشخص
SHARED ممکن است برچسب‌های مشترک با کاربران به اشتراک گذاشته شود تا روی موارد Drive اعمال شود.
ADMIN برچسب متعلق به مدیر فقط توسط ادمین ها قابل ایجاد و ویرایش است. از برخی ویژگی های اضافی فقط برای سرپرست پشتیبانی می کند.

اطلاعات کاربر

اطلاعات در مورد یک کاربر

نمایندگی JSON
{
  "person": string
}
زمینه های
person

string

شناسه این کاربر که می تواند با People API برای دریافت اطلاعات بیشتر استفاده شود. مثلا مردم/12345678.

خواص

ویژگی های اصلی برچسب

نمایندگی JSON
{
  "title": string,
  "description": string
}
زمینه های
title

string

ضروری. عنوان برچسب

description

string

توضیحات برچسب

چرخه زندگی

وضعیت چرخه حیات یک شی، مانند برچسب، فیلد یا انتخاب. چرخه حیات، انتقال‌های زیر را اعمال می‌کند:

  • UNPUBLISHED_DRAFT (وضعیت شروع)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (حذف شده)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (حذف شده)

ایالت های منتشر شده و غیرفعال دارای برخی ویژگی های متمایز هستند:

  • Published—ممکن است برخی از انواع تغییرات در یک شی در این حالت ایجاد شود، در این صورت hasUnpublishedChanges درست خواهد بود. همچنین، برخی از انواع تغییرات مجاز نیست. به طور کلی، هر تغییری که باعث بی اعتباری یا ایجاد محدودیت‌های جدید در ابرداده‌های موجود مرتبط با برچسب شود، رد می‌شود.
  • Disabled—در صورت غیرفعال شدن، DisabledPolicy پیکربندی شده اعمال می شود.
نمایندگی JSON
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
زمینه های
state

enum ( State )

فقط خروجی وضعیت جسم مرتبط با این چرخه حیات.

hasUnpublishedChanges

boolean

فقط خروجی اینکه آیا شیء مرتبط با این چرخه حیات، تغییرات منتشر نشده ای دارد یا خیر.

disabledPolicy

object ( DisabledPolicy )

خط‌مشی که نحوه نمایش برچسب، فیلد یا انتخاب غیرفعال را کنترل می‌کند.

حالت

وضعیت جسم مرتبط با این چرخه حیات.

Enums
STATE_UNSPECIFIED ایالت ناشناخته
UNPUBLISHED_DRAFT حالت اولیه یک جسم. پس از انتشار، شی هرگز نمی تواند به این حالت بازگردد. پس از انتشار یک شی، انواع خاصی از تغییرات دیگر مجاز نیستند.
PUBLISHED شی منتشر شده است. ممکن است شیء دارای تغییرات پیش نویس منتشر نشده باشد که توسط hasUnpublishedChanges نشان داده شده است.
DISABLED شی منتشر شده و از آن زمان غیرفعال شده است. ممکن است شیء دارای تغییرات پیش نویس منتشر نشده باشد که توسط hasUnpublishedChanges نشان داده شده است.
DELETED شی حذف شده است.

DisabledPolicy

خط مشی حاکم بر نحوه برخورد با برچسب، فیلد یا انتخاب غیرفعال در زمینه های مختلف.

نمایندگی JSON
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
زمینه های
showInApply

boolean

این شی غیرفعال در منوی اعمال در موارد Drive نمایش داده شود یا خیر.

  • وقتی true ، شی معمولاً در رابط کاربری غیرفعال نشان داده می شود و غیرقابل انتخاب است.
  • وقتی false ، شی به طور کلی در رابط کاربری پنهان می شود.

نمایش نکات

نکات نمایش UI برای ارائه برچسب.

نمایندگی JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
زمینه های
disabled

boolean

اینکه آیا برچسب باید در رابط کاربری غیرفعال نشان داده شود یا خیر.

shownInApply

boolean

این برچسب باید در منوی اعمال هنگام اعمال مقادیر به یک مورد Drive نشان داده شود.

priority

string ( int64 format)

ترتیب نمایش برچسب در یک لیست.

قابلیت های کاربردی

قابلیت‌هایی که کاربر در فراداده‌های کاربردی این برچسب دارد.

نمایندگی JSON
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
زمینه های
canRead

boolean

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

canApply

boolean

آیا کاربر می‌تواند این برچسب را روی موارد اعمال کند یا خیر.

canRemove

boolean

آیا کاربر می تواند این برچسب را از موارد حذف کند یا خیر.

SchemaCapabilities

قابلیت های مربوط به این برچسب در هنگام ویرایش لیبل.

نمایندگی JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
زمینه های
canUpdate

boolean

آیا کاربر می تواند این برچسب را تغییر دهد یا خیر.

canDelete

boolean

آیا کاربر می تواند این برچسب را حذف کند یا خیر. کاربر باید مجوز داشته باشد و برچسب باید غیرفعال باشد.

canDisable

boolean

آیا کاربر می تواند این برچسب را غیرفعال کند یا خیر. کاربر باید مجوز داشته باشد و این برچسب نباید قبلاً غیرفعال شده باشد.

canEnable

boolean

آیا کاربر می تواند این برچسب را فعال کند یا خیر. کاربر باید مجوز داشته باشد و این برچسب باید غیرفعال شود.

AppliedLabelPolicy

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

نمایندگی JSON
{
  "copyMode": enum (CopyMode)
}
زمینه های
copyMode

enum ( CopyMode )

نشان می دهد که وقتی یک مورد Drive کپی می شود، برچسب و مقادیر فیلد اعمال شده چگونه باید کپی شوند.

CopyMode

نشان می دهد که وقتی یک مورد Drive کپی می شود، برچسب و مقادیر فیلد اعمال شده چگونه باید کپی شوند.

Enums
COPY_MODE_UNSPECIFIED حالت کپی مشخص نشده است.
DO_NOT_COPY وقتی مورد Drive که روی آن اعمال شده است، مقادیر برچسب و فیلد اعمال شده به طور پیش‌فرض کپی نمی‌شوند.
ALWAYS_COPY مقادیر برچسب و فیلد اعمال شده همیشه زمانی کپی می‌شوند که مورد Drive که روی آن اعمال شده است کپی می‌شود. فقط مدیران می توانند از این حالت استفاده کنند.
COPY_APPLIABLE اگر برچسب توسط کاربر کپی کننده قابل اعمال باشد، مقادیر فیلد و برچسب اعمال شده کپی می شوند.

رشته

فیلدی را تعریف می کند که دارای نام نمایشی، نوع داده و سایر گزینه های پیکربندی است. این فیلد نوع فراداده‌ای را که ممکن است روی یک مورد Drive تنظیم شود، تعریف می‌کند.

نمایندگی JSON
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
زمینه های
id

string

فقط خروجی کلید یک فیلد، منحصر به فرد در یک برچسب یا کتابخانه.

این مقدار به صورت خودکار تولید می شود. با regex مطابقت دارد: ([a-zA-Z0-9])+

queryKey

string

فقط خروجی کلیدی که هنگام ساخت عبارت‌های جستجوی Drive برای یافتن فایل‌ها بر اساس مقادیر تعریف‌شده برای این فیلد روی فایل‌ها استفاده می‌شود. به عنوان مثال، " {queryKey} > 2001-01-01".

properties

object ( Properties )

ویژگی های اساسی میدان.

lifecycle

object ( Lifecycle )

فقط خروجی چرخه حیات این رشته

displayHints

object ( DisplayHints )

فقط خروجی نکات نمایش UI برای ارائه یک فیلد.

schemaCapabilities

object ( SchemaCapabilities )

فقط خروجی قابلیت هایی که این کاربر هنگام ویرایش این فیلد دارد.

appliedCapabilities

object ( AppliedCapabilities )

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

creator

object ( UserInfo )

فقط خروجی کاربری که این فیلد را ایجاد کرده است.

createTime

string ( Timestamp format)

فقط خروجی زمانی که این زمینه ایجاد شد.

updater

object ( UserInfo )

فقط خروجی کاربری که این فیلد را تغییر داده است.

updateTime

string ( Timestamp format)

فقط خروجی زمانی که این فیلد به روز شد.

publisher

object ( UserInfo )

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

disabler

object ( UserInfo )

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

disableTime

string ( Timestamp format)

فقط خروجی زمانی که این فیلد غیرفعال شد. وقتی فیلد غیرفعال نباشد این مقدار معنی ندارد.

lockStatus

object ( LockStatus )

فقط خروجی LockStatus این فیلد.

type فیلد اتحادیه نوع داده و گزینه های این فیلد. پس از انتشار، نوع داده قابل تغییر نیست. type می تواند تنها یکی از موارد زیر باشد:
textOptions

object ( TextOptions )

گزینه های فیلد متنی

integerOptions

object ( IntegerOptions )

گزینه های فیلد عدد صحیح

dateOptions

object ( DateOptions )

گزینه های فیلد تاریخ

selectionOptions

object ( SelectionOptions )

گزینه های فیلد انتخاب

userOptions

object ( UserOptions )

گزینه های فیلد کاربر

TextOptions

گزینه هایی برای نوع فیلد متن.

نمایندگی JSON
{
  "minLength": integer,
  "maxLength": integer
}
زمینه های
minLength

integer

فقط خروجی حداقل طول معتبر مقادیر برای فیلد متنی.

maxLength

integer

فقط خروجی حداکثر طول معتبر مقادیر برای فیلد متنی.

IntegerOptions

گزینه هایی برای نوع فیلد عدد صحیح.

نمایندگی JSON
{
  "minValue": string,
  "maxValue": string
}
زمینه های
minValue

string ( int64 format)

فقط خروجی حداقل مقدار معتبر برای فیلد عدد صحیح.

maxValue

string ( int64 format)

فقط خروجی حداکثر مقدار معتبر برای فیلد عدد صحیح.

گزینه های تاریخ

گزینه هایی برای نوع فیلد تاریخ.

نمایندگی JSON
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
زمینه های
dateFormatType

enum ( DateFormat )

گزینه قالب بندی تاریخ محلی. مقادیر فیلد در این قالب با توجه به محلی که دارند ارائه می شوند.

dateFormat

string

فقط خروجی فرمت تاریخ ICU

minValue

object ( Date )

فقط خروجی حداقل مقدار معتبر (سال، ماه، روز).

maxValue

object ( Date )

فقط خروجی حداکثر مقدار معتبر (سال، ماه، روز).

فرمت تاریخ

گزینه های قالب تاریخ محلی.

Enums
DATE_FORMAT_UNSPECIFIED قالب تاریخ مشخص نشده است.
LONG_DATE شامل نام ماه کامل است. به عنوان مثال، 12 ژانویه 1999 (MMMM d, y)
SHORT_DATE کوتاه، عددی، نمایش. به عنوان مثال، 12/13/99 (M/D/YY)

تاریخ

نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ مربوط به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:

  • تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایندگی JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
زمینه های
year

integer

سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد.

month

integer

ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود.

day

integer

روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.

SelectionOptions

گزینه هایی برای نوع فیلد انتخاب.

نمایندگی JSON
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
زمینه های
listOptions

object ( ListOptions )

وقتی مشخص شد، نشان می دهد که این فیلد لیستی از مقادیر را پشتیبانی می کند. پس از انتشار فیلد، نمی توان آن را تغییر داد.

choices[]

object ( Choice )

گزینه های موجود برای این فیلد انتخابی. ترتیب فهرست مطابق است و با insertBeforeChoice اصلاح شده است.

ListOptions

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

نمایندگی JSON
{
  "maxEntries": integer
}
زمینه های
maxEntries

integer

حداکثر تعداد ورودی های مجاز

انتخاب

انتخاب رشته انتخاب

نمایندگی JSON
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
زمینه های
id

string

ارزش منحصر به فرد انتخاب. این شناسه به صورت خودکار تولید می شود. با regex مطابقت دارد: ([a-zA-Z0-9_])+ .

properties

object ( Properties )

خواص اساسی انتخاب.

lifecycle

object ( Lifecycle )

فقط خروجی چرخه زندگی انتخابی

displayHints

object ( DisplayHints )

فقط خروجی نکات نمایش UI برای ارائه یک انتخاب.

schemaCapabilities

object ( SchemaCapabilities )

فقط خروجی قابلیت های مربوط به این گزینه در هنگام ویرایش گزینه.

appliedCapabilities

object ( AppliedCapabilities )

فقط خروجی قابلیت های مربوط به این انتخاب بر روی ابرداده های کاربردی.

creator

object ( UserInfo )

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

createTime

string ( Timestamp format)

فقط خروجی زمانی که این انتخاب ایجاد شد.

updater

object ( UserInfo )

فقط خروجی آخرین کاربری که این انتخاب را به روز کرده است.

updateTime

string ( Timestamp format)

فقط خروجی زمانی که این انتخاب آخرین بار به روز شد.

publisher

object ( UserInfo )

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

publishTime

string ( Timestamp format)

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

disabler

object ( UserInfo )

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

disableTime

string ( Timestamp format)

فقط خروجی زمانی که این انتخاب غیرفعال شد. وقتی انتخاب غیرفعال نباشد این مقدار معنی ندارد.

lockStatus

object ( LockStatus )

فقط خروجی LockStatus این انتخاب.

خواص

خواص اساسی انتخاب.

نمایندگی JSON
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
زمینه های
displayName

string

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

description

string

توضیحات این برچسب

badgeConfig

object ( BadgeConfig )

پیکربندی نشان برای این انتخاب. وقتی تنظیم شود، برچسبی که این انتخاب را دارد به عنوان "برچسب نشان" در نظر گرفته می شود.

insertBeforeChoice

string

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

BadgeConfig

وضعیت نشان برچسب.

نمایندگی JSON
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
زمینه های
color

object ( Color )

رنگ نشان. وقتی مشخص نیست، هیچ نشانی ارائه نمی شود. رنگ‌های پس‌زمینه، پیش‌زمینه و انفرادی (حالت روشن و تاریک) که در اینجا تنظیم شده‌اند، در رابط کاربری Drive به نزدیک‌ترین رنگ پشتیبانی‌شده توصیه‌شده تغییر می‌کنند.

priorityOverride

string ( int64 format)

اولویت جهانی پیش‌فرض این نشان را لغو کنید. وقتی روی 0 تنظیم می شود، از اکتشافی اولویت پیش فرض استفاده می شود.

رنگ

یک رنگ را در فضای رنگی RGBA نشان می دهد. این نمایش برای سادگی تبدیل به و از نمایش رنگ در زبان های مختلف بیش از فشرده سازی طراحی شده است. به عنوان مثال، فیلدهای این نمایش را می توان به صورت بی اهمیت در اختیار سازنده java.awt.Color در جاوا قرار داد. همچنین می‌توان آن را به روش UIColor +colorWithRed:green:blue:alpha در iOS ارائه کرد. و فقط با کمی کار می توان آن را به راحتی در یک رشته CSS rgba() در جاوا اسکریپت قالب بندی کرد.

این صفحه مرجع اطلاعاتی درباره فضای رنگ مطلقی که باید برای تفسیر مقدار RGB استفاده شود ندارد - برای مثال، sRGB، Adobe RGB، DCI-P3، و BT.2020. به طور پیش فرض، برنامه ها باید فضای رنگی sRGB را در نظر بگیرند.

هنگامی که نیاز به تصمیم گیری در مورد برابری رنگ است، پیاده سازی ها، مگر اینکه به گونه ای دیگر مستند شده باشد، اگر تمام مقادیر قرمز، سبز، آبی و آلفا هر کدام حداکثر 1e-5 متفاوت باشد، با دو رنگ برابر رفتار می کنند.

مثال (جاوا):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

مثال (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

مثال (جاوا اسکریپت):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
نمایندگی JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
زمینه های
red

number

مقدار قرمز در رنگ به عنوان مقدار در بازه [0، 1].

green

number

مقدار سبز در رنگ به عنوان مقدار در بازه [0، 1].

blue

number

مقدار آبی در رنگ به عنوان مقدار در بازه [0، 1].

alpha

number

کسری از این رنگ که باید روی پیکسل اعمال شود. یعنی رنگ پیکسل نهایی با معادله تعریف می شود:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

این بدان معنی است که مقدار 1.0 مربوط به یک رنگ ثابت است، در حالی که مقدار 0.0 مربوط به یک رنگ کاملا شفاف است. این به جای یک اسکالر شناور ساده از یک پیام پوششی استفاده می کند تا بتوان بین یک مقدار پیش فرض و مقدار تنظیم نشده تمایز قائل شد. اگر حذف شود، این شیء رنگی به صورت یک رنگ ثابت نمایش داده می شود (مثل اینکه مقدار آلفا به صراحت مقدار 1.0 داده شده است).

نکات نمایشی

نکات نمایش UI برای ارائه یک گزینه.

نمایندگی JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
زمینه های
disabled

boolean

آیا این گزینه باید در رابط کاربری غیرفعال نشان داده شود یا خیر.

shownInApply

boolean

این گزینه باید در منوی اعمال هنگام اعمال مقادیر به یک مورد Drive نشان داده شود.

badgeColors

object ( BadgeColors )

رنگ هایی که برای نشان استفاده می شود. به رنگ های Google Material بر اساس properties.badge_config.color انتخاب شده تغییر کرد.badge_config.color .

darkBadgeColors

object ( BadgeColors )

رنگ حالت تیره برای استفاده برای نشان. به رنگ های Google Material بر اساس properties.badge_config.color انتخاب شده تغییر کرد.badge_config.color .

badgePriority

string ( int64 format)

اولویت این نشان. برای مقایسه و مرتب سازی بین چندین نشان استفاده می شود. عدد کمتر به این معنی است که نشان باید ابتدا نشان داده شود. هنگامی که پیکربندی نشان وجود ندارد، این عدد 0 خواهد بود. در غیر این صورت، روی BadgeConfig.priority_override یا اکتشافی پیش‌فرض که تاریخ ایجاد برچسب و اولویت فیلد و گزینه را ترجیح می‌دهد، تنظیم می‌شود.

BadgeColors

رنگی که از BadgeConfig مشتق شده و به نزدیکترین رنگ پشتیبانی شده توصیه شده تغییر کرده است.

نمایندگی JSON
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
زمینه های
backgroundColor

object ( Color )

فقط خروجی پس‌زمینه نشان که با پیش‌زمینه جفت می‌شود.

foregroundColor

object ( Color )

فقط خروجی پیش زمینه نشان که با پس زمینه جفت می شود.

soloColor

object ( Color )

فقط خروجی رنگی که می تواند برای متن بدون پس زمینه استفاده شود.

قابلیت های طرحواره

قابلیت های مربوط به این انتخاب هنگام ویرایش انتخاب.

نمایندگی JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
زمینه های
canUpdate

boolean

آیا کاربر می تواند این انتخاب را به روز کند یا خیر.

canDelete

boolean

آیا کاربر می تواند این انتخاب را حذف کند یا خیر.

canDisable

boolean

آیا کاربر می تواند این انتخاب را غیرفعال کند یا خیر.

canEnable

boolean

آیا کاربر می تواند این انتخاب را فعال کند یا خیر.

قابلیت های کاربردی

قابلیت های مربوط به این انتخاب بر روی ابرداده های کاربردی.

نمایندگی JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
زمینه های
canRead

boolean

اینکه آیا کاربر می‌تواند ابرداده‌های کاربردی مرتبط را روی موارد بخواند یا خیر.

canSelect

boolean

آیا کاربر می تواند این انتخاب را روی یک مورد انتخاب کند یا خیر.

وضعیت قفل

حاوی اطلاعاتی در مورد اینکه آیا یک جزء برچسب باید قفل شده در نظر گرفته شود یا خیر.

نمایندگی JSON
{
  "locked": boolean
}
زمینه های
locked

boolean

فقط خروجی نشان می دهد که آیا این جزء برچسب هدف (مستقیم) یک LabelLock است یا خیر. یک جزء برچسب می‌تواند به طور ضمنی قفل شود، حتی اگر هدف مستقیم یک LabelLock نباشد، در این صورت این فیلد روی false تنظیم می‌شود.

UserOptions

گزینه هایی برای نوع فیلد کاربری

نمایندگی JSON
{
  "listOptions": {
    object (ListOptions)
  }
}
زمینه های
listOptions

object ( ListOptions )

وقتی مشخص شد، نشان می دهد که این فیلد لیستی از مقادیر را پشتیبانی می کند. پس از انتشار فیلد، نمی توان آن را تغییر داد.

خواص

ویژگی های اساسی میدان.

نمایندگی JSON
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
زمینه های
displayName

string

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

required

boolean

اینکه آیا این فیلد باید به عنوان مورد نیاز علامت گذاری شود یا خیر.

insertBeforeField

string

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

نکات نمایشی

نکات نمایش UI برای ارائه یک فیلد.

نمایندگی JSON
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
زمینه های
required

boolean

اینکه آیا این فیلد باید همانطور که در UI لازم است نشان داده شود یا خیر.

disabled

boolean

آیا این فیلد باید در رابط کاربری غیرفعال نشان داده شود یا خیر.

shownInApply

boolean

این فیلد باید در منوی اعمال هنگام اعمال مقادیر برای یک مورد Drive نشان داده شود.

قابلیت های طرحواره

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

نمایندگی JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
زمینه های
canUpdate

boolean

آیا کاربر می تواند این فیلد را تغییر دهد یا خیر.

canDelete

boolean

آیا کاربر می تواند این فیلد را حذف کند یا خیر. کاربر باید مجوز داشته باشد و فیلد باید منسوخ شده باشد.

canDisable

boolean

آیا کاربر می تواند این فیلد را غیرفعال کند یا خیر. کاربر باید مجوز داشته باشد و این قسمت نباید قبلاً غیرفعال باشد.

canEnable

boolean

آیا کاربر می تواند این فیلد را فعال کند یا خیر. کاربر باید مجوز داشته باشد و این قسمت باید غیرفعال باشد.

قابلیت های کاربردی

قابلیت های مربوط به این زمینه بر روی ابرداده های کاربردی.

نمایندگی JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
زمینه های
canRead

boolean

اینکه آیا کاربر می‌تواند ابرداده‌های کاربردی مرتبط را روی موارد بخواند یا خیر.

canWrite

boolean

آیا کاربر می‌تواند این فیلد را روی موارد Drive تنظیم کند یا خیر.

مواد و روش ها

create

 یک برچسب جدید ایجاد می کند.

delete

 یک برچسب و ابرداده مربوط به موارد Drive را برای همیشه حذف می کند.

delta

 با اعمال مجموعه‌ای از درخواست‌های به‌روزرسانی که منجر به ویرایش پیش‌نویس جدید می‌شود، یک برچسب را به‌روزرسانی می‌کند.

disable

 برچسب منتشر شده را غیرفعال کنید.

enable

 یک برچسب غیرفعال را فعال کنید و آن را به حالت منتشر شده بازگردانید.

get

 یک برچسب با نام منبع آن دریافت کنید.

list

 لیست برچسب ها

publish

 همه تغییرات پیش‌نویس برچسب را منتشر کنید.

updateLabelCopyMode

 CopyMode یک Label را به روز می کند.

updatePermissions

 مجوزهای یک برچسب را به روز می کند.