- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- ListUserProcessesFilter
- इसे आज़माएं!
किसी उपयोगकर्ता ने जो प्रोसेस शुरू की है या उसकी ओर से कौनसी प्रोसेस की गई है उसकी जानकारी दें. जैसे, प्रोसेस का टाइप और मौजूदा स्थिति.
एचटीटीपी अनुरोध
GET https://script.googleapis.com/v1/processes
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
userProcessFilter |
सूची के नतीजों को सीमित करने के लिए इस्तेमाल किया जाने वाला फ़िल्टर; सिर्फ़ फ़िल्टर करने की शर्तों से मेल खाने वाली प्रोसेस ही दिखाई जाती हैं. |
pageSize |
नतीजों के हर पेज पर दिखाई जाने वाली प्रक्रियाओं की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट तौर पर, यह 50 पर सेट होता है. |
pageToken |
अगले पेज पर, सूची के पिछले अनुरोध को जारी रखने के लिए टोकन. इसे पिछले जवाब की वैल्यू के तौर पर, |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
Process
संसाधनों की सूची की मदद से जवाब दें.
JSON के काेड में दिखाना |
---|
{
"processes": [
{
object ( |
फ़ील्ड | |
---|---|
processes[] |
अनुरोध के पैरामीटर से मिलती-जुलती प्रोसेस की सूची. |
nextPageToken |
नतीजों के अगले पेज के लिए टोकन. अगर खाली है, तो और पेज नहीं बचे हैं. |
अनुमति पाने के लिंक
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/script.processes
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.
ListUserProcessesFilter
फ़िल्टर का इस्तेमाल, यह तय करने के लिए किया जाता है कि किन प्रोसेस को लिस्ट करना है. सिर्फ़ तय की गई शर्तों से मेल खाने वाली प्रोसेस ही दिखाई जाती हैं.
JSON के काेड में दिखाना |
---|
{ "scriptId": string, "deploymentId": string, "projectName": string, "functionName": string, "startTime": string, "endTime": string, "types": [ enum ( |
फ़ील्ड | |
---|---|
scriptId |
इस फ़ील्ड का इस्तेमाल, किसी खास स्क्रिप्ट आईडी वाले प्रोजेक्ट से शुरू होने वाली प्रोसेस को सीमित करने के लिए किया जाता है. हालांकि, इस फ़ील्ड का इस्तेमाल करना ज़रूरी नहीं है. |
deploymentId |
इस फ़ील्ड का इस्तेमाल, किसी खास डिप्लॉयमेंट आईडी वाले प्रोजेक्ट से शुरू होने वाली प्रोसेस को सीमित करने के लिए किया जाता है. हालांकि, इस फ़ील्ड का इस्तेमाल करना ज़रूरी नहीं है. |
projectName |
इस फ़ील्ड का इस्तेमाल करके, सिर्फ़ उन प्रोजेक्ट की प्रोसेस को सीमित किया जा सकता है जो किसी खास स्ट्रिंग वाले प्रोजेक्ट के नाम से शुरू होती हैं. |
functionName |
यह फ़ील्ड ज़रूरी नहीं है. इसका इस्तेमाल, दिए गए फ़ंक्शन के नाम के साथ स्क्रिप्ट फ़ंक्शन से शुरू होने वाली प्रोसेस को सीमित करने के लिए किया जाता है. |
startTime |
वैकल्पिक फ़ील्ड, लौटाए गए उन प्रोसेस को सीमित करता है जो दिए गए टाइमस्टैंप पर या उसके बाद शुरू हुई थीं. आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: |
endTime |
यह फ़ील्ड ज़रूरी नहीं है. इसका इस्तेमाल, लौटाए गए उन प्रोसेस को सीमित करने के लिए किया जाता है जो दिए गए टाइमस्टैंप पर या उससे पहले पूरी हुई थीं. आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: |
types[] |
वैकल्पिक फ़ील्ड, लौटाए गए प्रोसेस को उन प्रोसेस तक सीमित करता है जिनमें कोई एक प्रोसेस टाइप हो. |
statuses[] |
वैकल्पिक फ़ील्ड, जिसका इस्तेमाल लौटाए जाने वाले प्रोसेस को उन प्रोसेस तक सीमित करने के लिए किया जाता है जिनकी प्रोसेस की खास स्थितियों में से कोई एक हो. |
userAccessLevels[] |
वैकल्पिक फ़ील्ड, लौटाए गए प्रोसेस को सिर्फ़ उन प्रोसेस को सीमित करने के लिए इस्तेमाल किया जाता है जिनके पास कोई खास उपयोगकर्ता ऐक्सेस लेवल होता है. |