Skip to content

Api

Jump to bottom
HURDOO edited this page Feb 21, 2022 · 1 revision

Every requests are GET, https://script.google.com/macros/s/**SCRIPT_KEY**/exec

Get Form List

Request

?type=getformlist

Key Value
type getformlist

Response

Json array that contains form data.

Type Key Value
String name name code of the form
String title form title to display to user
String description form description to display to user

Example Response:

[
    {
        "name":"en",
        "title":"English Sample",
        "description":"Check English Sample!"
    },
    {
        "name":"kr",
        "title":"한국어 예시",
        "description":""Check Korean Sample!"
    }
]

Get Form Data

Request

?type=getform&form=FORM_NAME

Key Value
type getform
form name code of the form, received at getformlist response.

Example Request:

https://script.google.com/macros/s/AKfycbz0xDE1DSaDKKl6AvzP6qLoEUFolnYlgo_tEpBb-LVVwYqoHXy2pDe-weEF7dSYeJb4/exec?type=getform&form=en

Response

Json Object that contains form data & submit token

Key Value Optional
title title of the form document
description description of form document Optional
items Json Array that contains form items, check below for more information
token token that will be used to submit form (Token expires after 10 minutes default. You may set this time via library__setCacheExpireTime() @TODO)

Example Response:

{
  "title": "English Sample",
  "description": "This is description! / Extform by HURDOO\n*Also* __supports__ ~~some~~ **MARKDOWN**!",
  "items": [
    // form items
  ],
  "token": "a4907236-b8e9-4ef4-881e-fb260d1cefc5"
}

Form Item

{
  "title": "English Sample",
  "description": "This is description! / Extform by HURDOO\n*Also* __supports__ ~~some~~ **MARKDOWN**!",
  "items": [
    {
      "title": "This is Section Header",
      "helpText": "This is also description",
      "id": 1198406534,
      "type": "SECTION_HEADER",
      "extra": {}
    },
    {
      "title": "Multiple choice",
      "helpText": "",
      "id": 984420844,
      "type": "MULTIPLE_CHOICE",
      "extra": {
        "choices": [
          {
            "value": "Option 1"
          },
          {
            "value": "Option 2"
          },
          {
            "value": "Option 3"
          }
        ],
        "hasOtherOption": true,
        "required": true
      }
    },
    {
      "title": "Checkboxes",
      "helpText": "",
      "id": 527425354,
      "type": "CHECKBOX",
      "extra": {
        "choices": [
          {
            "value": "Option 1"
          },
          {
            "value": "Option 2"
          },
          {
            "value": "Option 3"
          }
        ],
        "hasOtherOption": true,
        "required": false
      }
    },
    {
      "title": "Dropdown",
      "helpText": "This is description",
      "id": 1754718226,
      "type": "LIST",
      "extra": {
        "choices": [
          {
            "value": "Option 1"
          },
          {
            "value": "Option 2"
          },
          {
            "value": "Option 3"
          }
        ],
        "required": true
      }
    },
    {
      "title": "Short answer",
      "helpText": "",
      "id": 2042360110,
      "type": "TEXT",
      "extra": {
        "required": true
      }
    },
    {
      "title": "Paragraph",
      "helpText": "",
      "id": 40010923,
      "type": "PARAGRAPH_TEXT",
      "extra": {
        "required": true
      }
    },
    {
      "title": "Linear scale",
      "helpText": "",
      "id": 1729172976,
      "type": "SCALE",
      "extra": {
        "leftLabel": "Left label",
        "rightLabel": "Right label",
        "lowerBound": 1,
        "upperBound": 5,
        "required": true
      }
    },
    {
      "title": "Multiple choice grid",
      "helpText": "",
      "id": 1747983985,
      "type": "GRID",
      "extra": {
        "rows": [
          "Row 1",
          "Row 2",
          "Row 3"
        ],
        "columns": [
          "Column 1",
          "Column 2",
          "Column 3",
          "Column 4"
        ],
        "required": true
      }
    },
    {
      "title": "Checkbox grid",
      "helpText": "",
      "id": 1505186486,
      "type": "CHECKBOX_GRID",
      "extra": {
        "rows": [
          "Row 1",
          "Row 2",
          "Row 3",
          "Row 4"
        ],
        "columns": [
          "Column 1",
          "Column 2",
          "Column 3"
        ],
        "required": false
      }
    },
    {
      "title": "Date",
      "helpText": "",
      "id": 1863290637,
      "type": "DATE",
      "extra": {
        "includesYear": true,
        "required": true
      }
    },
    {
      "title": "Date (+Time)",
      "helpText": "",
      "id": 1912205331,
      "type": "DATETIME",
      "extra": {
        "includesYear": true,
        "required": true
      }
    },
    {
      "title": "Time",
      "helpText": "",
      "id": 1172953185,
      "type": "TIME",
      "extra": {
        "required": true
      }
    },
    {
      "title": "Time (Duration)",
      "helpText": "",
      "id": 1268965762,
      "type": "DURATION",
      "extra": {
        "required": true
      }
    },
    {
      "title": "Title",
      "helpText": "Description",
      "id": 1362699492,
      "type": "SECTION_HEADER",
      "extra": {}
    },
    {
      "title": "Image",
      "helpText": "",
      "id": 1845279172,
      "type": "IMAGE",
      "extra": {
        "image": "iVBORw0KGgoAAAANSUhEUgAAAOYAAABGCAYAAADYduhVAAANTUlEQVR4Xu2dzY4ctxHH9Qj7CGPkBfYRJgFyF2AgpxzmYOSSiw7OxacBdFCOtg/K0QJiOAb8AQlBLhaiLJzIEuJIsGBJsfzRtixlI63Xu15J+70S0//ZYodTVT3N7uZMz0hF4Gd5OWQVm+SfTfawOSeccycMw5gvRIRhGN0jIgzD6B4RYRhG94gIwzC6R0QYhtE9IsIwjO4REYZKP+dUTk/5rC79nOEU6OcsOenPWEBEhAIau+9kR2jDwEk/c8kP6+tv/LixcfjRxYvu4PBw1zXv/Ms5n+W4u99/f+uTK1cupuLOl1/+6+Ha2jew7Y7rl/s2FgwRwRgcHBzs3bx5y7117lwyYG97ZwcdifubO/Jybvzq5ZfzmjrhIE53fOcU6ao4Ojr6/PLlT9Z/+Yufj2xNA5Tz8PBwJ/d3kvs3FgsREbC8nwffKVOzt79/4NJMDadNUWYMKq7ZHWn58ZMnW7wOpsEHH36IO/ttpQzGAiEiPLu7u39AI/OGT8ULJsxBPktY43UwDTCQUuBlMBYIEeHZevToxm9eeaVo8N+9+qqYkjZlkaayDv+hOkDZXTNhDpGXi2ga/Oyll1BGBF4GY4EQEZ5QmFgX7ezurjv5EKcpA6f4nFOKTr8IwoSfvO1WlDIYC4SI8ITCxL/4m6d5QRjr9G6OhXn69Gm3t7d36I6fovMyGAuEiPCYMAuKjj9tYWKK3xQEPEF+uLb2a8W/sWCICI8Js2BmwqTQb0jPSb/GgiIiPCbMglkLk+c1XkBEhMeEWWDCNGaOiPCYMAtMmMbMEREeE2aBCdOYOSLCY8IsWGRhLu3t7d1xMwrbOzu/d7IMRgNEhOc5FGZPiYthkYV5amd39+m09juHvPHmm45CTymHURMR4elKmBh18XrV5uYmvpzDq1IiTU2WyZb7cWPjz8rnVRSdbwGFGeU3Ff998OCRm7y5AZ8N3PHbLz3lc4DPhjnnc1YUXqc0PF8I+k2f0PoQXt3zfrxdAJ+Iw2dIw/NpwD7eOEK5NFsDV36tpYgIT0fC7G/+9NMutgBiBD46Otp28RWkMZrKYTM+9pB+8cWd3Y3Nzd/SZ313XHFVFB2PhLmipOH0kS0gSiAUwnxtifKbiiz7dsPJawfLeOMFGyBu3ry1hnQYfOktGLQvGD59+vRxPng+/OulS3exiwn9jvOnd9/dgJ28b/yD8o35QTxs37t3fxVQ2s+DtMMch8/ee//9VewB97bh8/yFC9/gM6Rxx+LSrgechF28Znft2vVvUa6wnKEtpKEyQMC8zCoiwtOFMHNRvhV2pH9++ulBXrF4CVKkjWF/f/8diNHbQ2XhOnBXxsvP8BWDz4964J9p5OLfz/28FpQlSiAUxHW0IMpvKjJdmD10zLNnz27z9GjfvJ5W8k57H3lj31XFIEt352HgZxnC1vx8/PHfH6EfQRwP19Y2Y/zAB8RGL8efc/8XFP49D8GfOXPmCc9XBgYAiPTZs2coN+7IvK3GEBGeLoSZcxKdOqycra0t3DUx0vC0VQzwahlseHsQKQSTDwCr01x3UX3dC8oSJRAK/DraEOU3FZkiTAgiv3Ps8bQAbfOf1VVVtFWgoz/Z3r7m/eQC+ssf3367GIRD4AczMYg57A8xID2ui+54Pfz72Y0bm3XteNA3ArHz9ioQEZ6OhIkKvh2+BxpcCObyIn0JmDrt+vIDdFB6Qrk0C2HCR1CeKIFQWGmINk2K8puKTBEm2mHSHapNB2d9cqItCHlSOarA6RPwgX/5Z3VBOX9YX4e9c6y9CkSEhwsznxY+cHIt1ZSBU3wSvUmiUtJzRuvKsEMGLw+PxD2vU1nYbwKm6N99d3eNraWi/aYiU4SJSufpUoDr5sLkaVLjn1Xw+CYE4hyy+hohIjyhMDHS8M7XBrwNUfGitDoNxakKStox+LpywnS47+SAoVGUAWV3U3z40xZMsdz4KDwTv55shsLE+pT1B5Fm3gluGD1WZyfG/ggJhTkNqo4WwZrh2vXrxeIagwPOIHKTF85C0LABW0raWApbJMyhkqaKmQgkOIxrpn49WWJhos212cHt2/8+pDV8ODsQ+asI7ae4E3pbdabMly79Dd36HVZnJ3gHKuhamDlLmD7jaxOfB+uECV+hiCkw8ubT2rWS9LEU9uZdmOhcFGbq15MlECaEh2UG8qE9cSxnSP7ZZfrKi7epsFUG+gWWG94+PQ8Y3YXriApgMEQ+5Icd2MPJkrgG9FeengN/FMauh3eggo6nsp5lXGT4oAYjTC7qqzyt/74yrDAKdR4aaRQ2UXY3x8JEp8aZtbP268laCBODyr1793H3wLOMgVKHVQibGugjdLfts/xLjx4//iCfHh/FihN9DOlpKyIfKAYQPtqE5+Nkx/U2CPPziyvo8OEPZ4hH6n6qgX/xN9kZpcFaA43qLxRpMCI6ua5sQlGB8y5MTPGCDRQz8+vJWggz5ZKjDAiOnvD3lPwj0JdQjzyvBp5lVOwPxk2hcmpL/er1MC83VMCFOauvSzRwhwy/C2N3w5OYFocXX3ZXbQivwKGSpooogfD1VCyYMmE6RevLhXsqi7sKzaD4XacOwi4HdYG7opI3BGWoFBP6IB1Qx/OPAX/hckxD05cw5JknYTraPRLO2XGxeU9cxZozjEcjT1iHNqGwPW1hIvA1VQzYC1wynYrym4qsoTC/+urrqN0wFQi7nFg/Mc9X0P8iRA4G4bcEGpq+uBG1cFrGDhjdGflXKPxOijWpk52jDYW/WQhTyduGKL+pyBoKkwIfVOoi7HIyvXyCGGHW6Av9LPfL84do+uJGCuZQmOp3lOH/87VnIpo0BidKIBR43jZE+U1Fpnd8kY5DgZe9LsIuJ9PLJzBh1mcJ01dtzo47Z8J1ZUiTxuBECYQCz9uGKL+pyPSOL9JxKPCy10XY5WR6+QQmzGb0c8YW58HDoLbTIY0mjcGJEggFnrcNUX5TkekdX6TjUOBlr4uwy8n08glMmA3A2wp4AskvjqaxY4+cE9GkMThRAqHA87Yhym8qMr3ji3QcCrzsdRF2OZlePoEJsz6n8P2ktn1q9B3V8YOfyqduNWnSGJwogVDgedsQ5TcGLB9gaxJ4tcrJji9scSjwstdF2OVkJsypMPqyNtwFhMoJd1YEW/Z6Sv6mNGkMTpRAKPC8bYjyW0Vwng9mJMMKem68DMIeh0KYpwnCLiczYSZHPPRBmbCLg2/ZO3/hwt5B2h9ubdIYnCiBUOB52xDltwr6/m/oxs/SKYOv84U9DoUwTxOEXU5mwkwLf9MEU1naBD/IGduyBxKvN5s0BidKIBR43jZE+a0iow6NEwNwCgD+1nDHoR/4B8IehwIve12EXU5mwkzKKbxPyTcWhK/K4GsSbMPznydebzZpDE6UQCjwvG2I8ltFRh16UodFfMkWNZGWQ4Hnq4uwy8lMmMlQ15XKaQZLWFtOab3ZpDE4UQKhwPO2IcpvFVmFMNE+9K7sQCmDSM+hwPPVRdjlZCbMJJSuK53+Kld/SuvNJo3BiRIIBZ63DVF+q8gmCDNix5Wwx6HA89VF2OVkJsz2aNvvgnWlSE9MY73ZpDE4UQKhwPO2IcpvFVmJML0otTfwA4Q9DgWery7CLid73oSJNRutH4YJOeXkEzyPOCKEryvLmMJ6s0ljcKIEQoHnbUOU3yqyEmGiniNmJMIehwLPVxdhl5M9b8IEWLOhMKn46OJFf+wH9z3x6EklPSf1erNJY3AG2m6lkOAlXp63DVMT5uid17g2EfY4FHi+ugi7HBqge0reMXjf16jRF9IKE29yh0d1TAM6ZSBcL4qjJ1HoCevKMtT1ZsNN7oWNGo3BWcauGH79IRg86DdWeN42DDEAcl91yZgwMejRS9k9xSdH2AuBvZIBui7CNocCzyfAts+qI0Fq9IU+vmLi+UNqCTNnGU/aws6dGi7MvHCvNVhXliHWm+Svli0che/rAJ3cNTyuBB150ihMPxcQnkWbgkHOaOcOfDfF/1gQOs+Vq1e9KKMGyqrrRgePfOF4IlV+IDS6w4u8CsNwOaRBzy4GSl4OZhQTT0TQXrrmRjgDGMXhWXwq2hZtKouGD0eq2HVlGXy9iQrIfazwdJPA76ngxDOUt+q8mAoG+fUeagMdZiYJTvMrY4h6bQP9FMEyZlH0i2k9xU8ZYoD0JH6xvdQPREH7eAdKPo3RiYtaW4G6p2Sg3srKhjj6qqkf5hFGFOAcmYaJEQ9/cDwGDkJCYamzxqxhJjFab0KQaBwc2OXiGycED45Q3p7yWR2GaHDsYsLgNDqxbWtrG53fRd6BFhEMrhAgBkk/MOOHfmigG/L0TYEAYBO2uZ+Yw8IZA9yFcYh2eEPB3yTKgZKnlFEdaGXL60W7+QgDXUO3dL/eStFZi9/H5NOFjug52kpI9JU0zyNoy2FAioFOo+fS+cFNYeDG7eHvpjcLXgdA7eMiwjCM7hERhmF0j4gwDKN7RIRhGN0jIgzD6B4RYRhG94gIwzC6R0QYhtE9IsIwjO4REYZhdI+IMAyje0SEYRjdIyIMw+geEWEYRvf8D7R7b3MlwqaHAAAAAElFTkSuQmCC",
        "imageType": "image/png",
        "alignment": "CENTER"
      }
    }
  ],
  "token": "a4907236-b8e9-4ef4-881e-fb260d1cefc5"
}

extform

Clone this wiki locally