- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- VariableData
- ResourceData
- TextFormat
- TextFormatElement
- चिप
- आइकॉन
- StyledText
- स्टाइल
- FontWeight
- रंग
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- इसे आज़माएं!
Google को सूचना देता है कि कोई ट्रिगर इवेंट हुआ है.
एचटीटीपी अनुरोध
POST https://workspacestudio.googleapis.com/v1/{name=triggers/*}:fire
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
name |
ज़रूरी है. ट्रिगर का संसाधन नाम. फ़ॉर्मैट: triggers/{trigger_id} |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना |
|---|
{ "outputs": { string: { object ( |
| फ़ील्ड | |
|---|---|
outputs |
ज़रूरी नहीं. तीसरे पक्ष के ऐप्लिकेशन में ट्रिगर इवेंट से मिले आउटपुट वैरिएबल. एक ऑब्जेक्ट, जिसमें |
log |
ज़रूरी नहीं. ट्रिगर इवेंट के लिए, उपयोगकर्ता को दिखने वाला लॉग. यह लॉग देना ज़रूरी नहीं है. |
requestId |
ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आइडेंटिफ़ायर. इसमें 36 से ज़्यादा ASCII वर्ण इस्तेमाल नहीं किए जा सकते. हमारा सुझाव है कि आप रैंडम यूयूआईडी का इस्तेमाल करें. यह अनुरोध सिर्फ़ तब आइडेमपोटेंट होता है, जब |
जवाब का मुख्य भाग
अगर अनुरोध पूरा हो जाता है, तो जवाब का मुख्य हिस्सा खाली होता है.
अनुमति पाने के लिंक
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/workspace.studio.trigger
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
VariableData
यह वैरिएबल डेटा को दिखाता है. इसमें अलग-अलग टाइप की कई वैल्यू हो सकती हैं.
| JSON के काेड में दिखाना |
|---|
{
"booleanValues": [
boolean
],
"integerValues": [
string
],
"stringValues": [
string
],
"timestampValues": [
string
],
"resourceReferences": [
string
],
"resourceDataValues": [
{
object ( |
| फ़ील्ड | |
|---|---|
booleanValues[] |
बूलियन वैल्यू. |
integerValues[] |
पूर्णांक वैल्यू. |
stringValues[] |
स्ट्रिंग वैल्यू. |
timestampValues[] |
टाइमस्टैंप की वैल्यू. यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: |
resourceReferences[] |
संसाधन आईडी की सूची (जैसे, "spaces/123"). |
resourceDataValues[] |
संसाधन के डेटा की सूची. |
emailAddressValues[] |
ईमेल पते की वैल्यू. |
users[] |
Google उपयोगकर्ता की वैल्यू, |
ResourceData
ऐप्लिकेशन के हिसाब से संसाधन की वैल्यू.
| JSON के काेड में दिखाना |
|---|
{
"fields": {
string: {
object ( |
| फ़ील्ड | |
|---|---|
fields |
फ़ील्ड के नाम के हिसाब से संसाधन फ़ील्ड का मैप. एक ऑब्जेक्ट, जिसमें |
TextFormat
टेक्स्ट का एक ब्लॉक, जिसमें स्टाइल, हाइपरलिंक, और इंटरैक्टिव एलिमेंट जैसे रिच फ़ॉर्मैटिंग के विकल्प शामिल होते हैं.
| JSON के काेड में दिखाना |
|---|
{
"textFormatElements": [
{
object ( |
| फ़ील्ड | |
|---|---|
textFormatElements[] |
ज़रूरी नहीं. टेक्स्ट फ़ॉर्मैट के एलिमेंट का कलेक्शन. |
TextFormatElement
WorkflowTextFormatMarkup मैसेज में मौजूद एक एलिमेंट. यह कोई चिप, स्टाइल वाला टेक्स्ट, हाइपरलिंक या सूची कंटेनर हो सकता है.
| JSON के काेड में दिखाना |
|---|
{ "text": string, "chip": { object ( |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड element. यह एलिमेंट, टेक्स्ट फ़ॉर्मैट वाले कई एलिमेंट में से किसी एक को दिखाता है. element इनमें से सिर्फ़ एक हो सकता है: |
|
text |
टेक्स्ट फ़ॉर्मैट में टेक्स्ट. |
chip |
टेक्स्ट फ़ॉर्मैट में क्लिक की जा सकने वाली चिप. |
styledText |
टेक्स्ट फ़ॉर्मैट में स्टाइल किया गया टेक्स्ट. |
hyperlink |
टेक्स्ट फ़ॉर्मैट में हाइपरलिंक. |
listContainer |
टेक्स्ट फ़ॉर्मैट में सूची वाला कंटेनर. |
चिप
टेक्स्ट फ़ॉर्मैट में मौजूद, क्लिक की जा सकने वाली चिप.
| JSON के काेड में दिखाना |
|---|
{
"icon": {
object ( |
| फ़ील्ड | |
|---|---|
icon |
ज़रूरी नहीं. चिप में दिखने वाला आइकॉन. |
label |
ज़रूरी नहीं. चिप में दिखने वाला टेक्स्ट. |
url |
ज़रूरी नहीं. चिप पर क्लिक करने के बाद, जिस यूआरएल पर नेविगेट करना है. |
आइकॉन
चिप में मौजूद आइकॉन.
| JSON के काेड में दिखाना |
|---|
{ "iconUrl": string, "materialIcon": string } |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड icons. चिप में दिखने वाला आइकॉन. icons इनमें से सिर्फ़ एक हो सकता है: |
|
iconUrl |
एचटीटीपीएस यूआरएल पर होस्ट किया गया कस्टम आइकॉन दिखाएं. उदाहरण के लिए:
|
materialIcon |
Google Material Icon में तय किया गया आइकॉन का नाम. उदाहरण के लिए, |
StyledText
टेक्स्ट एलिमेंट, जिसमें बोल्ड, इटैलिक, और रंग जैसी स्टाइल शामिल हैं.
| JSON के काेड में दिखाना |
|---|
{ "text": string, "styles": [ enum ( |
| फ़ील्ड | |
|---|---|
text |
ज़रूरी नहीं. टेक्स्ट का मुख्य कॉन्टेंट. |
styles[] |
ज़रूरी नहीं. टेक्स्ट पर लागू की गई स्टाइल का कलेक्शन. |
fontWeight |
ज़रूरी नहीं. टेक्स्ट के फ़ॉन्ट की मोटाई. |
color |
ज़रूरी नहीं. टेक्स्ट का रंग. |
wrapStyle |
ज़रूरी नहीं. टेक्स्ट को रैप करने की स्टाइल. |
शैली
यह अलग-अलग टेक्स्ट स्टाइल के लिए Enum है. जैसे, इटैलिक, अंडरलाइन वगैरह.
| Enums | |
|---|---|
STYLE_UNSPECIFIED |
कोई स्टाइल लागू नहीं की गई. |
ITALIC |
इटैलिक स्टाइल. |
UNDERLINE |
अंडरलाइन स्टाइल. |
STRIKETHROUGH |
स्ट्राइकथ्रू स्टाइल. |
LINE_BREAK |
लाइन ब्रेक. |
UPPERCASE |
अपरकेस स्टाइल. |
CODE |
कोड. |
CODE_BLOCK |
कोड ब्लॉक. |
FontWeight
अलग-अलग फ़ॉन्ट वेट के लिए एनम.
| Enums | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
सामान्य मोटाई वाला स्टैंडर्ड वेट. |
LIGHT |
यह पहले से ज़्यादा हल्का और पतला है. |
MEDIUM |
यह फ़ॉन्ट, लाइट और बोल्ड के बीच का होता है. |
BOLD |
ज़्यादा मोटाई वाला भारी वज़न. |
रंग
यह RGBA कलर स्पेस में किसी रंग को दिखाता है. इस फ़ॉर्मैट को इस तरह से डिज़ाइन किया गया है कि इसे अलग-अलग भाषाओं में रंग के हिसाब से आसानी से बदला जा सके. उदाहरण के लिए, इस प्रज़ेंटेशन के फ़ील्ड को Java में java.awt.Color के कंस्ट्रक्टर को आसानी से दिया जा सकता है. साथ ही, इसे iOS में UIColor के +colorWithRed:green:blue:alpha तरीके को भी आसानी से दिया जा सकता है. इसके अलावा, इसे JavaScript में CSS rgba() स्ट्रिंग में आसानी से फ़ॉर्मैट किया जा सकता है.
इस रेफ़रंस पेज पर, आरजीबी वैल्यू को समझने के लिए इस्तेमाल किए जाने वाले ऐब्सलूट कलर स्पेस के बारे में जानकारी नहीं दी गई है. उदाहरण के लिए, sRGB, Adobe RGB, DCI-P3, और BT.2020. डिफ़ॉल्ट रूप से, ऐप्लिकेशन को sRGB कलर स्पेस का इस्तेमाल करना चाहिए.
जब रंग की समानता तय करनी होती है, तो लागू करने वाले लोग, दो रंगों को एक जैसा मानते हैं. हालांकि, ऐसा तब होता है, जब उनके लाल, हरे, नीले, और ऐल्फ़ा रंग की वैल्यू में ज़्यादा से ज़्यादा 1e-5 का अंतर हो.
उदाहरण (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
उदाहरण (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
उदाहरण (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
| JSON के काेड में दिखाना |
|---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
| फ़ील्ड | |
|---|---|
red |
रंग में लाल रंग की मात्रा, [0, 1] के इंटरवल में वैल्यू के तौर पर. |
green |
रंग में हरे रंग की मात्रा, [0, 1] इंटरवल में वैल्यू के तौर पर. |
blue |
रंग में नीले रंग की मात्रा, जिसे [0, 1] इंटरवल में वैल्यू के तौर पर दिखाया जाता है. |
alpha |
इस रंग का वह हिस्सा जिसे पिक्सल पर लागू किया जाना चाहिए. इसका मतलब है कि फ़ाइनल पिक्सल का रंग, इस समीकरण से तय होता है:
इसका मतलब है कि वैल्यू 1.0 का मतलब है कि रंग पूरी तरह से भरा हुआ है, जबकि वैल्यू 0.0 का मतलब है कि रंग पूरी तरह से पारदर्शी है. यह एक सामान्य फ़्लोट स्केलर के बजाय रैपर मैसेज का इस्तेमाल करता है, ताकि डिफ़ॉल्ट वैल्यू और अनसेट की जा रही वैल्यू के बीच अंतर किया जा सके. अगर इस रंग ऑब्जेक्ट को शामिल नहीं किया जाता है, तो इसे एक ठोस रंग के तौर पर रेंडर किया जाता है. ऐसा तब होता है, जब ऐल्फ़ा वैल्यू को साफ़ तौर पर 1.0 की वैल्यू दी गई हो. |
WrapStyle
अलग-अलग रैप स्टाइल के लिए Enum.
| Enums | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
टेक्स्ट रैप करने का कोई स्टाइल नहीं चुना गया है. |
NO_WRAP |
कोई रैप स्टाइल नहीं है. |
हाइपरलिंक
टेक्स्ट और लिंक वाला हाइपरलिंक एलिमेंट.
| JSON के काेड में दिखाना |
|---|
{ "link": string, "text": string } |
| फ़ील्ड | |
|---|---|
link |
ज़रूरी है. हाइपरलिंक का डेस्टिनेशन यूआरएल. |
text |
ज़रूरी है. हाइपरलिंक का टेक्स्ट. |
ListContainer
यह लिस्ट आइटम के लिए कंटेनर है. इसमें हर लिस्ट आइटम में कई TextFormatElement शामिल हो सकते हैं.
| JSON के काेड में दिखाना |
|---|
{ "listNestLevel": string, "listType": enum ( |
| फ़ील्ड | |
|---|---|
listNestLevel |
ज़रूरी नहीं. सूची का नेस्ट लेवल. टॉप लेवल के लिए इसकी वैल्यू 0 से शुरू होती है. साथ ही, हर नेस्ट की गई सूची के लिए इसकी वैल्यू 1 से बढ़ती है. |
listType |
ज़रूरी नहीं. सूची का टाइप. |
listItems[] |
ज़रूरी नहीं. सूची में मौजूद आइटम का कलेक्शन. |
ListType
अलग-अलग तरह की सूचियों के लिए Enum.
| Enums | |
|---|---|
LIST_TYPE_UNSPECIFIED |
सूची के टाइप के बारे में नहीं बताया गया. |
ORDERED |
क्रम वाली सूची. |
UNORDERED |
बिना क्रम वाली सूची. |
ListItem
सूची में मौजूद कोई आइटम.
| JSON के काेड में दिखाना |
|---|
{
"textFormatElements": [
{
object ( |
| फ़ील्ड | |
|---|---|
textFormatElements[] |
ज़रूरी नहीं. टेक्स्ट फ़ॉर्मैट के एलिमेंट का कलेक्शन. |