בניית פרמטרים "בהרכבה עצמית" לשימוש בשלוחת api. 📟

[יהודה צ. כ.]

שדרוג לשלוחת api וכן שלוחת הוספת ערך ID

שלום וברכה!
קרה לכם פעם שרציתם להוסיף הגדרה בשלוחת הוספת ערך id אבל לא רציתם שתצטרכו להקליד את ההגדרה כולה, אלא רק את החלק הרלוונטי לשינוי?
או מודול api שאתם קוראים בו בחזרה לימות המשיח לבצע הגדרה, אבל אתם רוצים שחלק מההגדרה תילקח מנתון קיים?
(לדוגמא Api phone או כל פרמטר שנשלח ביחד עם הבקשה)
או שהמשתמש יוכל להקיש רק חלק מהמפתח או הערך?
️

לדוגמא בשלוחת השמעת קבצים אתם מעוניינים לשנות את הגדרת

control_play9=go_to_folder

ואתם מעוניינים לשנות רק את ה 9,

עוד דוגמא

go_to_folder=/100/9

ואתם מעוניינים שהמשתמש יוכל לשנות את הערך אבל רק בתוך שלוחה 100 והלאה.
ועוד רבות הדוגמאות....

המודול בעצם מאפשר ליצור פרמטרים בשלוחת api (או בקריאות ישירות מהדפדפן) בחלקים לפי בחירתכם.️

לטובת הכלל אני משתף כתובת פריסה של סקריפט (ב apps script) הקוד מיועד לקבל כתובת לשליחת הבקשה, וכן את הפרמטרים לשליחה.️

הקוד בעצם מקבל את הכתובת לשליחת הבקשה (כערך של פרמטר) וכן את כלל הפרמטרים הרצויים.

הפרמטר שמיועד לכתובת של הבקשה נקרא g
לדוגמא

g=https://www.call2all.co.il/ym/api/DounloadFile

(חובה לצרף https://)

כמו כן ניתן לצרף פרמטרים כרצונכם.

עכשיו מגיעים אל העיקר,
כדי לבנות פרמטרים בהתאמה אישית, אתם צריכים לשלוח את המפתח + הערך תחת ערך של פרמטרים,
בשם
parameter_

לאחר הקידומת הזו, הקוד ידע לזהות שאתם רוצים להוסיף פרמטר שאותו הוא יצטרך להרכיב.

לאחר ה
parameter_
ישנם כמה ערכים שצריך למלאות, כדי שהקוד ידע איפה הוא צריך להכניס את הערך של הפרמטר.

דוגמא לפרמטרים שנשלחים לקוד

parameter_Aa1=a&parameter_Ab1=b

האפשרויות הם A-Z גדולות ומייד לאחר מכן a/b (או a או b בלבד) קטנות ולאחר מכן מספר החל מ 1 והלאה.
ככה זה אמור להיראות
psrameter_Aa1
עכשיו להסבר
הערך הראשון מייצג את מספר הפרמטר לבנייה.
לדוגמא פרמטר ראשון תוסיפו A/B וכו' באותיות גדולות.
הערך השני מייצג האם מדובר בחלק של לפני השווה או שלאחר השווה, יש להכניס a או b קטנות בלבד.
הערך השלישי מייצג את מספר החלק להכנסה חלק 1 ייכנס ראשון חלק 2 שני וכו'
דוגמא מלאה לשימוש כשלוחת api

https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec?g=https://www.call2all.co.il/ym/api/UploadTextFile?x=f&k=p&parameter_Aa1=tok&parameter_Aa2=en&parameter_Ab1=h&parameter_Ab2=k&parameter_Ba1=path&parameter_Bb1=ivr2:/10/&parameter_Bb2=1&parameter_Ca1=x&parameter_Cb1=k

בדוגמא רואים את החלק
1.

https://script.google.com/macros/s/AKfycbwsz4VbnqxqF7zoOTqUpO6DivjUhUgqhK_bTxoLJ9Q1vKO1J6f1_iisfM0dPfDMFrOvZQ/exec

שהוא הקישור של הפריסה

לאחר מכן

g=https://www.call2all.co.il/ym/api/UploadTextFile

שזה פרמטר שהערך שלו הוא בעצם הכתובת אליה הסקריפט ישלח את הבקשה והיא -
"https://www.call2all.co.il/ym/api/UploadTextFile"

שימו לב !
אין להוסיף "?" לאחר הערך של g זה מתווסף לבד.

עכשיו מתחילים עם פרמטרים

לאחר מכן יש את הפרמטרים המצורפים

x=f&k=p

הפרמטרים האלו ישלחו כרגיל.
ניתן לבטל את שליחתם של פרמטרים שאינם עם קידומת parameter_ על ידי צירוף של parameter_setting2=no
(גם אם תשלחו את " parameter_setting2=no" הפעולה של השימוש בהם (יפורט בהמשך) עדיין תפעל על הפרמטרים האלו.

לאחר מכן מגיעים הפרמטרים "בהרכבה אישית"

parameter_Aa1=tok&parameter_Aa2=en&parameter_Ab1=h&parameter_Ab2=k

א.
parameter_Aa1=tok
כלומר:
בפרמטר הראשון, - (A) תוסיף בחלק שלפני השווה - (a) את מה שמופיע בערך שלהלן, ותוסיף אותו כחלק מספר 1 (1)
=tok.

לאחר מכן
parameter_Aa2=en
כלומר:
בפרמטר הראשון (A) תוסיף בחלק שלפני השווה (a) חלק לאחר החלק הראשון (2) =en

לאחר מכן
parameter_Ab1=h
כלומר:
בפרמטר הראשון (A) תוסיף בחלק שאחרי השווה (b) כהחלק הראשון (1) =h

לאחר מכן
parameter_Ab2=k
כלומר:
בפרמטר הראשון (A) בחלק שאחרי השווה (b) תוסיף את חלק 2 (2) =k

למעשה מה שישלח בסוף זה
token=hk

פרמטר 2:
מה שהבאתי בדוגמא זה:

parameter_Ba1=path&parameter_Bb1=ivr2:/10/&parameter_Bb2=1

כלומר מה שישלח זה
path=ivr2:/10/1

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

מה שהובא בדוגמא:

parameter_Ca1=x&parameter_Cb1=k

לכאורה מה שישלח אמור להיות
x=k
אבל מכיוון שצורפו לבקשה פרמטרים
x=f וכן k=p
לכן מה שישלח זה לא:
x=k
אלא
f=p
ניתן לבטל את האופציה כך שמה שישלח הוא בכל זאת x=k על ידי צירוף של

parameter_setting1=no

Spoiler

אם צירפתם לבקשה - "parameter_setting2=no" הפעולה עדיין תתבצע, למרות שהפרמטרים - "x" וכן "k" עצמם לא יישלחו

דוגמאות לשימוש במודול:

Spoiler

https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec?g=https://www.call2all.co.il/ym/api/UploadTextFile&a=aaaaaaaa&parameter_Aa1=token&parameter_Ab1=a&parameter_setting2=no

מה שישלח:
https://www.call2all.co.il/ym/api/UploadTextFile?token=aaaaaaaa

דוגמא 2:

https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec?g=https://www.call2all.co.il/ym/api/UploadTextFile&token=aaaaaaaa&parameter_Aa1=a&parameter_Ab1=token&parameter_setting1=no

מה שישלח:
https://www.call2all.co.il/ym/api/UploadTextFile?token=aaaaaaaa&a=token
דוגמא 3:

https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec?g=https://www.call2all.co.il/ym/api/UploadTextFile&token=aaaaaaaa&parameter_Aa1=a&parameter_Ab1=b

מה שישלח:
https://www.call2all.co.il/ym/api/UploadTextFile?token=aaaaaaaa&a=b

דוגמא לשימוש כשלוחה במערכת:

||

type=api
api_link=https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec
api_add_0=g=https://www.call2all.co.il/ym/api/UploadTextFile
api_add_1=token=aaaaaaaa
api_add_2=parameter_Aa1=token
api_add_3=parameter_Ab1=token
api_add_4=parameter_setting1=no

כמובן שניתן ומומלץ לשנות חלק מההגדרות לערכים שהמאזין יכניס בעצמו...||

לסיכום, המאפיינים העיקריים בשימוש:
הפרמטרים:

הפרמטר להכנסה	משמעות	אפשרויות אופציונליות	הערות
g	פרמטר שמור לכתובת המיועדת לשליחת הבקשה		אין להכניס "?" לאחר ה URL. חובה להכניס https://
parameter_	קידומת שהסקריפט מזהה וממיין את הערך.	[A - Z], [a / b], [1 - 100000]
A	באיזה פרמטר לבנייה מדובר.	A - Z גדולות	חייב להופיע אחרי parameter_
a	האם מדובר בחלק שלפני השווה או שלאחר השווה	a/b קטנות בלבד.	חייב להופיע אחרי האות הגדולה
1	לאיזה חלק במפתח או בפרמטר להכניס,	1 והלאה.	חייב להופיע אחרי a או b
setting1	שאם הוכנס ערך, שקיים פרמטר בשמו, שלא יתייחס לערך אלא ישלח כמות שהוא.	-----------	חייב להופיע אחרי parameter_
setting2	שלא ישלח פרמטרים שלא מתחילים ב parameter_	----------	חייב להופיע אחרי parameter_

הקישור לפריסה הוא:

https://script.google.com/macros/s/AKfycbzcPTMhwrRBGH3J8ZI1sdbGAX7dfvOeItuGNg2_hYzYpZQxDBURsseoK4avTXHs84KzlA/exec

תשובת השרת היא:
הבקשה המלאה שנשלחה + תשובת השרת.
שימו לב שאם אתם משתמשים במודול api התשובה לא תושמע, או תיוחס, כמיטב המסורת של apps script עם ימות המשיח.️

באם יהיה צורך בכך אני אשתף פה את הסקריפט המלא.

מקווה שתפיקו תועלת.
לתגובות, פידבקים, באגים, הערות, והארות, אפשר להיכנס לשרשור התגובות.