Label

یک برچسب

نمایندگی JSON
{
  "resourceName": string,
  "status": enum (LabelStatus),
  "textLabel": {
    object (TextLabel)
  },
  "id": string,
  "name": string
}
فیلدها
resource Name

string

تغییرناپذیر. نام منبع نام منابع برچسب به این شکل است: customers/{customerId}/labels/{label_id}

status

enum ( LabelStatus )

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

text Label

object ( TextLabel )

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

id

string ( int64 format)

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

name

string

نام برچسب.

این فیلد ضروری است و هنگام ایجاد برچسب جدید نباید خالی باشد.

طول این رشته باید بین 1 تا 80 باشد.

وضعیت برچسب

وضعیت های احتمالی یک برچسب

Enums
UNSPECIFIED مشخص نشده است.
UNKNOWN فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است.
ENABLED برچسب فعال است.
REMOVED برچسب حذف می شود.

TextLabel

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

نمایندگی JSON
{
  "backgroundColor": string,
  "description": string
}
فیلدها
background Color

string

رنگ پس زمینه لیبل در فرمت HEX. این رشته باید با عبارت منظم '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$' مطابقت داشته باشد. توجه: رنگ پس‌زمینه ممکن است برای حساب‌های مدیر قابل مشاهده نباشد.

description

string

شرح مختصری از برچسب طول آن نباید بیشتر از 200 کاراکتر باشد.