GASでのでの外部API実行実行

Question

実現したいこと

＊マインクラフトサーバーです。

• Google Apps Scriptで外部のAPIを実行したい
• Agamesというマイクラサーバーの管理をしたい(pterodactyl)

前提

Google Apps Scriptでpterodactyl製のサーバー管理システムを管理したい
具体的に、

• LINE上でサーバー上のファイルを削除したい

用途

1. LINE上で指定フォルダ("worlds")を削除
2. 自動で再起動してワールドを一から作り直す

発生している問題・エラーメッセージ

GAS上では実行完了となっていますが実際にファイルを削除できていません。

///

該当のソースコード

function myFunction() {
  const Uli = "https://p2.agames.jp/api/client/";
 //サポートより教えていただきました。

  const options =
   {
     "headers" : {
       "Accept" : "application/json",
       "Content-Type" : "application/json",
       "Authorization" : apikey
       },
     "body" :{
         "root": "/home",
         "files": [
               "worlds"
  ]
}
    };
   UrlFetchApp.fetch(Uli, options);
}

試したこと

bodyの中の"files"を"folders"に変えたりしました。
公式のドキュメントの見方が難しくてよくわかりませんでした。

補足情報（FW/ツールのバージョンなど）

【Minecraft】
Bed Rock版
【使用サーバー】
Agamesさん
【ドキュメント】
pterodactyl［公式サイト］
pterodactyl [APIドキュメント]

Comments

[YAmaGNZ]

UrlFetchApp.fetchの戻り値は確認されましたか？

[s.20]

何も出なくて"完了"で終わってしまってます

[YAmaGNZ]

UrlFetchApp.fetch
と戻り値を取得していないので、取得して中身を確認してみましょう。
その中に404とかHTTPのステータスコードとかが入っています。

[s.20]

どうしたら取得できますか
教えて欲しいです。

また、エラーが起きた時は404や401などのHTTPステータスは表示されていました

[YAmaGNZ]

「UrlFetchApp.fetch　戻り値」とでも検索すればいろいろ出てきます。

[s.20]

{ toString: [Function],
getResponseCode: [Function],
getContent: [Function],
getContentText: [Function],
getHeaders: [Function],
getAllHeaders: [Function],
getBlob: [Function],
getAs: [Function] }

このように帰ってきました

[YAmaGNZ]

getResponseCodeやgetContentTextを使ってAPIを呼び出した結果何が返ってきたのか確認してみてください。

またAPIのドキュメントに
POST [ /delete] Delete file
https://pterodactyl.file.properties/api/client/servers/1a7ce997/files/delete
Deletes the specified file(s) or folder(s)

Headers
Accept
application/json
Content-Type
application/json
Authorization
Bearer apikey
とPOSTするようにありますので、それに合わせてoptionを指定してみてください。

私もこのAPIは使用したことがありませんので、このAPI特有の詳しい話はわかりません。

Answer 1

私はこのAPIを試せる環境にないのでAPIドキュメントを見てのあくまで予想での回答になります。

多分ですが手順としては以下のような手順になるのではないかと思います。

１．サーバーの情報を取得する

「https://p2.agames.jp/api/client/ 」をGETで呼び出してサーバーのID（？）を取得する。
ドキュメントによるとhttps://p2.agames.jp/api/client/ にてサーバーのリスト情報を取得できます。
それは下記のようにJSONで返ってきます。

{
"object": "list",
"data": [
{
"object": "server",
"attributes": {
"server_owner": true,
"identifier": "1a7ce997",
"uuid": "1a7ce997-259b-452e-8b4e-cecc464142ca",
"name": "Gaming",
"node": "Test",
"sftp_details": {
"ip": "pterodactyl.file.properties",
"port": 2022
},
"description": "Matt from Wii Sports",
"limits": {
以下省略

この中の
"identifier": "1a7ce997"
の部分の1a7ce997を取得する。
複数のサーバーがある場合はdataの中にサーバーの情報が複数返ってくると思われます。

コードは下記のような感じになると思います。（実行していないので動作するかは保証しません）

  headers = {
    "Accept" : "application/json",
    "Authorization" : 'Bearer '+ apikey
  };

  options = {
    "headers": headers
  };

  let response = UrlFetchApp.fetch('https://p2.agames.jp/api/client/', options);
  
  let data = JSON.parse(response.getContentText());
  // この後identifierの部分の情報を取り出す
  Logger.log(data.data[0].attributes.identifier);

２． ファイル削除のAPIを呼ぶ

「https://p2.agames.jp/api/client/servers/1a7ce997/files/delete 」をPOSTで呼び出す。
1a7ce997の部分は１で取得した情報

コード例は以下の通り（実行していないので動作するかは保証しません）

  let serverid = '１で取得したID';
  let uri = `https://p2.agames.jp/api/client/servers/${serverid}/files/delete`

  headers = {
    "Accept" : "application/json",
    "Content-Type" : "application/json",
    "Authorization" : 'Bearer '+ apikey
  };

  body = {
    "root": "/home",
    "files": [
      "worlds"
    ]
  };

  options = {
    "headers": headers,
    "method" : 'post',
    "payload" : JSON.stringify(body)
  };

  let response = UrlFetchApp.fetch(uri, options);

多分サーバーのIDが分かってしまえば１は毎回実行しなくてもいいのではないかと思います。

貴方の環境がどのようなものか分かりませんので、１の手順で取得したIDが間違えていて２で重要なファイルを削除するようなことになる可能性もありますのでテストは慎重に行ってください。

Comments

[s.20]

回答ありがとうございます。
実行はできましたが、
{ toString: [Function],
getResponseCode: [Function],
getContent: [Function],
getAllHeaders: [Function],
getContentText: [Function],
getHeaders: [Function],
getAs: [Function],
getBlob: [Function] }

と帰ってきて、実際にファイルの削除ができません。。
どうしたらいいのでしょうか

[YAmaGNZ]

どのようなコードで何を実行したのか知りませんが、質問へのコメントでも書いたようにgetResponseCodeやgetContentTextを使ってどのようなコードが返ってきているのかを確認してください。

[s.20]

返信ありがとうございます。
getResponseCodeなどを使用しても、204ステータスで、
{ toString: [Function], getResponseCode: [Function], getContent: [Function], getAllHeaders: [Function], getContentText: [Function], getHeaders: [Function], getAs: [Function], getBlob: [Function] }
としか返ってきません。

[YAmaGNZ]

私の回答での１の手順でIDが取得でき、２の手順を実行したときに204が返ってくるということですか？
もしそうなのだとすれば、APIの呼び出し自体は正常に行われているのではないかと思います。

ただ、消すべきファイルが存在しない場合などどのようなリターンとなるかドキュメントに記載がないので消すべきフォルダのパスが合っているのかなど確認してみてください。

私が分かるのは「こうやればAPIが呼び出せると思う」というレベルでAPIを呼んだときの動作などについては分かりません。