สร้างอินเทอร์เฟซการค้นหาด้วยวิดเจ็ตการค้นหา

วิดเจ็ตการค้นหามีอินเทอร์เฟซการค้นหาที่ปรับแต่งได้สําหรับเว็บแอปพลิเคชัน วิดเจ็ตนี้ใช้ HTML และ JavaScript เพียงเล็กน้อยในการติดตั้งใช้งานและเปิดใช้ฟีเจอร์การค้นหาทั่วไป เช่น มิติข้อมูลและการแบ่งหน้า นอกจากนี้ คุณยังปรับแต่งส่วนต่างๆ ของอินเทอร์เฟซด้วย CSS และ JavaScript ได้ด้วย

หากต้องการความยืดหยุ่นมากกว่าที่วิดเจ็ตนำเสนอ ให้ลองใช้ Query API ดูข้อมูลเกี่ยวกับการสร้างอินเทอร์เฟซการค้นหาด้วย Query API ได้ที่การสร้างอินเทอร์เฟซการค้นหาด้วย Query API

สร้างอินเทอร์เฟซการค้นหา

การสร้างอินเทอร์เฟซการค้นหาต้องดำเนินการหลายขั้นตอน ดังนี้

  1. กำหนดค่าแอปพลิเคชันการค้นหา
  2. สร้างรหัสไคลเอ็นต์สําหรับแอปพลิเคชัน
  3. เพิ่มมาร์กอัป HTML สําหรับช่องค้นหาและผลการค้นหา
  4. โหลดวิดเจ็ตในหน้าเว็บ
  5. เริ่มต้นวิดเจ็ต

กำหนดค่าแอปพลิเคชันการค้นหา

อินเทอร์เฟซการค้นหาแต่ละรายการต้องมีแอปพลิเคชันการค้นหาที่กําหนดไว้ในคอนโซลผู้ดูแลระบบ แอปพลิเคชันการค้นหาจะให้ข้อมูลเพิ่มเติมสําหรับการค้นหา เช่น แหล่งข้อมูล ข้อมูลประกอบ และการตั้งค่าคุณภาพการค้นหา

หากต้องการสร้างแอปพลิเคชันการค้นหา โปรดดูหัวข้อสร้างประสบการณ์การค้นหาที่กําหนดเอง

สร้างรหัสไคลเอ็นต์สําหรับแอปพลิเคชัน

นอกเหนือจากขั้นตอนในหัวข้อกำหนดค่าการเข้าถึง Google Cloud Search API แล้ว คุณยังต้องสร้างรหัสไคลเอ็นต์สำหรับเว็บแอปพลิเคชันด้วย

กําหนดค่าโปรเจ็กต์

สิ่งที่จะเกิดขึ้นเมื่อคุณกําหนดค่าโปรเจ็กต์

  • เลือกประเภทไคลเอ็นต์เว็บเบราว์เซอร์
  • ระบุ URI ต้นทางของแอป
  • หมายเหตุเกี่ยวกับรหัสไคลเอ็นต์ที่สร้าง คุณต้องใช้รหัสไคลเอ็นต์เพื่อดำเนินการขั้นตอนถัดไป ไม่จำเป็นต้องใช้รหัสลับไคลเอ็นต์กับวิดเจ็ต

ดูข้อมูลเพิ่มเติมที่หัวข้อOAuth 2.0 สําหรับเว็บแอปพลิเคชันฝั่งไคลเอ็นต์

เพิ่มมาร์กอัป HTML

วิดเจ็ตต้องใช้ HTML เพียงเล็กน้อยจึงจะทำงานได้ คุณต้องระบุข้อมูลต่อไปนี้

  • องค์ประกอบ input สำหรับช่องค้นหา
  • องค์ประกอบที่จะยึดป๊อปอัปคำแนะนำ
  • องค์ประกอบที่มีผลการค้นหา
  • (ไม่บังคับ) ระบุองค์ประกอบที่จะใส่ตัวควบคุมแง่มุม

ข้อมูลโค้ด HTML ต่อไปนี้แสดง HTML สําหรับวิดเจ็ตการค้นหา ซึ่งระบุองค์ประกอบที่จะเชื่อมโยงด้วยแอตทริบิวต์ id

serving/widget/public/with_css/index.html
<div id="search_bar">
  <div id="suggestions_anchor">
    <input type="text" id="search_input" placeholder="Search for...">
  </div>
</div>
<div id="facet_results"></div>
<div id="search_results"></div>

โหลดวิดเจ็ต

วิดเจ็ตจะโหลดแบบไดนามิกผ่านสคริปต์โปรแกรมโหลด หากต้องการรวมตัวโหลด ให้ใช้แท็ก <script> ดังที่แสดง

serving/widget/public/with_css/index.html
<!-- Google API loader -->
<script src="https://apis.google.com/js/api.js?mods=enable_cloud_search_widget&onload=onLoad" async defer></script>

คุณต้องระบุการเรียกกลับ onload ในแท็กสคริปต์ ระบบจะเรียกใช้ฟังก์ชันเมื่อโปรแกรมโหลดพร้อมใช้งาน เมื่อโปรแกรมโหลดพร้อมแล้ว ให้โหลดวิดเจ็ตต่อโดยเรียกใช้ gapi.load() เพื่อโหลดไคลเอ็นต์ API, Google Sign-In และโมดูล Cloud Search

serving/widget/public/with_css/app.js
/**
* Load the cloud search widget & auth libraries. Runs after
* the initial gapi bootstrap library is ready.
*/
function onLoad() {
  gapi.load('client:auth2:cloudsearch-widget', initializeApp)
}

ระบบจะเรียกใช้ฟังก์ชัน initializeApp() หลังจากที่โหลดโมดูลทั้งหมดแล้ว

เริ่มต้นวิดเจ็ต

ขั้นแรก ให้เริ่มต้นไลบรารีไคลเอ็นต์โดยเรียกใช้ gapi.client.init() หรือ gapi.auth2.init() ด้วยรหัสไคลเอ็นต์ที่สร้างขึ้นและสโคป https://www.googleapis.com/auth/cloud_search.query ถัดไป ให้ใช้คลาส gapi.cloudsearch.widget.resultscontainer.Builder และ gapi.cloudsearch.widget.searchbox.Builder เพื่อกําหนดค่าวิดเจ็ตและเชื่อมโยงกับองค์ประกอบ HTML

ตัวอย่างต่อไปนี้แสดงวิธีเริ่มต้นวิดเจ็ต

serving/widget/public/with_css/app.js
/**
 * Initialize the app after loading the Google API client &
 * Cloud Search widget.
 */
function initializeApp() {
  // Load client ID & search app.
  loadConfiguration().then(function() {
    // Set API version to v1.
    gapi.config.update('cloudsearch.config/apiVersion', 'v1');

    // Build the result container and bind to DOM elements.
    var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setSearchResultsContainerElement(document.getElementById('search_results'))
      .setFacetResultsContainerElement(document.getElementById('facet_results'))
      .build();

    // Build the search box and bind to DOM elements.
    var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setInput(document.getElementById('search_input'))
      .setAnchor(document.getElementById('suggestions_anchor'))
      .setResultsContainer(resultsContainer)
      .build();
  }).then(function() {
    // Init API/oauth client w/client ID.
    return gapi.auth2.init({
        'clientId': clientId,
        'scope': 'https://www.googleapis.com/auth/cloud_search.query'
    });
  });
}

ตัวอย่างข้างต้นอ้างอิงตัวแปร 2 รายการสําหรับการกําหนดค่าที่กําหนดไว้ดังนี้

serving/widget/public/with_css/app.js
/**
* Client ID from OAuth credentials.
*/
var clientId = "...apps.googleusercontent.com";

/**
* Full resource name of the search application, such as
* "searchapplications/<your-id>".
*/
var searchApplicationName = "searchapplications/...";

ปรับแต่งประสบการณ์การลงชื่อเข้าใช้

โดยค่าเริ่มต้น วิดเจ็ตจะแจ้งให้ผู้ใช้ลงชื่อเข้าใช้และให้สิทธิ์แอปเมื่อเริ่มพิมพ์ข้อความค้นหา คุณสามารถใช้ Google Sign-in สําหรับเว็บไซต์เพื่อมอบประสบการณ์การลงชื่อเข้าใช้ที่ปรับให้เหมาะกับผู้ใช้มากขึ้น

ให้สิทธิ์ผู้ใช้โดยตรง

ใช้ฟีเจอร์ลงชื่อเข้าใช้ด้วย Google เพื่อตรวจสอบสถานะการลงชื่อเข้าใช้ของผู้ใช้ และลงชื่อเข้าใช้หรือออกจากระบบของผู้ใช้ตามต้องการ ตัวอย่างเช่น ตัวอย่างต่อไปนี้จะตรวจสอบสถานะ isSignedIn เพื่อติดตามการเปลี่ยนแปลงการลงชื่อเข้าใช้ และใช้เมธอด GoogleAuth.signIn() เพื่อเริ่มการลงชื่อเข้าใช้จากการคลิกปุ่ม

serving/widget/public/with_signin/app.js
// Handle sign-in/sign-out.
let auth = gapi.auth2.getAuthInstance();

// Watch for sign in status changes to update the UI appropriately.
let onSignInChanged = (isSignedIn) => {
  // Update UI to switch between signed in/out states
  // ...
}
auth.isSignedIn.listen(onSignInChanged);
onSignInChanged(auth.isSignedIn.get()); // Trigger with current status.

// Connect sign-in/sign-out buttons.
document.getElementById("sign-in").onclick = function(e) {
  auth.signIn();
};
document.getElementById("sign-out").onclick = function(e) {
  auth.signOut();
};

โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อลงชื่อเข้าใช้ด้วย Google

ลงชื่อเข้าใช้ผู้ใช้โดยอัตโนมัติ

คุณเพิ่มประสิทธิภาพการลงชื่อเข้าใช้ให้ดียิ่งขึ้นได้ด้วยการให้สิทธิ์แอปพลิเคชันล่วงหน้าในนามของผู้ใช้ในองค์กร เทคนิคนี้ยังมีประโยชน์ในกรณีที่ใช้ Cloud Identity-Aware Proxy เพื่อปกป้องแอปพลิเคชันด้วย

ดูข้อมูลเพิ่มเติมได้ที่หัวข้อใช้ Google Sign-In กับแอปไอที

ปรับแต่งอินเทอร์เฟซ

คุณเปลี่ยนลักษณะที่ปรากฏของอินเทอร์เฟซการค้นหาได้โดยใช้เทคนิคต่อไปนี้ร่วมกัน

  • ลบล้างสไตล์ด้วย CSS
  • ตกแต่งองค์ประกอบด้วยอะแดปเตอร์
  • สร้างองค์ประกอบที่กําหนดเองด้วยอะแดปเตอร์

ลบล้างสไตล์ด้วย CSS

วิดเจ็ตการค้นหามาพร้อมกับ CSS ของตัวเองสำหรับจัดสไตล์คำแนะนำและองค์ประกอบผลการค้นหา รวมถึงการควบคุมการแบ่งหน้า คุณจัดสไตล์องค์ประกอบเหล่านี้ใหม่ได้ตามต้องการ

ในระหว่างการโหลด วิดเจ็ตการค้นหาจะโหลดสไตล์ชีตเริ่มต้นแบบไดนามิก ซึ่งจะเกิดขึ้นหลังจากโหลดสไตลชีตแอปพลิเคชัน ซึ่งจะเพิ่มลําดับความสําคัญของกฎ หากต้องการให้สไตล์ของคุณมีลําดับความสําคัญเหนือกว่าสไตล์เริ่มต้น ให้ใช้ตัวเลือกบรรพบุรุษเพื่อเพิ่มความเฉพาะเจาะจงของกฎเริ่มต้น

ตัวอย่างเช่น กฎต่อไปนี้จะไม่มีผลหากโหลดในแท็ก link หรือ style แบบคงที่ในเอกสาร

.cloudsearch_suggestion_container {
  font-size: 14px;
}

แต่ให้ระบุกฎด้วยรหัสหรือคลาสของคอนเทนเนอร์หลักที่ประกาศไว้ในหน้าแทน

#suggestions_anchor .cloudsearch_suggestion_container {
  font-size: 14px;
}

ดูรายการคลาสที่รองรับและตัวอย่าง HTML ที่วิดเจ็ตสร้างขึ้นได้ที่ข้อมูลอ้างอิงคลาส CSS ที่รองรับ

ตกแต่งองค์ประกอบด้วยอะแดปเตอร์

หากต้องการตกแต่งองค์ประกอบก่อนการแสดงผล ให้สร้างและลงทะเบียนอะแดปเตอร์ที่ใช้วิธีการตกแต่งอย่างใดอย่างหนึ่ง เช่น decorateSuggestionElement หรือ decorateSearchResultElement.

เช่น ตัวแปลงต่อไปนี้จะเพิ่มคลาสที่กำหนดเองลงในองค์ประกอบคำแนะนำและผลการค้นหา

serving/widget/public/with_decorated_element/app.js
/**
 * Search box adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.decorateSuggestionElement = function(element) {
  element.classList.add('my-suggestion');
}

/**
 * Results container adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.decorateSearchResultElement = function(element) {
  element.classList.add('my-result');
}

หากต้องการลงทะเบียนอะแดปเตอร์เมื่อเริ่มต้นวิดเจ็ต ให้ใช้setAdapter()วิธีของคลาส Builder ที่เกี่ยวข้อง ดังนี้

serving/widget/public/with_decorated_element/app.js
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

การตกแต่งอาจแก้ไขแอตทริบิวต์ขององค์ประกอบคอนเทนเนอร์และองค์ประกอบย่อยได้ อาจมีการเพิ่มหรือนำองค์ประกอบย่อยออกในระหว่างการตกแต่ง อย่างไรก็ตาม หากทำการเปลี่ยนแปลงโครงสร้างขององค์ประกอบ ให้พิจารณาสร้างองค์ประกอบโดยตรงแทนการตกแต่ง

สร้างองค์ประกอบที่กําหนดเองด้วยอะแดปเตอร์

หากต้องการสร้างองค์ประกอบที่กำหนดเองสำหรับคำแนะนำ คอนเทนเนอร์แง่มุม หรือผลการค้นหา ให้สร้างและลงทะเบียนอะแดปเตอร์ที่ใช้ createSuggestionElement, createFacetResultElement หรือ createSearchResultElement ตามลำดับ

ตัวแปลงต่อไปนี้แสดงการสร้างองค์ประกอบคำแนะนำและผลการค้นหาที่กําหนดเองโดยใช้แท็ก HTML <template>

serving/widget/public/with_custom_element/app.js
/**
 * Search box adapter that overrides creation of suggestion elements.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.createSuggestionElement = function(suggestion) {
  let template = document.querySelector('#suggestion_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.suggested_query').textContent = suggestion.suggestedQuery;
  return fragment.firstElementChild;
}

/**
 * Results container adapter that overrides creation of result elements.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.createSearchResultElement = function(result) {
  let template = document.querySelector('#result_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.title').textContent = result.title;
  fragment.querySelector('.title').href = result.url;
  let snippetText = result.snippet != null ?
    result.snippet.snippet : '';
  fragment.querySelector('.query_snippet').innerHTML = snippetText;
  return fragment.firstElementChild;
}

หากต้องการลงทะเบียนอะแดปเตอร์เมื่อเริ่มต้นวิดเจ็ต ให้ใช้setAdapter()วิธีของคลาส Builder ที่เกี่ยวข้อง ดังนี้

serving/widget/public/with_custom_element/app.js
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

การสร้างองค์ประกอบแง่มุมที่กําหนดเองด้วย createFacetResultElement มีข้อจํากัดหลายประการ ดังนี้

  • คุณต้องแนบคลาส CSS cloudsearch_facet_bucket_clickable กับองค์ประกอบที่ผู้ใช้คลิกเพื่อสลับที่เก็บข้อมูล
  • คุณต้องตัดบัケットแต่ละรายการไว้ในองค์ประกอบที่รองรับซึ่งมีคลาส CSS cloudsearch_facet_bucket_container
  • คุณไม่สามารถแสดงผลที่เก็บข้อมูลในลำดับอื่นนอกเหนือจากที่ปรากฏในการตอบกลับ

ตัวอย่างเช่น ข้อมูลโค้ดต่อไปนี้จะแสดงผลแง่มุมโดยใช้ลิงก์แทนช่องทําเครื่องหมาย

serving/widget/public/with_custom_facet/app.js
/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}

ResultsContainerAdapter.prototype.createFacetResultElement = function(result) {
  // container for the facet
  var container = document.createElement('div');

  // Add a label describing the facet (operator/property)
  var label = document.createElement('div')
  label.classList.add('facet_label');
  label.textContent = result.operatorName;
  container.appendChild(label);

  // Add each bucket
  for(var i in result.buckets) {
    var bucket = document.createElement('div');
    bucket.classList.add('cloudsearch_facet_bucket_container');

    // Extract & render value from structured value
    // Note: implementation of renderValue() not shown
    var bucketValue = this.renderValue(result.buckets[i].value)
    var link = document.createElement('a');
    link.classList.add('cloudsearch_facet_bucket_clickable');
    link.textContent = bucketValue;
    bucket.appendChild(link);
    container.appendChild(bucket);
  }
  return container;
}

// Renders a value for user display
ResultsContainerAdapter.prototype.renderValue = function(value) {
  // ...
}

ปรับแต่งลักษณะการทํางานของการค้นหา

การตั้งค่าแอปพลิเคชันการค้นหาแสดงการกำหนดค่าเริ่มต้นสำหรับอินเทอร์เฟซการค้นหาและเป็นแบบคงที่ หากต้องการใช้ตัวกรองหรือข้อมูลประกอบแบบไดนามิก เช่น อนุญาตให้ผู้ใช้สลับแหล่งข้อมูล คุณสามารถลบล้างการตั้งค่าแอปพลิเคชันการค้นหาได้โดยขัดขวางคำขอการค้นหาด้วยอะแดปเตอร์

ใช้อะแดปเตอร์ที่มีวิธี interceptSearchRequest เพื่อแก้ไขคําขอที่ส่งไปยัง Search API ก่อนการดําเนินการ

ตัวอย่างเช่น ตัวแปลงต่อไปนี้จะขัดขวางคําขอเพื่อจํากัดการค้นหาแหล่งที่มาที่ผู้ใช้เลือก

serving/widget/public/with_request_interceptor/app.js
/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}
ResultsContainerAdapter.prototype.interceptSearchRequest = function(request) {
  if (!this.selectedSource || this.selectedSource == 'ALL') {
    // Everything selected, fall back to sources defined in the search
    // application.
    request.dataSourceRestrictions = null;
  } else {
    // Restrict to a single selected source.
    request.dataSourceRestrictions = [
      {
        source: {
          predefinedSource: this.selectedSource
        }
      }
    ];
  }
  return request;
}

หากต้องการลงทะเบียนอะแดปเตอร์เมื่อเริ่มต้นวิดเจ็ต ให้ใช้วิธี setAdapter() เมื่อสร้าง ResultsContainer

serving/widget/public/with_request_interceptor/app.js
var resultsContainerAdapter = new ResultsContainerAdapter();
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(resultsContainerAdapter)
  // ...
  .build();

HTML ต่อไปนี้ใช้เพื่อแสดงช่องทําเครื่องหมายสําหรับกรองตามแหล่งที่มา

serving/widget/public/with_request_interceptor/index.html
<div>
  <span>Source</span>
  <select id="sources">
    <option value="ALL">All</option>
    <option value="GOOGLE_GMAIL">Gmail</option>
    <option value="GOOGLE_DRIVE">Drive</option>
    <option value="GOOGLE_SITES">Sites</option>
    <option value="GOOGLE_GROUPS">Groups</option>
    <option value="GOOGLE_CALENDAR">Calendar</option>
    <option value="GOOGLE_KEEP">Keep</option>
  </select>
</div>

โค้ดต่อไปนี้จะคอยฟังการเปลี่ยนแปลง ตั้งค่าการเลือก และเรียกใช้การค้นหาอีกครั้งหากจําเป็น

serving/widget/public/with_request_interceptor/app.js
// Handle source selection
document.getElementById('sources').onchange = (e) => {
  resultsContainerAdapter.selectedSource = e.target.value;
  let request = resultsContainer.getCurrentRequest();
  if (request.query) {
    // Re-execute if there's a valid query. The source selection
    // will be applied in the interceptor.
    resultsContainer.resetState();
    resultsContainer.executeRequest(request);
  }
}

นอกจากนี้ คุณยังขัดขวางการตอบกลับการค้นหาได้โดยการใช้ interceptSearchResponse ในอะแดปเตอร์

ปักหมุดเวอร์ชัน API

โดยค่าเริ่มต้น วิดเจ็ตจะใช้ API เวอร์ชันล่าสุดที่เสถียร หากต้องการใช้เวอร์ชันที่เจาะจง ให้ตั้งค่าพารามิเตอร์การกําหนดค่า cloudsearch.config/apiVersion เป็นเวอร์ชันที่ต้องการก่อนเริ่มต้นวิดเจ็ต

serving/widget/public/basic/app.js
gapi.config.update('cloudsearch.config/apiVersion', 'v1');

เวอร์ชัน API จะเริ่มต้นที่ 1.0 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็นค่าที่ไม่ถูกต้อง

ปักหมุดเวอร์ชันวิดเจ็ต

หากต้องการหลีกเลี่ยงการเปลี่ยนแปลงอินเทอร์เฟซการค้นหาที่ไม่คาดคิด ให้ตั้งค่าพารามิเตอร์การกําหนดค่า cloudsearch.config/clientVersion ดังที่แสดง

gapi.config.update('cloudsearch.config/clientVersion', 1.1);

เวอร์ชันวิดเจ็ตจะเป็น 1.0 โดยค่าเริ่มต้นหากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็นค่าที่ไม่ถูกต้อง

รักษาความปลอดภัยให้อินเทอร์เฟซการค้นหา

ผลการค้นหามีข้อมูลที่ละเอียดอ่อนสูง ทำตามแนวทางปฏิบัติแนะนำเพื่อรักษาความปลอดภัยให้กับเว็บแอปพลิเคชัน โดยเฉพาะการป้องกันการโจมตีด้วยคลิกแจ็กกิ้ง

ดูข้อมูลเพิ่มเติมได้ที่ OWASP Guide Project

เปิดใช้การแก้ไขข้อบกพร่อง

ใช้ interceptSearchRequest เพื่อเปิดการแก้ไขข้อบกพร่องสำหรับวิดเจ็ตการค้นหา เช่น

  if (!request.requestOptions) {
  // Make sure requestOptions is populated
  request.requestOptions = {};
  }
  // Enable debugging
  request.requestOptions.debugOptions = {enableDebugging: true}

  return request;