使用nextpagetoken提取超过500个结果的Google Apps脚本查询

时间:2015-12-22 14:58:33

标签: javascript google-apps-script google-admin-sdk

在对this post的有用回复中,我了解到我可以同时从我的域目录中提取最多500个用户结果。现在我试图让脚本继续运行并拉出500个批次,直到它从域中(或者在这种情况下,OU)中拉出所有用户并将它们全部添加到同一个电子表格中。

现在我的代码看起来像这样:

function writeToSpreadsheet(){
  var values = [];
  var users = AdminDirectory.Users.list({
    domain:'klht.org',
    maxResults: 500,
    query: "orgUnitPath=/CleverTeachers/King"
  }).users; 
  for (var i=0; i<users.length; i++){
    values.push([users[i].name.fullName, users[i].primaryEmail]);   
  }
  var spreadsheetID = '1JLDD2wm0_udmTn9ZHvdKhL_Ok3SvKYFqkBeiA1GdnYc';
  SpreadsheetApp.openById(spreadsheetID).getSheets()[0].getRange(1, 1, values.length, values[0].length).setValues(values);
}

我上一篇文章中的评论者表示“返回的对象的一部分将是'nextPageToken',您可以将其添加到后续查询或查询中,直到您拥有所有用户为止。”他包括以下片段:

var usersPage2 = AdminDirectory.Users.list({
                                      domain: 'klht.org',
                                      maxResults: 500,
                                      query: "orgUnitPath=/OU",
                                      pageToken: nextPageToken
                                      }).users;

我发现只需在上面的代码下面添加它就会抛出“ReferenceError:”nextPageToken“未定义。(第13行,文件”Code“)”。现在我又被卡住了。你能帮我做这个吗?

1 个答案:

答案 0 :(得分:3)

我在上一个答案中提到的nextPageToken是第一个查询结果的属性。

为了最好地处理您示例中未确定的最大用户数,您最好通过将查询包装到while循环中的AdminSDK来完成此操作,该循环会在没有其他用户可以找到时立即终止:

function writeToSpreadsheet(){
  var values = [],
      users = [],
      userListQuery = {},
      nextPageToken = '',
      listObject = {
          domain:'klht.org',
          maxResults: 500,
          query: "orgUnitPath=/CleverTeachers/King"
      },
      i = 0,
      spreadsheetID = '1JLDD2wm0_udmTn9ZHvdKhL_Ok3SvKYFqkBeiA1GdnYc';

  do {

    if (nextPageToken && nextPageToken !== '') {
      listObject.pageToken = nextPageToken;
    }  

    userListQuery = AdminDirectory.Users.list(listObject);

    // if there are more users than fit in the query a nextPageToken is returned
    nextPageToken = userListQuery.nextPageToken;

    // Add the query results to the users array
    users = users.concat(userListQuery.users);

  } while (nextPageToken);

  for (i = 0; i < users.length; i += 1) {
    values.push([users[i].name.fullName, users[i].primaryEmail]);   
  }

  SpreadsheetApp.openById(spreadsheetID).getSheets()[0].getRange(1, 1, values.length, values[0].length).setValues(values);
}