Method: organizations.sites.customcss.getEditorschema

Gets the information required for the theme editor.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*/sites/*/customcss}/editorschema

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name for the custom CSS. Use the following structure in your request: organizations/{org}/sites/customcss

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "status": string,
  "message": string,
  "requestId": string,
  "errorCode": string,
  "data": {
    object (ThemeEditorSchema)
  }
}
Fields
status

string

Status of the operation.

message

string

Details of the operation.

requestId

string

ID that can be used to find request details in the log files.

errorCode

string

ID that can be used to find errors in the log files.

data

object (ThemeEditorSchema)

Details of the theme editor schema.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

ThemeEditorSchema

JSON representation
{
  "schemaInfo": {
    object (CustomStyleSchemaInfo)
  },
  "defaultVariables": {
    object (CustomStyleConfig)
  }
}
Fields
schemaInfo

object (CustomStyleSchemaInfo)

Custom style details.

defaultVariables

object (CustomStyleConfig)

Custom styles for the default variables.

CustomStyleSchemaInfo

JSON representation
{
  "properties": {
    string: array,
    ...
  },
  "gui": [
    {
      object (GuiSection)
    }
  ],
  "copiedVariables": {
    string: string,
    ...
  },
  "enums": {
    string: array,
    ...
  }
}
Fields
properties

map (key: string, value: array (ListValue format))

Map of properties to their kinds. Multiple kinds are allowed on each variable. The value of this map is a list of strings, where each string is a kind associated with the property.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

gui[]

object (GuiSection)

JSON node which represents the input fields in the UI. The server does not type this structure beyond being plain JSON; the UI handles the rendering.

copiedVariables

map (key: string, value: string)

writeOnly: true

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

enums

map (key: string, value: array (ListValue format))

Array of values of type EnumOption. This is untyped beyond being a JSON object as the metadata can be in any format/structure.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

GuiSection

JSON representation
{
  "kind": string,
  "title": string,
  "elements": array
}
Fields
kind

string

Kind.

title

string

Title of the element.

elements

array (ListValue format)

List of values for the element.

CustomStyleConfig

JSON representation
{
  "variables": {
    string: {
      object
    },
    ...
  }
}
Fields
variables

map (key: string, value: object (Struct format))

Map of keys to style variables. Style variables can be one of many different structures created by the UI that the server can turn into styling.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.