Google Apps Platform

Reference Guide

Note: There's a new Google Apps Marketplace experience! Beginning November 19, 2013, new listings may only be created using the new version: existing developers may need to create a new Chrome Web Store account to publish new listings. Refer to the new documentation for more information.

This Reference Guide is a detailed technical reference of the collections, resources, methods, and authentication requirements for v2 of the Google Apps Billing and Licensing APIs.

Note: The endpoints in the reference guide refer to the production endpoint. If targeting the sandbox use https://www.googleapis.com/appsmarket/v2sandbox instead.

Introduction

Contents and Overview

Data REST URI relative to https://www.googleapis.com/appsmarket/v2 Access
CustomerLicense Collection
↳ CustomerLicense Resource
GET  /customerLicense/applicationId/customerId AUTHENTICATED
LicenseNotification Collection
↳ LicenseNotification Resource
GET  /licenseNotification/applicationId?timestamp=TIMESTAMP&start-token=START_TOKEN&max-results=MAX_RESULTS AUTHENTICATED
UserLicense Collection
↳ UserLicense Resource
GET  /userLicense/applicationId/userId AUTHENTICATED

CustomerLicense Collection

CustomerLicense

The CustomerLicense indicates the subscription status of a given domain.

The customerLicense.get method operates on a specified CustomerLicense Resource.

CustomerLicense Resource

A CustomerLicense Resource is a collection of metadata describing the license status of the given customerId (domain).

{
  "kind": "appsmarket#customerLicense",
  "id": value,
  "applicationId": value,
  "customerId": value,
  "state": value,
  "editions": [
    {
      "editionId": value,
      "seatCount": value,
      "assignedSeats": value
    }
  ],
  "subscription": subscription Resource,
  "subscriptionState": value,
  "nextRenewalTimestamp": value
}
Property Name Value Description Mutable
id string
applicationId string The ID of the application corresponding to this license query.
customerId string The domain name of the customer.
state string The customer's license status. One of:
ACTIVE -- The customer has a valid license.
UNLICENSED -- There is no license: either this customer has never installed your application, or else has deleted it.
EXPIRED -- The subscription is no longer active.
editions list Editions of the application for which the customer has a license.
editions.editionId string The name of the edition. This corresponds to the name supplied in the listing manifest.
editions.seatCount integer The number of seats the customer has purchased.
editions.assignedSeats integer The number of seats the customer has assigned.
subscription object The most recent subscription, corresponding to the subscription state.
subscriptionState string The subscription status. One of:
ACTIVE -- The subscription is in use, and the customer has been charged.
TRIAL -- The subscription is active, but the customer has not been charged.
CANCELED -- The customer canceled the subscription. It is no longer active.
LOCKED -- The subscription is inaccessible. This most often occurs when the server is in the middle of processing an update. When LOCKED, new orders should not be placed for this customer.
NOTEXIST -- There is no subscription. Most likely the customer currently has a free edition of the application.

appsmarket.customerLicense.get (AUTHENTICATED)

The customerLicense.get method retrieves a CustomerLicense Resource for the provided customerId (domain). Authentication is required.

GET https://www.googleapis.com/appsmarket/v2/customerLicense/applicationId/customerId

LicenseNotification Collection

LicenseNotification

LicenseNotifications indicates actions taken by customers of a given application.

The licenseNotification.list method operates on a collection of LicenseNotification Resources.

LicenseNotification Resource

A LicenseNotification Resource provides metadata on an event (either active or passive) involving a customer and an application.

appsmarket.licenseNotification.list (AUTHENTICATED)

The licenseNotification.list method retrieves a set of LicenseNotification Resources. Developers may optionally include a max-results parameter indicating the desired size of the resulting resources (default 10).


Developers may also optionally include one of timestamp (in milliseconds since UNIX epoch) or start-token. The timestamp may be used to limit queries to notifications after the provided time (though the API may occasionally return one or more results just prior to the specified timestamp). The start-token may be used to continue querying just after the results of a previous query (by using the nextPageToken returned by that query as the value of start-token).
Authentication is required.

GET https://www.googleapis.com/appsmarket/v2/licenseNotification/applicationId?timestamp=TIMESTAMP&start-token=START_TOKEN&max-results=MAX_RESULTS
{
  "kind": "appsmarket#licenseNotificationList",
  "notifications": [{
    "applicationId": value,
    "kind": "appsmarket#licenseNotification",
    "provisions": [{
      "kind": "appsmarket#provisionNotification",
      "seatCount": value,
      "editionId": value
    }],
    "timestamp": value,
    "customerId": value,
    "id": value
  },
  {
    "applicationId": value,
    "kind": "appsmarket#licenseNotification",
    "deletes": [{
      "kind": "appsmarket#deletionNotification"
    }],
    "timestamp": value,
    "customerId": value,
    "id": value
  },
  {
    "applicationId": value,
    "kind": "appsmarket#licenseNotification",
    "reassignments": [{
      "kind": "appsmarket#reassignmentNotification",
      "editionId": value,
      "type": value,
      "userId": value,
    }],
    "timestamp": value,
    "customerId" value,
    "id": value
  },
  {
    "applicationId": value,
    "kind": "appsmarket#licenseNotification",
    "expiries": [{
      "kind": "appsmarket#expiryNotification",
    }],
    "timestamp": value,
    "customerId": value,
    "id": value
  }],
  "nextPageToken": value
}
Property Name Value Description Mutable
notifications list The list of notifications. One or more of:
provisions -- A new license of the application has been provisioned.
expiries -- A license of the application has expired.
deletions -- An application has been deleted from a domain.
reassignments -- An administrator has assigned or revoked a seat license for the application on the provided domain.
nextPageToken string The token used to continue querying for notifications after the final notification in the current result set.
notifications.provisions list The list of provisioning notifications.
notifications.expiries list The list of expiry notifications.
notifications.deletions list The list of deletion notifications.
notifications.reassignments list The list of reassignment notifications.
notifications.applicationId string The ID of the application according to this notification.
notifications.customerId string The domain name of the customer corresponding to this notification.
notifications.timestamp number The time the event occurred, measuring in milliseconds since the UNIX epoch.
notifications.provisions.editionId string The edition that was provisioned.
notifications.provisions.seatCount string The number of seats that were provisioned.
notifications.reassignments.editionId string The edition that was reassigned.
notifications.reassignments.userId string The email address of the reassigned user.
notifications.reassignments.type string The type of reassignment. One of:
ASSIGN -- The seat was assigned to the user.
REVOKE -- The seat was revoked from the user.

UserLicense Collection

UserLicense

The UserLicense indicates the subscription status of an individual user.

The userLicense.get method operates on a specified UserLicense Resource.

UserLicense Resource

{
  "kind": "appsmarket#userLicense",
  "id": value,
  "applicationId": value,
  "userId": value,
  "state": value,
  "enabled": value,
  "editionId": value,
  "customerId": value
}
Property Name Value Description Mutable
applicationId string The ID of the application corresponding to the license query.
userId string The email address of the user.
state string The user's licensing status. One of:
ACTIVE -- The user has a valid license and should be permitted to use the application.
UNLICENSED -- The administrator of this user's domain never assigned a seat for the application to this user.
EXPIRED -- The administrator assigned a seat to this user, but the license is expired.
enabled boolean The domain administrator has activated the application for this domain.
editionId string The edition for which the user has a seat.
customerId string The domain name of the user.

appsmarket.userLicense.get (AUTHENTICATED)

The userLicense.get method retrieves a UserLicense Resource for the provided userId (email address). Authentication is required.

GET https://www.googleapis.com/appsmarket/v2/userLicense/applicationId/userId




Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.