Skip to main content
PATCH
/
library
/
v1beta1
/
{libId}
/
customuiactions
/
{customUIActionId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/library/v1beta1/{libId}/customuiactions/{customUIActionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayedOn": {
    "classIds": [
      {
        "documents": true,
        "id": "<string>",
        "kind": "<string>",
        "views": true
      }
    ],
    "viewIds": [
      {
        "id": "<string>",
        "kind": "<string>"
      }
    ]
  },
  "icon": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "libraryId": "<string>",
  "role": "NONE",
  "selection": "ANY",
  "title": "<string>",
  "url": "<string>",
  "windowName": "<string>"
}
'
{
  "displayedOn": {
    "classIds": [
      {
        "documents": true,
        "id": "<string>",
        "kind": "<string>",
        "views": true
      }
    ],
    "viewIds": [
      {
        "id": "<string>",
        "kind": "<string>"
      }
    ]
  },
  "icon": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "libraryId": "<string>",
  "role": "NONE",
  "selection": "ANY",
  "title": "<string>",
  "url": "<string>",
  "windowName": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
libId
string
required

The ID of the library

​
customUIActionId
string
required

The ID of the custom ui action.

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
displayedOn
object
​
icon
string

Must be an icon id from the Material Design Iconic Font set version 2.2.0

​
id
string
​
kind
string
​
libraryId
string

The ID of the library (read-only field)

​
role
enum<string>

The minimum required role on the library for the entry to be displayed

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
selection
enum<string>

The "type" of selection that will allow the entry to be displayed

Available options:
ANY,
EMPTY,
NOT_EMPTY,
SINGLE_DOCUMENT,
SINGLE_FOLDER,
SINGLE_ATTACHMENT,
ONLY_DOCUMENTS,
ONLY_FOLDERS,
ONLY_WITH_ATTACHMENT,
HAS_DOCUMENTS,
HAS_FOLDERS,
HAS_ATTACHMENTS
​
title
string

Title to be used as tooltip on buttons, or text for menu entries

​
url
string

The url to use when clicking on the item. It can be a template URL, as a template literal

​
windowName
string

The window name that the target url should be opened in (second parameter in window.open()). Defaults to "_blank"

Response

200 - application/json

A ApiCustomUIAction response

​
displayedOn
object
​
icon
string

Must be an icon id from the Material Design Iconic Font set version 2.2.0

​
id
string
​
kind
string
​
libraryId
string

The ID of the library (read-only field)

​
role
enum<string>

The minimum required role on the library for the entry to be displayed

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
selection
enum<string>

The "type" of selection that will allow the entry to be displayed

Available options:
ANY,
EMPTY,
NOT_EMPTY,
SINGLE_DOCUMENT,
SINGLE_FOLDER,
SINGLE_ATTACHMENT,
ONLY_DOCUMENTS,
ONLY_FOLDERS,
ONLY_WITH_ATTACHMENT,
HAS_DOCUMENTS,
HAS_FOLDERS,
HAS_ATTACHMENTS
​
title
string

Title to be used as tooltip on buttons, or text for menu entries

​
url
string

The url to use when clicking on the item. It can be a template URL, as a template literal

​
windowName
string

The window name that the target url should be opened in (second parameter in window.open()). Defaults to "_blank"