App-Installations- und Lizenzierungsdetails abrufen

In diesem Dokument wird anhand von Beispielanfragen und ‑antworten für die Google Workspace Marketplace API gezeigt, wie Sie Installations- und Lizenzierungsdetails für Google Workspace Marketplace-Apps abrufen.

Die App wurde von einem Administrator installiert

Der Administrator von cymbalgroup.com hat die Anwendung für alle Nutzer in der Organisation installiert.

userLicense.get-Anfrage

Mit dieser Anfrage wird die Methode userLicense.get aufgerufen, um den Lizenzierungsstatus von user1@cymbalgroup.com abzurufen und festzustellen, ob der Nutzer die Berechtigung hat, die Anwendung zu verwenden.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/APPLICATION_ID/user1@cymbalgroup.com

Antworttext

Da cymbalgroup.com die Anwendung installiert hat, wird in der Antwort die userLicense-Ressource für user1@cymbalgroup.com zurückgegeben. Das Feld enabled der userLicense-Ressource ist auf true gesetzt. Das bedeutet, dass der Domainadministrator für cymbalgroup.com die Anwendung für diese Domain aktiviert hat. Das Feld state ist auf ACTIVE gesetzt. Das bedeutet, dass user1@cymbalgroup.com eine gültige Lizenz hat und die Anwendung verwenden darf.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "user1@cymbalgroup.com",
  "applicationId": "APPLICATION_ID",
  "id": "USER_LICENSE_ID",
  "userId": "user1@cymbalgroup.com"
}

customerLicense.get-Anfrage

Bei dieser Anfrage wird die Methode customerLicense.get aufgerufen, um den Lizenzierungsstatus von cymbalgroup.com abzurufen und festzustellen, ob das Unternehmen Zugriff auf die Anwendung hat.

GET /appsmarket/v2/customerLicense/{applicationId}/{customerId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/customerLicense/APPLICATION_ID/cymbalgroup.com

Antworttext

In der Antwort wird die customerLicense-Ressource für cymbalgroup.com zurückgegeben, wobei das Feld state auf ACTIVE gesetzt ist. Das bedeutet, dass der Kunde eine gültige Lizenz hat.

{
  "kind": "appsmarket#customerLicense",
  "id": "CUSTOMER_LICENSE_ID",
  "applicationId": "APPLICATION_ID",
  "customerId": "cymbalgroup.com",
  "state": "ACTIVE",
  "editions": [
    {
      "editionId": "default_edition",
      "seatCount": -1
    }
  ]
}

Die Anwendung wird nur vom Administrator für die Organisationseinheit eines bestimmten Nutzers installiert.

Die Anwendung wird jetzt nur noch für die Organisationseinheit von user2@cymbalgroup.com installiert. Sie wird nicht mehr vom Administrator für alle Mitglieder der Organisation installiert.

userLicense.get-Anfrage

Mit dieser Anfrage wird die Methode userLicense.get aufgerufen, um den Lizenzierungsstatus von user3@cymbalgroup.com abzurufen und festzustellen, ob der Nutzer die Berechtigung hat, die Anwendung zu verwenden.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/APPLICATION_ID/user3@cymbalgroup.com

Antworttext

Da die Anwendung nur für user2@cymbalgroup.com vom Administrator installiert wurde, wird in der Antwort eine userLicense-Ressource für user3@cymbalgroup.com zurückgegeben, in der das Feld enabled auf false gesetzt ist. Das bedeutet, dass der Domainadministrator für cymbalgroup.com die Anwendung für diese Domain nicht aktiviert hat. Das Feld state ist auf ACTIVE gesetzt, was darauf hinweist, dass der Nutzer eine gültige Lizenz hat und die Anwendung verwenden darf.

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "cymbalgroup.com",
  "applicationId": "APPLICATION_ID",
  "id": "USER_LICENSE_ID",
  "userId": "user3@cymbalgroup.com"
}

userLicense.get-Anfrage

Mit dieser Anfrage wird die Methode userLicense.get aufgerufen, um den Lizenzierungsstatus von user2@cymbalgroup.com abzurufen und festzustellen, ob der Nutzer die Berechtigung zur Verwendung der Anwendung hat.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/APPLICATION_ID/user2@cymbalgroup.com

Antworttext

Da die Anwendung nur für user2@cymbalgroup.com vom Administrator installiert wurde, wird in der Antwort eine userLicense-Ressource für user2@cymbalgroup.com zurückgegeben, bei der das Feld enabled auf true und das Feld state auf ACTIVE gesetzt ist.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "cymbalgroup.com",
  "applicationId": "APPLICATION_ID",
  "id": "USER_LICENSE_ID",
  "userId": "user2@cymbalgroup.com"
}

Die Anwendung wird für alle Nutzer in der Organisation gelöscht.

Obwohl die Anwendung für alle Nutzer in der Organisation gelöscht wurde, hat user1@cymbalgroup.com weiterhin Zugriff, da sie sie zuvor individuell installiert hat.

userLicense.get-Anfrage

Mit dieser Anfrage wird die Methode userLicense.get aufgerufen, um den Lizenzierungsstatus von user2@cymbalgroup.com abzurufen und festzustellen, ob der Nutzer die Berechtigung zur Verwendung der Anwendung hat.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/APPLICATION_ID/user2@cymbalgroup.com

Antworttext

Da die Anwendung für alle Nutzer in der Organisation gelöscht wurde, wird in der Antwort eine userLicense-Ressource für user2@cymbalgroup.com zurückgegeben, in der das Feld enabled auf false und das Feld state auf UNLICENSED gesetzt ist. Das bedeutet, dass der Administrator der Domain dieses Nutzers diesem Nutzer keinen Arbeitsplatz für die Anwendung zugewiesen hat.

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "UNLICENSED",
  "applicationId": "APPLICATION_ID",
  "id": "USER_LICENSE_ID",
  "userId": "user2@cymbalgroup.com"
}

userLicense.get-Anfrage

Mit dieser Anfrage wird die Methode userLicense.get aufgerufen, um den Lizenzierungsstatus von user1@cymbalgroup.com abzurufen und festzustellen, ob der Nutzer die Berechtigung hat, die Anwendung zu verwenden.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/APPLICATION_ID/user1@cymbalgroup.com

Antworttext

Da user1@cymbalgroup.com die Anwendung zuvor einzeln installiert hat, hat er weiterhin die Berechtigung, sie zu verwenden. Die Antwort gibt eine userLicense-Ressource zurück, deren Feld enabled auf true und deren Feld state auf ACTIVE gesetzt ist.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "user1@cymbalgroup.com",
  "applicationId": "APPLICATION_ID",
  "id": "USER_LICENSE_ID",
  "userId": "user1@cymbalgroup.com"
}