List Activities By Admin with Google Workspace Admin API on Daily schedule from Schedule API

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

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

List Activities By Admin with the Google Workspace Admin API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Google Workspace Admin action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Daily schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the List Activities By Admin action
1. Connect your Google Workspace Admin account
2. Select a Application Name
3. Select a User Key
4. Optional- Configure End Time
5. Optional- Configure Start Time
6. Optional- Configure Max Results
7. Optional- Configure Filters
8. Optional- Configure Event Name
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Daily schedule on Schedule

Description:Trigger your workflow every day.

Version:0.0.1

Key:schedule-daily

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Daily schedule",
  version: "0.0.1",
  key: "schedule-daily",
  type: "source",
  description: "Trigger your workflow every day.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 11 * * *",
      },
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

List Activities By Admin on Google Workspace Admin

Description:Retrieves a report of all Admin console activities done by a specific administrator. [See the docs](https://developers.google.com/admin-sdk/reports/v1/guides/manage-audit-admin#get_admin_events) for more information

Version:0.0.1

Key:google_workspace-list-activities-by-admin

View on GitHub

Google Workspace Admin Overview#

The Google Workspace Admin API unlocks the power to manage your organization's Google Workspace services. With Pipedream, leverage this API to automate user account management tasks, control devices, manage groups, and gain insights through reports. Simplify complex operational workflows and keep your Workspace environment finely tuned and secure without manual intervention.

Action Code#

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

Action Configuration#

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

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`
User Key	`userKey`	`string`	Select a value from the drop down menu.
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
Event Name	`eventName`	`string`	The name of the event being queried by the API. Each Event Name is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar Event Name activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and Event Name parameters. For more information about Event Name query strings and parameters, see the list of event names for various applications above in Application Name. For more details on this parameter see the docs here

Action 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