Yahoo!広告 スクリプト | Developer Center

const SPREAD_SHEET_ID = '12345abcde'; 

const SHEET_NAME_WEATHER = '天気';

const SHEET_NAME_REPORT = 'キャンペーンレポート';

const SHEET_NAME_REPORT = '広告グループレポート';

const SHEET_NAME_REPORT = '広告レポート';

const TARGET_CAMPAIGN_ID = ['123456','234567'];

const TARGET_CAMPAIGN_ID = [];

const TARGET_ADGROUP_ID = ['1234567','2345678'];

const TARGET_ADGROUP_ID = [];

const TARGET_AREA = ["北海道", "青森県", "岩手県", "宮城県", "秋田県", "山形県", "福島県",
  "茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県", "新潟県", "富山県",
  "石川県", "福井県", "山梨県", "長野県", "岐阜県", "静岡県", "愛知県", "三重県", "滋賀県",
  "京都府", "大阪府", "兵庫県", "奈良県", "和歌山県", "鳥取県", "島根県", "岡山県", "広島県",
  "山口県", "徳島県", "香川県", "愛媛県", "高知県", "福岡県", "佐賀県", "長崎県", "熊本県",
  "大分県", "宮崎県", "鹿児島県", "沖縄県"];//47都道府県

const TARGET_AREA = ["茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県"];

/*このソースコードは MIT License のもとで提供されています。
https://ads-developers.yahoo.co.jp/ja/ads-script/post/30418913.html
■スクリプト内容
指定したエンティティ単位の昨日分のレポートと、本日の天気予報をスプレッドシートに出力します。
■利用方法
１．テンプレートスプレッドシートをお使いのGoogleアカウントにコピーしてください。
２．当スクリプトを、ディスプレイ広告のアカウントに設定してください。
３．定数を以下のように設定してください。
４．実行頻度を1日1回（時間は任意）に設定してください。
５．必要に応じて、不要な列を削除してください。
■定数
・SPREAD_SHEET_ID   //スプレットシートIDを指定
・SHEET_NAME_WEATHER//天気データを出力するシート名
・SHEET_NAME_REPORT //レポートデータを出力するシート名（実際にご覧いただくシートです）
・TARGET_CAMPAIGN_ID   //出力対象キャンペーンID。空欄の場合、全て出力します。
                        指定する際は、シングルクオーテーションで囲み、半角カンマ区切りで入力してください。
                         例）const TARGET_CAMPAIGN_ID = ['123456','234567'];
・TARGET_ADGROUP_ID   //出力対象広告グループID。空欄の場合、全て出力します。
                        指定する際は、シングルクオーテーションで囲み、半角カンマ区切りで入力してください。
                         例）const TARGET_ADGROUP_ID = ['1234567','2345678'];
・TARGET_AREA       //対象エリア（初期値は47都道府県）
・FLAG_MAIL         //結果をメール送信するならtrue、しないならfalse
・MAIL_TO           //メール送信先のYahoo! BusinessID
・MAIL_TITLE        //メールタイトル
・FLAG_SLACK        //結果をSlack送信するならtrue、しないならfalse
・URL_FETCH_APP     //SlackのWebhook URL
■制限事項
・データ量によっては、タイムアウトになることがございます。その場合、以下のどちらかでご対応ください。
  1.キャンペーンIDフィルタか、広告グループIDフィルタを指定する
    例）キャンペーンIDフィルタを追加する場合
     const TARGET_CAMPAIGN_ID = ['123456','234567'];
  2.上位のエンティティのシートを指定する
    例）「広告グループレポート」→「キャンペーンレポート」
*/
//設定が必要な定数
const SPREAD_SHEET_ID = '';
const SHEET_NAME_WEATHER = '天気';
const SHEET_NAME_REPORT = 'キャンペーンレポート';
//設定が任意の定数（初期値でお使いいただけますが、任意の値に変更も可能です）
const TARGET_CAMPAIGN_ID = [];
const TARGET_ADGROUP_ID = [];
const TARGET_AREA = ["北海道", "青森県", "岩手県", "宮城県", "秋田県", "山形県", "福島県",
  "茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県", "新潟県", "富山県",
  "石川県", "福井県", "山梨県", "長野県", "岐阜県", "静岡県", "愛知県", "三重県", "滋賀県",
  "京都府", "大阪府", "兵庫県", "奈良県", "和歌山県", "鳥取県", "島根県", "岡山県", "広島県",
  "山口県", "徳島県", "香川県", "愛媛県", "高知県", "福岡県", "佐賀県", "長崎県", "熊本県",
  "大分県", "宮崎県", "鹿児島県", "沖縄県"];//47都道府県
const FLAG_MAIL = false;
const MAIL_TO = ['Yahoo! JAPAN Business ID'];
let MAIL_TITLE = '天気・レポートデータの出力';
const FLAG_SLACK = false;
const URL_FETCH_APP = 'SLACK_WEBHOOK_URL';
//設定不要な定数（変更するとエラーになります）
let TEXT_MESSAGE_ARRAY = [];
const accountId = AdsUtilities.getCurrentAccountId();
const SS_URL = 'https://docs.google.com/spreadsheets/d/' + SPREAD_SHEET_ID;
function main() {
  try {
    const ss = validateAndGetSpreadsheet();
    outputWeather(ss);
    outputReport(ss);
    logAndMessage('スプレッドシートへのレポート・天気予報データの出力が完了しました。\n' + SS_URL);
    sendMailAndSlack();
  } catch (error) {
    MAIL_TITLE = '!!エラーが発生しました!!' + MAIL_TITLE;
    logAndMessage('エラーが発生しました！！詳細は管理画面をご確認ください。\n' + error);
    sendMailAndSlack();
    throw error;
  }
}
//天気をスプレッドシートに出力
function outputWeather(ss) {
  const sh = validateAndGetSheet(ss, SHEET_NAME_WEATHER);
  const todayStr = Utilities.formatDate(new Date(), 'Asia/Tokyo', 'yyyy-MM-dd');
  let outputData = [];
  for (let i = 0; i < TARGET_AREA.length; i++) {
    const areaName = TARGET_AREA[i];
    const weather = WeatherApp.getWeatherByName(
      areaName,
      'TODAY'
    );
    //1日単位データ
    const dayWeather = weather[0].day[0];
    //1時間単位データごとに行生成
    for (let j = 0; j < weather[0].hour.length; j++) {
      const hourWeather = weather[0].hour[j];
      outputData.push([
        todayStr + ':' + j + ':' + areaName,
        areaName,
        todayStr,
        j,
        hourWeather.weather.telop,//天気テロップ（1h）
        hourWeather.precip.value + hourWeather.precip.unit,//降水量（1h）
        hourWeather.temp,//気温
        hourWeather.probPrecip + '%',//降水確率（1h）
        hourWeather.humidity + '%',//湿度（1h）
        hourWeather.snowFall + 'cm',//降雪量（1h）
        hourWeather.windDirection.name,//風向き（1h）
        hourWeather.windSpeed.value + hourWeather.windSpeed.unit,//風速（1h）
        dayWeather.temp.min,//最低気温（1日）
        dayWeather.temp.minDiff,//最低気温前日差（1日）
        dayWeather.temp.max,//最高気温（1日）
        dayWeather.temp.maxDiff,//最高気温前日差（1日）
        dayWeather.wave,//波予報（1日）
        dayWeather.sunrise,//日の出時間（1日）
        dayWeather.sunset//日の入時間（1日）
      ]);
    }
  };
  const newRow = sh.getLastRow() + 1;
  sh.getRange('A' + newRow).setValues(outputData);
}
//レポートをスプレッドシートに出力
function outputReport(ss) {
  const sh = validateAndGetSheet(ss, SHEET_NAME_REPORT);
  const entityFields = getEntityFields(sh);
  const operand = {
    accountId: AdsUtilities.getCurrentAccountId(),
    fields: entityFields,
    reportDateRangeType: 'YESTERDAY'
  };
  // フィルタを追加
  const filters = [];
  if (TARGET_CAMPAIGN_ID.length > 0) {
    filters.push({
      field: 'CAMPAIGN_ID',
      filterOperator: 'IN',
      values: TARGET_CAMPAIGN_ID
    });
  }
  if (TARGET_ADGROUP_ID.length > 0) {
    filters.push({
      field: 'ADGROUP_ID',
      filterOperator: 'IN',
      values: TARGET_ADGROUP_ID
    });
  }
  // フィルタがある場合のみ設定
  if (filters.length > 0) {
    operand.filters = filters;
  }
  const newRow = getLastRow(sh) + 1;
  Logger.log('レポート条件：' + JSON.stringify(operand));//何かあった時用に出力しておく
  const reportData = AdsUtilities.getDisplayReport(operand).reports[0].rows;
  if (reportData.length > 0) {
    sh.getRange('A' + newRow).setValues(reportData);
  } else {
    Logger.log('レポートデータはありませんでした');
  }
}
//Range.getLastRow()がYASにはないので（Sheetならある）
function getLastRow(sh) {
  const ssAcolData = sh.getRange('A:A').getValues();
  //空白も値が入っている扱いになる
  let lastRowNo = 1;
  for (let i = 1; i < ssAcolData.length; i++) {//ヘッダは抜く
    const row = ssAcolData[i];
    if (row == '') {
      lastRowNo = i;//1つ前が値の入っている最後の行なので、-1は不要
      break;
    }
  }
  return lastRowNo;
}
//スプレッドシートデータからリクエスト用operand生成しつつ組み合わせ不可のチェック
function getEntityFields(sh) {
  const ssReportData = sh.getDataRange().getValues();
  const ssHeaderRow = ssReportData[0];//スプレッドシート側のヘッダ行を取得
  if (ssHeaderRow.length < 2) {//ヘッダが空の場合も、空文字で要素1の配列になるので
    throw new Error('スプレッドシートはテンプレートをご利用ください');
  }
  //マスタ情報取得
  const { fieldConvMap, impossibleCombiFieldMap } = getReportFieldMasterMaps();
  //スプレッドシートデータからリクエスト用operand生成しつつ組み合わせ不可のチェック
  let operandFields = [];
  for (let i = 0; i < ssHeaderRow.length; i++) {
    const ssFieldName = ssHeaderRow[i];
    if (ssFieldName == 'キー') {//キー以降は不要
      break;
    }
    if (!fieldConvMap.has(ssFieldName)) {
      throw new Error('スプレッドシートのヘッダ名は、規定のレポート項目名を指定してください:' + ssFieldName);
    }
    const convFieldName = fieldConvMap.get(ssFieldName);
    const impossibleCombiArr = impossibleCombiFieldMap.get(convFieldName);
    //組み合わせ不可チェック
    if (impossibleCombiArr != null) {
      for (let j = 0; j < impossibleCombiArr.length; j++) {
        if (operandFields.includes(impossibleCombiArr[j])) {
          throw new Error('組み合わせ不可な項目です。' + convFieldName + 'と' + impossibleCombiArr[j]);
        }
      }
    }
    //全部通ったらOK
    operandFields.push(convFieldName);
  }
  return operandFields;
}
//以下の2つのMapを生成する
//fieldConvMap...{日本語名：リクエスト用項目名を作成}
//impossibleCombiFieldMap...{日本語名：NG項目の配列}
function getReportFieldMasterMaps() {
  const reportFieldMaster = Display.ReportDefinitionService.getReportFields({
    reportType: 'AD'
  }).rval;
  let fieldConvMap = new Map();
  let impossibleCombiFieldMap = new Map();
  for (let i = 0; i < reportFieldMaster.fields.length; i++) {
    const field = reportFieldMaster.fields[i];
    fieldConvMap.set(field.displayFieldNameJa, field.fieldName);
    impossibleCombiFieldMap.set(field.fieldName, field.impossibleCombinationFields);
  }
  return { fieldConvMap: fieldConvMap, impossibleCombiFieldMap: impossibleCombiFieldMap };
}
function validateAndGetSpreadsheet() {
  if (SPREAD_SHEET_ID === 'SPREAD_SHEET_ID' || SPREAD_SHEET_ID === '') {
    throw new Error('スプレッドシートIDを設定してください。');
  }
  try {
    return SpreadsheetApp.openById(SPREAD_SHEET_ID);
  } catch (e) {
    throw new Error('スプレッドシートを開くことが出来ませんでした。スプレッドシートIDまたはスプレッドシートの権限が正しいか確認してください。' + e);
  }
}
function validateAndGetSheet(ss, sheetName) {
  if (sheetName === '') {
    throw new Error('シート名を設定してください。');
  }
  const sh = ss.getSheetByName(sheetName);
  if (sh === null) {
    throw new Error('シートが開けませんでした。シート名を確認してください。');
  }
  return sh;
}
//ログ、メールなどに流すテキスト
function logAndMessage(text) {
  Logger.log(text);
  TEXT_MESSAGE_ARRAY.push(text);
}
function sendMailAndSlack() {
  validateAndSendSlack();
  validateAndSendMail();
}
function validateAndSendSlack() {
  if (FLAG_SLACK) {
    if (URL_FETCH_APP === 'SLACK_WEBHOOK_URL' || URL_FETCH_APP === '') {
      throw new Error('SlackのWebhook URLを設定してください。Slack送信前までに実行された処理は完了しています。');
    }
    UrlFetchApp.fetch(URL_FETCH_APP, {
      method: 'post',
      contentType: 'application/json',
      payload: JSON.stringify({
        text: TEXT_MESSAGE_ARRAY.join('\n'),
      }),
    });
  }
}
function validateAndSendMail() {
  if (FLAG_MAIL) {
    if (MAIL_TO.length < 1 || !MAIL_TO.every(str => typeof str === 'string' && /^[a-zA-Z0-9]+$/.test(str))) {
      throw new Error('Yahoo! JAPANビジネスIDを設定してください。メール送信前までに実行された処理は完了しています。');
    }
    MailApp.sendEmail({
      to: MAIL_TO,
      subject: '【アカウントID：' + accountId + '】' + MAIL_TITLE,
      body: TEXT_MESSAGE_ARRAY.join('\n'),
    });
  }
}