pythonからGASに移植したい

Question

以下のpythonコードをGASに翻訳したいのですが、どのようにしたらよいでしょうか？
よろしくお願いします。
これまでもGASはそこそこ書いてきてるのですが、掲載したコードではbad requestのエラーがでます。
どこか修正できるところがあるでしょうか？
ご教示よろしくお願いいたします。

import requests

url = "http://myapi/internal/ocr/requestid/ng"

payload={}
headers = {
  'X-Authorization': 'abcdefghijklmn'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

function sending(yesorno, requestId) {  
  var requestId = "*******************"
　var STAGING_KEY = "abcdefghijklmn"

  var url = url = "http://myapi/internal/ocr/"+requestId+"/ng"

  var data = {}
  var options = {
    'muteHttpExceptions': true,
    'method': 'post',
    'payload': JSON.stringify(data),
    'headers': {
      'X-Authorization': STAGING_KEY
    }
  };

  //Error processing
  try {
    var response = JSON.parse(UrlFetchApp.fetch(url, options));
    if (response && response["id"]) {
      return 'sent';
    } else {
      //reportError("Invalid response: " + JSON.stringify(response));
      //return 'error';
      Logger.log('error')
    }    
  } catch (e) {
    //reportError(e.toString());
    //return 'error';
    Logger.log('error')
  }  
}

Comments

[1T2R3M4]

まずGASを学習しましょう。

[papinianus]

社内用の API だとしたら origin みてるんじゃないですかね。
それよりも gas にすることのメリットというか、gas にすることで解決したい課題を共有いただいたほうがよいような気がします。

[SYSYSYSYSYSY]

ご指摘ありがとうございます。スプレッドシート上でステータスを変更するとapiにpostされて、post先のステータスも変更されるというものを作ろうとしておりました。
python、curlで試すとうまくいくのですが、ＧＡＳだけ通らないので、ＧＡＳ特有の理由かコードミスと思っておりました。説明になってるといいのですが。
何かアイデアがあればよろしくお願いします。

Answer 1

GASのUrlfetchAppはリクエスト送信時に特有のUserAgentを付け加えます。

サーバーは、そのUserAgentを判別してアクセスを弾いている可能性があります。

なお、このUserAgentは変更できません。（ヘッダに任意のUser-Agentを付け加えても元のUser-Agentに上書きされます）

---

追記

どのような内容のrequestを行ったかを知りたいとき、https://httpbin.org/ というサイトを利用することができます。

今回のように、post内容を調べたい場合は、https://httpbin.org/post というエンドポイントに対してpostすると、自分がpostした内容がそのままレスポンスとして返ってきます。

質問文のpost内容を調べてみました。
調べるためのソースコードは以下です。（単純に、apiエンドポイントを "https://httpbin.org/post"に変えて、responseをダンプしているだけです）

python

import requests

url = "https://httpbin.org/post"

payload={}
headers = {
  'X-Authorization': 'abcdefghijklmn'
}

response = requests.request("POST", url, headers=headers, data=payload)


print(response.text)

GAS

function sending(yesorno, requestId) {  
  var requestId = "*******************"
　var STAGING_KEY = "abcdefghijklmn"

  // var url = url = "http://myapi/internal/ocr/"+requestId+"/ng"
  var url = "https://httpbin.org/post"
  var data = {}
  var options = {
    'muteHttpExceptions': true,
    'method': 'post',
    'payload': JSON.stringify(data),
    'headers': {
      'X-Authorization': STAGING_KEY
    }
  };

  //Error processing
  try {
    var response = JSON.parse(UrlFetchApp.fetch(url, options));
    Logger.log(JSON.stringify(response,undefined,1))
    if (response && response["id"]) {
      return 'sent';
    } else {
      //reportError("Invalid response: " + JSON.stringify(response));
      //return 'error';
      Logger.log('error')
    }    
  } catch (e) {
    //reportError(e.toString());
    //return 'error';
    Logger.log('error')
  }  
}

＜結果比較＞
pythonのレスポンス

{
  "args": {},
  "data": "",
  "files": {},
  "form": {},
  "headers": {
    "Accept": "*/*",
    "Accept-Encoding": "gzip, deflate",
    "Content-Length": "0",
    "Host": "httpbin.org",
    "User-Agent": "python-requests/2.12.4",
    "X-Amzn-Trace-Id": "Root=*-******-***************",
    "X-Authorization": "abcdefghijklmn"
  },
  "json": null,
  "origin": "***.***.***.***",
  "url": "https://httpbin.org/post"
}

GASのレスポンス

{
 "args": {},
 "data": "",
 "files": {},
+"form": {
+ "{}": ""
+},
 "headers": {
  "Accept-Encoding": "gzip, deflate, br",
+ "Content-Length": "2",
  "Content-Type": "application/x-www-form-urlencoded",
  "Host": "httpbin.org",
  "User-Agent": "Mozilla/5.0 (compatible; Google-Apps-Script; beanserver; +https://script.google.com; id: *****-********************)",
  "X-Amzn-Trace-Id": "Root=*-******-***************",
  "X-Authorization": "abcdefghijklmn"
 },
 "json": null,
+"origin": "****:****:****:****:****:****:****:****, ***.***.***.***",
 "url": "https://httpbin.org/post"
}

---

比較した結果、色付き（先頭行が+の行）が主な相違点です。
まとめると

1. form（pythonは {}だが、GASは {"{}":""}
2. Content-Length (python は0、GASは2)
3. origin　(pythonはIPv4、GASはIPv6)
4. User-Agent（前述）

となっています。

おそらく、2は1に依存しています。
もし違いが出るとするならば、formのところと推測されます。

formに関して、GASの方をpythonと同じ形にするには、下記のように、payloadを削除すればよいことがわかりました。

GAS改

function sending(yesorno, requestId) {  
  var requestId = "*******************"
　var STAGING_KEY = "abcdefghijklmn"

  // var url = url = "http://myapi/internal/ocr/"+requestId+"/ng"
  var url = "https://httpbin.org/post"
  var data = {}
  var options = {
    'muteHttpExceptions': true,
    'method': 'post',
    // 'payload': JSON.stringify(data),  //削除
    'headers': {
      'X-Authorization': STAGING_KEY
    }
  };

  //Error processing
  try {
    var response = JSON.parse(UrlFetchApp.fetch(url, options));
    Logger.log(JSON.stringify(response,undefined,1))
    if (response && response["id"]) {
      return 'sent';
    } else {
      //reportError("Invalid response: " + JSON.stringify(response));
      //return 'error';
      Logger.log('error')
    }    
  } catch (e) {
    //reportError(e.toString());
    //return 'error';
    Logger.log('error')
  }  
}

上記のように「payloadなし」で試してみてはいかがでしょうか。

Comments

[SYSYSYSYSYSY]

丁寧なご説明ありがとうございます！
カード自体には問題なさそうでしょうか？

[退会済みユーザー]

サーバーを明らかにされていませんので何とも言えません。

httpbinというサイトで、自分がどのようなリクエストをpostしたのか調べられますので、
(正常に通る)pythonのpostと(Bad Requestになる)gasのpostのどこが違うのか、確かめてみてはいかがでしょうか。

https://qiita.com/sameyasu/items/adacceb8a1bee893599b

ただし、httpbinはあくまでリクエスト内容を確認できるだけです。
サーバー依存の処理がある場合は、たとえhttpbin上で同一のpostであっても異なる挙動を示す場合が有りますので
完全ではありません。

具体的なapiエンドポイントを非公開にしている以上、誰もつっこんだ回答はできないと思います。
使いたいapiサービスのヘルプ等に問い合わせてみることをお勧めします。

[SYSYSYSYSYSY]

丁寧なご返答ありがとうございます。
社内開発したAPIを使用しており、RPAを秘密で進めているため、開発者に直接仕様をきくことができず、このような曖昧な質問になってしまいました。
ただpythonでは通るので、可能性としてまずGASのコードに間違いがないかをチェックして頂きたかったです。
もしコードに間違いがないのであれば、サーバではじかれている可能性が高いと思います。

[退会済みユーザー]

追記しました。GASについてはpayloadなしで試してみて下さい。

[SYSYSYSYSYSY]

追記ありがとうございます！
postmanで成功する場合のContent-Lengthが0だったため、payloadを削除して試してみましたが、やはりエラーが出てしまいます。前述いただいた通り、UserAgentの問題でしょうか？？
色々試していただいて、本当にありがとうございます！！

[退会済みユーザー]

ご記載の通り、おそらくUserAgentの問題である可能性が高いと思います。

[SYSYSYSYSYSY]

そうですね、色々教えていただき、本当に勉強になりました！
今一度、ありがとうございます！！