Microsoft 365 OneDrive for Business: ファイル / フォルダ削除 (Microsoft 365 OneDrive for Business: Delete File / Folder)
OneDrive 上のファイル / フォルダを削除します。一度に複数の削除が可能です。複数削除する場合、データ項目では1行につき1つずつ URL を書くようにしてください。
2020-07-02 (C) Questetra, Inc. (MIT License)
Configs
  • C1: OAuth2 設定名 *
  • C2: 削除するファイル / フォルダの URL が保存されている文字型データ項目 *
Script
// OAuth2 config sample at [OAuth 2.0 Setting]
// - Authorization Endpoint URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
// - Token Endpoint URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
// - Scope: https://graph.microsoft.com/Files.ReadWrite.All offline_access
// - Consumer Key: (Get by Microsoft Azure Active Directory)
// - Consumer Secret: (Get by Microsoft Azure Active Directory)

const GRAPH_URI = "https://graph.microsoft.com/v1.0/";

main();
function main(){
  //// == 工程コンフィグの参照 / Config Retrieving ==
  const oauth2 = configs.get("conf_OAuth2");
  const urlsDef = configs.getObject("conf_urls");

  //// == ワークフローデータの参照 / Data Retrieving ==
  const urlArray = retrieveUrlArray(urlsDef);

  //// == 演算 / Calculating ==
  checkHttpRequestingLimit(urlArray);
  const token = httpClient.getOAuth2Token(oauth2);
  deleteItems( urlArray, token );
}

/**
  * ワークフローデータから URL の配列を読み出す
  * @param {ProcessDataDefinitionView} urlsDef  データ項目の ProcessDataDefinitionView
  * @return {Array<String>} urlArray  URL の配列
  */
function retrieveUrlArray( urlsDef ) {
  const urls = engine.findData(urlsDef);
  if (urls === "" || urls === null) {
    throw "File / Folder URLs aren't set.";
  }
  let urlArray = urls.split("\n");
  urlArray = urlArray.filter(url => url !== ""); // 空文字列を削除
  if (urlArray.length === 0) {
    throw "File / Folder URLs aren't set.";
  }
  return urlArray;
}

/**
  * HTTPリクエストの上限を超えないか確認する
  * @param {Array<String>} urlArray  URL の配列
  */
function checkHttpRequestingLimit( urlArray ) {
  if ( urlArray.length * 2 > httpClient.getRequestingLimit() ){
    throw "Necessary HTTP requests exceeds the limit.";
  }
}

/**
  * ドライブアイテム(ファイル/フォルダ)を削除する。
  * @param {Array<String>} urlArray  ドライブアイテムの URL の配列
  * @param {String} token  OAuth2 トークン
  */
function deleteItems( urlArray, token ) {
  const itemNum = urlArray.length;
  engine.log(`Deleting ${itemNum} items.\n======\n`);
  for (let i = 0; i < itemNum; i++){
    engine.log(`${i+1}: ${urlArray[i]}`);
    const itemInfo = getItemInfoByUrl(urlArray[i],token);
    deleteItem(itemInfo,token);
  }
  engine.log(`======\nSuccessfully deleted ${itemNum} items.\n`);
}

/**
  * ドライブアイテム(ファイル/フォルダ)の URL からアイテム情報(ドライブIDとアイテムID)を取得し、
  * オブジェクトで返す
  * @param {String} driveItemUrl  ドライブアイテムの URL
  * @param {String} token  OAuth2 トークン
  * @return {Object} itemInfo  ドライブアイテム情報 {driveId, id}
  */
function getItemInfoByUrl( driveItemUrl, token ) {
  // 分割代入
  const {
    id,
    parentReference: {
      driveId
    }
  } = getObjBySharingUrl( driveItemUrl, token ); // driveItemUrlが不正ならここでエラー
  const itemInfo = {driveId, id};
  return itemInfo;
}

/**
  * OneDriveのドライブアイテム(ファイル/フォルダ)のメタデータを取得し、JSONオブジェクトを返す
  * APIの仕様:https://docs.microsoft.com/ja-jp/onedrive/developer/rest-api/api/shares_get?view=odsp-graph-online
  * @param {String} sharingUrl  ファイルの共有URL
  * @param {String} token  OAuth2 トークン
  * @return {Object} responseObj  ドライブアイテムのメタデータのJSONオブジェクト
  */
function getObjBySharingUrl( sharingUrl, token ) {
  if (sharingUrl === "" || sharingUrl === null) {
    throw `Sharing URL is empty.`;
  }

  // encoding sharing URL
  const encodedSharingUrl = encodeSharingUrl(sharingUrl);

  // preparing for API Request
  let apiRequest = httpClient.begin(); // HttpRequestWrapper
  // com.questetra.bpms.core.event.scripttask.HttpClientWrapper
  // Request HEADER (OAuth2 Token, HTTP Basic Auth, etc)
  apiRequest = apiRequest.bearer( token );
  // Access to the API (POST, GET, PUT, etc)
  let response = apiRequest.get( `${GRAPH_URI}shares/${encodedSharingUrl}/driveItem` ); // HttpResponseWrapper
  const httpStatus = response.getStatusCode();
  if (httpStatus >= 300) {
    const accessLog = `---GET request--- ${httpStatus}\n${response.getResponseAsString()}\n`;
    engine.log(accessLog);
    const error = `Failed to get drive item. status: ${httpStatus}`;
    throw error;
  }
  const responseObj = JSON.parse( response.getResponseAsString() );
  return responseObj;
}

/**
  * 共有URLをunpadded base64url 形式にエンコードする
  * @param {String} sharingUrl  共有URL
  * @return {String} encodedSharingUrl  エンコードされた共有URL
  */
function encodeSharingUrl( sharingUrl ) {
  let encodedSharingUrl = base64.encodeToUrlSafeString( sharingUrl );
  while ( encodedSharingUrl.slice(-1) === '=' ) {
    encodedSharingUrl = encodedSharingUrl.slice(0,-1);
  }
  encodedSharingUrl = "u!" + encodedSharingUrl;
  return encodedSharingUrl;
}

/**
  * ドライブアイテム(ファイル/フォルダ)を削除する。
  * @param {String,String} driveId,id  ドライブアイテムのドライブID、アイテムID
  * @param {String} token  OAuth2 トークン
  */
function deleteItem( {
  driveId,
  id
}, token ){
  const apiUrl = `${GRAPH_URI}drives/${driveId}/items/${id}`;
  let response = httpClient.begin()
    .bearer(token)
    .delete(apiUrl);

  const responseJson = response.getResponseAsString();
  const status = response.getStatusCode();
  if (status >= 300) {
    //when error thrown
    const accessLog = `---DELETE request--- ${status}\n${responseJson}\n`;
    engine.log(accessLog);
    throw `Failed to delete. status: ${status}`;
  }
  engine.log("Deleted.\n");
}

Download

Capture

Notes

  1. Microsoft 365 の OneDrive for Business で使用できるアドオンです。個人用の OneDrive では使用できません。
  2. ファイルやフォルダの URL は、OneDrive でファイルやフォルダの詳細ウィンドウ(右上のiのアイコン)から「その他の詳細」へ進み、「パス」の隣のアイコンから取得します。(上部メニューの「共有」や「リンクのコピー」から取得した URL も使用できます)
    ファイル、フォルダURLの取得方法
%d人のブロガーが「いいね」をつけました。