Подпишитесь на события Google Диска

На этой странице описаны события Google Диска, на которые ваше приложение может подписаться с помощью API событий Google Workspace. Определив, какие типы событий вам нужны, создайте подписку , чтобы начать получать события из Диска.

Подробнее о разработке приложений для Диска см. в обзоре API Google Диска .

Поддерживаемые события Drive

Подписки на Google Workspace позволяют получать события о следующих типах изменений на Диске:

• Файл — это:
  • Добавлено в папку или на общий диск.
  • Перемещено в папку или на общий диск.
  • Отредактировано или загружена новая версия.
  • Выброшено или удалено из корзины.
• Предложение о доступе создано или разрешено для файла.

Ресурсы, которые вы можете отслеживать на предмет событий

Для получения событий необходимо указать ресурс Диска для мониторинга, который называется целевым ресурсом подписки.

API событий Google Workspace поддерживает следующие целевые ресурсы для Диска:

Типы событий для создания подписок

При создании подписки на ресурс Диска вы используете поле eventTypes[] чтобы указать, какие типы событий вы хотите получать. Типы событий форматируются в соответствии со спецификацией CloudEvents , например, google.workspace. APPLICATION . RESOURCE . VERSION . ACTION .

Например, чтобы получать события о создании файла в папке или на общем диске, укажите файл в качестве целевого ресурса, а тип события — google.workspace.drive.file.v3.created . Чтобы получать события о создании предложения доступа для файла, укажите предложение доступа в качестве целевого ресурса, а тип события — google.workspace.drive.accessproposal.v3.created . Подробнее о работе событий см. в статье Структура событий Google Workspace .

В следующей таблице показаны типы событий, поддерживаемые для подписок на ресурсы Диска:

Данные о событиях

В этом разделе описываются данные событий и примеры полезной нагрузки для событий на Диске.

Когда ваша подписка на Google Workspace получает событие от Диска, поле data содержит полезную нагрузку события. Эта полезная нагрузка содержит информацию об изменившемся ресурсе Google Workspace. Например, если вы подписаны на события, связанные с файлами, полезная нагрузка для этих событий содержит информацию об изменившемся ресурсе file .

Данные о ресурсах в полезной нагрузке события

При создании подписки вы можете указать, должна ли полезная нагрузка включать сведения о ресурсе или только имя ресурса. Например, если вы хотите получать события о файлах на Диске, вы можете указать, какие поля ресурса files вы хотите получать в полезной нагрузке события.

В следующей таблице приведены примеры полезных данных JSON для подписки на ресурс Диска. Идентификатор файла содержит буквы, цифры и некоторые специальные символы, структурированные как files/^[01][0-9a-zA-Z_-]+$/ . Например, files/1aaabbbAAABBB111222-_ . Для каждого события, получаемого подпиской, полезные данные отображаются в поле data события:

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
}
      

{
    "file": {
      "id": "FILE_ID"
    }
}
      

{
    "accessProposal": [
      {
        "file_id": "FILE_ID",
        "proposalId": "PROPOSAL_ID",
        "recipientEmailAddress": "63",
        "requesterEmailAddress": "application/vnd.google-apps.document",
        "requestMessage": "grant me access to this file",
        "rolesAndViews": [
          {
            "role": "writer",
            "view": "published"
          }
        ]
      }
    ]
}
      

{
    "accessProposal": [
      {
        "proposalId": "PROPOSAL_ID"
      }
    ]
}
      

{
    "accessProposal": [
      {
        "file_id": "FILE_ID",
        "proposalId": "PROPOSAL_ID",
        "recipientEmailAddress": "63",
        "requesterEmailAddress": "application/vnd.google-apps.document",
        "requestMessage": "resolve access to this file",
        "rolesAndViews": [
          {
            "role": "writer",
            "view": "published"
          }
        ]
      }
    ]
}
      

{
    "accessProposal": [
      {
        "proposalId": "PROPOSAL_ID"
      }
    ]
}
      

• Если логическое поле includeDescendants в DriveOptions имеет значение true , подписки Drive на общих дисках и папках всегда отправляют событие, даже если файл, вызвавший событие, находится на много уровней ниже папки, используемой для подписки Drive.
• Даже если вы создали подписку на папку, вы можете не получать все события в иерархии файлов, поскольку у пользователя или приложения может быть не предоставлен к ним доступ. В этом случае подписка останется активной, но вы не будете получать события для ресурсов, к которым у вас нет доступа.
• Подписки поддерживаются для событий во всех файлах и папках, за исключением событий в корневой папке общих дисков. Подписки поддерживаются только для файлов и папок внутри общих дисков. Изменения, вносимые непосредственно в корневую папку общих дисков, не приводят к возникновению событий.
• Пользователь, авторизующий подписку, должен иметь разрешение на файл, соответствующий событиям, на которые он подписывается.
• Подписка получает только события для ресурсов, к которым пользователь имеет доступ через свою учетную запись Google Workspace или учетную запись Google.

Похожие темы

• Обзор API событий Google Workspace
• Структура событий Google Workspace
• Выберите области действия API событий Google Workspace
• Выберите области действия API Google Drive