YahooAPIのv12への対応

Question

実現したいこと

YahooAPIのv12への対応

質問内容

こちらにて今後はリクエストヘッダーにx-z-base-account-idの指定が必須と記載があります。
またそれはBaseAccountServiceで取得可能と記載があるのですが、方法が分からないので教えていただきたいです。
下記の様に記述したのですがBad requestとなったため質問いたしました。

試したソースコード①

function check() {
  var access_token = 'something';

  var params = {
    method: 'post',
    contentType: 'application/json',
    headers: {
      'Authorization': 'Bearer ' + access_token
    },
    muteHttpExceptions: true
  }

  var response = UrlFetchApp.fetch("https://ads-search.yahooapis.jp/api/v12/BaseAccountService/get", params);

  Logger.log('getHeaders(): ' + response.getHeaders());
  Logger.log('getResponseCode(): ' + response.getResponseCode());
  Logger.log('getContentText(): ' + response.getContentText());
}

ログ①

getHeaders(): {"Transfer-Encoding":"chunked","x-yahoo-ads-rid":"50577f5cbb1b1541ff25c0df4ac900a1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Date":"Wed, 20 Sep 2023 06:55:57 GMT","Content-Type":"application/json;charset=UTF-8","X-Frame-Options":"SAMEORIGIN","x-vcap-request-id":"c4916d79-ea22-44e4-74fc-84bab8d34898","Connection":"keep-alive","Vary":"Access-Control-Request-Headers"}

getResponseCode(): 400

getContentText(): {"rid":"dd1fa4ef4f6af9dabace8cc3ce471056","errors":[{"code":"0005","message":"Bad request.","details":[]}]}

試したソースコード②

function check() {

  var CLIENT_ID = 'something';
  var CLIENT_SECRET = 'something';
  var access_token = 'something';

  var payload = {
    client_id: CLIENT_ID,
    client_secret: CLIENT_SECRET
  };

  var params = {
    method : 'post',
    contentType: 'application/json',
    headers: {
      'Authorization': 'Bearer ' + access_token
    },
    payload: JSON.stringify(payload),
    muteHttpExceptions: true
  };
  var response = UrlFetchApp.fetch("https://ads-search.yahooapis.jp/api/v12/BaseAccountService/get", params);

  Logger.log('getHeaders(): ' + JSON.stringify(response.getHeaders()));
  Logger.log('getResponseCode(): ' + response.getResponseCode());
  Logger.log('getContentText(): ' + response.getContentText());
}

ログ②

getHeaders(): {"X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","x-vcap-request-id":"52eae2bc-dc0d-4242-6470-2ae6d0934bcf","Content-Type":"application/json;charset=UTF-8","Vary":"Access-Control-Request-Headers","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Wed, 20 Sep 2023 08:15:16 GMT","X-XSS-Protection":"1; mode=block","x-yahoo-ads-rid":"8309ff0dcc59fc23e593e705d468b982"}

getResponseCode(): 400

getContentText(): {"rid":"8309ff0dcc59fc23e593e705d468b982","errors":[{"code":"0005","message":"Bad request.","details":[]}]}

解決

function check() {

  var access_token = 'something';

  var payload = {
    "accountIds": []
  };

  var params = {
    method : 'post',
    contentType: 'application/json',
    headers: {
      'Authorization': 'Bearer ' + access_token
    },
    payload: JSON.stringify(payload),
    muteHttpExceptions: true
  };

  var response = UrlFetchApp.fetch("https://ads-search.yahooapis.jp/api/v12/BaseAccountService/get", params);

  var accountId = JSON.parse(response)["rval"]["values"][0]["account"]["accountId"];

  Logger.log('accountId: ' + accountId);
}

Comments

[jimbe]

タグにある java は関係ありますか？

[quwant]

すみません、Javaは関係ありませんのでタグを削除いたしました。
お指摘いただきありがとうございます。

Answer 1

リファレンスページを見る限り、リクエストメソッドはgetではなくてpostの様です。

リファレンスを読む限り、リクエストボディが必須ではなさそうな記述はしますが、 '{}' といった空オブジェクトを送信するなど試してみてください。
パラメータを何らか設定するのであれば accountIds[] など、定義されているパラメータを送信してください。

リファレンスは下記になります。
https://ads-developers.yahoo.co.jp/reference/ads-search-api/v12/BaseAccountService/get/

Comments

[quwant]

ご回答ありがとうございます。
下記コードに修正して実行したのですが取得できませんでした。。。

```
function check() {

var access_token = 'something';

var params = {
method: 'post',
contentType: 'application/json',
headers: {
'Authorization': 'Bearer ' + access_token
},
muteHttpExceptions: true
}

var response = UrlFetchApp.fetch("https://ads-search.yahooapis.jp/api/v12/BaseAccountService/get", params);
var response_body = JSON.parse(response.getContentText());
Logger.log(response_body);
}
```

```エラー
{rid=f0cdb3c2c6b203d65cbea9c06e480e4f, errors=[{message=Bad request., details=[], code=0005}]}
```

[Eggpan]

エラーコードやレスポンスも変わりませんでしたか？
response.getHeaders()
response.getResponseCode()
などでレスポンスのヘッダやステータスを取得できますので、body以外にこれらも合わせて質問欄に起きていることを追記いただければ、より良い回答がつくかもしれません。

[quwant]

postにしたことで今まで「code: 0001, message: Invalid Request」だったものが「code: 0005, message: Bad request」に変化しました。
また、ご指摘のあったbody以外の情報も出力するようにコードを修正しました。

[Eggpan]

ヘッダがobjectのようなので、これは JSON.stringify() にかければ文字列として表示出来ると思います。
あとはそうですね、リクエストボディが未指定のようなので、
payload : "{}",
を headers の中に追加してみる、とかでしょうか。
Bad requestはリクエストの内容が正しくない場合に帰ってくるコードですが、詳細がないのでちょっとわからないですね・・

[quwant]

JSON.stringify()を使用したことでヘッダ内容が確認できました。質問内容を修正しております。

「payload : "{}",を headers の中に追加してみる」というのは下記のような形式になる認識で合ってますでしょうか？

```
var params = {
method: 'post',
contentType: 'application/json',
headers: {
payload : "{
aaa: bbb,
ccc: ddd
}",
'Authorization': 'Bearer ' + access_token
},
muteHttpExceptions: true
}
```

[Eggpan]

payloadはヘッダではないので、この場合だとparams.payloadにセットします。
また、例として上げてもらった内容のpayloadはjsonとして正しく無いです。内容をセットするならオブジェクトをJSON.stringifyで変換したほうが良いです。

[quwant]

payloadを追加したのですが変わらずBad requestでした。
質問内容に追記してあります。

おそらく、paramやpayloadに不足があるのかなと考えているのですが、何が必要かという記載はどこかにあるものでしょうか。リファレンスに記載があるとかですか。

[quwant]

payloadにaccountIds[]を指定したら取得することができました！
パラメータが省略可能なのではなく、指定値が省略可能という意味だったんですね。
色々とご教授いただきありがとうございました！

[Eggpan]

解決されたようで良かったです。
リファレンスページを読む限り、accountIdsを含む全部のキーは必須ではない（任意）の様に思えましたが、payload完全に無しがだめなのかな？と思い、 '{}' ではどうかと記載していました。