ड्राइविंग दूरी कैलकुलेट करें और मीटर को मील में बदलें

कोडिंग लेवल: शुरुआती
अवधि: 10 मिनट
प्रोजेक्ट टाइप: कस्टम फ़ंक्शन और कस्टम मेन्यू के साथ ऑटोमेशन

मकसद

• यह समझना कि समाधान क्या करता है.
• जानें कि समाधान में Apps Script की सेवाएं क्या करती हैं.
• स्क्रिप्ट सेट अप करें.
• स्क्रिप्ट चलाएं.

इस समाधान के बारे में जानकारी

कस्टम फ़ंक्शन का इस्तेमाल करके, दो जगहों के बीच की ड्राइविंग की दूरी का हिसाब लगाया जा सकता है. साथ ही, दूरी को मीटर से मील में बदला जा सकता है. एक और ऑटोमेशन, कस्टम मेन्यू उपलब्ध कराता है. इसकी मदद से, नई शीट में शुरू और आखिरी पते के बीच, सिलसिलेवार निर्देश जोड़े जा सकते हैं.

यह कैसे काम करता है

इस स्क्रिप्ट में दो कस्टम फ़ंक्शन और एक ऑटोमेशन का इस्तेमाल किया गया है.

• drivingDistance(origin, destination) फ़ंक्शन, Maps Service का इस्तेमाल करके, दो जगहों के बीच ड्राइविंग के निर्देशों का हिसाब लगाता है. साथ ही, दोनों पतों के बीच की दूरी को मीटर में दिखाता है.
• metersToMiles(meters) फ़ंक्शन, किसी दी गई संख्या के लिए, मीटर के बराबर मील की संख्या का हिसाब लगाता है.
• ऑटोमेशन, उपयोगकर्ता से पूछता है कि ड्राइविंग के दिशा-निर्देशों का हिसाब लगाने के लिए, शुरू और आखिर के पतों की कौनसी पंक्ति डालनी है. साथ ही, यह नई शीट में ड्राइविंग के दिशा-निर्देशों को सिलसिलेवार तरीके से जोड़ता है.

Apps Script की सेवाएं

यह समाधान इन सेवाओं का इस्तेमाल करता है:

• स्प्रेडशीट सेवा–यह कस्टम मेन्यू जोड़ती है, इस समाधान की जांच करने के लिए डेमो डेटा जोड़ती है, और स्क्रिप्ट के ड्राइविंग निर्देश जोड़ने पर नई शीट को फ़ॉर्मैट करती है.
• बुनियादी सेवा–Browser क्लास का इस्तेमाल करके, उपयोगकर्ता को निर्देशों के लिए पंक्ति संख्या डालने के लिए कहा जाता है. साथ ही, कोई गड़बड़ी होने पर उपयोगकर्ता को सूचना दी जाती है.
• उपयोगिता सेवा–टेंप्लेट की गई स्ट्रिंग को, उपयोगकर्ता की दी गई जानकारी के साथ अपडेट करती है.
• Maps की सेवा–इससे, Google Maps पर शुरू और आखिरी पते के बीच के रास्ते के लिए, सिलसिलेवार निर्देश मिलते हैं.

ज़रूरी शर्तें

इस सैंपल का इस्तेमाल करने के लिए, आपको ये ज़रूरी शर्तें पूरी करनी होंगी:

• Google खाता (Google Workspace खातों के लिए, एडमिन की अनुमति की ज़रूरत पड़ सकती है).
• इंटरनेट का ऐक्सेस वाला वेब ब्राउज़र.

स्क्रिप्ट सेट अप करना

1. ड्राइविंग की दूरी कैलकुलेट करें और मीटर को मील में बदलें स्प्रेडशीट की कॉपी बनाएं. इस समाधान के लिए, स्प्रेडशीट में Apps Script प्रोजेक्ट अटैच किया गया है.
   कॉपी बनाना
2. अपनी शीट में हेडर और डेमो डेटा जोड़ने के लिए, निर्देश > शीट तैयार करें पर क्लिक करें. पसंद के मुताबिक बनाए गए इस मेन्यू को देखने के लिए, आपको पेज को रीफ़्रेश करना पड़ सकता है.

3. जब आपसे कहा जाए, तब स्क्रिप्ट को अनुमति दें. अगर OAuth की सहमति वाली स्क्रीन पर यह चेतावनी दिखती है, इस ऐप्लिकेशन की पुष्टि नहीं की गई है, तो बेहतर > {Project Name} पर जाएं (असुरक्षित) को चुनकर जारी रखें.

4. निर्देश > शीट तैयार करें पर फिर से क्लिक करें.

स्क्रिप्ट चलाना

1. सेल C2 में, फ़ॉर्मूला =DRIVINGDISTANCE(A2,B2) डालें और Enter दबाएं. अगर आप किसी ऐसी जगह पर हैं जहां दशमलव के लिए कॉमा का इस्तेमाल किया जाता है, तो आपको इसके बजाय =DRIVINGDISTANCE(A2;B2) डालना पड़ सकता है.
2. सेल D2 में, फ़ॉर्मूला =METERSTOMILES(C2) डालें और Enter दबाएं.
3. (ज़रूरी नहीं) शुरू और आखिर के पतों की अतिरिक्त पंक्तियां जोड़ें. साथ ही, अलग-अलग जगहों के बीच की ड्राइविंग की दूरी का हिसाब लगाने के लिए, C और D कॉलम में फ़ॉर्मूला कॉपी करें.
4. निर्देश > सिलसिलेवार निर्देश जनरेट करें पर क्लिक करें.
5. डायलॉग बॉक्स में, उन पतों की पंक्ति संख्या डालें जिनके लिए आपको निर्देश जनरेट करने हैं और ठीक है पर क्लिक करें.
6. स्क्रिप्ट से बनाई गई नई शीट में, ड्राइविंग के निर्देश देखें.

कोड की समीक्षा करना

इस समाधान के लिए Apps Script कोड की समीक्षा करने के लिए, यहां दिए गए सोर्स कोड देखें पर क्लिक करें:

सोर्स कोड देखें

Code.gs

sheets/customFunctions/customFunctions.gs

GitHub पर देखना

/**
 * @OnlyCurrentDoc Limits the script to only accessing the current sheet.
 */

/**
 * A special function that runs when the spreadsheet is open, used to add a
 * custom menu to the spreadsheet.
 */
function onOpen() {
  try {
    const spreadsheet = SpreadsheetApp.getActive();
    const menuItems = [
      {name: 'Prepare sheet...', functionName: 'prepareSheet_'},
      {name: 'Generate step-by-step...', functionName: 'generateStepByStep_'}
    ];
    spreadsheet.addMenu('Directions', menuItems);
  } catch (e) {
    // TODO (Developer) - Handle Exception
    console.log('Failed with error: %s' + e.error);
  }
}

/**
 * A custom function that converts meters to miles.
 *
 * @param {Number} meters The distance in meters.
 * @return {Number} The distance in miles.
 */
function metersToMiles(meters) {
  if (typeof meters !== 'number') {
    return null;
  }
  return meters / 1000 * 0.621371;
}

/**
 * A custom function that gets the driving distance between two addresses.
 *
 * @param {String} origin The starting address.
 * @param {String} destination The ending address.
 * @return {Number} The distance in meters.
 */
function drivingDistance(origin, destination) {
  const directions = getDirections_(origin, destination);
  return directions.routes[0].legs[0].distance.value;
}

/**
 * A function that adds headers and some initial data to the spreadsheet.
 */
function prepareSheet_() {
  try {
    const sheet = SpreadsheetApp.getActiveSheet().setName('Settings');
    const headers = [
      'Start Address',
      'End Address',
      'Driving Distance (meters)',
      'Driving Distance (miles)'];
    const initialData = [
      '350 5th Ave, New York, NY 10118',
      '405 Lexington Ave, New York, NY 10174'];
    sheet.getRange('A1:D1').setValues([headers]).setFontWeight('bold');
    sheet.getRange('A2:B2').setValues([initialData]);
    sheet.setFrozenRows(1);
    sheet.autoResizeColumns(1, 4);
  } catch (e) {
    // TODO (Developer) - Handle Exception
    console.log('Failed with error: %s' + e.error);
  }
}

/**
 * Creates a new sheet containing step-by-step directions between the two
 * addresses on the "Settings" sheet that the user selected.
 */
function generateStepByStep_() {
  try {
    const spreadsheet = SpreadsheetApp.getActive();
    const settingsSheet = spreadsheet.getSheetByName('Settings');
    settingsSheet.activate();

    // Prompt the user for a row number.
    const selectedRow = Browser
        .inputBox('Generate step-by-step', 'Please enter the row number of' +
        ' the' + ' addresses to use' + ' (for example, "2"):',
        Browser.Buttons.OK_CANCEL);
    if (selectedRow === 'cancel') {
      return;
    }
    const rowNumber = Number(selectedRow);
    if (isNaN(rowNumber) || rowNumber < 2 ||
      rowNumber > settingsSheet.getLastRow()) {
      Browser.msgBox('Error',
          Utilities.formatString('Row "%s" is not valid.', selectedRow),
          Browser.Buttons.OK);
      return;
    }


    // Retrieve the addresses in that row.
    const row = settingsSheet.getRange(rowNumber, 1, 1, 2);
    const rowValues = row.getValues();
    const origin = rowValues[0][0];
    const destination = rowValues[0][1];
    if (!origin || !destination) {
      Browser.msgBox('Error', 'Row does not contain two addresses.',
          Browser.Buttons.OK);
      return;
    }

    // Get the raw directions information.
    const directions = getDirections_(origin, destination);

    // Create a new sheet and append the steps in the directions.
    const sheetName = 'Driving Directions for Row ' + rowNumber;
    let directionsSheet = spreadsheet.getSheetByName(sheetName);
    if (directionsSheet) {
      directionsSheet.clear();
      directionsSheet.activate();
    } else {
      directionsSheet =
        spreadsheet.insertSheet(sheetName, spreadsheet.getNumSheets());
    }
    const sheetTitle = Utilities
        .formatString('Driving Directions from %s to %s', origin, destination);
    const headers = [
      [sheetTitle, '', ''],
      ['Step', 'Distance (Meters)', 'Distance (Miles)']
    ];
    const newRows = [];
    for (const step of directions.routes[0].legs[0].steps) {
      // Remove HTML tags from the instructions.
      const instructions = step.html_instructions
          .replace(/<br>|<div.*?>/g, '\n').replace(/<.*?>/g, '');
      newRows.push([
        instructions,
        step.distance.value
      ]);
    }
    directionsSheet.getRange(1, 1, headers.length, 3).setValues(headers);
    directionsSheet.getRange(headers.length + 1, 1, newRows.length, 2)
        .setValues(newRows);
    directionsSheet.getRange(headers.length + 1, 3, newRows.length, 1)
        .setFormulaR1C1('=METERSTOMILES(R[0]C[-1])');

    // Format the new sheet.
    directionsSheet.getRange('A1:C1').merge().setBackground('#ddddee');
    directionsSheet.getRange('A1:2').setFontWeight('bold');
    directionsSheet.setColumnWidth(1, 500);
    directionsSheet.getRange('B2:C').setVerticalAlignment('top');
    directionsSheet.getRange('C2:C').setNumberFormat('0.00');
    const stepsRange = directionsSheet.getDataRange()
        .offset(2, 0, directionsSheet.getLastRow() - 2);
    setAlternatingRowBackgroundColors_(stepsRange, '#ffffff', '#eeeeee');
    directionsSheet.setFrozenRows(2);
    SpreadsheetApp.flush();
  } catch (e) {
    // TODO (Developer) - Handle Exception
    console.log('Failed with error: %s' + e.error);
  }
}

/**
 * Sets the background colors for alternating rows within the range.
 * @param {Range} range The range to change the background colors of.
 * @param {string} oddColor The color to apply to odd rows (relative to the
 *     start of the range).
 * @param {string} evenColor The color to apply to even rows (relative to the
 *     start of the range).
 */
function setAlternatingRowBackgroundColors_(range, oddColor, evenColor) {
  const backgrounds = [];
  for (let row = 1; row <= range.getNumRows(); row++) {
    const rowBackgrounds = [];
    for (let column = 1; column <= range.getNumColumns(); column++) {
      if (row % 2 === 0) {
        rowBackgrounds.push(evenColor);
      } else {
        rowBackgrounds.push(oddColor);
      }
    }
    backgrounds.push(rowBackgrounds);
  }
  range.setBackgrounds(backgrounds);
}

/**
 * A shared helper function used to obtain the full set of directions
 * information between two addresses. Uses the Apps Script Maps Service.
 *
 * @param {String} origin The starting address.
 * @param {String} destination The ending address.
 * @return {Object} The directions response object.
 */
function getDirections_(origin, destination) {
  const directionFinder = Maps.newDirectionFinder();
  directionFinder.setOrigin(origin);
  directionFinder.setDestination(destination);
  const directions = directionFinder.getDirections();
  if (directions.status !== 'OK') {
    throw directions.error_message;
  }
  return directions;
}

योगदानकर्ता

इस सैंपल को Google, Google डेवलपर विशेषज्ञों की मदद से मैनेज करता है.

अगले चरण

• Google Sheets में कस्टम फ़ंक्शन
• Google Workspace में कस्टम मेन्यू