List All Activities with Google Workspace Admin API

Pipedream makes it easy to connect APIs for Google Workspace Admin and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List All Activities with the Google Workspace Admin API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List All Activities with the Google Workspace Admin API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List All Activities action
1. Connect your Google Workspace Admin account
2. Select a Application Name
3. Optional- Configure End Time
4. Optional- Configure Start Time
5. Optional- Configure Max Results
6. Optional- Configure Filters
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List All Activities with Google Workspace Admin API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Workspace Admin

Try it

List All Activities with Google Workspace Admin API on New Item in Feed from RSS API

RSS + Google Workspace Admin

Try it

List All Activities with Google Workspace Admin API on New Message in Channel from Discord Bot API

Discord Bot + Google Workspace Admin

Try it

List All Activities with Google Workspace Admin API on New Submission from Typeform API

Typeform + Google Workspace Admin

Try it

List All Activities with Google Workspace Admin API on Custom Events from Zoom API

Zoom + Google Workspace Admin

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List All Activities on Google Workspace Admin

Description:Retrieves a report of all administrative activities done for an account. [See the docs](https://developers.google.com/admin-sdk/reports/v1/guides/manage-audit-admin#get_account_events) for more information

Version:0.0.1

Key:google_workspace-list-all-activities

View on GitHub

Code#

import { defineAction } from "@pipedream/types";
import googleWorkspace from "../../app/google_workspace.app.mjs";
export default defineAction({
    key: "google_workspace-list-all-activities",
    name: "List All Activities",
    description: "Retrieves a report of all administrative activities done for an account. [See the docs](https://developers.google.com/admin-sdk/reports/v1/guides/manage-audit-admin#get_account_events) for more information",
    version: "0.0.1",
    type: "action",
    props: {
        googleWorkspace,
        applicationName: {
            propDefinition: [
                googleWorkspace,
                "applicationName",
            ],
        },
        endTime: {
            propDefinition: [
                googleWorkspace,
                "endTime",
            ],
        },
        startTime: {
            propDefinition: [
                googleWorkspace,
                "startTime",
            ],
        },
        maxResults: {
            propDefinition: [
                googleWorkspace,
                "maxResults",
            ],
        },
        filters: {
            propDefinition: [
                googleWorkspace,
                "filters",
            ],
        },
    },
    async run({ $ }) {
        const { applicationName, endTime, startTime, maxResults, filters, } = this;
        const { items: activities } = await this.googleWorkspace.listAdminActivities({
            userKey: "all",
            applicationName,
            endTime,
            startTime,
            maxResults,
            filters,
        });
        $.export("$summary", `Successfully listed ${activities.length} activities.`);
        return activities;
    },
});

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Workspace Admin	`googleWorkspace`	`app`	This component uses the Google Workspace Admin app.
Application Name	`applicationName`	`string`	Select a value from the drop down menu:`access_transparencyadmincalendarchatdrivegcpgplusgroupsgroups_enterprisejamboardloginmeetmobilerulessamltokenuser_accountscontext_aware_accesschromedata_studiokeep`
End Time	`endTime`	`string`	Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example `2010-10-28T10:26:35.000Z`. The default value is the approximate time of the API request. For more details on this parameter see the docs here
Start Time	`startTime`	`string`	Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example `2010-10-28T10:26:35.000Z`. The report returns all activities from Start Time until End Time. The Start Time must be before the End Time (if specified) and the current time when the request is made, or the API returns an error. For more details on this parameter see the docs here
Max Results	`maxResults`	`integer`	Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The Max Results query string is optional in the request. The default value is `1000`. For more details on this parameter see the docs here
Filters	`filters`	`string`	The filters query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},....`. For more details on this parameter see the docs here

Authentication#

Google Workspace Admin uses OAuth authentication. When you connect your Google Workspace Admin account, Pipedream will open a popup window where you can sign into Google Workspace Admin and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Workspace Admin API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/admin.directory.user.securityhttps://apps-apis.google.com/a/feeds/alias/https://www.googleapis.com/auth/admin.directory.userhttps://www.googleapis.com/auth/admin.directory.user.aliashttps://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/admin.directory.device.chromeoshttps://www.googleapis.com/auth/admin.directory.customerhttps://www.googleapis.com/auth/admin.directory.domainhttps://www.googleapis.com/auth/admin.directory.domain.readonlyhttps://apps-apis.google.com/a/feeds/groups/https://www.googleapis.com/auth/admin.directory.grouphttps://www.googleapis.com/auth/admin.directory.group.memberhttps://www.googleapis.com/auth/admin.directory.device.mobilehttps://www.googleapis.com/auth/admin.directory.device.mobile.actionhttps://apps-apis.google.com/a/feeds/policies/https://www.googleapis.com/auth/admin.directory.orgunithttps://www.googleapis.com/auth/admin.directory.orgunit.readonlyhttps://www.googleapis.com/auth/admin.directory.rolemanagementhttps://apps-apis.google.com/a/feeds/calendar/resource/https://www.googleapis.com/auth/admin.directory.resource.calendarhttps://www.googleapis.com/auth/admin.directory.userschemahttps://www.googleapis.com/auth/admin.reports.audit.readonly