ApiProduct

JSON representation
{
  "name": string,
  "displayName": string,
  "approvalType": string,
  "attributes": [
    {
      object (ApiProductAttribute)
    }
  ],
  "description": string,
  "apiResources": [
    string
  ],
  "environments": [
    string
  ],
  "proxies": [
    string
  ],
  "quota": string,
  "quotaInterval": string,
  "quotaTimeUnit": string,
  "scopes": [
    string
  ],
  "createdAt": string,
  "lastModifiedAt": string
}
Fields
name

string

The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._-$ %.

displayName

string

The name to be displayed in the UI or developer portal to developers registering for API access.

approvalType

string

manual or auto. If manual, consumer key is generated and returned in 'pending' state. If auto consumer key generated and returned in 'Approved' state.

attributes[]

object (ApiProductAttribute)

Arbitrary name/value pairs.

description

string

An overview of the API product. Include key information about the API product that is not captured by other fields.

apiResources[]

string

A comma separated list of API resources to be bundled in the API Product.

environments[]

string

A comma-separated list of environment name in an organization. Requests to environments not listed are rejected

proxies[]

string

A comma-separated list of API proxy names in an organization.

quota

string

The number of request messages permitted by this API product for the specified quotaInterval and quotaTimeUnit.

quotaInterval

string

The time interval over which the number of request messages is calculated.

quotaTimeUnit

string

The time unit defined for the quotaInterval, as either: minute, hour, day, month.

scopes[]

string

A comma separated list of scopes. These must map to the scopes defined in an Oauth policy associated with the API Product.

createdAt

string (int64 format)

Output only. Creation time of this environment as milliseconds since epoch. json key: createdAt

lastModifiedAt

string (int64 format)

Output only. Modified time of this environment as milliseconds since epoch. json key: lastModifiedAt