oEmbed API

oEmbed API, oEmbed-संगत फ़ॉर्मैट में सरल एम्बेड HTML लौटाता है।

आप oEmbed API का उपयोग प्रोग्रामेटिक रूप से एम्बेड किया गया कॉन्टेंट लौटाने के लिए कर सकते हैं, जैसे Tweets और timelines। 

oEmbed API का रिस्पॉन्स एक HTML स्निपेट लौटाता है, जिसे पेज में X का widget JavaScript शामिल होने पर स्वचालित रूप से पहचान लिया जाता है।

कृपया ध्यान दें कि API का उपयोग बड़े पैमाने पर कार्य करने के लिए सुझाया जाता है, और कॉन्टेंट एम्बेड करने के लिए हम अपने सशक्त publish.x.com टूल का उपयोग करने की सलाह देते हैं।

एम्बेड की गई टाइमलाइनें

लौटाया गया HTML स्निपेट अपने-आप एक एम्बेडेड टाइमलाइन के रूप में पहचाना जाएगा, जब पेज में X का widget JavaScript शामिल हो.

oEmbed endpoint, HTML markup में संबंधित गुण सेट करके, एम्बेडेड टाइमलाइन के अंतिम रूप को अनुकूलित करने की सुविधा देता है। इन गुणों की व्याख्या डिफ़ॉल्ट रूप से HTML रिस्पॉन्स के साथ बंडल किए गए X के JavaScript द्वारा की जाती है। लौटाए गए markup का प्रारूप समय के साथ बदल सकता है, क्योंकि X नई सुविधाएँ जोड़ता है या अपनी टाइमलाइन प्रस्तुति को समायोजित करता है।

टाइमलाइन URL द्वारा निर्दिष्ट X टाइमलाइन के लिए, oEmbed-संगत JSON प्रारूप में। उपयोगकर्ता और सूची टाइमलाइन समर्थित हैं। टाइमलाइन markup को आपके सर्वरों पर cache_age गुण द्वारा निर्दिष्ट सुझाई गई cache lifetime तक कैश किया जाना चाहिए।

रिसोर्स URL

https://publish.x.com/oembed

रिसोर्स जानकारी

रिस्पॉन्स प्रारूप	JSON
प्रमाणीकरण आवश्यक है?	नहीं
रेट लिमिटेड	नहीं

पैरामीटर

नाम	विवरण	उदाहरण
url	एम्बेड की जाने वाली X टाइमलाइन का URL	* https://x.com/TwitterDev *https://x.com/TwitterDev/lists/national-parks
limit	अधिकतम N आइटम दिखाएँ, जहाँ N का मान 1 से 20 के बीच (दोनों सहित) हो	6
maxwidth	widget की अधिकतम चौड़ाई सेट करें। यह 180 से 1200 के बीच (दोनों सहित) होनी चाहिए	300
maxheight	widget की अधिकतम ऊँचाई सेट करें। यह 200 से अधिक होनी चाहिए	400
omit_script	रिस्पॉन्स में script element शामिल न करें	1
lang	समर्थित X भाषा कोड	es
theme	जब इसे dark पर सेट किया जाता है, तो टाइमलाइन गहरे बैकग्राउंड पर हल्के टेक्स्ट के साथ दिखाई जाती है	dark
chrome	स्पेस से अलग किए गए tokens का उपयोग करके टाइमलाइन के डिस्प्ले घटक हटाएँ * noheader - header छिपाता है * nofooter - footer छिपाता है, यदि वह दिखाई दे रहा हो * noborders - सभी borders हटाता है: widget के चारों ओर, Tweets के बीच, और किसी Tweet के अंदर * noscrollbar- टाइमलाइन scrollbar को काटकर छिपाता है, यदि वह दिखाई दे रही हो * transparent- background color हटाता है	noheader%20nofooter
aria_polite	टाइमलाइन में जोड़े गए Tweets के लिए assertive ARIA live region politeness मान सेट करें	assertive
dnt	जब इसे true पर सेट किया जाता है, तो टाइमलाइन और आपकी साइट पर उसका एम्बेडेड पेज उन उद्देश्यों के लिए उपयोग नहीं किए जाते जिनमें व्यक्तिकृत सुझाव और व्यक्तिकृत विज्ञापन शामिल हैं	true

उदाहरण अनुरोध

curl --request GET --url 'https://publish.x.com/oembed?url=https%3A%2F%2Ftwitter.com%2FInterior%2Fstatus%2F507185938620219395'
twurl -H publish.x.com "/oembed?url=https://x.com/Interior/status/463440424141459456"

रिस्पॉन्स का उदाहरण

{
  "url": "https://x.com/TwitterDev",
  "title": "",
  "html": "<a class=\"twitter-timeline\" href=\"https://x.com/TwitterDev\">Tweets by TwitterDev</a>\n<script async src=\"//platform.x.com/widgets.js\" charset=\"utf-8\"></script>",
  "width": null,
  "height": null,
  "type": "rich",
  "cache_age": "3153600000",
  "provider_name": "Twitter",
  "provider_url": "https://x.com",
  "version": "1.0"
}

एम्बेड किए गए Tweet

लौटाया गया HTML स्निपेट स्वचालित रूप से एक embedded Tweet के रूप में पहचाना जाएगा, जब X का widget JavaScript पेज पर include किया गया हो।

oEmbed एंडपॉइंट, Embedded Tweet के अंतिम स्वरूप को कस्टमाइज़ करने की सुविधा देता है — इसके लिए HTML मार्कअप में संबंधित गुण सेट किए जाते हैं, जिन्हें डिफ़ॉल्ट रूप से HTML रिस्पॉन्स के साथ बंडल किए गए X के JavaScript द्वारा interpret किया जाता है। लौटाए गए मार्कअप का फ़ॉर्मेट समय के साथ बदल सकता है, क्योंकि X नई सुविधाएँ जोड़ता रहता है या अपने Tweet representation में बदलाव करता है।

Tweet फ़ॉलबैक मार्कअप को आपके सर्वर पर cache_age प्रॉपर्टी में निर्दिष्ट सुझाई गई कैश अवधि तक कैश किया जाना चाहिए।

संसाधन URL

https://publish.x.com/oembed

संसाधन जानकारी

रिस्पॉन्स फ़ॉर्मैट	JSON
क्या प्रमाणीकरण आवश्यक है?	नहीं
क्या रेट लिमिट लागू है?	नहीं

पैरामीटर

नाम	डिफ़ॉल्ट	विवरण
url आवश्यक String		एम्बेड किए जाने वाले Tweet का URL
maxwidth Int [220..550]	325	रेंडर किए गए Tweet की अधिकतम चौड़ाई, पूर्ण पिक्सेल में। यदि दिया गया मान अनुमत सीमा से कम या अधिक है, तो क्रमशः न्यूनतम या अधिकतम समर्थित चौड़ाई लौटाई जाएगी; रीसेट की गई चौड़ाई का मान लौटाई गई width प्रॉपर्टी में दर्शाया जाएगा। ध्यान दें कि X, oEmbed maxheight पैरामीटर का समर्थन नहीं करता। Tweet मूल रूप से टेक्स्ट होते हैं, इसलिए उनकी ऊंचाई का अनुमान नहीं लगाया जा सकता और उन्हें इमेज या वीडियो की तरह स्केल नहीं किया जा सकता। इसी वजह से, oEmbed रिस्पॉन्स height के लिए कोई मान नहीं देगा। जिन इम्प्लीमेंटेशन को Tweets के लिए एकसमान ऊंचाई चाहिए, उन्हें नीचे दिए गए hide_thread और hide_media पैरामीटर का संदर्भ लेना चाहिए।
hide_media बूलियन, स्ट्रिंग या इंट	false	जब इसे true, "t" या 1 पर सेट किया जाता है, तो Tweet में मौजूद लिंक फ़ोटो, वीडियो या लिंक प्रीव्यू के रूप में विस्तारित नहीं होते।
hide_thread बूलियन, स्ट्रिंग या इंट	false	जब इसे true, "t" या 1 पर सेट किया जाता है, तो बातचीत के थ्रेड में पिछले Tweet का संक्षिप्त संस्करण प्रदर्शित नहीं किया जाएगा, यदि अनुरोधित Tweet किसी दूसरे Tweet के जवाब में है।
omit_script बूलियन, स्ट्रिंग या इंट	false	जब इसे true, "t" या 1 पर सेट किया जाता है, तो widgets.js लोड करने वाला <script> वापस नहीं किया जाएगा। आपके वेबपृष्ठों में Embedded Tweets सहित सभी X विजेट्स में उपयोग के लिए widgets.js का अपना संदर्भ शामिल होना चाहिए।
align एनम {left,right,center,none}	none	यह निर्दिष्ट करता है कि एम्बेड किया गया Tweet, पैरेंट एलिमेंट के सापेक्ष, पेज में बाईं ओर, दाईं ओर या बीच में फ़्लोट होना चाहिए या नहीं।
lang Enum(भाषा)	en	लौटाए गए HTML और रेंडर किए गए Tweet को निर्दिष्ट embedded Tweets द्वारा समर्थित X भाषा में अनुरोध करें।
theme Enum {light, dark}	light	जब इसे dark पर सेट किया जाता है, तो Tweet गहरी पृष्ठभूमि पर हल्के टेक्स्ट के साथ प्रदर्शित होता है।
dnt बूलियन	false	जब इसे true पर सेट किया जाता है, तो Tweet और आपकी साइट पर उसका एम्बेडेड पेज वैयक्तिकृत सुझाव और वैयक्तिकृत विज्ञापनों जैसे उद्देश्यों के लिए उपयोग नहीं किए जाते।

उदाहरण अनुरोध

curl --request GET --url 'https://publish.x.com/oembed?url=https%3A%2F%2Ftwitter.com%2Ftwiterdev'
twurl -H publish.x.com "/oembed?url=https://x.com/TwitterDev"

उदाहरण रिस्पॉन्स

{
  "url": "https:\/\/twitter.com\/Interior\/status\/463440424141459456",
  "author_name": "US Department of the Interior",
  "author_url": "https:\/\/twitter.com\/Interior",
  "html": "<blockquote class=\"twitter-tweet\"><p lang=\"en\" dir=\"ltr\">Sunsets don&#39;t get much better than this one over <a href=\"https:\/\/twitter.com\/GrandTetonNPS?ref_src=twsrc%5Etfw\">@GrandTetonNPS<\/a>. <a href=\"https:\/\/twitter.com\/hashtag\/nature?src=hash&amp;ref_src=twsrc%5Etfw\">#nature<\/a> <a href=\"https:\/\/twitter.com\/hashtag\/sunset?src=hash&amp;ref_src=twsrc%5Etfw\">#sunset<\/a> <a href=\"http:\/\/t.co\/YuKy2rcjyU\">pic.x.com\/YuKy2rcjyU<\/a><\/p>&mdash; US Department of the Interior (@Interior) <a href=\"https:\/\/twitter.com\/Interior\/status\/463440424141459456?ref_src=twsrc%5Etfw\">May 5, 2014<\/a><\/blockquote>\n<script async src=\"https:\/\/platform.x.com\/widgets.js\" charset=\"utf-8\"><\/script>\n",
  "width": 550,
  "height": null,
  "type": "rich",
  "cache_age": "3153600000",
  "provider_name": "Twitter",
  "provider_url": "https:\/\/twitter.com",
  "version": "1.0"
}