Types

Open Cloud represents request and response payloads as standard JSON. The standards JSON types are text, values, objects, arrays, numbers, and strings. Some types have special considerations for representing specific kinds of data, which are described in the following sections.

Timestamp

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.

Example Timestamp
{ "timestamp": "1972-01-01T10:00:20.021Z" }

Duration

Generated output always contains 0, 3, 6, or 9 fractional digits, depending on required precision, followed by the suffix "s". Accepted are any fractional digits (also none) as long as they fit into nano-seconds precision and the suffix "s" is required.

Example Durations
{
  "duration-9": "1.000340012s",
  "duration-0": "1s"
}

Bytes

Byte data are encoded as a string using standard base64 encoding with paddings. Either standard or URL-safe base64 encoding with or without paddings are supported.

Example Bytes
{
  "bytes": "YWJjMTIzIT8kKiYoKSctRbLx+"
}

FieldMask

A FieldMask is a string that describes the fields to act on when making a request. To construct a field mask, you specify comma delimited JSON field names in a string. For example, given the following resource:

Example JSON resource
{
  "foo": {
    "a": "c",
    "b": "d"
  },
  "bar": "x",
  "baz": "y"
}

If you wanted to specify a field mask to update the values of only foo.b and bar, the field mask would look like: foo.b, bar

In Open Cloud, update methods that support a field mask have a parameter named updateMask, where you can specify a field mask as a value.

Money

Generally used to define a price, the Money type has a three-letter currency code (as defined in ISO 4217) and a quantity, which uses the Decimal type. For example, a $17.99 Creator Store product looks like this:

"myPrice": {
  "currencyCode": "USD",
  "quantity": {
    "significand": 1799,
    "exponent": -2
  }
}

Decimal

Represents a decimal number in a form similar to scientific notation, with significant digits and an exponent.

Examples:

• 17

  {"significand": 17, "exponent": 0} or just {"significand": 17}

• -0.005

  {"significand": -5, "exponent": -3}

• 33.5 million (33,500,000)

  {"significand": 335, "exponent": 5}

• 11/8 (1.375)

  {"significand": 1375, "exponent": -3}

When exponent is greater than 0, it represents the number of trailing zeroes after the significant digits. When exponent is less than 0, it represents how many of the significant digits come after the decimal point. When exponent is 0, the value of the Decimal is the value of the significand.