GCal events_list(): return all events, not just first 250 #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Google Calendar API v3 limits the number of events returned by the "Events: list" endpoint to 250 by default, and API::Google::GCal provides no means of overriding this behaviour. This commit makes two changes to API::Google::GCal's events_list() method so that it returns all events in the requested calendar: * Iterate over all pages of the event result list by using the nextPageToken property in each API response as the value of the pageToken parameter in the next API request. * Set the maxResults query parameter to its maximum permitted value under the v3 API (2500), to minimise the number of API requests that must be made to iterate over all of the result pages.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Google Calendar API v3 limits the number of events returned by the "Events: list" endpoint to 250 by default, and API::Google::GCal provides no means of overriding this behaviour. This commit makes two changes to API::Google::GCal's
events_list()method so that it returns all events in the requested calendar:nextPageTokenproperty in each API response as the value of the pageToken parameter in the next API request.maxResultsquery parameter to its maximum permitted value under the v3 API (2500), to minimise the number of API requests that must be made to iterate over all of the result pages.