Docs: Drive pagination code is incorrect

API v3 https://developers.google.com/drive/api/v3/reference/files/list

Looking at the List documentation (Node at the very least), there is a lot of information that is left out which is fundamental to making paginated requests:

• The pagination parameter is called nextPageToken, not pageToken as it lists. Even my linter tells me that what I’ve written is incorrect, but if I ignore the lint error and submit the request, it works. When using the ‘linter-correct’ version, the request fails.
• It appears you must include the same ‘q’ parameter in your request as well
• You must include fields: 'nextPageToken,files(id, name)' in the request, even though not including it returns a nextPageToken, it appears to be invalid

[fhinkel]

@TaylorDale Thanks for the bug report. Looks like a duplicate to https://github.com/googleapis/google-api-nodejs-client/issues/1885

[TaylorDale]

Your implementation is dependant on your use case but if you wanted to pull all of the data when there is pagination you can do something like the following:

const generateRequest = (nextPageToken: string) => drive.files.list({ q: "", nextPageToken, pageSize: 10, fields: 'nextPageToken, files(id, name)' });

const data = [];
let token = undefined;

do {
  const req = generateRequest(token);
  const resp = await req.execute();

  data.push(data.files);
  token = data.nextPageToken;
} while (token)

This assumes that nextPageToken is undefined when pagination is finished, which may not be the case with Google APIs, there may be another field that indicates this is the last page of data so deal with it accordingly.

Please note though that is more psuedocode, you’ll need to use the correct Google API methods and more robust error checking is probably needed, but that would be how you’d deal with pagination and have all the data in the data variable.

You might have better luck with further help on Stack Overflow seeing as this isn’t related to the actual bug in the docs 😃