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

/*
■スクリプト内容
スプレッドシートで指定した単語を含む名称のものを、指定開始日時に開始時配信状態にし、指定終了日時に終了配信状態にします。
■利用方法
１．当スクリプトを、検索広告またはディスプレイ広告のスクリプトとしてください。
２．各定数を以下のように設定してください。
■定数
・SPREAD_SHEET_ID：スプレッドシートID
・SHEET_NAME：スプレッドシート名
・TEST_EXECUTION：テスト実行時はtrue、本番実行時はfalse
・ENTITY_TYPE：実行するエンティティを設定。キャンペーン：CAMPAIGN、広告グループ：ADGROUP、広告：AD
・MATCH_TYPE：名称の検索方法を設定。完全一致：EXACT　部分一致：BROAD
*/
//設定が必要な定数
const SPREAD_SHEET_ID = 'SPREAD_SHEET_ID';
const SHEET_NAME = 'SHEET_NAME'
const TEST_EXECUTION = true; // テスト実行：true  本番実行：false
const ENTITY_TYPE = 'AD'; // CAMPAIGN ADGROUP AD
const MATCH_TYPE = 'BROAD'; //  完全一致：EXACT　部分一致：BROAD
const FLAG_SLACK = false;
const URL_FETCH_APP = 'SLACK_WEBHOOK_URL';
const FLAG_MAIL = true;
const MAIL_TO = ['Yahoo! JAPAN Business ID'];
const MAIL_TITLE = '配信設定オンオフスクリプト';
//設定が不要な定数（変更すると動かなくなります）
let PRODUCT_OBJ;
let MAX_NUMBER = 10000;
let TEXT_MESSAGE = '';
const accountId = AdsUtilities.getCurrentAccountId();
function main() {
  initServiceSetting();
  const sheetData = getSheetData();
  const operand =getSetOperand(sheetData);
  if(TEST_EXECUTION){
    Logger.log('テストモードで実行します');
    switchStatusText(operand);
  } else {
    switchStatus(operand);
  }
  validateAndSendMail();
  validateAndSendSlack();
}
function getSheetData(){
  const ss = validateAndGetSpreadsheet();
  const sh = validateAndGetSheet(ss);
  //スプレットシート情報を取得する
  let dataArray = sh.getDataRange().getValues();
  //もし2行以上の記載がなければ
  if (dataArray.length < 2) {
    throw new Error(SHEET_NAME + 'シートにオンオフの条件を記載してください');
  }
  const toDay = new Date(Utilities.formatDate(new Date(), 'Asia/Tokyo', 'yyyy/MM/d H:00'));
  let sheetData = {
    'ACTIVE': [],
    'PAUSED': [],
  };
  for (let i = 1; i < dataArray.length; i++) {
    const row = createRowData(dataArray[i], toDay, i);
    if( row != null ){
      sheetData[row.targetStatus].push(row);
      Logger.log(i + '行目 名称:' +  row.targetName + ' 配信設定:' + ((row.targetStatus == 'ACTIVE') ? 'オン': 'オフ'));
    }
  }
  return sheetData;
}
function createRowData(dataRow, toDay, index){
  const targetName = dataRow[0];
  const campaignId = getNumber(dataRow[7]);
  const adGroupId = getNumber(dataRow[8]);
  if (targetName == '') return null;
  //開始日時と設定のチェック
  const startStatus = createSepRowData(dataRow[1], dataRow[2], dataRow[3], toDay, index);
  // 終了日時と設定をチェック
  const endStatus = createSepRowData(dataRow[4], dataRow[5], dataRow[6], toDay, index);
  // 有効な設定を反映
  const targetStatus = ( endStatus != null) ? endStatus : startStatus;
  return (targetStatus != null) ? {
    targetName: targetName,
    targetStatus: targetStatus,
    campaignId: campaignId,
    adGroupId: adGroupId,
  } : null;
}
function getNumber(value) {
  if (value == '' || isNaN(value)) {
    return '';
  }
  return Number(value);
}
function createSepRowData(date, time, status, toDay, index){
  if( date == '' && time == '' && status == '' ) return null;
  const targetStatus = isStatus(status, index);
  return isSameDate(toDay, date, time) ? targetStatus : null;
}
function isSameDate(toDay, date, time){
  const targetDate = new Date( date + ' ' + time );
  if(isNaN(targetDate.getDate())){
    throw new Error('日付の形式に間違いがあります。入力例 2024/04/01 12:00　実際に入力された値：' + date + ' ' + time);
  }
  return ( toDay.getFullYear() === targetDate.getFullYear() &&
      toDay.getMonth() === targetDate.getMonth() &&
      toDay.getDate() === targetDate.getDate() &&
      toDay.getHours() === targetDate.getHours() );
}
function getSetOperand(sheetData) {
  let operands = [];
  let num = 0;
  while (true) {
    const entitys = getDataFromGetService(num);
    for (let i = 0; i < entitys.values.length; i++) {
      const operand = getOperand(entitys.values[i]);
      if( chkName(operand, operand.userStatus, sheetData) ){
        operands.push(operand);
      }
    }
    num++;
    if (num * 10000 >= entitys.totalNumEntries) break;
  }
  return operands;
}
function chkName(operand, status, sheetData){
  const rows = ( status == 'ACTIVE' ) ? sheetData.ACTIVE : sheetData.PAUSED ;
  const name = getName(operand);
  for( const row of rows ){
    if( row.campaignId != '' && row.campaignId != operand.campaignId ) continue;
    if( row.adGroupId != '' && row.adGroupId != operand.adGroupId ) continue;
    switch (MATCH_TYPE){
      case 'BROAD':
        if( name.indexOf(row.targetName) > -1){
          return true;
        }
        break;
      case 'EXACT':
        if( name === row.targetName){
          return true;
        }
        break;
      default:
        throw new Error('MATCH_TYPEは、BROADまたはEXACTのいずれかを設定してください。');
    }
  }
  return false;
}
function getOperand( value ){
  let entity;
  let operand = {};
  switch (ENTITY_TYPE){
    case 'AD':
      entity = value.adGroupAd;
      operand.adId = entity.adId;
      operand.adGroupId = entity.adGroupId;
      operand.adName = entity.adName;
      break;
    case 'ADGROUP':
      entity = value.adGroup;
      operand.adGroupId = entity.adGroupId;
      operand.adGroupName = entity.adGroupName;
      break;
    case 'CAMPAIGN':
      entity = value.campaign;
      operand.campaignName = entity.campaignName;
      break;
  }
  operand.campaignId = entity.campaignId;
  operand.userStatus = ( entity.userStatus == 'ACTIVE' ) ? 'PAUSED':'ACTIVE';
  return operand;
}
function getDataFromGetService(num){
  let request = {
    accountId: accountId,
    numberResults: MAX_NUMBER,
    startIndex: num * MAX_NUMBER + 1,
  };
  return PRODUCT_OBJ.get(request).rval;
}
function switchStatus(operand){
  if(operand.length == 0){
    Logger.log('更新対象がありませんでした');
    return;
  }
  let num = 0;
  while (true) {
    const switchRes = PRODUCT_OBJ.set({
      accountId: accountId,
      operand: operand.slice(num * 2000, Math.min((num + 1) * 2000, operand.length)),
    }).rval;
    for (let i = 0; i < switchRes.values.length; i++) {
      if (switchRes.values[i].operationSucceeded) {
        const entity = operand[num * 2000 + i];
        const statusName = (entity.userStatus == 'ACTIVE')? 'オン' : 'オフ';
        logAndMessage(getName(entity) + 'を配信' + statusName + 'にしました');
      } else {
        logAndMessage(getName(entity) + 'の配信切替に失敗しました');
      }
    }
    num++;
    if (num * 2000 >= operand.length) break;
  }
}
function switchStatusText(operand){
  if(operand.length == 0){
    Logger.log('更新対象がありませんでした');
    return;
  }
  for (let i = 0; i < operand.length; i++) {
    const entity = operand[i];
    const status =  (entity.userStatus == 'ACTIVE') ? 'オン': 'オフ';
    logAndMessage(getName(entity) + 'を配信' + status + 'にしました');
  }
}
function initServiceSetting(){
  const productType = AdsUtilities.getProductType();
  if (productType == 'SEARCH') {
    PRODUCT_OBJ = getService(Search);
    Logger.log('検索広告のアカウントで実行します。対象は「' + getEntityName() + '」です');
  } else if (productType == 'DISPLAY') {
    PRODUCT_OBJ = getService(Display);
    if( ENTITY_TYPE == 'CAMPAIGN' ){
      MAX_NUMBER = 2000;
    }
    Logger.log('ディスプレイ広告のアカウントで実行します。対象は「' + getEntityName() + '」です');
  } else {
    throw new Error('検索広告またはディスプレイ広告のアカウントで実行してください。');
  }
}
function getService(ojb){
  switch (ENTITY_TYPE){
    case 'AD':
      return ojb.AdGroupAdService;
    case 'ADGROUP':
      return ojb.AdGroupService;
    case 'CAMPAIGN':
      return ojb.CampaignService;
    default:
      throw new Error('ENTITY_TYPEは、CAMPAIGN、ADGROUP、ADのいずれかを設定してください。');
  }
}
function isStatus(status, index){
  if (status == 'オン') {
    return 'ACTIVE';
  } else if (status == 'オフ') {
    return 'PAUSED';
  } else {
    throw new Error(index + '行目の配信設定に間違いがあります。 設定内容：' + status);
  }
}
function getName( operand ){
  switch (ENTITY_TYPE){
    case 'AD':
      return operand.adName;
    case 'ADGROUP':
      return operand.adGroupName;
    case 'CAMPAIGN':
      return operand.campaignName;
  }
}
function getEntityName(){
  switch (ENTITY_TYPE){
    case 'AD':
      return '広告';
    case 'ADGROUP':
      return '広告グループ';
    case 'CAMPAIGN':
      return 'キャンペーン';
  }
}
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) {
  if (SHEET_NAME === '') {
    throw new Error('シート名を設定してください。');
  }
  const sh = ss.getSheetByName(SHEET_NAME);
  if(sh === null){
    throw new Error('シートが開けませんでした。シート名を確認してください。');
  }
  return sh;
}
function logAndMessage(text) {
  Logger.log(text);
  TEXT_MESSAGE += text + '\n';
}
function validateAndSendMail() {
  if (FLAG_MAIL && TEXT_MESSAGE.length > 0) {
    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: MAIL_TITLE,
      body: TEXT_MESSAGE,
    });
  }
}
function validateAndSendSlack() {
  if (FLAG_SLACK && TEXT_MESSAGE.length > 0) {
    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,
      }),
    });
  }
}