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

const SPREAD_SHEET_ID = '12345abcde'; 

const SHEET_NAME = 'raw';

/*
■スクリプト内容
検索広告またはディスプレイ広告のレポートを取得し、結果をスプレッドシートに自動で書き込みます。
■利用方法
１．当スクリプトを、検索広告またはディスプレイ広告のスクリプトとしてください。
２．定数を以下のように設定してください。
■定数
・SPREAD_SHEET_ID：スプレッドシートID
・SHEET_NAME：スプレッドシート名
・FLAG_MAIL：結果をメール送信するならtrue、しないならfalse
・MAIL_TO：メール送信先のYahoo! BusinessID
・MAIL_TITLE：メールタイトル
・FLAG_SLACK：Slack配信するときはtrue、配信しないときはfalse
・URL_FETCH_APP：SlackのWebhook URL
*/
//設定が必要な定数
const SPREAD_SHEET_ID = '';//書き出すスプレッドシートID。例：'SPREAD_SHEET_ID'
const SHEET_NAME = '';//スプレッドシートのシート名。例：'シート1'
const FLAG_MAIL = false;//メール送信するならtrue、しないならfalse
const MAIL_TO = '';//メール通知先のビジネスIDを指定。例：['abcde12345']
let MAIL_TITLE = '日予算自動変更のレポート取得';//メールタイトルを指定
const FLAG_SLACK = false;//Slack配信するときはtrue、配信しないときはfalse
const URL_FETCH_APP = '';//SlackのWebhook URL。例：'https://hooks.slack.com/services/XXXXXXXX/XXXXXXXX/XXXXXXXX'
//設定が不要な定数
const accountId = AdsUtilities.getCurrentAccountId();
const FIELDS =  ['DAY', 'CAMPAIGN_NAME', 'IMPS', 'CLICKS', 'COST', 'CONVERSIONS'];
const REPORT_DATE_RANGE_TYPE = 'THIS_MONTH';
const productType = AdsUtilities.getProductType();
let TEXT_MESSAGE_ARRAY = [];
function main() {
  try {
    getSearchReport();
  } catch (e) {
    MAIL_TITLE += ' スクリプトが失敗しています';
    TEXT_MESSAGE_ARRAY.push('何らかのエラーによりスクリプトが失敗しました。詳細は管理画面のログをご確認ください。');
    sendMailOrSlack();
    throw e;
  }
  sendMailOrSlack();
}
function getSearchReport() {
  //スプレッドシート
  const ss = validateAndGetSpreadsheet();
  const sh = validateAndGetSheet(ss);
  //スプレッドシートの内容をクリア
  sh.clear();
  //レポート取得
  let report = getReport();
  if(report.length <= 1){
    logAndMessage("レポートが存在しませんでした。");
    return;
  }
  //結果をスプレッドシートに書き込み
  sh.getRange('A1').setValues(report);
  logAndMessage("レポート取得とスプレッドシートへの書き込み処理が完了しました。");
}
function getReport(){
  let report;
  if (productType == 'SEARCH') {
    report = AdsUtilities.getSearchReport({
      accountId: accountId,
      fields: FIELDS,
      reportDateRangeType: REPORT_DATE_RANGE_TYPE,
      reportType: 'CAMPAIGN',
      reportSkipColumnHeader: 'FALSE',
      sortFields: [{
        field: 'DAY',
        reportSortType: 'ASC',
      }]
    }).reports[0].rows;
  } else if (productType == 'DISPLAY') {
    report = AdsUtilities.getDisplayReport({
      accountId: accountId,
      fields: FIELDS,
      reportDateRangeType: REPORT_DATE_RANGE_TYPE,
      reportSkipColumnHeader: 'FALSE',
      sortFields: [//並び順
        {//コストの多い順
          field: "DAY",
          reportSortType: "ASC"
        }
      ]
    }).reports[0].rows;
  } else {
    throw new Error('当スクリプトは検索広告またはディスプレイ広告のアカウントに設定してください（MCCアカウント等は対象外です）');
  }
  return report;
}
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_ARRAY.push(text);
}
//メール、Slack、もしくはその両方に通知
function sendMailOrSlack() {
  if (TEXT_MESSAGE_ARRAY.length > 0) {
    validateAndSendMail();
    validateAndSendSlack();
  }
}
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'),
    });
  }
}

const SHEET_NAME = '当月予算進捗';

/*
■スクリプト内容
スプレッドシートの内容を参照し、指定したキャンペーンの予算を自動で変更します。
■利用方法
１．当スクリプトを、検索広告またはディスプレイ広告のスクリプトとしてください。
２．定数を以下のように設定してください。
■定数
・SPREAD_SHEET_ID：スプレッドシートID
・SHEET_NAME：スプレッドシート名
・FLAG_MAIL：結果をメール送信するならtrue、しないならfalse
・MAIL_TO：メール送信先のYahoo! BusinessID
・MAIL_TITLE：メールタイトル
・FLAG_SLACK：Slack配信するときはtrue、配信しないときはfalse
・URL_FETCH_APP：SlackのWebhook URL
■制限事項
検索広告の場合、予算の数値は10の位で切り捨てた値となります。
*/
//設定が必要な定数
const SPREAD_SHEET_ID = ''; //書き出すスプレッドシートID。例：'SPREAD_SHEET_ID'
const SHEET_NAME = '';//スプレッドシートのシート名。例：'シート1'
const FLAG_MAIL = false;//メール送信するならtrue、しないならfalse
const MAIL_TO = '';//メール通知先のビジネスIDを指定。例：['abcde12345']
let MAIL_TITLE = '日予算自動変更';//メールタイトルを指定
const FLAG_SLACK = false;//Slack配信するときはtrue、配信しないときはfalse
const URL_FETCH_APP = '';//SlackのWebhook URL。例：'https://hooks.slack.com/services/XXXXXXXX/XXXXXXXX/XXXXXXXX'
//設定が不要な定数
const accountId = AdsUtilities.getCurrentAccountId();
const productType = AdsUtilities.getProductType();
let campaignArray = [];
let TEXT_MESSAGE_ARRAY = [];
let errFlag = false;
function main() {
  try {
    setBudget();
  } catch (e) {
    MAIL_TITLE += ' スクリプトが失敗しています';
    TEXT_MESSAGE_ARRAY.push('何らかのエラーによりスクリプトが失敗しました。詳細は管理画面のログをご確認ください。');
    sendMailOrSlack();
    throw e;
  }
  sendMailOrSlack();
}
function setBudget() {
  //スプレッドシート
  const ss = validateAndGetSpreadsheet();
  const sh = validateAndGetSheet(ss);
  let lastRow = sh.getLastRow();
  let firstLow = lastRow - 6;
  if(lastRow == 6){
    throw new Error(SHEET_NAME + 'シートにキャンペーン情報を記入してください。');
  }
  //スプレッドシートのデータ取得
  let data = sh.getRange(7, 2, firstLow, 9).getValues();
  //日予算自動変更
  for(let i = 0; i < firstLow; i++){
    let campaignName = data[i][2];
    let budgetAmount = data[i][7];
    //上の2つがnullじゃないかチェックする。
    if(!campaignName || !budgetAmount){
      throw new Error(SHEET_NAME + 'シートのキャンペーン情報に不備があります。');
    }
    //適正日予算がマイナスかチェック。
    if(budgetAmount.indexOf('-') == 0){
      throw new Error(SHEET_NAME + 'シートの適正日予算がマイナスの値です。');
    }
    //CampaignService/getを実行してキャンペーンを取得する。
    let campaigns =  getCampaign();
    //予算変更のsetリクエストを作成する。
    createSetOperand(campaigns, campaignName, budgetAmount);
  }
  if(campaignArray.length == 0){
    logAndMessage("予算変更の対象となるキャンペーンは一つも存在しませんでした。");
    return;
  }
  //日予算の変更。
  setCampaign();
  Logger.log("処理を終了します。");
}
function getCampaign(){
  let campaigns;
  if (productType == 'SEARCH') {
    campaigns = Search.CampaignService.get({
      accountId: accountId,
    }).rval;
  } else if (productType == 'DISPLAY') {
    campaigns = Display.CampaignService.get({
      accountId: accountId,
    }).rval;
  } else {
    throw new Error('当スクリプトは検索広告またはディスプレイ広告のアカウントに設定してください（MCCアカウント等は対象外です）');
  }
  return campaigns;
}
function createSetOperand(campaigns, campaignName, budgetAmount){
  let checkFlg = false;
  for (let j = 0; j < campaigns.values.length; j++) {
    let campaign = campaigns.values[j].campaign;
    //スプレッドシートのキャンペーン名と一致するか確認する。
    if(campaignName === campaign.campaignName){
      let campaignId = campaign.campaignId;
      //予算の数値のみ抽出。
      let amountValue = budgetAmount.replace(/[^0-9]/g, '');
      let amountNumber = parseInt(amountValue);
      if(!amountNumber){
        throw new Error('適正日予算に不正な値が存在します。');
      }
      if (productType == 'SEARCH') {
        //2桁以下の数値は切り捨て。
        amountNumber = Math.floor(amountNumber/100)*100;
      }
      //operandの中にデータを入れる。
      let campaignOperand = {
        campaignId: campaignId,
        budget: {
          amount: amountNumber
        },
      };
      campaignArray.push(campaignOperand);
      checkFlg = true;
    }
  }
  if(!checkFlg) {
    Logger.log(SHEET_NAME + "シートの " + campaignName + 'は存在しないため、予算変更はできませんでした。');
    errFlag = true;
  }
}
function setCampaign(){
  let campaignsSet;
  if (productType == 'SEARCH') {
    campaignsSet = Search.CampaignService.set({
      accountId: accountId,
      operand: campaignArray,
    }).rval;
  } else if (productType == 'DISPLAY') {
    campaignsSet = Display.CampaignService.set({
      accountId: accountId,
      operand: campaignArray,
    }).rval;
  }
  //処理が成功したかチェック。
  let successCnt = 0;
  for (let k = 0; k < campaignsSet.values.length; k++) {
    if (campaignsSet.values[k].operationSucceeded){
      successCnt++;
    }
  }
  if(successCnt > 0 && !errFlag){
    logAndMessage("予算変更に" + successCnt +"件成功しました。");
  } else if(successCnt > 0 && errFlag){
    logAndMessage("予算変更に" + successCnt +"件成功しましたが、一部のキャンペーンについては予算変更に失敗しております。詳細は管理画面のログをご確認ください。");
  } else{
    logAndMessage("予算変更に失敗しました。");
  }
}
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_ARRAY.push(text);
}
//メール、Slack、もしくはその両方に通知
function sendMailOrSlack() {
  if (TEXT_MESSAGE_ARRAY.length > 0) {
    validateAndSendMail();
    validateAndSendSlack();
  }
}
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'),
    });
  }
}