שימוש ב-Region Lookup API עם Google Sheets

המוצר או התכונה האלה הם ניסיוניים (לפני השקה לכל המשתמשים). יכול להיות שתהיה תמיכה מוגבלת במוצרים ובתכונות טרום-GA, וששינויים במוצרים ובתכונות טרום-GA לא יהיו תואמים לגרסאות אחרות של טרום-GA. התנאים הספציפיים לשירות של הפלטפורמה של מפות Google חלים על מוצרים במצב טרום-זמינות לכלל המשתמשים. מידע נוסף זמין בקטע תיאורים של שלבי ההשקה.

כדי לחפש מזהי מקומות של אזורים במצב אופליין, אפשר להפעיל את Region Lookup API מ-Google Sheets באמצעות Apps Script. מומלץ להשתמש באפשרות הזו בקבוצות נתונים שבהן פרמטרים של קלט מעורפלים ויכולים להוביל לכמה מזהי מיקומים (לדוגמה, 'רחוב ראשי 10'), שעשויים לחייב ניפוי באגים. סקריפט לדוגמה עם הפונקציות הבאות:

• SearchRegionByLocation מחפש מקום שהגבול שלו מכיל את קואורדינטות קו הרוחב או קו האורך שצוינו.
• SearchRegionByAddress מחפש מקום שהגבול שלו מכיל את הכתובת שצוינה.
• SearchRegionByPlaceId מחפש מקום עם מזהה המקום שצוין.
• LookupRegionByName מחפש מקום בשם שצוין.
• LookupRegionByUnitCode מחפש מקום עם קוד היחידה שצוין.

זהירות: ה-Region Lookup API והקוד של Apps Script הם גרסאות ניסיוניות.

פונקציות מותאמות אישית של חיפוש אזורים

כדי להשתמש בפונקציות בהתאמה אישית, קודם צריך להוסיף את קוד הסקריפט ‎ .gs של הפונקציות בהתאמה אישית לעורך הסקריפטים של Apps Script. אחרי שהסקריפט נטען, אפשר לקרוא לפונקציות כמו שקוראים לכל פונקציה אחרת בגיליון אלקטרוני. הסקריפטים מקבלים נתוני קלט מהתאים. אפשר להפעיל פונקציות בהתאמה אישית מהגיליון באופן הבא: =LookupRegionByName(A2,C2,D2,E2)

התוצאות יוצגו בתא שמכיל את הפונקציה ובשני התאים שמשמאל. אם יש מזהי מקומות מועמדים, התוצאות שלהם יוצגו גם בתאים סמוכים. לצורך אימות, יש לספק קישור לדף המקום שבו מוצגים שם האזור והפוליגון במפות Google. בדוגמה הבאה, אם מדביקים את הפונקציה בתא A1, התוצאות ייראו כך:

מזהה מקום	כתובת אתר של דף מקום	קוד שגיאה
ChIJLQQwv4qBb0gRIMaY1COLDQU	https://www.google.com/maps/search/?api=1&query=%20&query_place_id=ChIJLQQwv4qBb0gRIMaY1COLDQU

בדוגמה הקודמת, הבקשה בוצעה בהצלחה ולכן תא השגיאה ריק. אם יהיו שגיאות שמונעות את הפעלת הסקריפט כראוי (למשל, השמטה של מפתח API תקין), השגיאה תופיע כתגובה לתא שמכיל את הפונקציה.

הוספת הפונקציות בהתאמה אישית ל-Apps Script

1. פותחים גיליון אלקטרוני ב-Google Sheets.
2. בוחרים באפשרות תוספים > Apps Script בתפריט.
3. מוחקים את כל הקוד בכלי לעריכת סקריפטים.
4. מעתיקים את הקוד מהדוגמה שבהמשך ומדביקים אותו בעורך הסקריפטים.
5. מחליפים את YOUR_API_KEY במפתח API ללא הגבלות ששייך לפרויקט שבו ממשק ה-API לחיפוש אזורים מופעל.
6. בחלק העליון, לוחצים על סמל השמירה .

/**
 * @fileoverview Provides custom Geo functions in Google Sheets for matching boundaries.
 * * SearchRegionByLocation searches for a region whose boundary contains the specified latitude/longitude coordinates.
 * * SearchRegionByAddress searches for a region whose boundary contains the specified address.
 * * SearchRegionByPlaceId searches for a region whose boundary contains the specified place ID.
 * * LookupRegionByName looks up a region with the specified name.
 * * LookupRegionByUnitCode looks up a region with the specified unit code.
 * @OnlyCurrentDoc
 */

var api_key = "YOUR_API_KEY"; // An unrestricted key is recommended for local use only (deployment is NOT recommended).

function format_url(place_id) {
  return place_id && 'https://www.google.com/maps/search/?api=1&query=%20&query_place_id=' + place_id;
}

function format_result(result) {
  let matches = result.matches || [];
  let firstMatch = result.matches[0] || {};

  let placeId = firstMatch.matchedPlaceId || '';
  let debugInfo = firstMatch.debugInfo || '';
  let candidates = firstMatch.candidatePlaceIds || [];

  return [[
    placeId || '(NULL)',
    format_url(placeId),
    debugInfo,
    candidates[0],
    format_url(candidates[0]),
    candidates[1],
    format_url(candidates[1]),
    candidates[2],
    format_url(candidates[2])
    ]];
}

/**
 * Searches for a place whose boundary contains the specified latitude/longitude coordinates.
 *
 * @param {number} latitude - The latitude where the place will be found (e.g., 37.531939).
 * @param {number} longitude - The longitude where the place will be found (e.g., -122.2994121).
 * @param {string} place_type - The place type of the place ("postal_code", "administrative_area_level_1", "administrative_area_level_2", "locality", or "country").
 *
 * @return {string} The place_id of the place, or null if none was found.
 *
 * @customfunction
 */
function SearchRegionByLocation(
  latitude, longitude, place_type) {
  var data = {
    "search_values": [ {
      "latlng": { 'latitude': latitude, 'longitude': longitude }, // { latitude: 37.531939, longitude: -122.2994121 }
      "place_type": place_type,
      "region_code": null,
      "language_code": null,
    } ]
  };

  var options = {
    'method' : 'post',
    'contentType': 'application/json',
    'headers': {
        'X-Goog-Api-Key' : api_key
      },
      // Convert the JavaScript object to a JSON string.
      'payload' : JSON.stringify(data)
    };

  var response = UrlFetchApp.fetch(
    'https://regionlookup.googleapis.com/v1alpha:searchRegion',
    options);

  var resultText = response.getContentText();
  console.log(resultText);
  var result = JSON.parse(resultText);

  return format_result(result);
}

/**
 * Searches for a place whose boundary contains the specified address.
 *
 * @param {string} address - An address within the place boundaries (e.g., "1505 Salado Dr, Mountain View, CA").
 * @param {string} place_type - The geo type id of the place (e.g., "locality").
 * @param {string} [region_code='us'] - The region code of the place (e.g., "US").
 * @param {string} [language_code='en'] - The language code of the place's name. (e.g., "en").
 *
 * @return {string} The place_id of the place, or null if none was found.
 *
 * @customfunction
 */

function SearchRegionByAddress(
  address, place_type, region_code, language_code) {

  var data = {
    "search_values": {
        "address": address,
        "place_type" : place_type,
        "region_code": region_code || 'us',
        "language_code": language_code || 'en',
      }
  };

  var options = {
    'method' : 'post',
    'contentType': 'application/json',
    'headers': {
        'X-Goog-Api-Key' : api_key
      },
      // Convert the JavaScript object to a JSON string.
      'payload' : JSON.stringify(data)
    };

  var response = UrlFetchApp.fetch(
    'https://regionlookup.googleapis.com/v1alpha:searchRegion',
    options);

  var resultText = response.getContentText();
  console.log(resultText);
  var result = JSON.parse(resultText);

  return format_result(result);
}


/**
 * Searches for a place with the specified place ID.
 *
 * @param {string} place_id - The place ID to search for.
 * @param {string} place_type - The geo type id of the place (e.g., "locality").
 * @param {string} [region_code='us'] - The region code of the place (e.g., "US").
 * @param {string} [language_code='en'] - The language code of the place's name. (e.g., "en").
 *
 * @return {string} The place_id of the place, or null if none was found.
 *
 * @customfunction
 */
function SearchRegionByPlaceId(
  place_id, place_type, region_code, language_code) {

 var data = {
   "search_values": {
       "place_id": place_id,
       "place_type" : place_type,
       "region_code": region_code || 'us',
       "language_code": language_code || 'en',
     }
 };

 var options = {
   'method' : 'post',
   'contentType': 'application/json',
   'headers': {
       'X-Goog-Api-Key' : api_key
     },
     // Convert the JavaScript object to a JSON string.
     'payload' : JSON.stringify(data)
   };

 var response = UrlFetchApp.fetch(
   'https://regionlookup.googleapis.com/v1alpha:searchRegion',
   options);
  var resultText = response.getContentText();
 console.log(resultText);
 var result = JSON.parse(resultText);

 return format_result(result);
}

/**
 * Looks up a place with the specified name.
 *
 * @param {string} place_name - The name of the place (e.g., "Palo Alto").
 * @param {string} place_type - The geo type id of the place (e.g., "locality").
 * @param {string} [region_code='us'] - The region code of the place (e.g., "US").
 * @param {string} [language_code='en'] - The language code of the place's name. (e.g., "en").
 *
 * @return {string} The place_id of the place, or null if none was found.
 *
 * @customfunction
 */
function LookupRegionByName(
  place, place_type, region_code, language_code) {
  var data = {
    "identifiers": [ {
        "place": '' + place,
        "place_type": place_type,
        "region_code": region_code || 'us',
        "language_code": language_code || 'en',
      }
    ]
  };

  var options = {
    'method' : 'post',
    'contentType': 'application/json',
    'headers': {
        'X-Goog-Api-Key' : api_key
      },
      // Convert the JavaScript object to a JSON string.
      'payload' : JSON.stringify(data),
      //'muteHttpExceptions' : true,
    };

  var response = UrlFetchApp.fetch(
    'https://regionlookup.googleapis.com/v1alpha:lookupRegion',
    options);

  var resultText = response.getContentText();

  console.log(resultText);
  var result = JSON.parse(resultText);

  return format_result(result);
}

/**
 * Looks up a place with the specified unit code.
 *
 * @param {string} place_name - The name of the place (e.g., "Palo Alto").
 * @param {string} place_type - The geo type id of the place (e.g., "locality").
 * @param {string} [region_code='us'] - The region code of the place (e.g., "US").
 * @param {string} [language_code='en'] - The language code of the place's name. (e.g., "en").
 *
 * @return {string} The place_id of the place, or null if none was found.
 *
 * @customfunction
 */
function LookupRegionByUnitCode(
  unit_code, place_type, region_code, language_code) {
  var data = {
    "identifiers": [ {
        "unit_code": '' + unit_code,
        "place_type": place_type,
        "region_code": region_code || 'us',
        "language_code": language_code || 'en',
      }
    ]
  };

  var options = {
    'method' : 'post',
    'contentType': 'application/json',
    'headers': {
        'X-Goog-Api-Key' : api_key
      },
      // Convert the JavaScript object to a JSON string.
      'payload' : JSON.stringify(data),
      //'muteHttpExceptions' : true,
    };

  var response = UrlFetchApp.fetch(
    'https://regionlookup.googleapis.com/v1alpha:lookupRegion',
    options);

  var resultText = response.getContentText();

  console.log(resultText);
  var result = JSON.parse(resultText);

  return format_result(result);
}