【GAS】Pythonならきちんと動いてるLINE Ads APIのHTTPリクエストをGASでも動かしたい

Question

解決したいこと

• LINE広告APIドキュメントにある、パフォーマンスレポートを作成するPOSTリクエストをGAS（Google Apps Script）で動かしたい
• サンプルコードがPythonだったので、Pythonで書いてみたところ動いたが、これをGASでとなると思ったようにいかない

開発の背景

• LINE広告のパフォーマンスレポートをスプレッドシートに自動で書き出したい
• 他にGoogle広告やYahoo!広告のデータ抽出もすでにGASで実装しているため、できればGASで書きたい

発生しているエラー

Request failed for https://ads.line.me returned code 401.
Truncated server response: {"errors":[{"reason":"Unauthorized","message":"Request digest is invalid."}]}

エラーコードをドキュメントで調べてみると、

401　The token specified in 'Authorization' header is invalid.

「Authorization ヘッダーで指定されたトークンが無効」だと言われます。

ただ、Authorization ヘッダーに渡しているtoken という変数の中身は、PythonでもGASでも一致しているんです...。ここが今一番混乱しているところです。

以下が「レスポンスが返ってくるPythonのコード」と「エラーで返ってくるGASのコード」です。
変数名も全体の構成もなるべく同じにしています。

Python

import base64
import datetime
import hashlib
import hmac
from inspect import signature
import json
import urllib.request
from datetime import datetime, timedelta

def calc_sha256_digest(content: str) -> str:
    sha256 = hashlib.new('sha256')
    sha256.update(content.encode())
    return sha256.hexdigest()

def encode_with_base64(value: bytes) -> str:
    return base64.urlsafe_b64encode(value).decode()

if __name__ == '__main__':
    # Setting parameters for your request
    today = datetime.now()
    yesterday = (today - timedelta(1)).strftime('%Y-%m-%d')
    accountId = "A00000000000"
    
    access_key = "XXXXXXXXXXXXXXXX"
    secret_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    method = "POST"
    canonical_url = "/api/v3/adaccounts/" + accountId + "/pfreports"
    url_parameters = ""
    request_body = {
        "level":"ADACCOUNT",
        "since": yesterday,
        "until": yesterday,
        "filtering":{
            "idType":"ADACCOUNT",
            "ids":[accountId]
        },
        "fileFormat":"CSV"
    }
    has_request_body = request_body is not None

    endpoint = 'https://ads.line.me' + canonical_url + url_parameters
    request_body_json = json.dumps(request_body) if has_request_body else ""
    content_type = 'application/json' if has_request_body else ""

    jws_header = encode_with_base64(
        json.dumps({
            "alg": "HS256",
            "kid": access_key,
            "typ": "text/plain"
        }).encode()
    )

    hex_digest = calc_sha256_digest(request_body_json)
    payload_date = today.strftime('%Y%m%d')
    payload = "%s\n%s\n%s\n%s" % (hex_digest, content_type, payload_date, canonical_url)
    jws_payload = encode_with_base64(payload.encode())

    signing_input = "%s.%s" % (jws_header, jws_payload)
    signature = hmac.new(
        secret_key.encode(),
        signing_input.encode(),
        hashlib.sha256
    ).digest()
    encoded_signature = encode_with_base64(signature)
    token = "%s.%s.%s" % (jws_header, jws_payload, encoded_signature)
    print(token)

    http_headers = {
        "Date": today.strftime('%a, %d %b %Y %H:%M:%S GMT'),
        "Authorization": "Bearer %s" % token
    }
    if has_request_body:
        http_headers["Content-Type"] = content_type
        req = urllib.request.Request(endpoint, data=request_body_json.encode(), headers=http_headers, method=method)
    else:
        req = urllib.request.Request(endpoint, headers=http_headers, method=method)

    with urllib.request.urlopen(req) as res:
        resp = res.read()
    print(resp.decode())

GAS

function main() {
  const today = new Date();
  const yesterday = getYesterday(new Date());
  const accountId = "A00000000000";

  const access_key = "XXXXXXXXXXXXXXXX";
  const secret_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
  const method = "POST";
  const canonical_url = `/api/v3/adaccounts/${accountId}/pfreports`;
  const url_parameters = "";
  const request_body = {
    "level":"ADACCOUNT",
    "since":yesterday,
    "until":yesterday,
    "filtering": {
      "idType": "ADACCOUNT",
      "ids": [accountId]
    },
    "fileFormat": "CSV"
  };
  const has_request_body = request_body

  const endpoint = "https://ads.line.me" + canonical_url + url_parameters;
  const request_body_json = JSON.stringify(request_body).replace(/:/g, ': ').replace(/,/g, ', ');
  const content_type = "application/json";

  const jws_header = encode_with_base64(JSON.stringify({
    "alg":"HS256",
    "kid":access_key,
    "typ":"text/plain"
  }).replace(/:/g, ': ').replace(/,/g, ', '));
  
  const hex_digest = calc_sha256_digest(request_body_json);
  const payload_date = Utilities.formatDate(today, 'JST', 'yyyyMMdd');
  const payload = `${hex_digest}\n${content_type}\n${payload_date}\n${canonical_url}`;
  const jws_payload = encode_with_base64(payload);

  const signing_input = `${jws_header}.${jws_payload}`;
  const encoded_signature = hmacSha256(secret_key, signing_input);
  const token = `${jws_header}.${jws_payload}.${encoded_signature}`;
  console.log(token);

  const http_headers = {
    "Date": Utilities.formatDate(today, 'GMT', 'E, dd MMM yyyy HH:mm:ss z'),
    "Authorization": `Bearer ${token}`,
    "Content-Type":content_type
  }
  const resp = UrlFetchApp.fetch(endpoint, {
    "data": request_body_json,
    "headers": http_headers,
    "method": method,
  });
  console.log(resp.getContentText());
}

/**
 * SHA 256でハッシュ化
 * @param {string} input - ハッシュ化する文字列
 * @return {string} - ハッシュ値
 */
function calc_sha256_digest(input) {
  const rawHash = Utilities.computeDigest(Utilities.DigestAlgorithm.SHA_256, input, Utilities.Charset.UTF_8);
  let txtHash = '';
  for (i = 0; i < rawHash.length; i++) {
    let hashVal = rawHash[i];
    if (hashVal < 0) {
      hashVal += 256;
    }
    if (hashVal.toString(16).length == 1) {
      txtHash += '0';
    }
    txtHash += hashVal.toString(16);
  }
  return txtHash
}

/**
 * base64エンコード
 * @param {string} input - エンコードしたい文字列
 * @return {string} - base64エンコードされた文字列
 */
function encode_with_base64(input) {
  return Utilities.base64Encode(input, Utilities.Charset.UTF_8)
}

/**
 * HMAC SHA 256でハッシュ化
 * @param {string} key - ハッシュ化するシークレットキー
 * @param {string} text - ハッシュ化する文字列
 * @return {string} - ハッシュ値
 */
function hmacSha256(key, text) {
  const rowHash = Utilities.computeHmacSignature(Utilities.MacAlgorithm.HMAC_SHA_256, text, key);
  return Utilities.base64Encode(rowHash);
};

/**
 * 昨日の日付を計算
 * @param {date} date - 今日の日付
 * @return {date} - 昨日の日付（YYYY-MM-DD形式）
 */
function getYesterday(date) {
  date.setDate(date.getDate() - 1);
  const yesterday = Utilities.formatDate(date, 'JMT', 'yyyy-MM-dd');
  return yesterday
}

エラーの原因っぽいところ

エラーメッセージ的にはtoken が間違っているみたいなんですが...。
Pythonでprint(tokne) とした結果と、GASでconsole.log(token) とした結果は完全に一致していました。

だとすると最後のHTTPリクエストのところなのかなと...。
Pythonだと

resp = urllib.request.Request(endpoint, data=request_body_json.encode(), headers=http_headers, method=method)

と書いていて、GASでは

const resp = UrlFetchApp.fetch(endpoint, {
    "data": request_body_json,
    "headers": http_headers,
    "method": method,
  });

と書いているのですが、このあたりは自信がないです。

「Pythonはrequest_body_json をエンコードしてるけどこれってバイト列に変えてるってこと...？GAS（JavaScript）にバイト列ってあるっけ...？これ変換しないとだめなのか...？」となっています。

Pythonに関してはかなり知識不足なところがありますが、上記誤っている箇所がお分かりになる方いらっしゃいましたら、ご教示いただけるととても勉強になります...。よろしくお願いいたします...。

補足

この「LINE Ads APIのPython→GAS変換」は以前にも当サイトで質問させていただいたことがありました。
今回と直接関係するか分かりませんが、こちらも記載させていただきます。

Pythonで書かれたLINE Ads APIのサンプルコードをGAS(JavaScript)に翻訳したい

Comments

[nonoshu]

一つずつ値をチェックしていくしかないと思います。
getYesterdayが想定している値になっているのでしょうか？
JMT　→　GMTまたはJST？
```
function getYesterday(date) {
date.setDate(date.getDate() - 1);
const yesterday = Utilities.formatDate(date, 'JMT', 'yyyy-MM-dd');
return yesterday
}
```

[退会済みユーザー]

ご返信ありがとうございます...！
タイムゾーンの指定はおっしゃる通り、JSTが正しいです...。
ただ形式に関してはドキュメントの指定通りになっていて、returnされる値も正しいこと確認できております。
https://ads.line.me/public-docs/v3/3.9.1/certificated-ad-tech-general-partner#_reportqueryparams

Answer 1

下記のように data ではなく、payload プロパティに request_body_json を指定してみてはいかがでしょうか。

  const resp = UrlFetchApp.fetch(endpoint, {
    // "data": request_body_json, // 削除
    "headers": http_headers,
    "method": method,
    "payload": request_body_json  // 追加
  });

---

python 側のコードでは、urllib.request.Request 関数の引数 data に、 「request_body_json をバイト列に変換したもの」が指定されています。

        req = urllib.request.Request(endpoint, data=request_body_json.encode(), headers=http_headers, method=method)

これによって data に指定された内容が POST リクエストされます。
（request_body_json.encode() によって文字列をバイト列に変換している理由は、urllib.request.Request 関数の data には文字列を直接渡せないからだと考えられます。）

これと同様の機能を GAS の UrlFetchApp.fetch 関数で実現させる場合、
エンドポイントに渡すデータを payload に指定します。
（もちろん、POST リクエストを行うためには method:'POST' の指定も必要です。）

なお、GAS では payload に「文字列、バイト配列、blob、JavaScript オブジェクトのいずれかを使用可能」とされていますので、ここでバイト列に変換する必要はありません。

参照：
https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#advanced-parameters

---

自分のアプリケーションがどのようなリクエストを送っているかについては httpbin.org というサイトで調べることが可能です。
https://qiita.com/sameyasu/items/adacceb8a1bee893599b

httpbin.org に対して HTTP リクエストを送ると、自分の送った内容がそのままレスポンスとして返ってきます。

たとえば本件の場合、endpoint に「https://httpbin.org/post」 を指定してみることで、POSTリクエストの内容を検証することが可能です。

Comments

[退会済みユーザー]

ご回答いただきありがとうございます...！
今回もご指摘いただいた箇所の修正で、意図した通りに動かすことできました！！
過去投稿を掘り返してコメントまでしてしまい...おかげさまでした...。

> これと同様の機能を GAS の UrlFetchApp.fetch 関数で実現させる場合、エンドポイントに渡すデータを payload に指定します。
ここがとても盲点でした。
UrlFetchApp.fetch に使うpayloadは名称を変えたりしてはいけないということですよね...。
Pythonの書き方に引きづられていました。

いつもいつもありがとうございます。とても勉強になりました。