Is it necessary to update the Drive API to support WorkplaceSearch?

I am using WorkplaceSearch to be able to search for documents in GoogleDrive.

The other day, Google announced a security update to the Drive API, and it seems that Google Drive's file resourcekey will be given.

Will this have any impact on WorkplaceSearch?

In particular, we do not need to maintain WorkplaceSearch, and we hope that it will work with Google's new rules, but please let us know if there are things that we need to adjust in advance.

Attached below is an email I received from Google.

Hello Google Drive Developer,

We have identified you as a Developer who has used the Drive API in the last 30 days. We are writing to let you know that on September 13, 2021, Drive will apply a security update that will change the links used to share some files, and may lead to some new file access requests. Access to files won’t change for people who have already viewed or modified these files.

Please update your code as detailed below before September 13, 2021, to avoid failing requests.

What do I need to know?
Items that have a Drive API permission with type=domain or type=anyone, where withLink=true (v2) or allowFileDiscovery=false (v3), will be affected by this security update.

In addition to the item ID, your application may now also need a resource key to access these items. Without a resource key, requests for these items may result in a 404 Not Found error (See below for details). Note that access to items that are directly shared with the user or group are not affected.

Will this change affect me?
If your application uses the Drive API to access files which have been shared with a user through link sharing, your application may be affected by this change.

What do I need to do?
To avoid errors accessing files, you must update your code for accessing files to include the appropriate resource keys. Details on how to do this for each of the affected Drive APIs is included below:

Changes to the Drive API
The resource key of an item is returned on the resourceKey field of the file metadata in the Drive API response.

If the file is a shortcut file, then the resource key for the target of the shortcut can be read from the shortcutDetails.targetResourceKey field of the same resource.
URL type fields such as exportLinks, webContentLink, and webViewLink will include the resourceKey.
Requests to the Drive API can specify one or more resource keys with the X-Goog-Drive-Resource-Keys HTTP request header.
Learn more about this change from the Drive API guide.

Changes to Apps Script
The DriveApp from Apps Script has been updated to return the resource key of a file or folder with the getResourceKey method.

Note: When fetching a file or folder, the resource key can be specified on the getFileByIdAndResourceKey or getFolderByIdAndResourceKey methods.
Changes to Drive UI Integrations
If your application is integrated with the Drive UI to create or open items, it will receive resource keys when your application is invoked from the Drive UI.

The state information for a New URL will contain folderResourceKey, which is the resource key of the folder where the new item should be created.
The state for an Open URL will contain a mapping of file ID to resource key in the resourceKeys field.
Learn more about integrating with the Drive UI on our website.

Which projects may be affected?
Your projects that have used the Drive API in the last 30 days and may be affected by this change are below:

WorkplaceSearchProject (rising-amp-315702)
To get help with these changes, see the Drive API support options on our website.

Thanks for choosing Drive API.


The Google Drive Team

Hello @its-ogawa , thank you for your question! Yes indeed, Google posted that notice a while ago, and we have investigated it to determine whether it would lead to any issues in Workplace Search. Short answer: it should not. Everything should be working as normal after this change. But if you notice something that's not working, please feel free to post an issue here.

Hope that helps!

1 Like

Hello @maryna.cherniavska,

Thank you for doing the research beforehand.
I am relieved to hear that.

If there are any problems after Google's changes are made, I will consult with you again.