REST Resource: labels

Kaynak: Etiket

Etiket, öğeleri düzenlemek ve öğeler arasında arama yapmak için Drive öğelerine uygulanabilecek bir sınıflandırmayı tanımlar. Etiketler basit dizeler olabilir veya Drive öğelerini düzenlemek ve aramak için daha fazla kullanılabilecek ek meta verileri açıklayan alanlar içerebilir.

JSON gösterimi
{
  "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)
  }
}
Alanlar
name

string

Yalnızca çıkış. Etiketin kaynak adı. İsteğe bağlı olarak labels/{id} veya labels/{id}@{revisionId} biçiminde olacaktır. Aşağıda id ve revisionId bölümlerine bakın.

id

string

Yalnızca çıkış. Bu etiketin genel olarak benzersiz tanımlayıcısı. Kimlik, name etiketinin bir kısmını oluşturur, ancak name etiketinin aksine kimlik, düzeltmeler arasında tutarlıdır. Şu normal ifadeyle eşleşir: ([a-zA-Z0-9])+

revisionId

string

Yalnızca çıkış. Etiketin düzeltme kimliği. Düzeltme kimliği, gönderilen isteğe bağlı olarak name etiketinin bir parçası olabilir. Bir etiketin düzeltilmiş özellikleri her değiştirildiğinde yeni bir düzeltme oluşturulur. Şu normal ifadeyle eşleşir: ([a-zA-Z0-9])+

labelType

enum (LabelType)

Zorunlu. Etiketin türü.

creator

object (UserInfo)

Yalnızca çıkış. Bu etiketi oluşturan kullanıcı.

createTime

string (Timestamp format)

Yalnızca çıkış. Bu etiketin oluşturulduğu zaman.

revisionCreator

object (UserInfo)

Yalnızca çıkış. Bu etiket düzeltmesini oluşturan kullanıcı.

revisionCreateTime

string (Timestamp format)

Yalnızca çıkış. Bu etiket düzeltmesinin oluşturulduğu zaman.

publisher

object (UserInfo)

Yalnızca çıkış. Bu etiketi yayınlayan kullanıcı. Etiket yayınlanmadığında bu değerin bir anlamı yoktur.

publishTime

string (Timestamp format)

Yalnızca çıkış. Bu etiketin yayınlanma zamanı. Etiket yayınlanmadığında bu değerin bir anlamı yoktur.

disabler

object (UserInfo)

Yalnızca çıkış. Bu etiketi devre dışı bırakan kullanıcı. Etiket devre dışı bırakılmadığında bu değerin bir anlamı yoktur.

disableTime

string (Timestamp format)

Yalnızca çıkış. Bu etiketin devre dışı bırakıldığı zaman. Etiket devre dışı bırakılmadığında bu değerin bir anlamı yoktur.

customer

string

Yalnızca çıkış. Bu etiketin ait olduğu müşteri. Örneğin: "müşteriler/123abc789."

properties

object (Properties)

Zorunlu. Etiketin temel özellikleri.

lifecycle

object (Lifecycle)

Yalnızca çıkış. Etiketin yayınlanıp yayınlanmadığı, kullanımdan kaldırılıp kaldırılmadığı ve taslak değişiklikleri içerip içermediği dahil olmak üzere yaşam döngüsü durumu.

displayHints

object (DisplayHints)

Yalnızca çıkış. Etiketi oluşturmaya ilişkin kullanıcı arayüzü ipuçları gösteriliyor.

appliedCapabilities

object (AppliedCapabilities)

Yalnızca çıkış. Uygulanan meta verilerde bu etiketle ilgili özellikler.

schemaCapabilities

object (SchemaCapabilities)

Yalnızca çıkış. Kullanıcının bu etikette sahip olduğu özellikler.

appliedLabelPolicy

object (AppliedLabelPolicy)

Yalnızca çıkış. Bu etiketin Drive öğelerine uygulandığında davranışı.

fields[]

object (Field)

Öncelik sırasına göre, alanların listesi.

learnMoreUri

string

Bu etiket ve nasıl kullanılması gerektiği hakkında daha fazla bilgi edinebilmeleri için kullanıcılara sunulacak özel URL.

lockStatus

object (LockStatus)

Yalnızca çıkış. Bu etiketin LockStatus.

LabelType

Bu etiketin türü.

Sıralamalar
LABEL_TYPE_UNSPECIFIED Bilinmeyen etiket türü.
SHARED Paylaşılan etiketler, Drive öğelerine uygulamak üzere kullanıcılarla paylaşılabilir.
ADMIN Yöneticiye ait etiket. Yalnızca yöneticiler tarafından oluşturulabilir ve düzenlenebilir. Yalnızca yöneticiye yönelik bazı ek özellikleri destekler.

UserInfo

Kullanıcı bilgileri.

JSON gösterimi
{
  "person": string
}
Alanlar
person

string

Bu kullanıcıya ait, daha fazla bilgi edinmek için People API ile kullanılabilecek tanımlayıcı. Örneğin, kişiler/12345678.

Özellikler

Etiketin temel özellikleri.

JSON gösterimi
{
  "title": string,
  "description": string
}
Alanlar
title

string

Zorunlu. Etiketin başlığı.

description

string

Etiketin açıklaması.

Yaşam döngüsü

Etiket, alan veya seçim gibi bir nesnenin yaşam döngüsü durumu. Yaşam döngüsünde aşağıdaki geçişler uygulanır:

  • UNPUBLISHED_DRAFT (başlangıç durumu)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Silindi)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Silindi)

Yayınlanan ve devre dışı bırakılan eyaletlerin bazı farklı özellikleri vardır:

  • Yayınlandı: Bu durumdaki bir nesnede bazı değişiklikler yapılabilir. Bu durumda hasUnpublishedChanges doğru olur. Ayrıca, bazı tür değişikliklere izin verilmez. Genel olarak, etiketle alakalı mevcut meta verileri geçersiz kılacak veya yeni kısıtlamalara neden olacak değişiklikler reddedilir.
  • Devre Dışı - Devre dışı bırakıldığında, yapılandırılmış DisabledPolicy geçerlilik kazanır.
JSON gösterimi
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Alanlar
state

enum (State)

Yalnızca çıkış. Bu yaşam döngüsüyle ilişkili nesnenin durumu.

hasUnpublishedChanges

boolean

Yalnızca çıkış. Bu yaşam döngüsüyle ilişkili nesnede yayınlanmamış değişiklikler olup olmadığı.

disabledPolicy

object (DisabledPolicy)

Devre dışı bırakılan bir etiketin, alanın veya seçim seçiminin nasıl gösterileceğini yöneten politika.

Eyalet

Bu yaşam döngüsüyle ilişkili nesnenin durumu.

Sıralamalar
STATE_UNSPECIFIED Bilinmeyen Durum.
UNPUBLISHED_DRAFT Bir nesnenin başlangıç durumu. Nesne, yayınlandıktan sonra bir daha bu duruma geri dönemez. Bir nesne yayınlandıktan sonra, belirli türlerdeki değişikliklere artık izin verilmez.
PUBLISHED Nesne yayınlandı. Nesnenin hasUnpublishedChanges ile belirtilen şekilde yayınlanmamış taslak değişiklikleri olabilir.
DISABLED Nesne yayınlandı ve devre dışı bırakıldı. Nesnenin hasUnpublishedChanges ile belirtilen şekilde yayınlanmamış taslak değişiklikleri olabilir.
DELETED Nesne silindi.

DisabledPolicy

Devre dışı bırakılan bir etiketin, alanın veya seçim seçiminin farklı bağlamlarda nasıl ele alınacağını yöneten politika.

JSON gösterimi
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Alanlar
showInApply

boolean

Bu devre dışı bırakılan nesnenin, Drive öğelerinde uygula menüsünde gösterilip gösterilmeyeceğini belirler.

  • true olduğunda, nesne genellikle kullanıcı arayüzünde devre dışı olarak gösterilir ve seçilemez.
  • false olduğunda, nesne genellikle kullanıcı arayüzünde gizlenir.

DisplayHints

Etiketi oluşturmaya ilişkin kullanıcı arayüzü ipuçları gösteriliyor.

JSON gösterimi
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Alanlar
disabled

boolean

Etiketin kullanıcı arayüzünde devre dışı olarak gösterilip gösterilmeyeceği.

shownInApply

boolean

Bir Drive öğesine değerler uygulanırken bu etiket, uygula menüsünde gösterilmelidir.

priority

string (int64 format)

Etiketi bir listede gösterme sırası.

AppliedCapabilities

Kullanıcının bu etikete uygulanan meta verilerde sahip olduğu özellikler.

JSON gösterimi
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Alanlar
canRead

boolean

Kullanıcının bu etiketle ilgili uygulanan meta verileri okuyup okuyamayacağı.

canApply

boolean

Kullanıcının bu etiketi öğelere uygulayıp uygulayamayacağı.

canRemove

boolean

Kullanıcının bu etiketi öğelerden kaldırıp kaldıramayacağı.

SchemaCapabilities

Etiket düzenlenirken bu etiketle ilgili özellikler.

JSON gösterimi
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Alanlar
canUpdate

boolean

Kullanıcının bu etiketi değiştirip değiştiremeyeceği.

canDelete

boolean

Kullanıcının bu etiketi silip silemeyeceği. Kullanıcının izne sahip olması ve etiket devre dışı bırakılması gerekir.

canDisable

boolean

Kullanıcının bu etiketi devre dışı bırakıp bırakamayacağı. Kullanıcının izne sahip olması ve bu etiketin zaten devre dışı bırakılmamış olması gerekir.

canEnable

boolean

Kullanıcının bu etiketi etkinleştirip etkinleştiremeyeceğini belirtir. Kullanıcının izne sahip olması ve bu etiket devre dışı bırakılması gerekir.

AppliedLabelPolicy

Bu etiketin Drive öğelerine uygulandığında davranışı.

JSON gösterimi
{
  "copyMode": enum (CopyMode)
}
Alanlar
copyMode

enum (CopyMode)

Bir Drive öğesi kopyalandığında uygulanan etiketin ve alan değerlerinin nasıl kopyalanması gerektiğini belirtir.

CopyMode

Bir Drive öğesi kopyalandığında uygulanan etiketin ve alan değerlerinin nasıl kopyalanması gerektiğini belirtir.

Sıralamalar
COPY_MODE_UNSPECIFIED Kopyalama modu belirtilmedi.
DO_NOT_COPY Uygulanan etiket ve alan değerleri, uygulandığı Drive öğesi kopyalandığında varsayılan olarak kopyalanmaz.
ALWAYS_COPY Uygulanan etiket ve alan değerleri, uygulandığı Drive öğesi kopyalandığında her zaman kopyalanır. Bu modu yalnızca yöneticiler kullanabilir.
COPY_APPLIABLE Kopyayı oluşturan kullanıcı etiket uygulanabiliyorsa uygulanan etiket ve alan değerleri kopyalanır.

Alan

Görünen adı, veri türü ve diğer yapılandırma seçenekleri olan bir alanı tanımlar. Bu alan, bir Drive öğesinde ayarlanabilecek meta veri türünü tanımlar.

JSON gösterimi
{
  "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.
}
Alanlar
id

string

Yalnızca çıkış. Bir etiket veya kitaplık içinde benzersiz olan alan anahtarı.

Bu değer otomatik olarak oluşturulmuştur. Şu normal ifadeyle eşleşir: ([a-zA-Z0-9])+

queryKey

string

Yalnızca çıkış. Dosyalardaki bu alan için tanımlanmış değerleri temel alan dosyaları bulmak amacıyla Drive arama sorguları oluştururken kullanılacak anahtar. Örneğin, "{queryKey} > 2001-01-01".

properties

object (Properties)

Alanın temel özellikleri.

lifecycle

object (Lifecycle)

Yalnızca çıkış. Bu alanın yaşam döngüsü.

displayHints

object (DisplayHints)

Yalnızca çıkış. Bir alanı oluşturmak için kullanıcı arayüzü gösterilen ipuçları.

schemaCapabilities

object (SchemaCapabilities)

Yalnızca çıkış. Kullanıcının bu alanı düzenlerken sahip olduğu özellikler.

appliedCapabilities

object (AppliedCapabilities)

Yalnızca çıkış. Bu kullanıcının bu alandaki özellikleri ve etiket Drive öğelerine uygulandığında değeri.

creator

object (UserInfo)

Yalnızca çıkış. Bu alanı oluşturan kullanıcı.

createTime

string (Timestamp format)

Yalnızca çıkış. Bu alanın oluşturulduğu zaman.

updater

object (UserInfo)

Yalnızca çıkış. Bu alanı değiştiren kullanıcı.

updateTime

string (Timestamp format)

Yalnızca çıkış. Bu alanın güncellenme zamanı.

publisher

object (UserInfo)

Yalnızca çıkış. Bu alanı yayınlayan kullanıcı. Alan yayınlanmadığında bu değerin bir anlamı yoktur.

disabler

object (UserInfo)

Yalnızca çıkış. Bu alanı devre dışı bırakan kullanıcı. Alan devre dışı bırakılmadığında bu değerin bir anlamı yoktur.

disableTime

string (Timestamp format)

Yalnızca çıkış. Bu alanın devre dışı bırakıldığı zaman. Alan devre dışı bırakılmadığında bu değerin bir anlamı yoktur.

lockStatus

object (LockStatus)

Yalnızca çıkış. Bu alanın LockStatus.

Birleştirme alanı type. Bu alandaki veri türü ve seçenekleri. Veri türü yayınlandıktan sonra değiştirilemez. type şunlardan yalnızca biri olabilir:
textOptions

object (TextOptions)

Metin alanı seçenekleri.

integerOptions

object (IntegerOptions)

Tam sayı alanı seçenekleri.

dateOptions

object (DateOptions)

Tarih alanı seçenekleri.

selectionOptions

object (SelectionOptions)

Seçim alanı seçenekleri.

userOptions

object (UserOptions)

Kullanıcı alanı seçenekleri.

TextOptions

Metin alanı türü seçenekleri.

JSON gösterimi
{
  "minLength": integer,
  "maxLength": integer
}
Alanlar
minLength

integer

Yalnızca çıkış. Metin alanı için değerlerin minimum geçerli uzunluğu.

maxLength

integer

Yalnızca çıkış. Metin alanı için değerlerin maksimum geçerli uzunluğu.

IntegerOptions

Tam sayı alan türü için seçenekler.

JSON gösterimi
{
  "minValue": string,
  "maxValue": string
}
Alanlar
minValue

string (int64 format)

Yalnızca çıkış. Tam sayı alanı için geçerli minimum değer.

maxValue

string (int64 format)

Yalnızca çıkış. Tam sayı alanı için geçerli maksimum değer.

DateOptions

Tarih alanı türü seçenekleri.

JSON gösterimi
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Alanlar
dateFormatType

enum (DateFormat)

Yerelleştirilmiş tarih biçimlendirme seçeneği. Alan değerleri, yerel ayarlarına göre bu biçimde oluşturulur.

dateFormat

string

Yalnızca çıkış. Yoğun bakım ünitesi tarih biçimi.

minValue

object (Date)

Yalnızca çıkış. Minimum geçerli değer (yıl, ay, gün).

maxValue

object (Date)

Yalnızca çıkış. Maksimum geçerli değer (yıl, ay, gün).

DateFormat

Yerelleştirilmiş tarih biçimi seçenekleri.

Sıralamalar
DATE_FORMAT_UNSPECIFIED Tarih biçimi belirtilmedi.
LONG_DATE Ayın tam adını içerir. Örneğin, 12 Ocak 1999 (DDMM d, y)
SHORT_DATE Kısa, sayısal, temsili. Örneğin, 12/13/99 (A/g/yy)

Tarih

Takvimin tamamını veya bir kısmını temsil eder (ör. doğum günü). Günün saati ve saat dilimi başka bir yerde belirtilmiş veya önemsiz. Tarih, Miladi Takvim'e göredir. Bu, aşağıdakilerden birini temsil edebilir:

  • Sıfır olmayan yıl, ay ve gün değerleriyle tam tarih.
  • Bir ay ve gün ile sıfır yıl (örneğin, bir yıl dönümü).
  • Tek başına bir yıl, sıfır ay ve sıfır gün.
  • Sıfır gün içeren bir yıl ve ay (örneğin, kredi kartı son kullanma tarihi).

İlgili türler:

JSON gösterimi
{
  "year": integer,
  "month": integer,
  "day": integer
}
Alanlar
year

integer

Tarihin yılı. 1 ile 9999 arasında veya yıl içermeyen bir tarihi belirtmek için 0 arasında olmalıdır.

month

integer

Bir yılın ayı. 1 ile 12 arasında veya ay ve gün içermeyen bir yılı belirtmek için 0 arasında olmalıdır.

day

integer

Ayın günü. 1 ile 31 arasında bir değer olmalı ve yıl ve ay için geçerlidir. Yalnızca yılı belirtmek için 0 değerini veya günün önemli olmadığı bir yılı ve ayı belirtmek için 0 değerini girin.

SelectionOptions

Seçim alanı türü seçenekleri.

JSON gösterimi
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Alanlar
listOptions

object (ListOptions)

Belirtildiğinde, bu alanın bir değer listesini desteklediğini belirtir. Alan yayınlandıktan sonra bu değiştirilemez.

choices[]

object (Choice)

Bu seçim alanı için kullanılabilen seçenekler. Liste sırası tutarlı ve insertBeforeChoice ile değiştirildi.

ListOptions

İlişkilendirilmiş alan türünün birden çok değerli varyantı için seçenekler.

JSON gösterimi
{
  "maxEntries": integer
}
Alanlar
maxEntries

integer

İzin verilen maksimum giriş sayısı.

Seçim

Seçim alanı seçimi.

JSON gösterimi
{
  "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)
  }
}
Alanlar
id

string

Seçimin benzersiz değeri. Bu kimlik otomatik olarak oluşturulmuştur. Şu normal ifadeyle eşleşir: ([a-zA-Z0-9_])+.

properties

object (Properties)

Seçimin temel özellikleri.

lifecycle

object (Lifecycle)

Yalnızca çıkış. Tercih edilen yaşam döngüsü.

displayHints

object (DisplayHints)

Yalnızca çıkış. Bir seçimi oluşturmak için kullanıcı arayüzü gösterim ipuçları.

schemaCapabilities

object (SchemaCapabilities)

Yalnızca çıkış. Seçenek düzenlenirken kullanılan bu seçenekle ilgili özellikler.

appliedCapabilities

object (AppliedCapabilities)

Yalnızca çıkış. Uygulanan meta verilerde bu seçimle ilgili özellikler.

creator

object (UserInfo)

Yalnızca çıkış. Bu seçimi oluşturan kullanıcı.

createTime

string (Timestamp format)

Yalnızca çıkış. Bu seçimin oluşturulduğu zaman.

updater

object (UserInfo)

Yalnızca çıkış. Bu seçimi en son güncelleyen kullanıcı.

updateTime

string (Timestamp format)

Yalnızca çıkış. Bu seçimin en son güncellendiği zaman.

publisher

object (UserInfo)

Yalnızca çıkış. Bu seçimi yayınlayan kullanıcı. Seçim yayınlanmadığında bu değerin bir anlamı yoktur.

publishTime

string (Timestamp format)

Yalnızca çıkış. Bu seçimin yayınlandığı zaman. Seçim yayınlanmadığında bu değerin bir anlamı yoktur.

disabler

object (UserInfo)

Yalnızca çıkış. Bu seçeneği devre dışı bırakan kullanıcı. Seçenek devre dışı bırakılmadığında bu değerin bir anlamı yoktur.

disableTime

string (Timestamp format)

Yalnızca çıkış. Bu seçeneğin devre dışı bırakıldığı zaman. Seçim devre dışı bırakılmamışsa bu değerin bir anlamı yoktur.

lockStatus

object (LockStatus)

Yalnızca çıkış. Bu seçimin LockStatus.

Özellikler

Seçimin temel özellikleri.

JSON gösterimi
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Alanlar
displayName

string

Zorunlu. Bu alanı tanımlayan kullanıcı arayüzünde gösterilecek görünen metin.

description

string

Bu etiketin açıklaması.

badgeConfig

object (BadgeConfig)

Bu seçim için rozet yapılandırması. Ayarlandığında, bu seçimin sahibi olan etiket "rozetli etiket" olarak kabul edilir.

insertBeforeChoice

string

Yalnızca giriş. Bu seçeneği belirtilen seçimin önüne ekleyin veya taşıyın. Boşsa seçim, listenin sonuna yerleştirilir.

BadgeConfig

Etiketin rozet durumu.

JSON gösterimi
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Alanlar
color

object (Color)

Rozetin rengi. Belirtilmezse rozet oluşturulmaz. Burada ayarlanan arka plan, ön plan ve solo (açık ve koyu mod) renkler Drive kullanıcı arayüzünde, önerilen en yakın renklerle değiştirilir.

priorityOverride

string (int64 format)

Bu rozetin varsayılan genel önceliğini geçersiz kılın. 0 olarak ayarlandığında varsayılan öncelik buluşsal yöntem kullanılır.

Renk

RGBA renk alanındaki bir rengi temsil eder. Bu sunum, kompaktlık yerine, çeşitli dillerdeki renk gösterimlerine ve bu gösterimlerden dönüştürmenin basitleştirilmesi için tasarlanmıştır. Örneğin, bu temsilin alanları, Java'da java.awt.Color oluşturucuya standart bir şekilde sağlanabilir; Ayrıca, iOS'te UIColor'ın +colorWithRed:green:blue:alpha yöntemine de sağlanabilir; ve küçük bir çalışmayla, JavaScript'te bir CSS rgba() dizesi olarak kolayca biçimlendirilebilir.

Bu referans sayfasında, RGB değerini yorumlamak için kullanılması gereken mutlak renk alanıyla ilgili bilgiler (ör. sRGB, Adobe RGB, DCI-P3 ve BT.2020) yer almaz. Varsayılan olarak uygulamalar sRGB renk alanını kabul etmelidir.

Renk eşitliğinin belirlenmesi gerektiğinde, aksi belirtilmediği sürece uygulamalarda iki rengin tamamının kırmızı, yeşil, mavi ve alfa değerlerinin her biri en fazla 1e-5 farklılık gösterdiği takdirde eşit kabul edilir.

Örnek (Java):

 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();
 }
 // ...

Örnek (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;
}
// ...

Örnek (JavaScript):

// ...

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 gösterimi
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Alanlar
red

number

[0, 1] aralığındaki bir değer olarak renkteki kırmızı miktarı.

green

number

[0, 1] aralığındaki bir değer olarak renkteki yeşilin miktarı.

blue

number

[0, 1] aralığındaki bir değer olarak renkteki mavi miktarı.

alpha

number

Bu rengin piksele uygulanması gereken oranı. Yani son piksel rengi denklemle tanımlanır:

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

Bu, 1,0 değeri düz bir renge karşılık gelirken, 0.0 değeri tamamen şeffaf bir renge karşılık gelir. Bu yöntem, varsayılan değer ile ayarlanmayan değeri birbirinden ayırt edebilmek için basit bir kayan skaler yerine bir sarmalayıcı mesajı kullanır. Atlanırsa bu renk nesnesi düz renk olarak oluşturulur (alfa değerine açık bir şekilde 1, 0 değeri verilmiş gibi).

DisplayHints

Bir seçeneği oluşturmak için kullanıcı arayüzü gösterim ipuçları.

JSON gösterimi
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Alanlar
disabled

boolean

Seçeneğin kullanıcı arayüzünde devre dışı olarak gösterilip gösterilmeyeceği.

shownInApply

boolean

Bir Drive öğesine değer uygulanırken bu seçenek, uygula menüsünde gösterilmelidir.

badgeColors

object (BadgeColors)

Rozet için kullanılacak renkler. Seçilen properties.badge_config.color temel alınarak Google Materyal renklerine değiştirildi.

darkBadgeColors

object (BadgeColors)

Rozet için kullanılacak koyu mod rengi. Seçilen properties.badge_config.color temel alınarak Google Materyal renklerine değiştirildi.

badgePriority

string (int64 format)

Bu rozetin önceliği. Birden çok rozeti karşılaştırmak ve sıralamak için kullanılır. Daha düşük bir sayı, önce rozetin gösterilmesi gerektiği anlamına gelir. Rozet yapılandırması mevcut değilse bu değer 0 olur. Aksi takdirde, bu ayar BadgeConfig.priority_override değerine veya etiketin oluşturulma tarihini ve alan ve seçenek önceliğini tercih eden varsayılan buluşsal yönteme ayarlanır.

BadgeColors

Renk rozetiConfig'den türetilmiş ve desteklenen en yakın renkle değiştirildi.

JSON gösterimi
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Alanlar
backgroundColor

object (Color)

Yalnızca çıkış. Ön planla eşleşen rozet arka planı.

foregroundColor

object (Color)

Yalnızca çıkış. Arka planla eşleşen rozet ön planı.

soloColor

object (Color)

Yalnızca çıkış. Arka planı olmayan metin için kullanılabilecek renk.

SchemaCapabilities

Seçim düzenlenirken bu seçimle ilgili özellikler.

JSON gösterimi
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Alanlar
canUpdate

boolean

Kullanıcının bu seçimi güncelleyip güncelleyemeyeceği.

canDelete

boolean

Kullanıcının bu seçeneği silip silemeyeceği.

canDisable

boolean

Kullanıcının bu seçeneği devre dışı bırakıp bırakamayacağı.

canEnable

boolean

Kullanıcının bu seçeneği etkinleştirip etkinleştiremeyeceğini belirtir.

AppliedCapabilities

Uygulanan meta verilerde bu seçimle ilgili özellikler.

JSON gösterimi
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Alanlar
canRead

boolean

Kullanıcının öğelerde uygulanan ilgili meta verileri okuyup okuyamayacağı.

canSelect

boolean

Kullanıcının bir öğede bu seçeneği belirleyip belirleyemeyeceği.

LockStatus

Bir etiket bileşeninin kilitli olarak kabul edilip edilmeyeceğiyle ilgili bilgileri içerir.

JSON gösterimi
{
  "locked": boolean
}
Alanlar
locked

boolean

Yalnızca çıkış. Bu etiket bileşeninin bir Etiket Kilidi'nin (doğrudan) hedefi olup olmadığını belirtir. Bir etiket bileşeni, bir LabelLock'un doğrudan hedefi olmasa bile dolaylı olarak kilitlenebilir. Bu durumda bu alan false (yanlış) değerine ayarlanır.

UserOptions

Kullanıcı alanı türü seçenekleri.

JSON gösterimi
{
  "listOptions": {
    object (ListOptions)
  }
}
Alanlar
listOptions

object (ListOptions)

Belirtildiğinde, bu alanın bir değer listesini desteklediğini gösterir. Alan yayınlandıktan sonra bu değiştirilemez.

Özellikler

Alanın temel özellikleri.

JSON gösterimi
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Alanlar
displayName

string

Zorunlu. Bu alanı tanımlayan kullanıcı arayüzünde gösterilecek görünen metin.

required

boolean

Alanın zorunlu olarak işaretlenip işaretlenmeyeceğini belirtir.

insertBeforeField

string

Yalnızca giriş. Bu alanı belirtilen alanın önüne ekleyin veya taşıyın. Boşsa alan, listenin sonuna yerleştirilir.

DisplayHints

Bir alanı oluşturmak için kullanıcı arayüzü gösterilen ipuçları.

JSON gösterimi
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Alanlar
required

boolean

Alanın, kullanıcı arayüzünde gerektiği gibi gösterilip gösterilmeyeceği.

disabled

boolean

Alanın kullanıcı arayüzünde devre dışı olarak gösterilip gösterilmeyeceği.

shownInApply

boolean

Bir Drive öğesine değer uygulanırken bu alan, uygula menüsünde gösterilmelidir.

SchemaCapabilities

Alan düzenlenirken bu alanla ilgili özellikler.

JSON gösterimi
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Alanlar
canUpdate

boolean

Kullanıcının bu alanı değiştirip değiştiremeyeceği.

canDelete

boolean

Kullanıcının bu alanı silip silemeyeceği. Kullanıcı izne sahip olmalı ve alan kullanımdan kaldırılmalıdır.

canDisable

boolean

Kullanıcının bu alanı devre dışı bırakıp bırakamayacağı. Kullanıcı izne sahip olmalıdır ve bu alan devre dışı bırakılmamış olmalıdır.

canEnable

boolean

Kullanıcının bu alanı etkinleştirip etkinleştiremeyeceği. Kullanıcının izne sahip olması ve bu alan devre dışı bırakılması gerekir.

AppliedCapabilities

Uygulanan meta verilerde bu alanla ilgili özellikler.

JSON gösterimi
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Alanlar
canRead

boolean

Kullanıcının öğelerde uygulanan ilgili meta verileri okuyup okuyamayacağı.

canWrite

boolean

Kullanıcının bu alanı Drive öğelerinde ayarlayıp ayarlayamayacağı.

Yöntemler

create

Yeni bir etiket oluşturur.

delete

Drive Öğelerindeki bir etiketi ve ilgili meta verileri kalıcı olarak siler.

delta

Bir dizi güncelleme isteği uygulayarak tek bir Etiketi günceller ve sonuçta yeni bir düzeltme taslağı oluşturulur.

disable

Yayınlanan bir etiketi devre dışı bırakma

enable

Devre dışı bırakılmış bir etiketi etkinleştirin ve yayınlanmış durumuna geri yükleyin.

get

Kaynak adına göre bir etiket alın.

list

Etiketleri listeleme.

publish

Tüm taslak değişiklikleri Etikete yayınlama.

updateLabelCopyMode

Bir etiketin CopyMode öğesini günceller.

updatePermissions

Bir etiketin izinlerini günceller.