Skip to main content

परिचय

X API के v2 संस्करण के लॉन्च के साथ, हमने डेटा रिस्पॉन्स के लिए एक नया फ़ॉर्मैट और अलग-अलग ऑब्जेक्ट्स व फ़ील्ड्स का अनुरोध करने का नया तरीका अपनाया है, जिसे हम सरल रूप से X API v2 फ़ॉर्मैट कहते हैं।  सामान्य अंतरों वाले अनुभाग में, आप कुछ ऐसे बदलावों के बारे में जान सकते हैं जो standard और enterprise उपयोगकर्ताओं के लिए प्रासंगिक हैं। हालांकि, हमने standard v1.1 Native फ़ॉर्मैट, enterprise Native Enriched फ़ॉर्मैट, और enterprise Activity Streams फ़ॉर्मैट के लिए एक विशेष गाइड भी तैयार की है, जो फ़ील्ड्स का मिलान करने में मदद करती है और यह समझाती है कि नए v2 फ़ील्ड्स का अनुरोध करने के लिए आपको कौन-से फ़ील्ड्स और expansions इस्तेमाल करने होंगे।  आप हमारे visual data फ़ॉर्मैट migration tool में भी रुचि ले सकते हैं, जो आपको X API v1.1 data फ़ॉर्मैट और X API v2 फ़ॉर्मैट के बीच के अंतर जल्दी से देखने में मदद करता है।

सामान्य अंतर

ऑब्जेक्ट्स और फ़ील्ड्स का अनुरोध करना

pre-v2 endpoints और v2 के बीच सबसे बड़े बदलावों में से एक यह है कि नया वर्शन डिफ़ॉल्ट रूप से केवल कुछ ही फ़ील्ड्स लौटाता है, जबकि standard, premium, और enterprise endpoints डिफ़ॉल्ट रूप से ज़्यादातर फ़ील्ड्स प्रदान करते हैं। नया वर्शन fields और expansions नामक पैरामीटर का उपयोग करके डिफ़ॉल्ट से अतिरिक्त डेटा का विशेष रूप से अनुरोध करने की सुविधा देता है। इसका मतलब है कि आप केवल वही डेटा अनुरोध कर सकते हैं जिसकी आपको ज़रूरत है, बिना उन फ़ील्ड्स को ingest किए जो आपके लिए महत्वपूर्ण नहीं हैं।  आप जिन फ़ील्ड्स का अनुरोध करते हैं, अगर वे प्राथमिक डेटा ऑब्जेक्ट से संबंधित हैं, तो वे डिफ़ॉल्ट मानों के साथ उसी प्राथमिक डेटा ऑब्जेक्ट में लौटेंगी। हालांकि, अगर आप expansions पैरामीटर का उपयोग करके किसी भी expanded ऑब्जेक्ट्स का अनुरोध करते हैं, तो वे द्वितीयक ऑब्जेक्ट्स एक नए includes ऑब्जेक्ट में लौटेंगे। आप includes ऑब्जेक्ट में मौजूद expanded ऑब्जेक्ट्स को ID फ़ील्ड की मदद से फिर से प्राथमिक ऑब्जेक्ट से मैच कर सकते हैं, क्योंकि यह दोनों में लौटेगी। उदाहरण के लिए, अगर आप v2 पोस्ट लुकअप endpoint का उपयोग कर रहे हैं और अपने अनुरोध में expansions=author_id पैरामीटर शामिल करते हैं, तो आपको प्राथमिक पोस्ट ऑब्जेक्ट के भीतर author_id फ़ील्ड मिलेगी। साथ ही, includes ऑब्जेक्ट में प्रति पोस्ट एक user ऑब्जेक्ट भी मिलेगा, जिनमें से प्रत्येक में डिफ़ॉल्ट id फ़ील्ड शामिल होगी, जिसका उपयोग user ऑब्जेक्ट को वापस पोस्ट ऑब्जेक्ट से मैच करने के लिए किया जा सकता है। यह कैसा दिखता है, इसका एक उदाहरण यहां दिया गया है:

अपडेट किया गया JSON डिज़ाइन

कुछ फ़ील्ड्स का अनुरोध करने के तरीके में हुए बदलावों के अलावा, X API v2 API द्वारा लौटाए गए ऑब्जेक्ट्स के लिए नए JSON डिज़ाइन भी पेश कर रहा है, जिनमें पोस्ट और उपयोगकर्ता ऑब्जेक्ट शामिल हैं।
  • JSON रूट स्तर पर, मानक endpoints statuses array में पोस्ट ऑब्जेक्ट लौटाते हैं, जबकि X API v2 data array लौटाता है।
  • Retweeted और Quoted “statuses” का संदर्भ देने के बजाय, X API v2 JSON में Retweeted और Quoted Tweets का संदर्भ दिया जाता है। contributors और user.translator_type जैसे कई legacy और deprecated फ़ील्ड्स हटाए जा रहे हैं।
  • favorites (पोस्ट ऑब्जेक्ट में) और favourites (उपयोगकर्ता ऑब्जेक्ट में) दोनों का उपयोग करने के बजाय, X API v2 में like शब्द का उपयोग किया जाता है।
  • X इस परंपरा को अपना रहा है कि जिन JSON values का कोई मान नहीं होता (उदाहरण के लिए, null), उन्हें payload में नहीं लिखा जाता। पोस्ट और उपयोगकर्ता attributes केवल तभी शामिल किए जाते हैं, जब उनके मान non-null हों।   

नए v2 फ़ील्ड्स

हमने पोस्ट ऑब्जेक्ट में फ़ील्ड्स का एक नया सेट भी जोड़ा है, जिसमें निम्नलिखित शामिल हैं:
  • एक conversation_id फ़ील्ड
  • दो नए annotations फ़ील्ड्स, जिनमें context और entities शामिल हैं
  • कई नए metrics फ़ील्ड्स
  • एक नया reply_setting फ़ील्ड, जो यह दिखाता है कि किसी दिए गए पोस्ट का जवाब कौन दे सकता है

standard v1.1 के data फ़ॉर्मैट से v2 पर माइग्रेट करना

यदि आपने अभी तक ऐसा नहीं किया है, तो शुरुआत करने के लिए हम आपको data formats migration का परिचय पढ़ने की सलाह देते हैं। आपको हमारा visual data फ़ॉर्मैट migration tool भी उपयोगी लग सकता है, जिसकी मदद से आप X API v1.1 data फ़ॉर्मैट और X API v2 फ़ॉर्मैट के बीच के अंतर जल्दी से देख सकते हैं। standard v1.1 data फ़ॉर्मैट, जिसे native फ़ॉर्मैट भी कहा जाता है, वह मुख्य फ़ॉर्मैट है जो standard v1.1 endpoints के साथ उपलब्ध कराया जाता है। यदि आप premium product का उपयोग कर रहे हैं, तो कृपया native enriched guide देखें। Enterprise clients native enriched या activity streams का उपयोग कर सकते हैं, यह इस पर निर्भर करता है कि Gnip console में आपका सेटअप कैसे किया गया है। 

Standard v1.1 बनाम v2 पेलोड संरचना

नीचे दी गई तालिका उन उच्च-स्तरीय ऑब्जेक्ट और फ़ॉर्मैट को दिखाती है, जिन्हें v1.1 फ़ॉर्मैट की तुलना में आप v2 से प्राप्त कर सकते हैं। फ़ील्ड मैपिंग अगला अनुभाग बताता है कि v1.1 के कौन-से फ़ील्ड v2 के फ़ील्ड्स से मैप होते हैं, और नया फ़ील्ड पाने के लिए कौन-से v2 पैरामीटर आवश्यक हैं।  

Tweet ऑब्जेक्ट

उदाहरण

उपयोगकर्ता ऑब्जेक्ट

उदाहरण

Entities और expanded entities ऑब्जेक्ट्स

उदाहरण

Place ऑब्जेक्ट

उदाहरण अगला चरण

Native Enriched डेटा फ़ॉर्मैट से v2 पर माइग्रेट करना

Native Enriched डेटा फ़ॉर्मैट का उपयोग हमारे enterprise प्रोडक्ट्स में किया जाता है। Edited Tweet metadata उपलब्ध कराने के लिए Native Enriched डेटा फ़ॉर्मैट को अपडेट किया गया है। Edit Tweet metadata के बारे में अधिक जानने के लिए, Tweet संपादन की मूल बातें पेज देखें। अगर आप standard v1.1 endpoints का उपयोग कर रहे हैं, तो कृपया standard v1.1 to v2 guide देखें। अगर आप Activity Streams के साथ enterprise products का उपयोग कर रहे हैं, तो इसके लिए हमारे पास Activity Streams to v2 गाइड भी है। X API v2, Tweet और user objects के लिए नए JSON डिज़ाइन पेश करता है।
  • JSON के root level पर, Native Enriched फ़ॉर्मैट results array में Tweet objects लौटाता है, जबकि X API v2 data array लौटाता है। 
  • favorites (Tweet ऑब्जेक्ट में) और favourites (उपयोगकर्ता ऑब्जेक्ट में) दोनों का उपयोग करने के बजाय, X API v2 like शब्द का इस्तेमाल करता है। 
  • X इस परंपरा को अपना रहा है कि जिन JSON values का कोई मान नहीं होता (उदाहरण के लिए, null), उन्हें payload में नहीं लिखा जाता। Tweet और user attributes केवल तभी शामिल किए जाते हैं, जब उनके मान non-null हों। 
  • v2 में सभी id फ़ील्ड्स string फ़ॉर्मैट में होंगी  
नए JSON फ़ॉर्मैट में किए गए बदलावों के अलावा, हमने Tweet ऑब्जेक्ट में फ़ील्ड्स का एक नया सेट भी जोड़ा है, जिनमें निम्न शामिल हैं:
  • conversation_id
  • reply_settings
  • media पर alt_text
  • दो नए annotations फ़ील्ड्स, जिनमें context और entities शामिल हैं
  • कई नए metrics फ़ील्ड्स
  • कई नए polls फ़ील्ड्स  
कई legacy और deprecated फ़ील्ड्स हटाए जा रहे हैं:
  • contributors
  • कुछ entities.media और extended_entities.media फ़ील्ड्स
  • filter_level
  • timestamp_ms
  • truncated

Native Enriched बनाम v2 payload संरचना

निम्न तालिका उन उच्च-स्तरीय ऑब्जेक्ट्स और फ़ॉर्मैट को दिखाती है, जिन्हें आप Native Enriched फ़ॉर्मैट की तुलना में v2 से प्राप्त होने की अपेक्षा कर सकते हैं। फ़ील्ड मैपिंग निम्न अनुभाग बताता है कि कौन-से Native Enriched फ़ील्ड्स, v2 फ़ील्ड्स से मैप होते हैं, साथ ही नया फ़ील्ड प्राप्त करने के लिए कौन-से v2 पैरामीटर आवश्यक हैं।  

Tweet ऑब्जेक्ट

उपयोगकर्ता ऑब्जेक्ट

Entities और expanded entities ऑब्जेक्ट

Place ऑब्जेक्ट

पोल ऑब्जेक्ट

Activity Streams फ़ॉर्मैट से v2 पर माइग्रेट करना

Activity Streams फ़ॉर्मैट हमारे enterprise प्रोडक्ट्स के साथ उपलब्ध है। एडिट किए गए Tweet मेटाडेटा उपलब्ध कराने के लिए Activity Streams फ़ॉर्मैट को अपडेट किया गया है। Edit Tweet मेटाडेटा के बारे में अधिक जानने के लिए, Tweet संपादन की मूल बातें पेज देखें। अगर आप standard v1.1 endpoints का उपयोग कर रहे हैं, तो कृपया standard v1.1 to v2 guide देखें। अगर आप premium endpoints, या enterprise के लिए Native Enriched फ़ॉर्मैट का उपयोग कर रहे हैं, तो कृपया Native Enriched to v2 guide देखें। X API v2, पोस्ट और उपयोगकर्ता ऑब्जेक्ट्स के लिए नए JSON डिज़ाइन पेश करता है।
  • JSON रूट लेवल पर, Activity Streams फ़ॉर्मैट results array में Tweet ऑब्जेक्ट्स लौटाता है, जबकि X API v2 data array लौटाता है।
  • Retweeted और Quoted “activities” का उल्लेख करने के बजाय, X API v2 JSON Retweeted और Quoted Tweets का उल्लेख करता है।
  • favorites (Tweet ऑब्जेक्ट में) और favourites (उपयोगकर्ता ऑब्जेक्ट में) दोनों का उपयोग करने के बजाय, X API v2 like शब्द का उपयोग करता है।
  • Twitter उस परंपरा को अपना रहा है जिसमें जिन JSON values का कोई मान नहीं होता (उदाहरण के लिए, null), उन्हें payload में नहीं लिखा जाता। Tweet और उपयोगकर्ता attributes केवल तभी शामिल किए जाते हैं, जब उनके मान non-null हों।
  • v2 में सभी id फ़ील्ड्स स्ट्रिंग फ़ॉर्मैट में होंगे。  
नए JSON फ़ॉर्मैट में किए गए बदलावों के अलावा, हमने Tweet ऑब्जेक्ट में फ़ील्ड्स का एक नया सेट भी पेश किया है, जिसमें निम्नलिखित शामिल हैं:
  • conversation_id
  • reply_settings
  • media पर alt_text
  • दो नए annotations फ़ील्ड्स, जिनमें context और entities शामिल हैं
  • कई नए metrics फ़ील्ड्स
  • कई नए polls फ़ील्ड्स  
कई legacy और deprecated फ़ील्ड्स हटाए जा रहे हैं या बदले जा रहे हैं:
  • display_text_range
  • generator
  • gnip
  • link
  • objectType
  • provider
  • twitter_entities.symbols को data.entities.cashtags से बदला गया है
  • कुछ twitter_extended_entities.media और twitter_entities.media फ़ील्ड्स
  • twitter_filter_level
  • twitterTimeZone
  • verb

Tweet ऑब्जेक्ट

उपयोगकर्ता ऑब्जेक्ट

पोल ऑब्जेक्ट

Place ऑब्जेक्ट

मीडिया ऑब्जेक्ट

मैचिंग नियम ऑब्जेक्ट

विज़ुअल डेटा फ़ॉर्मैट माइग्रेशन टूल

विज़ुअल डेटा फ़ॉर्मैट माइग्रेशन टूल एक वेब एप्लिकेशन है, जो किसी दिए गए Tweet ऑब्जेक्ट या उपयोगकर्ता ऑब्जेक्ट के लिए X API v1.1. data format से X API v2 format में मैप होने वाले फ़ील्ड्स दिखाता है। इस मैपिंग को देखने के लिए एप्लिकेशन में Tweet ID या user ID में से कोई एक दिया जा सकता है। कृपया ध्यान दें कि ऐप का उपयोग करने के लिए आपको अपने Twitter अकाउंट से लॉग इन करना होगा।