Home > User Guide > Get Started > Custom Google App

    Export to PDF

    Custom Google App

    Configuring a custom Google app is required in the following scenarios:

    - When using the default service app (**AvePoint Cloud Backup)**, you may encounter throttling issues caused by Google quota limits. If performance is a concern, consider configuring a custom Google app for your organization. - If your organization wants to enable the protection for Chat, Vault, or Directory, it is necessary to configure a custom Google app. - If your organization has configured both the default **AvePoint Cloud Backup** app and a custom Google app, only the custom Google app will be used in backup and restore jobs.

    Follow the instructions below to configure a custom Google app and create an app profile to consent to the custom app:

    1. Configure a custom Google app by referring to the section in the AvePoint Online Services user guide.

    2. Refer to the information below to enable the required APIs:

      • Admin SDK API must be enabled for common functionalities.

      • Gmail API must be enabled if you want to protect the Gmail data.

      • Google Drive API must be enabled if you want to protect drives and shared drives.

      • Drive Labels API must be enabled if you want to protect labels for drives and shared drives.

      • Google Calendar API must be enabled if you want to protect calendars.

      • Google People API must be enabled if you want to protect contacts.

      • Google Chat API must be enabled if you want to protect chats. After enabling the Google Chat API at , you need to configure the app information under its CONFIGURATION tab by following the steps below. (Note that the Chat apps are required to access Chat data but are invisible to Google users.)

        Configure the app information under its CONFIGURATION tab.

        1. Configure the following application information:

          • App Name – Enter the name of the app.

          • Avatar URL – Provide an icon for the app. Any valid URL is acceptable.

          • Description – Write a brief description of the app.

        2. Disable the Enable Interactive features option.

          ![Disable the "Enable Interactive features" option.](/en/google-backup/user-guide/get-started/images/image7.png "Disable the "Enable Interactive features" option.")

        3. Click Save.

      • Google Vault API and Google Cloud Storage JSON API must be enabled if you want to protect the Vault data.

      • Google Classroom API must be enabled if you want to protect the Classroom data.

      • Cloud Identity, Admin SDK API, Groups Settings API, and Enterprise License Manager API must be enabled if you want to protect the Directory data.

    3. Refer to the following information to configure the related OAuth scopes:

      Refer to the table below for details about why we need the scopes:

    ServiceAPIScopePurpose
    CommonAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.group.readonlyRetrieve groups in your domain.
    CommonAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.user.readonlyRetrieve users in your domain.
    CommonAdmin SDK APIhttps://www.googleapis.com/auth/admin.reports.usage.readonlyRetrieve your organization subscription usage for backup admins to monitor their subscription in the app.
    CommonAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.orgunit.readonlyRetrieve organization units in your workspace.
    GmailGmail APIhttps://mail.google.com/Back up emails and labels in Gmail for future recovery.
    DriveGoogle Drive APIhttps://www.googleapis.com/auth/driveBack up folders and files under My Drive and shared drives for future recovery.
    Drive labelDrive Labels APIhttps://www.googleapis.com/auth/drive.admin.labelsRetrieve all information of labels on files in Drives for backup and restore.
    Drive labelDrive Labels APIhttps://www.googleapis.com/auth/drive.labelsBack up and restore properties of labels on files in Drives.
    CalendarGoogle Calendar APIhttps://www.googleapis.com/auth/calendarBack up calendars and events from Google Calendar for future recovery.
    ContactsGoogle People APIhttps://www.googleapis.com/auth/contacts.other.readonlyBack up Other contacts data.
    ContactsGoogle People APIhttps://www.googleapis.com/auth/contactsBack up contact groups and contacts from Google Contacts for future recovery.
    ChatGoogle Chat APIhttps://www.googleapis.com/auth/chat.spaces.readonlyRetrieve all chat spaces.
    ChatGoogle Chat APIhttps://www.googleapis.com/auth/chat.memberships.readonlyRetrieve the membership of each chat space.
    ChatGoogle Chat APIhttps://www.googleapis.com/auth/chat.messages.readonlyBack up chats and related attachments.
    VaultGoogle Vault APIhttps://www.googleapis.com/auth/ediscoveryUse this API to export Google Vault data.
    VaultGoogle Cloud Storage JSON APIhttps://www.googleapis.com/auth/devstorage.read_onlyDownload the exported Google Vault data.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.coursesBack up and restore classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.announcementsBack up and restore announcements in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.coursework.meBack up classwork in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.coursework.studentsRestore classwork in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.courseworkmaterialsBack up and restore classwork materials.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.rostersBack up and restore students and teachers in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.profile.emailsRetrieve email addresses in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.topicsBack up and restore topics in classes.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.topics.readonlyRetrieve information of topics.
    ClassroomGoogle Classroom APIhttps://www.googleapis.com/auth/classroom.guardianlinks.studentsRetrieve guardians of students in classes.
    Google DirectoryCloud Identityhttps://www.googleapis.com/auth/cloud-identity.groupsBack up and restore groups.
    Google DirectoryAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.groupBack up and restore groups.
    Google DirectoryAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.group.memberBack up and restore group members.
    Google DirectoryAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.userBack up and restore users.
    Google DirectoryAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.rolemanagementBack up and restore group roles and user roles.
    Google DirectoryAdmin SDK APIhttps://www.googleapis.com/auth/admin.directory.userschemaBack up and restore user attributes.
    Google DirectoryGroups Settings APIhttps://www.googleapis.com/auth/apps.groups.settingsBack up and restore group settings.
    Google DirectoryEnterprise License Manager APIhttps://www.googleapis.com/auth/apps.licensingBack up and restore user licenses.
    1. After you finish configuring scopes for the custom Google app, go to AvePoint Online Services and navigate to Management > App management to create an app profile and consent to the custom Google app. For more details, refer to the section in the AvePoint Online Services user guide.