Gmail API . users . labels

Instance Methods

create(userId, body=None, x__xgafv=None)

Creates a new label.

delete(userId, id, x__xgafv=None)

Immediately and permanently deletes the specified label and removes it from

get(userId, id, x__xgafv=None)

Gets the specified label.

list(userId, x__xgafv=None)

Lists all labels in the user's mailbox.

patch(userId, id, body=None, x__xgafv=None)

Patch the specified label.

update(userId, id, body=None, x__xgafv=None)

Updates the specified label.

Method Details

create(userId, body=None, x__xgafv=None)
Creates a new label.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the
    # user's mailbox.
  "name": "A String", # The display name of the label.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "messagesTotal": 42, # The total number of messages with the label.
  "color": { # The color to assign to the label. Color is only available for labels that
      # have their <code>type</code> set to <code>user</code>.
      # @mutable gmail.users.labels.create gmail.users.labels.update
    "textColor": "A String", # The text color of the label, represented as hex string.
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
  },
  "type": "A String", # The owner type for the label. User labels are created by the user and
      # can be modified and deleted by the user and can be applied to any
      # message or thread. System labels are internally created and cannot be
      # added, modified, or deleted. System labels may be able to be applied to or
      # removed from messages and threads under some circumstances but this is
      # not guaranteed. For example, users can apply and remove the
      # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
      # threads, but cannot apply or remove the <code>DRAFTS</code> or
      # <code>SENT</code> labels from messages or threads.
  "threadsTotal": 42, # The total number of threads with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "threadsUnread": 42, # The number of unread threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the
      # Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "id": "A String", # The immutable ID of the label.
  "messagesUnread": 42, # The number of unread messages with the label.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the
      # user's mailbox.
    "name": "A String", # The display name of the label.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "messagesTotal": 42, # The total number of messages with the label.
    "color": { # The color to assign to the label. Color is only available for labels that
        # have their <code>type</code> set to <code>user</code>.
        # @mutable gmail.users.labels.create gmail.users.labels.update
      "textColor": "A String", # The text color of the label, represented as hex string.
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
      "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
    },
    "type": "A String", # The owner type for the label. User labels are created by the user and
        # can be modified and deleted by the user and can be applied to any
        # message or thread. System labels are internally created and cannot be
        # added, modified, or deleted. System labels may be able to be applied to or
        # removed from messages and threads under some circumstances but this is
        # not guaranteed. For example, users can apply and remove the
        # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
        # threads, but cannot apply or remove the <code>DRAFTS</code> or
        # <code>SENT</code> labels from messages or threads.
    "threadsTotal": 42, # The total number of threads with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "threadsUnread": 42, # The number of unread threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the
        # Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "id": "A String", # The immutable ID of the label.
    "messagesUnread": 42, # The number of unread messages with the label.
  }
delete(userId, id, x__xgafv=None)
Immediately and permanently deletes the specified label and removes it from
any messages and threads that it is applied to.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(userId, id, x__xgafv=None)
Gets the specified label.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the
      # user's mailbox.
    "name": "A String", # The display name of the label.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "messagesTotal": 42, # The total number of messages with the label.
    "color": { # The color to assign to the label. Color is only available for labels that
        # have their <code>type</code> set to <code>user</code>.
        # @mutable gmail.users.labels.create gmail.users.labels.update
      "textColor": "A String", # The text color of the label, represented as hex string.
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
      "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
    },
    "type": "A String", # The owner type for the label. User labels are created by the user and
        # can be modified and deleted by the user and can be applied to any
        # message or thread. System labels are internally created and cannot be
        # added, modified, or deleted. System labels may be able to be applied to or
        # removed from messages and threads under some circumstances but this is
        # not guaranteed. For example, users can apply and remove the
        # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
        # threads, but cannot apply or remove the <code>DRAFTS</code> or
        # <code>SENT</code> labels from messages or threads.
    "threadsTotal": 42, # The total number of threads with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "threadsUnread": 42, # The number of unread threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the
        # Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "id": "A String", # The immutable ID of the label.
    "messagesUnread": 42, # The number of unread messages with the label.
  }
list(userId, x__xgafv=None)
Lists all labels in the user's mailbox.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "labels": [ # List of labels. Note that each label resource only contains an
        # <code>id</code>, <code>name</code>, <code>messageListVisibility</code>,
        # <code>labelListVisibility</code>, and <code>type</code>. The
        # <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method
        # can fetch additional label details.
      { # Labels are used to categorize messages and threads within the
          # user's mailbox.
        "name": "A String", # The display name of the label.
            # @mutable gmail.users.labels.create gmail.users.labels.update
        "messagesTotal": 42, # The total number of messages with the label.
        "color": { # The color to assign to the label. Color is only available for labels that
            # have their <code>type</code> set to <code>user</code>.
            # @mutable gmail.users.labels.create gmail.users.labels.update
          "textColor": "A String", # The text color of the label, represented as hex string.
              # This field is required in order to set the color of a label.
              # Only the following predefined set of color values are allowed:
              # <br/>
              # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
              #
              # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
              #
              # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
              #
              # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
              #
              # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
              #
              # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
              #
              # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
              #
              # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
              #
              # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
              #
              # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
              #
              # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
              #
              # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
              #
              # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
              #
              # @mutable gmail.users.labels.create gmail.users.labels.update
          "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
              # This field is required in order to set the color of a label.
              # Only the following predefined set of color values are allowed:
              # <br/>
              # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
              #
              # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
              #
              # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
              #
              # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
              #
              # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
              #
              # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
              #
              # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
              #
              # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
              #
              # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
              #
              # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
              #
              # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
              #
              # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
              #
              # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
              #
              # @mutable gmail.users.labels.create gmail.users.labels.update
        },
        "type": "A String", # The owner type for the label. User labels are created by the user and
            # can be modified and deleted by the user and can be applied to any
            # message or thread. System labels are internally created and cannot be
            # added, modified, or deleted. System labels may be able to be applied to or
            # removed from messages and threads under some circumstances but this is
            # not guaranteed. For example, users can apply and remove the
            # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
            # threads, but cannot apply or remove the <code>DRAFTS</code> or
            # <code>SENT</code> labels from messages or threads.
        "threadsTotal": 42, # The total number of threads with the label.
        "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
            # @mutable gmail.users.labels.create gmail.users.labels.update
        "threadsUnread": 42, # The number of unread threads with the label.
        "messageListVisibility": "A String", # The visibility of the label in the message list in the
            # Gmail web interface.
            # @mutable gmail.users.labels.create gmail.users.labels.update
        "id": "A String", # The immutable ID of the label.
        "messagesUnread": 42, # The number of unread messages with the label.
      },
    ],
  }
patch(userId, id, body=None, x__xgafv=None)
Patch the specified label.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the
    # user's mailbox.
  "name": "A String", # The display name of the label.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "messagesTotal": 42, # The total number of messages with the label.
  "color": { # The color to assign to the label. Color is only available for labels that
      # have their <code>type</code> set to <code>user</code>.
      # @mutable gmail.users.labels.create gmail.users.labels.update
    "textColor": "A String", # The text color of the label, represented as hex string.
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
  },
  "type": "A String", # The owner type for the label. User labels are created by the user and
      # can be modified and deleted by the user and can be applied to any
      # message or thread. System labels are internally created and cannot be
      # added, modified, or deleted. System labels may be able to be applied to or
      # removed from messages and threads under some circumstances but this is
      # not guaranteed. For example, users can apply and remove the
      # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
      # threads, but cannot apply or remove the <code>DRAFTS</code> or
      # <code>SENT</code> labels from messages or threads.
  "threadsTotal": 42, # The total number of threads with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "threadsUnread": 42, # The number of unread threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the
      # Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "id": "A String", # The immutable ID of the label.
  "messagesUnread": 42, # The number of unread messages with the label.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the
      # user's mailbox.
    "name": "A String", # The display name of the label.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "messagesTotal": 42, # The total number of messages with the label.
    "color": { # The color to assign to the label. Color is only available for labels that
        # have their <code>type</code> set to <code>user</code>.
        # @mutable gmail.users.labels.create gmail.users.labels.update
      "textColor": "A String", # The text color of the label, represented as hex string.
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
      "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
    },
    "type": "A String", # The owner type for the label. User labels are created by the user and
        # can be modified and deleted by the user and can be applied to any
        # message or thread. System labels are internally created and cannot be
        # added, modified, or deleted. System labels may be able to be applied to or
        # removed from messages and threads under some circumstances but this is
        # not guaranteed. For example, users can apply and remove the
        # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
        # threads, but cannot apply or remove the <code>DRAFTS</code> or
        # <code>SENT</code> labels from messages or threads.
    "threadsTotal": 42, # The total number of threads with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "threadsUnread": 42, # The number of unread threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the
        # Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "id": "A String", # The immutable ID of the label.
    "messagesUnread": 42, # The number of unread messages with the label.
  }
update(userId, id, body=None, x__xgafv=None)
Updates the specified label.

Args:
  userId: string, The user's email address. The special value <code>me</code>
can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the
    # user's mailbox.
  "name": "A String", # The display name of the label.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "messagesTotal": 42, # The total number of messages with the label.
  "color": { # The color to assign to the label. Color is only available for labels that
      # have their <code>type</code> set to <code>user</code>.
      # @mutable gmail.users.labels.create gmail.users.labels.update
    "textColor": "A String", # The text color of the label, represented as hex string.
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
        # This field is required in order to set the color of a label.
        # Only the following predefined set of color values are allowed:
        # <br/>
        # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
        #
        # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
        #
        # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
        #
        # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
        #
        # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
        #
        # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
        #
        # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
        #
        # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
        #
        # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
        #
        # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
        #
        # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
        #
        # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
        #
        # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
        #
        # @mutable gmail.users.labels.create gmail.users.labels.update
  },
  "type": "A String", # The owner type for the label. User labels are created by the user and
      # can be modified and deleted by the user and can be applied to any
      # message or thread. System labels are internally created and cannot be
      # added, modified, or deleted. System labels may be able to be applied to or
      # removed from messages and threads under some circumstances but this is
      # not guaranteed. For example, users can apply and remove the
      # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
      # threads, but cannot apply or remove the <code>DRAFTS</code> or
      # <code>SENT</code> labels from messages or threads.
  "threadsTotal": 42, # The total number of threads with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "threadsUnread": 42, # The number of unread threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the
      # Gmail web interface.
      # @mutable gmail.users.labels.create gmail.users.labels.update
  "id": "A String", # The immutable ID of the label.
  "messagesUnread": 42, # The number of unread messages with the label.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the
      # user's mailbox.
    "name": "A String", # The display name of the label.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "messagesTotal": 42, # The total number of messages with the label.
    "color": { # The color to assign to the label. Color is only available for labels that
        # have their <code>type</code> set to <code>user</code>.
        # @mutable gmail.users.labels.create gmail.users.labels.update
      "textColor": "A String", # The text color of the label, represented as hex string.
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
      "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
          # This field is required in order to set the color of a label.
          # Only the following predefined set of color values are allowed:
          # <br/>
          # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
          #
          # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
          #
          # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
          #
          # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
          #
          # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
          #
          # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
          #
          # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
          #
          # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
          #
          # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
          #
          # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
          #
          # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
          #
          # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
          #
          # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
          #
          # @mutable gmail.users.labels.create gmail.users.labels.update
    },
    "type": "A String", # The owner type for the label. User labels are created by the user and
        # can be modified and deleted by the user and can be applied to any
        # message or thread. System labels are internally created and cannot be
        # added, modified, or deleted. System labels may be able to be applied to or
        # removed from messages and threads under some circumstances but this is
        # not guaranteed. For example, users can apply and remove the
        # <code>INBOX</code> and <code>UNREAD</code> labels from messages and
        # threads, but cannot apply or remove the <code>DRAFTS</code> or
        # <code>SENT</code> labels from messages or threads.
    "threadsTotal": 42, # The total number of threads with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "threadsUnread": 42, # The number of unread threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the
        # Gmail web interface.
        # @mutable gmail.users.labels.create gmail.users.labels.update
    "id": "A String", # The immutable ID of the label.
    "messagesUnread": 42, # The number of unread messages with the label.
  }