अवलोकन
- POST accounts/:account_id/cards Tweets:
- POST accounts/:account_id/tweets - Tweets में कार्ड्स जोड़ने के लिए,
card_uriपैरामीटर का उपयोग करें। शेड्यूल किए गए Tweets: - POST accounts/:account_id/scheduled_tweets
कार्ड्स
इमेज
- वेबसाइट: 1:1 और 1.91:1
- इमेज ऐप डाउनलोड: 1:1 और 1.91:1
- पोल: 1.91:1
- इमेज कन्वर्सेशन: 1.91:1
- इमेज डायरेक्ट मैसेज: 1.91:1
वीडियो
- वीडियो वेबसाइट: 16:9 और 1:1
- वीडियो ऐप डाउनलोड: 16:9 और 1:1
- पोल: 16:9
- वीडियो कन्वर्सेशन: 16:9
- वीडियो डायरेक्ट मैसेज: 16:9
प्रमोटेड वीडियो
media_id का उपयोग करके, POST accounts/:account_id/videos एंडपॉइंट के माध्यम से वीडियो को किसी Ads अकाउंट से संबद्ध करें। वीडियो का id, जिसे कभी-कभी media_key भी कहा जाता है, बाद के अनुरोधों में इस्तेमाल किया जाएगा। यह एक string है जो एक int से शुरू होती है, फिर एक underscore आता है, और अंत में एक long value होती है। उदाहरण के लिए, देखें: 13_875943225764098048.
Tweets में प्रमोटेड वीडियो
id के साथ POST accounts/:account_id/tweet endpoint का इस्तेमाल करें। इस चरण में, आप वीडियो का शीर्षक, विवरण और कॉल-टू-एक्शन (CTA) भी दे सकते हैं। ये मान उपयोगकर्ताओं को दिखाई देते हैं।
कार्ड में प्रमोटेड वीडियो
- POST accounts/:account_id/cards/video_website
- POST accounts/:account_id/cards/video_app_download
- POST accounts/:account_id/cards/video_conversation
id और वैकल्पिक रूप से इमेज के media_id (पोस्टर इमेज के लिए) का उपयोग करके।
अंत में, POST accounts/:account_id/tweet endpoint का उपयोग करके Tweet बनाएं। कार्ड को card_uri parameter का उपयोग करके Tweets से अटैच किया जाता है।
सामान्य जानकारी
- (2015-10-22 से) प्रमोटेड सामग्री में उपयोग के लिए वीडियो अपलोड करते समय, POST media/upload (chunked) endpoint पर सभी
INITकमांड अनुरोधों मेंmedia_categoryपैरामीटर का मानamplify_videoहोना चाहिए। इस नए पैरामीटर का उपयोग यह सुनिश्चित करता है कि वीडियो का असिंक्रोनस रूप से प्री-प्रोसेसिंग हो और उसे प्रमोटेड सामग्री में उपयोग के लिए तैयार किया जाए। वीडियो अपलोड होने के बाद असिंक्रोनस प्रोसेसिंग पूरी हुई है या नहीं, यह जांचने के लिएSTATUSकमांड का उपयोग किया जा सकता है। - वर्तमान में अनुमत प्रमोटेड वीडियो की अधिकतम लंबाई 10 मिनट है, और फ़ाइल का आकार 500MB या उससे कम होना चाहिए।
- अपलोड किया गया वीडियो mp4 या mov फ़ॉर्मैट में होना चाहिए।
- अपलोड किया गया वीडियो आम तौर पर जल्दी प्रोसेस हो जाता है, लेकिन प्रोसेसिंग में लगने वाला समय वीडियो की लंबाई और फ़ाइल के आकार के अनुसार अलग-अलग हो सकता है।
- अपलोड की गई पोस्टर इमेज png या jpg फ़ॉर्मैट में होनी चाहिए। आस्पेक्ट रेशियो या आकार के लिए कोई आवश्यकता नहीं है, लेकिन पोस्टर इमेज को वीडियो प्लेयर के अनुसार समायोजित किया जाएगा।
मार्गदर्शिकाएँ
शेड्यूल किए गए Tweets
परिचय
- नए शेड्यूल किए गए Tweets बनाएँ, संशोधित करें और देखें
- किसी Scheduled Tweet को line item से संबद्ध करें
- मौजूदा Scheduled Tweets को क्वेरी करें और प्रबंधित करें
- Scheduled Tweet के लाइव हो जाने पर, लाइव Tweet
idप्राप्त करें
API एंडपॉइंट्स
शेड्यूल किए गए Tweet का प्रबंधन
- GET accounts/:account_id/scheduled_tweets (सभी शेड्यूल किए गए Tweets की सूची प्राप्त करें)
- GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (उसके
idका उपयोग करके किसी विशिष्ट शेड्यूल किए गए Tweet को देखें) - POST accounts/:account_id/scheduled_tweets (एक नया शेड्यूल किया गया Tweet बनाएँ)
- PUT accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (किसी मौजूदा शेड्यूल किए गए Tweet में बदलाव करें)
- DELETE accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (उसके
idका उपयोग करके किसी शेड्यूल किए गए Tweet को हटाएँ) - GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (किसी मौजूदा शेड्यूल किए गए Tweet का पूर्वावलोकन करें)
शेड्यूल किए गए प्रमोटेड Tweets
- GET accounts/:account_id/scheduled_promoted_tweets (सभी शेड्यूल किए गए प्रमोटेड Tweets की सूची प्राप्त करें)
- GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (किसी शेड्यूल किए गए प्रमोटेड Tweet को उसके
idसे देखें) - POST accounts/:account_id/scheduled_promoted_tweets (एक नया शेड्यूल किया गया प्रमोटेड Tweet बनाएँ)
- DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (किसी मौजूदा शेड्यूल किए गए प्रमोटेड Tweet को उसके
idसे हटाएँ)
शेड्यूल किया गया Tweet देखें
- GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (किसी मौजूदा शेड्यूल किए गए Tweet को देखें)
निर्धारित Tweet बनाना:
- सत्यापित करें कि प्रमाणीकृत उपयोगकर्ता के पास दिए गए @handle के लिए ऑर्गेनिक Tweets बनाने की अनुमति है। Promoted-Only Tweet बनाने की सुविधा के लिए आवश्यक है कि प्रमाणीकृत उपयोगकर्ता खाते का उपयोगकर्ता हो और उसके पास Tweet composer permissions हों।
- सत्यापित करें कि
scheduled\_atसमय के 15 मिनट के अंतराल में बनाए जाने के लिए 30 से अधिक Tweets निर्धारित न हों। SCHEDULED_TWEET_LIMIT_EXCEEDED त्रुटि संदेश यह दर्शाता है कि भविष्य के उसी 15 मिनट के समय-अंतराल में बहुत अधिक शेड्यूल किए गए Tweets शेड्यूल कर दिए गए हैं। विज्ञापनदाताओं को किसी मौजूदा शेड्यूल किए गए Tweet को हटाना होगा याscheduled\_atसमय को पहले या बाद के समय पर बदलना होगा।
शेड्यूल किया गया Tweet “लाइव” होता है:
- ये सत्यापन नियम scheduled_at के समय चलाए जाते हैं और API में सामान्य Tweet बनाते समय लागू किए जाने वाले नियमों के समान होते हैं। उदाहरण के लिए, अगर किसी शेड्यूल किए गए Tweet में image और gif दोनों शामिल हों, तो वह लाइव नहीं होगा और scheduled_status को FAILED पर सेट कर दिया जाएगा
कार्यप्रवाह
scheduled_at समय, और यदि Tweet में कोई media entities शामिल नहीं हैं, तो Tweet का text। इसके अलावा, यह endpoint कुछ अतिरिक्त विकल्प भी देता है, जिनकी मदद से आप as_user_id param के माध्यम से किसी अन्य @handle की ओर से शेड्यूल किया गया Tweet बना सकते हैं। साथ ही, आप एक card (card_uri) और media (media_ids) भी जोड़ सकते हैं। ध्यान दें कि किसी Tweet में केवल एक ही प्रकार की entities हो सकती हैं, यानी Video, Gif, या Image में से कोई एक। nullcast param यह नियंत्रित करता है कि Tweet “Promoted-Only” Tweet है या नहीं। सभी नए बनाए गए शेड्यूल किए गए Tweets डिफ़ॉल्ट रूप से “Promoted-Only” (nullcast=true) होते हैं। यदि nullcast=false है, तो एक Organic शेड्यूल किया गया Tweet बनाया जाता है।
जब कोई शेड्यूल किया गया Tweet सफलतापूर्वक बन जाता है, तो रिस्पॉन्स में एक id फ़ील्ड शामिल होती है, जो उस शेड्यूल किए गए Tweet के अद्वितीय पहचानकर्ता को दर्शाती है। इसके अलावा, tweet_id नाम की एक और फ़ील्ड भी लौटाई जाती है। यह फ़ील्ड शुरुआत में null होती है, लेकिन Tweet के लाइव होने पर इसमें “live” Tweet की ID भर दी जाती है।
tweet_id फ़ील्ड में “live” Tweet की ID भर दी जाएगी।
शेड्यूल किया गया Tweet देखें
इसके बाद, पिछले चरण के शेड्यूल किए गए Tweet id के साथ GET accounts/:account_id/tweet_previews endpoint का उपयोग करके Tweet का प्रीव्यू जनरेट किया जा सकता है। API रिस्पॉन्स में एक iframe URL शामिल होगा, जो शेड्यूल किए गए Tweet का प्रीव्यू रेंडर करने के लिए तैयार होगा। संबंधित CSS और इमेज सीधे X के माध्यम से सर्व की जाएंगी。
nullcast=true) Tweet बनाने की भी अनुमति देते हैं। इनमें से किसी एक को लाइन आइटम से संबद्ध किया जा सकता है। इसे संभव बनाने के लिए, हम POST accounts/:account_id/scheduled_promoted_tweets endpoint भी प्रदान करते हैं। यह endpoint एक API कॉल में केवल एक Promoted शेड्यूल किया गया Tweet को किसी लाइन आइटम से संबद्ध करने की अनुमति देता है। एक ही लाइन आइटम से कई शेड्यूल किए गए Tweets को संबद्ध करने के लिए, कई API कॉल करनी होंगी।
कृपया ध्यान दें कि किसी मौजूदा Promoted शेड्यूल किया गया Tweet को संशोधित करना संभव नहीं है।
SCHEDULED स्थिति में है और दिया गया शेड्यूल किया गया Tweet दिए गए objective के लिए मान्य है, लेकिन इसके अलावा कोई अन्य validations नहीं चलाई जातीं। line item और शेड्यूल किए गए Tweet पर लागू बाकी validation नियम तब चलाए जाते हैं, जब Tweet “live” हो जाता है।
यह सुनिश्चित करने के लिए कि campaign serving में कोई समस्या न आए, अनुशंसा की जाती है कि शेड्यूल किए गए Tweet का scheduled_at समय campaign/line item की flight dates से पहले रखा जाए।
उदाहरण के लिए, मान लें कि शेड्यूल किए गए Tweet को campaign की start date के बाद live होने के लिए सेट किया गया है (और एक ही line item से केवल एक ही Tweet associated है), तो campaign ACTIVE होगा। हालांकि, क्योंकि शेड्यूल किया गया Tweet अभी live नहीं है, इसलिए serving के लिए कोई creatives उपलब्ध नहीं होंगे।
शेड्यूल किया गया Tweet Management
बाकी endpoint sets API consumers को अपने सभी शेड्यूल किए गए Tweets और Scheduled Promoted Tweets को manage करने की सुविधा देते हैं। इन APIs का उपयोग सभी शेड्यूल किए गए Tweets की सूची लौटाने के लिए किया जा सकता है, जिसे वैकल्पिक रूप से किसी दिए गए state के आधार पर filter किया जा सकता है, साथ ही किसी दिए गए शेड्यूल किए गए Tweet को उसके id से lookup करने के लिए भी।
जब कोई शेड्यूल किया गया Tweet लाइव होता है, तो क्या होता है?
scheduled_at समय पर, तो निम्नलिखित अपडेट किए जाते हैं:
- “लाइव” Tweet बनाया जाता है, हालांकि इसमें 1 सेकंड तक की देरी हो सकती है
tweet_idको निम्नलिखित इकाइयों में जोड़ा जाता है:- शेड्यूल किया गया Tweet
- Promoted शेड्यूल किया गया Tweet
- एक नई Promoted Tweet इकाई बनाई जाती है
सर्वोत्तम प्रथाएँ
- शेड्यूल किया गया Tweet बनाते समय सुनिश्चित करें कि Tweet मान्य हो (उदाहरण के लिए, किसी Tweet में केवल Image, Video या Gif में से एक ही हो सकता है, इन तीनों का कोई संयोजन नहीं)
- सुनिश्चित करें कि अभियान की flight dates (अर्थात
start_timeऔरend_time) शेड्यूल किए गए Tweet केscheduled_atसमय के अनुरूप हों - शेड्यूल किए गए Tweets को भविष्य में एक वर्ष (365 दिन) से अधिक आगे के लिए शेड्यूल नहीं किया जाना चाहिए
- शेड्यूल किए गए Tweets के लिए फिलहाल Tweet preview समर्थित नहीं है (अर्थात, बनाते समय शेड्यूल किए गए Tweets का पहले से पूर्वावलोकन करने की सुविधा उपलब्ध नहीं है)
मीडिया लाइब्रेरी
परिचय
API एंडपॉइंट्स
- POST media/upload or POST media/upload (chunked) (मीडिया अपलोड करना)
- POST accounts/:account_id/media_library (मीडिया को मीडिया लाइब्रेरी में जोड़ना)
लाइब्रेरी में जोड़ना
अनुरोध पैरामीटर
media\_id का उपयोग करते समय, जैसा कि ऊपर दिए गए उदाहरण में दिखाया गया है, media\_category भी निर्दिष्ट करना आवश्यक है। श्रेणी के चार संभावित मान हैं: AMPLIFY_VIDEO, TWEET_GIF, TWEET_IMAGE, और TWEET_VIDEO।
वैकल्पिक रूप से, मीडिया लाइब्रेरी में ऑब्जेक्ट्स के लिए name और file\_name मान सेट किए जा सकते हैं। ये एट्रिब्यूट उपयोगकर्ताओं को लाइब्रेरी में मीडिया के अलग-अलग वैरिएंट्स के बीच अंतर करने में मदद करते हैं।
वीडियो के लिए title और description सेट करना भी संभव है। इन मानों को POST accounts/:account_id/tweet endpoint के साथ video\_title और video\_description अनुरोध पैरामीटर के रूप में भेजने के लिए अभिप्रेत है। Tweet में यह टेक्स्ट वीडियो के नीचे दिखाई देता है।
विशेषताएँ
उपयोग
कार्डों की पहचान
परिचय
| card_uri | preview_url |
|---|---|
| card://1043282691834048513 | https://cards.x.com/cards/18ce54d4x5t/68w3s |
card_uri के साथ Tweets की पहचान
preview_url वाले Tweets की पहचान
कार्ड फ़ेच करना
मीडिया की पहचान
परिचय
| मीडिया ID | मीडिया key |
|---|---|
| 1029825579531807971 | 13_1029825579531807971 |
इमेज
| Resource | Identifier | Attribute(s) |
|---|---|---|
| Image cards | कोई नहीं | |
| Tweet | दोनों | entities["media"]["id_str"] entities["media"]["media_key"] |
| Scheduled Tweet | दोनों | media_ids and media_keys |
| Draft Tweet | दोनों | media_ids and media_keys |
| Account Media | कोई नहीं | |
| Media Library | दोनों | media_id and media_key |
id और id_str फ़ील्ड्स media ID के अनुरूप हैं। जिन मामलों में किसी Tweet में कई इमेज शामिल होती हैं, उनमें प्रत्येक media entity के संदर्भ केवल extended_entities[“media”] में ही मिल सकते हैं।
पहचानकर्ता के संदर्भों के अलावा, अक्सर इमेज के URL तक पहुँच होना भी महत्वपूर्ण होता है।
| Resource | Attribute(s) | Format |
|---|---|---|
| Image cards | image | .jpg |
| Tweet* | entities["media"][0]["media_url"] or extended_entities["media"][i]["media_url"] | .jpg |
| Scheduled Tweet | कोई नहीं | |
| Draft Tweet | कोई नहीं | |
| Account Media | media_url | .jpg |
| Media Library | media_url | .jpg |
- इन URL के स्थान इस बात पर निर्भर करते हैं कि Tweet में एक इमेज है या कई इमेज।
वीडियो
| Resource | Identifier | Attribute(s) |
|---|---|---|
| वीडियो कार्ड्स | इनमें से कोई एक हो सकता है | video_content_id |
| वीडियो पोल कार्ड्स | कोई नहीं | |
| Tweet | दोनों | entities["media"]["id_str"] entities["media"]["media_key"] |
| Scheduled Tweet | दोनों | media_ids और media_keys |
| Draft Tweet | दोनों | media_ids और media_keys |
| Account Media | मीडिया key | video_id |
| Media Library | दोनों | media_id और media_key |
video_content_id रिस्पॉन्स एट्रिब्यूट शामिल होता है, लेकिन लौटाए गए मान के प्रकार में एकरूपता नहीं है। कुछ मामलों में यह media ID होता है; अन्य में यह media key होता है।
वीडियो के URL को कैसे एक्सेस किया जाए, इसकी जानकारी नीचे दी गई है।
| Resource | Attribute(s) | Format |
|---|---|---|
| वीडियो कार्ड्स | video_url और video_hls_url | .vmap .m3u8 |
| वीडियो वाला Tweet | extended_entities["media"][i]["video_info"]["variants"][j]["url"] | .mp4 |
| Scheduled Tweet | कोई नहीं | |
| Draft Tweet | कोई नहीं | |
| Account Media | कोई नहीं | |
| Media Library | media_url | .mp4 |
video_url और video_hls_url रिस्पॉन्स एट्रिब्यूट शामिल होते हैं।
मीडिया लाइब्रेरी
vmap URL के बजाय mp4 URL प्राप्त करना। यह जानकारी मीडिया लाइब्रेरी में उपलब्ध है। उपलब्ध जानकारी के विवरण के लिए हमारी Media Library Guide देखें। ads account के FULL promotable user से संबंधित अधिकांश एसेट लाइब्रेरी में मिल जाते हैं। हालांकि, इसके कुछ अपवाद हैं।
मीडिया फ़ेच करना
जैसा कि ऊपर बताया गया है, image cards में न media ID का संदर्भ होता है और न media key का। इसलिए, मीडिया लाइब्रेरी के माध्यम से उनके एसेट फ़ेच करना संभव नहीं है। यही बात Account Media images पर भी लागू होती है।
Video cards के लिए यह आवश्यक है कि वीडियो एसेट उसे बनाने से पहले मीडिया लाइब्रेरी में मौजूद हो (या उससे पहले Videos resource में हो)। इसलिए, ये एसेट हमेशा मीडिया लाइब्रेरी में प्राप्त किए जा सकते हैं। यही बात Account Media PREROLL एसेट्स पर भी लागू होती है।
अंत में, Tweets में मौजूद मीडिया के लिए हमेशा यह सुनिश्चित होता है कि वह मीडिया लाइब्रेरी में मौजूद होगा।
नीचे दी गई तालिका यह संक्षेप में बताती है कि कौन-से एसेट मीडिया लाइब्रेरी में प्राप्त किए जा सकते हैं। इसमें यह भी ध्यान रखा गया है कि lookup में उपयोग के लिए resource रिस्पॉन्स में कोई पहचानकर्ता शामिल है या नहीं।
| Resource | मीडिया लाइब्रेरी में |
|---|---|
| Image cards | नहीं |
| Video cards | हाँ* |
| Tweets (कोई भी मीडिया)** | हाँ |
| Scheduled Tweets | हाँ |
| Draft Tweets | हाँ |
| Account media images | नहीं |
Account media videos (PREROLL) | हाँ |
- उन cards के लिए जहाँ
video_content_idएक media key है। जब इसका मान media ID होता है, तब भी एसेट मीडिया लाइब्रेरी में मौजूद रहता है, लेकिन उसे प्राप्त करने के लिए उसके आगे एक संख्यात्मक prefix और underscore जोड़ना पड़ता है। ** Tweets केवल media ID लौटाते हैं। हालांकि एसेट के मीडिया लाइब्रेरी में मौजूद होने की गारंटी होती है, उसे फ़ेच करने के लिए उसके आगे एक संख्यात्मक prefix और underscore जोड़ना पड़ता है।
- जब कोई AMPLIFY_VIDEO एसेट मीडिया लाइब्रेरी में जोड़ा जाता है, तो उसे अपने-आप PREROLL creative type वाले Account Media एसेट के रूप में भी जोड़ दिया जाता है।
- जब विशिष्ट dimensions वाली images (हमारे enumerations page में “Creative Types” देखें) मीडिया लाइब्रेरी में जोड़ी जाती हैं, तो उन्हें अपने-आप Account Media एसेट्स के रूप में भी जोड़ दिया जाता है। creative type (उदाहरण के लिए, INTERSTITIAL) image dimensions पर निर्भर करता है।
Tweets
परिचय
Nullcast किए गए Tweets
nullcast पैरामीटर को सपोर्ट करता है, जो API उपयोगकर्ता को nullcast किए गए या organic Tweets बनाने का विकल्प देता है। Nullcast किए गए Tweets उपयोगकर्ता स्वयं बना सकता है या कोई भी व्यक्ति बना सकता है जिसे उपयोगकर्ता की ओर से Tweets बनाने की अनुमति हो। Organic Tweets केवल full promotable user द्वारा बनाए जा सकते हैं।
Tweets अपडेट करना
scheduled और draft Tweets के लिए nullcast property को अपडेट किया जा सकता है। scheduled Tweets के लिए, Tweet के scheduled_at समय तक बदलाव किए जा सकते हैं। Draft Tweets को अनिश्चितकाल तक संपादित किया जा सकता है। हालांकि, एक बार प्रकाशित हो जाने के बाद, किसी Tweet को nullcast किए गए से organic में या इसके उलट बदला नहीं जा सकता।
Tweets को प्रमोट करना
Tweet आईडी
id फ़ील्ड भी शामिल होती है, जिसका मान 3qw1q6 है, और यही promoted Tweet ID है।
कैरोसेल
परिचय
- मीडिया अपलोड करें
- कार्ड बनाएँ
- Tweet बनाएँ
- Tweet को प्रमोट करें
एंडपॉइंट्स
JSON POST बॉडी
- एक
SWIPEABLE_MEDIAकॉम्पोनेंट, जो media keys की एक array स्वीकार करता है - निम्नलिखित में से एक:
- वेबसाइट की जानकारी निर्दिष्ट करने के लिए एक
DETAILSकॉम्पोनेंट - ऐप की जानकारी निर्दिष्ट करने के लिए एक
BUTTONकॉम्पोनेंट
SWIPEABLE_MEDIA कॉम्पोनेंट में एक media_keys array शामिल होना चाहिए, जिसमें आप 2 से 6 images या videos निर्दिष्ट कर सकते हैं। media keys जिस क्रम में पास की जाती हैं, उसी क्रम में वे render की जाएंगी।
| वेबसाइट | ऐप | |
|---|---|---|
| component type निर्दिष्ट करें | "type": "DETAILS" | "type": "BUTTON" |
| शीर्षक/लेबल | "title": "X" | "label": { "type": "ENUM", "value": "INSTALL" } |
| गंतव्य | "destination": { "type": "WEBSITE", "url": "https://www.x.com" } | "destination": { "type": "APP", ... } |
BUTTON कॉम्पोनेंट्स के भीतर ऐप गंतव्य ऑब्जेक्ट्स के लिए एक country code और कम से कम एक ऐप पहचानकर्ता आवश्यक है। वैकल्पिक रूप से, ये deep links भी स्वीकार करते हैं। इन फ़ील्ड्स के विवरण के लिए, reference documentation देखें।
इसे मिलाकर, नीचे एक उदाहरण ऐप carousel JSON POST body दिखाई गई है।
उदाहरण
media_type request parameter का उपयोग करें।
card_uri भी शामिल होता है, जिसका उपयोग Tweet बनाते समय किया जाएगा।
Tweet
अपना Tweet बनाने के लिए POST accounts/:account_id/tweet endpoint का उपयोग करें। पिछले अनुरोध से मिला card_uri उपयोग करें। (पठनीयता के लिए रिस्पॉन्स को संक्षिप्त किया गया है।)
क्रिएटिव-मेटाडेटा-टैगिंग
परिचय
Creative Assets को टैग करना
exiftool -contributor="<YOUR APP ID>" -creative_file.jpg
exiftool -date="<date>" -creative_file.jpg
app_id को Projects & Apps के अंतर्गत डेवलपर कंसोल में पाया जा सकता है। उदाहरण: 16489123
नीचे दिया गया उदाहरण किसी image के लिए contributor tag के रूप में app_id और date tag के रूप में date जोड़ता है:
exiftool -xmp:all -G1 <filename>
उदाहरण:
exiftool -xmp:all -G1 eiffel_tower.jpg
प्रश्न?
API संदर्भ
अकाउंट मीडिया
GET accounts/:account_id/account_media
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/account_media
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड अकाउंट का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| account_media_ids optional | कॉमा-सेपरेटेड पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित account media तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 3wpx |
| count optional | प्रत्येक request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| creative_types optional | रिस्पॉन्स को केवल उन account media तक सीमित करता है जो निर्दिष्ट creative types से मेल खाते हैं। एक से अधिक creative type बताने के लिए enum values को कॉमा से अलग करें। Type: enum Possible values: BANNER, BANNER_TABLET, INTERSTITIAL, INTERSTITIAL_LANDSCAPE, INTERSTITIAL_LANDSCAPE_TABLET, INTERSTITIAL_TABLET, MEDIUM_RECTANGLE, PREROLL, VAST_PREROLL |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | request में deleted results शामिल करता है। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करता है। Note: यह parameter और cursor एक साथ उपयोग नहीं किए जा सकते। Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो फिलहाल प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
अनुरोध का उदाहरण
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media?account_media_ids=3wpx
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| account_media_id required | उस account media का संदर्भ जिस पर आप request में काम कर रहे हैं। Type: string Example: 2pnfd |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_id
पैरामीटर
| Name | Description |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| account_media_id आवश्यक | उस account media का संदर्भ, जिस पर आप इस अनुरोध में कार्य कर रहे हैं। Type: string Example: 2pnfd |
अनुरोध का उदाहरण
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd
उदाहरण रिस्पॉन्स
कार्ड्स
card_uri पैरामीटर का उपयोग करें।
वर्तमान खाते से संबद्ध कुछ या सभी कार्ड्स का विवरण प्राप्त करें।
नोट: यह केवल उन कार्ड्स को लौटाता है जो POST accounts/:account_id/cards एंडपॉइंट का उपयोग करके बनाए गए थे। अन्य एंडपॉइंट्स का उपयोग करके बनाए गए कार्ड्स नहीं लौटाए जाते।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_types optional | comma-separated enum values की सूची देकर रिस्पॉन्स को केवल वांछित card types तक सीमित करें। प्रकार: enum संभावित मान: IMAGE_APP, IMAGE_CAROUSEL_APP, IMAGE_CAROUSEL_WEBSITE, IMAGE_MULTI_DEST_CAROUSEL_WEBSITE, IMAGE_WEBSITE, MIXED_MEDIA_MULTI_DEST_CAROUSEL_WEBSITE, MIXED_MEDIA_SINGLE_DEST_CAROUSEL_APP, MIXED_MEDIA_SINGLE_DEST_CAROUSEL_WEBSITE, VIDEO_APP, VIDEO_CAROUSEL_APP, VIDEO_CAROUSEL_WEBSITE, VIDEO_MULTI_DEST_CAROUSEL_WEBSITE, VIDEO_WEBSITE |
| card_id optional | comma-separated identifiers की सूची देकर रिस्पॉन्स को केवल वांछित cards तक सीमित करें। अधिकतम 200 card IDs दिए जा सकते हैं। प्रकार: string उदाहरण: 1044294149527166979,1044301099031658496 |
| card_uris optional | comma-separated identifiers की सूची देकर रिस्पॉन्स को केवल वांछित cards तक सीमित करें। अधिकतम 200 card URI values दिए जा सकते हैं। प्रकार: string उदाहरण: card://1044294149527166979,card://1044301099031658496 |
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। प्रकार: int डिफ़ॉल्ट: 100 न्यूनतम, अधिकतम: 1, 200 |
| cursor optional | results का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। प्रकार: string उदाहरण: 8x7v00oow |
| include_legacy_cards optional | रिस्पॉन्स में legacy website और app cards शामिल करें। Legacy cards वे हैं जिनका resource URL इस प्रारूप में होता है: accounts/:account_id/cards/:card_type. अतिरिक्त संदर्भ के लिए this developer forum post देखें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
| q optional | name के आधार पर cards को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। अधिकतम लंबाई: 80 characters। नोट: यह case-insensitive prefix matching करता है। प्रकार: string उदाहरण: dtc |
| sort_by optional | समर्थित attribute के अनुसार ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। प्रकार: string उदाहरण: created_at-asc |
| with_deleted optional | अपनी request में deleted results शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards?count=1
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/:card_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_id required | कार्ड का id। Type: string Example: 1044294149527166979 |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
उदाहरण रिस्पॉन्स
POST accounts/:account_id/cards
Content-Type को application/json पर सेट किया जाना चाहिए।
विस्तृत उपयोग उदाहरण के लिए हमारी Carousels Guide देखें।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards
पैरामीटर
name और components की एक array होना चाहिए। Components को objects के रूप में दर्शाया जाता है और वे कार्ड की विज्ञापनदाता-संबंधी विशेषताओं का वर्णन करते हैं।
निम्न उदाहरण payload की सामान्य संरचना दिखाता है (लेकिन इसमें ऐसी जानकारी शामिल है जो काम नहीं करेगी)।
| नाम | विवरण |
|---|---|
| account_id required | लेवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| name required | card का नाम। अधिकतम लंबाई: 80 वर्ण। प्रकार: string उदाहरण: component based card |
| components sometimes required | card बनाने के लिए उपयोग किए जाने वाले घटकों का वर्णन करता है। अतिरिक्त जानकारी नीचे दी गई है। इसे slides के साथ निर्दिष्ट नहीं किया जा सकता। नोट: घटकों का क्रम महत्वपूर्ण है। प्रकार: objects की array |
| slides sometimes required | Multi-Destination Carousels बनाने के लिए इस array of array का उपयोग करें। यह प्रत्येक card को घटकों के एक समूह के रूप में वर्णित करता है। प्रत्येक slide, card का पूर्ण निरूपण होना चाहिए। इसे components के साथ निर्दिष्ट नहीं किया जा सकता। नोट: प्रत्येक slide का क्रम महत्वपूर्ण है। प्रकार: array of array |
घटक
type फ़ील्ड होना चाहिए, जो ऑब्जेक्ट का schema निर्धारित करती है। Ads API निम्नलिखित घटक प्रकारों का समर्थन करता है, जिन्हें media-आधारित और description-आधारित घटकों में समूहित किया गया है।
- मीडिया:
MEDIA: एकल video या imageSWIPEABLE_MEDIA: 2-6 videos या images- विवरण:
DETAILSBUTTON
type key के अलावा)। इन्हें नीचे दी गई तालिका में सूचीबद्ध किया गया है।
Component type | फ़ील्ड | मान का type |
|---|---|---|
MEDIA | media_key | string |
SWIPEABLE_MEDIA | media_keys | string की array |
DETAILS | title destination | string object |
BUTTON | label destination | object object |
components array के संदर्भ में BUTTON घटक का एक उदाहरण दिया गया है (name key को जानबूझकर छोड़ा गया है)। (ellipsis उन स्थानों को दर्शाते हैं जहाँ अधिक जानकारी निर्दिष्ट करने की आवश्यकता होगी।)
DETAILS या BUTTON component में से किसी एक का उपयोग करके बनाया जाना चाहिए। Description-based components, media के नीचे render किए जाते हैं और उनसे destinations संबद्ध होती हैं, जो या तो URLs होती हैं या mobile apps।
लेबल
लेबल बटनों पर दिखने वाले text को परिभाषित करते हैं और इसलिए केवल BUTTON component पर लागू होते हैं। Label objects में दो आवश्यक keys होती हैं: type और value। type को ENUM पर सेट किया जाना चाहिए और value इनमें से एक हो सकता है: BOOK, CONNECT, INSTALL, OPEN, ORDER, PLAY, या SHOP।
पिछले उदाहरण को आगे बढ़ाते हुए, नीचे BUTTON component के भीतर label object दिखाया गया है।
DETAILS या BUTTON कॉम्पोनेंट के भीतर हमेशा आवश्यक होते हैं। गंतव्य के दो type होते हैं: WEBSITE या APP।
नोट: वेबसाइट गंतव्य का उपयोग केवल DETAILS कॉम्पोनेंट के साथ किया जा सकता है और ऐप गंतव्य का उपयोग केवल BUTTON कॉम्पोनेंट के साथ किया जा सकता है।
वेबसाइट गंतव्य
| Name | Description |
|---|---|
| type required | गंतव्य का type, जो उसकी schema निर्धारित करता है। Type: enum Possible values: WEBSITE |
| url required | उस वेबसाइट का URL, जिस पर उपयोगकर्ता को रीडायरेक्ट किया जाएगा। Type: string Example: https://devcommunity.x.com/c/advertiser-api |
| Name | Description |
|---|---|
| type required | गंतव्य का type, जो उसकी schema निर्धारित करता है। Type: enum Possible values: APP |
| country_code required | उस देश का ISO 3166-1 alpha-2 दो-अक्षरीय कोड जहाँ ऐप बेचा जाता है। Type: string Example: US |
| googleplay_app_id sometimes required | Google Play ऐप्लिकेशन का पैकेज नाम। नोट: निम्न में से कम-से-कम एक आवश्यक है: ios_app_store_identifier या googleplay_app_id। Type: string Example: com.twitter.android |
| ios_app_store_identifier sometimes required | iOS App Store पहचानकर्ता। नोट: निम्न में से कम-से-कम एक आवश्यक है: ios_app_store_identifier या googleplay_app_id। Type: string Example: 333903271 |
| googleplay_deep_link optional | आपके द्वारा प्रमोट किए जा रहे Android ऐप का deep link। नोट: इसका उपयोग केवल तभी किया जा सकता है, जब googleplay_app_id दिया गया हो। Type: string |
| ios_deep_link optional | आपके द्वारा प्रमोट किए जा रहे iOS ऐप का deep link। नोट: इसका उपयोग केवल तभी किया जा सकता है, जब ios_app_store_identifier दिया गया हो। Type: string |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards
उदाहरण रिस्पॉन्स
Content-Type को application/json पर सेट किया जाना चाहिए।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/1321554298900107264
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर par GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| name optional | कार्ड का नाम। अधिकतम लंबाई: 80 वर्ण। Type: string Example: component based card |
| components optional | कार्ड को अपडेट करने के लिए उपयोग किए जाने वाले components का विवरण देता है। अतिरिक्त जानकारी नीचे दी गई है। इसे slides के साथ निर्दिष्ट नहीं किया जा सकता। Note: components का क्रम महत्वपूर्ण है। Type: array of objects |
| slides optional | Multi-Destination Carousels को अपडेट करने के लिए इस array of array का उपयोग करें। यह components के समूह के रूप में प्रत्येक कार्ड का विवरण देता है। प्रत्येक slide कार्ड का पूर्ण representation होना चाहिए। इसे components के साथ निर्दिष्ट नहीं किया जा सकता। Note: प्रत्येक slide का क्रम महत्वपूर्ण है। Type: array of array |
उदाहरण अनुरोध
यह उदाहरण, ऊपर दिए गए उदाहरण के components फ़ील्ड सेmedia_keys में से एक को हटाने के साथ-साथ, नाम को भी अपडेट करता है।
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/:card_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_id required | हटाए जाने वाले card का पहचानकर्ता। Type: string Example: 1044294149527166979 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
उदाहरण रिस्पॉन्स
कार्ड प्राप्त करें
card_uri के आधार पर कई कार्ड प्राप्त करें।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/all
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लेवरेज्ड खाता का आइडेंटिफ़ायर। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए required parameter होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_uris required | कॉमा से अलग की गई आइडेंटिफ़ायरों की सूची देकर रिस्पॉन्स को केवल इच्छित cards तक सीमित करें। अधिकतम 200 card URI values दी जा सकती हैं। Type: string Example: card://1044294149527166979,card://1044301099031658496 |
| with_deleted optional | अपने request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/all?card_uris=card://1044294149527166979,card://1044301099031658496
उदाहरण रिस्पॉन्स
card_id द्वारा प्राप्त करें.
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/all/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | लेवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id आवश्यक | उस card का संदर्भ, जिस पर आप इस request में काम कर रहे हैं। प्रकार: string उदाहरण: 508pf |
| with_deleted वैकल्पिक | अपनी request में deleted results शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/all/508pf
उदाहरण रिस्पॉन्स
ड्राफ़्ट Tweets
GET accounts/:account_id/draft_tweets
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 100 Min, Max: 1, 200 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: c-jh1g0ryb |
| user_id optional | उस उपयोगकर्ता को निर्दिष्ट करता है जिसके लिए Draft Tweets प्राप्त करने हैं। सेट न होने पर, यह account पर FULL promotable user को डिफ़ॉल्ट रूप से मानता है। Type: string Example: 756201191646691328 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?count=1
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account के लिए पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| draft_tweet_id required | उस ड्राफ्ट Tweet का संदर्भ जिसके साथ आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 994788364334325760 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994788364334325760
रिस्पॉन्स का उदाहरण
POST accounts/:account_id/draft_tweets
as_user_id पैरामीटर में निर्दिष्ट उपयोगकर्ता के लिए एक ड्राफ़्ट Tweet बनाएँ।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग में लिए जा रहे अकाउंट का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests में एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| as_user_id required | उस विज्ञापनदाता की user ID, जिसकी ओर से आप Tweet पोस्ट कर रहे हैं। विज्ञापनदाता को ads.x.com के माध्यम से आपके handle (या handles) को अपने ads account का access देना होगा। यह अनुमति आपको विज्ञापनदाता के बजाय अपने handle के OAuth tokens का उपयोग करके API call करने देती है। प्रकार: string उदाहरण: 756201191646691328 |
| text sometimes required | आपके status update का टेक्स्ट। अगर media_keys निर्दिष्ट नहीं हैं, तो यह आवश्यक है। प्रकार: string उदाहरण: Just setting up my X. |
| card_uri optional | यदि उपलब्ध हो, तो किसी भी cards रिस्पॉन्स के card_uri मान का उपयोग करके Tweet के साथ एक card संबद्ध करें। प्रकार: string उदाहरण: card://960880280705392541 |
| media_keys optional | अल्पविराम से अलग किए गए identifiers की सूची देकर Tweet के साथ media संबद्ध करें। इसमें अधिकतम 4 images, 1 animated GIF, या 1 video शामिल किया जा सकता है। नोट: media asset अकाउंट की Media Library में होना चाहिए। प्रकार: string उदाहरण: 13_1153584529292270722 |
| nullcast optional | क्या nullcasted (या “केवल Promoted”) Tweet बनाना है। प्रकार: boolean डिफ़ॉल्ट: true संभावित मान: true, false |
| name optional | Draft Tweet का नाम। अधिकतम लंबाई: 80 characters। प्रकार: string उदाहरण: Tweet with name |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?as_user_id=756201191646691328&text=Just setting up my X.
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग में लिए गए खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| draft_tweet_id required | उस Draft Tweet का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 994747471329873920 |
| card_uri optional | यदि उपलब्ध हो, तो किसी भी cards रिस्पॉन्स से card_uri मान का उपयोग करके Tweet के साथ एक card संबद्ध करें। Note: पैरामीटर को बिना किसी मान के निर्दिष्ट करके इसे हटाया जा सकता है। Type: string Example: card://970582057284129151 |
| media_keys optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची निर्दिष्ट करके Tweet के साथ media संबद्ध करें। इसमें अधिकतम 4 images, 1 animated GIF, या 1 video शामिल किया जा सकता है। Note: media asset खाते की Media Library में होना चाहिए। Note: पैरामीटर को बिना किसी मान के निर्दिष्ट करके इसे हटाया जा सकता है। Type: string Example: 13_1153584529292270722 |
| nullcast optional | क्या nullcasted (या “Promoted-only”) Tweet बनाना है। Type: boolean Possible values: true, false |
| text optional | आपके status update का टेक्स्ट। Type: string Example: just setting up my twttr |
| name optional | Draft Tweet का नाम। अधिकतम लंबाई: 80 characters. Type: string Example: Tweet with name |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994747471329873920?text=just setting up my twttr
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| draft_tweet_id required | उस ड्राफ्ट Tweet का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। Type: string Example: 994787835663155200 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994787835663155200
रिस्पॉन्स का उदाहरण
POST accounts/:account_id/draft_tweets/preview/:draft_tweet_id
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/preview/:draft_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests में एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| draft_tweet_id required | उस ड्राफ्ट Tweet का संदर्भ जिसके साथ आप request में काम कर रहे हैं। Type: string Example: 996132315829948416 |
अनुरोध का उदाहरण
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/preview/996132315829948416
रिस्पॉन्स का उदाहरण
इमेज कन्वर्सेशन कार्ड्स
card_uri पैरामीटर का उपयोग करें।
GET accounts/:account_id/cards/image_conversation
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_ids optional | comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स ko केवल वांछित इमेज कन्वर्सेशन कार्ड्स तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 59woh |
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | results का अगला page प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | name के आधार पर cards को सीमित करने के लिए एक वैकल्पिक query। सभी cards प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। अधिकतम लंबाई: 80 characters। Note: यह case-insensitive prefix matching करता है। Type: string Example: night |
| sort_by optional | समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक-दूसरे के साथ उपयोग नहीं किए जा सकते। Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 minutes में 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
अनुरोध का उदाहरण
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?card_ids=59woh
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id required | इमेज कन्वर्सेशन कार्ड का संदर्भ, जिस पर आप request में काम कर रहे हैं। प्रकार: string उदाहरण: 59woh |
| with_deleted optional | अपनी request में deleted results शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
अनुरोध का उदाहरण
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh
उदाहरण रिस्पॉन्स
POST accounts/:account_id/cards/image_conversation
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| first_cta required | पहले विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareNow |
| first_cta_tweet required | पहले CTA पर क्लिक किए जाने पर उपयोग किया जाने वाला Tweet text। Type: string Example: I Heart @AdsAPI |
| media_key required | इस card में उपयोग की जाने वाली image की media key। Note: image account की Media Library में होनी चाहिए। Note: image की न्यूनतम चौड़ाई 800px और width:height aspect ratio 1.91:1 होना चाहिए। Type: string Example: 3_1151345051104991073 |
| name required | card का नाम। Type: string Example: image conversation card |
| thank_you_text required | CTA पर क्लिक करने के बाद प्रदर्शित किया जाने वाला text। अधिकतम लंबाई: 23 वर्ण। Type: string Example: Thank you |
| second_cta sometimes required | दूसरे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Note: यदि title सेट not है, तो यह आवश्यक है। Example: #ShareAgain |
| second_cta_tweet sometimes required | दूसरे CTA पर क्लिक किए जाने पर उपयोग किया जाने वाला Tweet text। Note: यदि second_cta सेट है, तो यह आवश्यक है। Type: string Example: I Heart @AdsAPI Again |
| title sometimes required | card का title, जो image के नीचे और CTAs के ऊपर दिखाई देता है। अधिकतम लंबाई: 23 वर्ण। Type: string Note: यदि second_cta सेट not है, तो यह आवश्यक है। Example: Start a conversation |
| third_cta optional | तीसरे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareMore |
| third_cta_tweet sometimes required | तीसरे CTA पर क्लिक किए जाने पर उपयोग किया जाने वाला Tweet text। Type: string Note: यदि third_cta सेट है, तो यह आवश्यक है। Example: I Heart @TwitterDev |
| fourth_cta optional | चौथे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareExtra |
| fourth_cta_tweet sometimes required | चौथे CTA पर क्लिक किए जाने पर उपयोग किया जाने वाला Tweet text। Type: string Note: यदि fourth_cta सेट है, तो यह आवश्यक है। Example: I Heart @TwitterDev Again |
| unlocked_image_media_key optional | किसी image का media_key, जिसका उपयोग instant unlock scenario में किया जाएगा। यह केवल लिखने योग्य field है। रिस्पॉन्स में, API इस image के लिए एक X URL प्रदान करेगा। Note: image account की media library में होनी चाहिए। Note: image की न्यूनतम चौड़ाई 800px और width:height aspect ratio 5:2 होना चाहिए। Type: string Example: 3_883112887618682880 |
| thank_you_url optional | thank you text के साथ प्रदर्शित किया जाने वाला URL। Type: string Example: https://example.com/thankyou |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?media_key=3_957113581522141184&name=image conversation card&first_cta=#moon&first_cta_tweet=stars&thank_you_text=thanks&title=Full moon
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_id required | उस इमेज कन्वर्सेशन कार्ड का reference, जिस पर आप request में काम कर रहे हैं। Type: string Example: 4i0qg |
| first_cta optional | पहले विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareNow |
| first_cta_tweet optional | पहले CTA पर क्लिक किए जाने पर इस्तेमाल किया जाने वाला Tweet text। Type: string Example: I Heart @AdsAPI |
| second_cta optional | दूसरे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Note: यदि title सेट नहीं है, तो यह आवश्यक है। Example: #ShareAgain |
| second_cta_tweet optional | दूसरे CTA पर क्लिक किए जाने पर इस्तेमाल किया जाने वाला Tweet text। Note: यदि second_cta सेट है, तो यह आवश्यक है। Type: string Example: I Heart @AdsAPI Again |
| third_cta optional | तीसरे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareMore |
| third_cta_tweet optional | तीसरे CTA पर क्लिक किए जाने पर इस्तेमाल किया जाने वाला Tweet text। Type: string Note: यदि third_cta सेट है, तो यह आवश्यक है। Example: I Heart @TwitterDev |
| fourth_cta optional | चौथे विकल्प के लिए Call-To-Action (CTA) hashtag। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string Example: #ShareExtra |
| fourth_cta_tweet optional | चौथे CTA पर क्लिक किए जाने पर इस्तेमाल किया जाने वाला Tweet text। Type: string Note: यदि fourth_cta सेट है, तो यह आवश्यक है। Example: I Heart @TwitterDev Again |
| media_key optional | इस card में इस्तेमाल की जाने वाली image की media key। Note: image account की Media Library में होनी चाहिए। Note: image की न्यूनतम चौड़ाई 800px होनी चाहिए और width:height aspect ratio 1.91:1 होना चाहिए। Type: string Example: 3_1151345051104991073 |
| name optional | card का नाम। Type: string Example: moon card |
| thank_you_text optional | CTA पर क्लिक किए जाने के बाद दिखाया जाने वाला text। अधिकतम लंबाई: 23 वर्ण। Type: string Example: Thank you |
| thank_you_url optional | thank you text के साथ दिखाया जाने वाला URL। Type: string Example: https://example.com/thankyou |
| title optional | card का शीर्षक, जो image के नीचे और CTA के ऊपर दिखाई देता है। अधिकतम लंबाई: 23 वर्ण। Type: string Note: यदि second_cta सेट नहीं है, तो यह आवश्यक है। Example: Start a conversation |
| unlocked_image_media_key optional | image का एक media_key, जिसका इस्तेमाल instant unlock scenario में किया जाएगा। यह एक write-only field है। रिस्पॉन्स में, API इस image के लिए एक X URL देगा। Note: image account की media library में होनी चाहिए। Note: image की न्यूनतम चौड़ाई 800px होनी चाहिए और width:height aspect ratio 5:2 होना चाहिए। Type: string Example: 3_883112887618682880 |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh?name=moon card
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id required | उस इमेज कन्वर्सेशन कार्ड का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 4i0qe |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/4i0qe
रिस्पॉन्स का उदाहरण
मीडिया लाइब्रेरी
GET accounts/:account_id/media_library
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/media_library
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाता का पहचानकर्ता। यह संसाधन के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 20 Min, Max: 1, 50 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: c-1 |
| media_type optional | रिस्पॉन्स को केवल इच्छित media type तक सीमित करता है। Type: enum Possible values: GIF, IMAGE, VIDEO |
| q optional | name, title, file_name, और description फ़ील्ड्स के आधार पर संसाधन को सीमित करने के लिए एक वैकल्पिक query। Note: यह case-insensitive term matching करता है। Type: string Min, Max length: 1, 255 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?count=1
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | लीवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| media_key आवश्यक | उस मीडिया लाइब्रेरी ऑब्जेक्ट का संदर्भ जिसके साथ आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 13_909110614026444802 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/13_909110614026444802
रिस्पॉन्स का उदाहरण
AMPLIFY_VIDEO media category वाला वीडियो मीडिया लाइब्रेरी में जोड़ने पर, वह अपने-आप PREROLL account_media एसेट के रूप में उपलब्ध हो जाता है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/media_library
पैरामीटर
| Name | Description |
|---|---|
| account_id अनिवार्य | लीवरेज किए गए खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक अनिवार्य पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| media_key अनिवार्य | अपलोड की गई सामग्री का media_key। जब media_category निर्दिष्ट किया जाता है, तो POST media/upload रिस्पॉन्स में media_key लौटाया जाता है। Type: string Example: 3_931236738554519552 |
| description वैकल्पिक | वह विवरण जो Tweet किए जाने पर वीडियो के नीचे दिखाई देता है। अधिकतम लंबाई: 200 वर्ण। यह डिफ़ॉल्ट रूप से Tweet में रेंडर नहीं होता। वीडियो का description दिखाने के लिए, POST accounts/:account_id/tweet endpoint के साथ video_description पैरामीटर का उपयोग करें। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। Type: string Example: This is the description under the video. |
| file_name वैकल्पिक | मीडिया लाइब्रेरी ऑब्जेक्ट का फ़ाइल नाम। अधिकतम लंबाई: 255। फ़ाइल नाम ads.x.com पर Media Library UI में प्रत्येक media asset के media detail में देखा जा सकता है। यदि file_name सेट नहीं है, तो यह खाली रहेगा। Type: string Example: coffee.jpeg |
| name वैकल्पिक | मीडिया लाइब्रेरी ऑब्जेक्ट का नाम। अधिकतम लंबाई: 100। यह ads.x.com पर Media Library UI में प्रत्येक media asset के नीचे दिखने वाला लेबल है। यदि name सेट नहीं है, तो लेबल “Untitled” होगा। Type: string Example: Latte |
| poster_media_key वैकल्पिक | अपलोड की गई छवि के media_key का उपयोग करके वीडियो के लिए poster image निर्दिष्ट करें। यदि यह निर्दिष्ट नहीं किया गया है, तो पहले frame का उपयोग किया जाएगा। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। Type: string Example: 3_890599134483242005 |
| title वैकल्पिक | वह title (headline) जो Tweet किए जाने पर वीडियो के नीचे दिखाई देता है। अधिकतम लंबाई: 70 वर्ण। यह डिफ़ॉल्ट रूप से Tweet में रेंडर नहीं होता। वीडियो का title दिखाने के लिए, POST accounts/:account_id/tweet endpoint के साथ video_title पैरामीटर का उपयोग करें। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। Type: string Example: Video title |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?media_key=3_931236738554519552
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड खाता का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| media_key required | उस मीडिया लाइब्रेरी ऑब्जेक्ट का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 16_844800354743074820 |
| description optional | वह विवरण जो वीडियो के पोस्ट किए जाने पर उसके नीचे दिखाई देता है। अधिकतम लंबाई: 200 वर्ण। यह डिफ़ॉल्ट रूप से पोस्ट में रेंडर नहीं होता। वीडियो का description दिखाने के लिए, POST accounts/:account_id/tweet endpoint के साथ video_description पैरामीटर का उपयोग करें। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। प्रकार: string उदाहरण: This is the description under the video. |
| file_name optional | मीडिया लाइब्रेरी ऑब्जेक्ट का फ़ाइल नाम। अधिकतम लंबाई: 255। फ़ाइल नाम ads.x.com पर Media Library UI में प्रत्येक media asset के media detail में देखा जा सकता है। जब file_name सेट नहीं होता, तो यह खाली रहता है। प्रकार: string उदाहरण: coffee.jpeg |
| name optional | मीडिया लाइब्रेरी ऑब्जेक्ट का नाम। अधिकतम लंबाई: 100। यह ads.x.com पर Media Library UI में प्रत्येक media asset के नीचे दिखने वाला लेबल है। जब name सेट नहीं होता, तो लेबल “Untitled” होगा। प्रकार: string उदाहरण: Latte |
| poster_media_key optional | अपलोड की गई image के media_key का उपयोग करके वीडियो के लिए poster image निर्दिष्ट करें। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। प्रकार: string उदाहरण: 3_885003359340375465 |
| title optional | वह title (headline) जो वीडियो के पोस्ट किए जाने पर उसके नीचे दिखाई देता है। अधिकतम लंबाई: 70 वर्ण। यह डिफ़ॉल्ट रूप से पोस्ट में रेंडर नहीं होता। वीडियो का title दिखाने के लिए, POST accounts/:account_id/tweet endpoint के साथ video_title पैरामीटर का उपयोग करें। नोट: इसका उपयोग केवल वीडियो के साथ किया जा सकता है। प्रकार: string उदाहरण: Video title |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/16_844800354743074820?title=cat GIF&description=in space
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड खाता का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| media_key required | उस मीडिया लाइब्रेरी ऑब्जेक्ट का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 7_860318603387600896 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/7_860318603387600896
रिस्पॉन्स का उदाहरण
पोल कार्ड
GET accounts/:account_id/cards/poll
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/poll
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_ids optional | पहचानकर्ताओं की कॉमा-सेपरेटेड सूची देकर रिस्पॉन्स को केवल इच्छित poll cards तक सीमित करता है। अधिकतम 200 IDs दी जा सकती हैं। Type: string Example: 57i77 |
| count optional | हर अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | name के आधार पर cards को सीमित करने के लिए एक वैकल्पिक query। सभी प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। अधिकतम लंबाई: 80 वर्ण। Note: यह case-insensitive prefix matching करता है। Type: string Example: night |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक-दूसरे के साथ इस्तेमाल नहीं किए जा सकते। Note: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो फिलहाल प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?card_ids=57i77
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। टाइप: string उदाहरण: 18ce54d4x5t |
| card_id आवश्यक | उस poll card का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। टाइप: string उदाहरण: 57i8t |
| with_deleted वैकल्पिक | अपने अनुरोध में deleted परिणाम शामिल करें। टाइप: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i8t
उदाहरण रिस्पॉन्स
POST accounts/:account_id/cards/poll
PROMOTED_MEDIA_POLLS account feature की आवश्यकता होती है।
नोट: पोल कार्ड को update (PUT) करना संभव नहीं है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/poll
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| duration_in_minutes required | वह अवधि (मिनटों में) जिसके दौरान poll खुला रहेगा। निर्दिष्ट duration_in_minutes के बाद poll बंद हो जाएगा और वोट स्वीकार नहीं किए जाएंगे। यह रिस्पॉन्स में end_time के अनुरूप है। Note: यह card बनते ही शुरू हो जाता है, न कि इसे किसी Tweet में जोड़ने पर। Type: int Min, Max: 5, 10080 |
| first_choice required | poll का पहला विकल्प। अधिकतम लंबाई: 25 अक्षर। Type: string Example: One |
| name required | card का नाम। Type: string Example: poll card |
| second_choice required | poll का दूसरा विकल्प। अधिकतम लंबाई: 25 अक्षर। Type: string Example: Two |
| fourth_choice optional | poll का चौथा विकल्प। अधिकतम लंबाई: 25 अक्षर। Note: इस पैरामीटर का उपयोग करते समय पहला, दूसरा और तीसरा विकल्प सेट होना चाहिए। Type: string Example: Four |
| media_key optional | media library की image या video का media_key, जिसका उपयोग इस card में किया जाएगा। यह केवल-लिखने योग्य field है। रिस्पॉन्स में API इस media के लिए एक X URL प्रदान करेगा। Note: image या video account की media library में होना चाहिए। Note: image की न्यूनतम चौड़ाई 800px और width:height aspect ratio 1.91:1 होना आवश्यक है। |
| third_choice optional | poll का तीसरा विकल्प। अधिकतम लंबाई: 25 अक्षर। Note: इस पैरामीटर का उपयोग करते समय पहला और दूसरा विकल्प सेट होना चाहिए। Type: string Example: Three |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?duration_in_minutes=10080&first_choice=East&second_choice=West&media_key=13_950589518557540353&name=best coast poll
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह संसाधन के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id आवश्यक | उस poll card का संदर्भ, जिसके साथ आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 57i9t |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i9t
उदाहरण रिस्पॉन्स
प्रीरोल कॉल टू एक्शन
GET accounts/:account_id/preroll_call_to_actions
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_ids optional | comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल उन preroll CTAs तक सीमित करें जो निर्दिष्ट line items से संबद्ध हैं। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8v53k |
| count optional | प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | results का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| preroll_call_to_action_ids optional | comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित preroll CTAs तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8f0 |
| sort_by optional | समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक-दूसरे के साथ उपयोग नहीं किए जा सकते। Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
अनुरोध का उदाहरण
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_ids=8v53k
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| preroll_call_to_action_id required | उस preroll call to action का reference जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8f0 |
| with_deleted optional | अपने अनुरोध में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0
उदाहरण रिस्पॉन्स
POST accounts/:account_id/preroll_call_to_actions
PREROLL_VIEWS line item के लिए वैकल्पिक Call-to-Action (CTA) सेट करें।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों में आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| call_to_action आवश्यक | विज्ञापन में दिखाए जाने वाले बटन का CTA टेक्स्ट। Type: enum Possible values: GO_TO, SEE_MORE, SHOP, VISIT_SITE, WATCH_NOW |
| call_to_action_url आवश्यक | CTA बटन पर क्लिक करने पर उपयोगकर्ता को जिस URL पर रीडायरेक्ट किया जाएगा। Type: string Example: https://www.x.com |
| line_item_id आवश्यक | अनुरोध में जिस line item पर आप कार्य कर रहे हैं, उसका संदर्भ। Type: string Example: 8v53k |
अनुरोध का उदाहरण
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_id=8v53k&call_to_action=VISIT_SITE&call_to_action_url=https://www.x.com
रिस्पॉन्स का उदाहरण
PREROLL_VIEWS line item के लिए वैकल्पिक Call-to-Action (CTA) अपडेट करें.
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id
पैरामीटर
| Name | Description |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| preroll_call_to_action_id आवश्यक | उस preroll CTA का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 8f0 |
| call_to_action वैकल्पिक | विज्ञापन में दिखाए जाने वाले button का CTA text। Type: enum Possible values: GO_TO, SEE_MORE, SHOP, VISIT_SITE, WATCH_NOW |
| call_to_action_url वैकल्पिक | CTA button पर क्लिक करने पर user को redirect करने के लिए URL। Type: string Example: https://www.x.com |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0?call_to_action=WATCH_NOW
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| preroll_call_to_action_id आवश्यक | उस preroll CTA का संदर्भ जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8f0 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0
रिस्पॉन्स का उदाहरण
Scheduled Tweets
GET accounts/:account_id/scheduled_tweets
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | प्रयुक्त leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count वैकल्पिक | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 100 Min, Max: 1, 200 |
| cursor वैकल्पिक | परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: c-j3cn6n40 |
| user_id वैकल्पिक | Scheduled Tweets प्राप्त करने के लिए उपयोगकर्ता निर्दिष्ट करता है। यदि यह सेट नहीं है, तो डिफ़ॉल्ट रूप से खाते के FULL promotable user का उपयोग किया जाता है। Type: long Example: 756201191646691328 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?count=1
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | लीवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| scheduled_tweet_id आवश्यक | उस Scheduled Tweet का संदर्भ जिस पर आप इस अनुरोध में कार्रवाई कर रहे हैं। Type: string Example: 917438609065623552 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552
रिस्पॉन्स का उदाहरण
POST accounts/:account_id/scheduled_tweets
as_user_id पैरामीटर में निर्दिष्ट उपयोगकर्ता के लिए एक Scheduled Tweet बनाएँ।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| scheduled_at आवश्यक | ISO 8601 में व्यक्त वह समय, जब Tweet प्रकाशित होना चाहिए (या लाइव होना चाहिए)। नोट: Tweets को भविष्य में अधिकतम एक वर्ष तक ही शेड्यूल किया जा सकता है। नोट: Tweets को केवल मिनट-स्तर की सटीकता पर शेड्यूल किया जाना चाहिए; seconds को अनदेखा कर दिया जाएगा। प्रकार: string उदाहरण: 2017-12-31T23:59:00Z |
| as_user_id आवश्यक | उस विज्ञापनदाता का user ID, जिसकी ओर से आप Tweet पोस्ट कर रहे हैं। विज्ञापनदाता को ads.x.com के माध्यम से आपके handle (या handles) को अपने ads account का access देना होगा। यह अनुमति आपको विज्ञापनदाता के बजाय अपने handle के OAuth tokens का उपयोग करके API call करने देती है। प्रकार: long उदाहरण: 756201191646691328 |
| text कभी-कभी आवश्यक | आपके status update का टेक्स्ट। यदि media_keys निर्दिष्ट नहीं हैं, तो यह आवश्यक है। प्रकार: string उदाहरण: just setting up my twttr |
| card_uri वैकल्पिक | यदि उपलब्ध हो, तो किसी भी cards रिस्पॉन्स से मिले card_uri मान का उपयोग करके Tweet के साथ एक card संबद्ध करें। प्रकार: string उदाहरण: card://855591459410511943 |
| media_keys वैकल्पिक | अल्पविराम से अलग की गई identifiers की सूची देकर Tweet के साथ media संबद्ध करें। इसमें अधिकतम 4 images, 1 animated GIF, या 1 video शामिल किया जा सकता है। नोट: media asset खाते की Media Library में होना चाहिए। प्रकार: string उदाहरण: 13_1153584529292270722 |
| nullcast वैकल्पिक | क्या nullcasted (या “Promoted-only”) Tweet बनाना है। प्रकार: boolean डिफ़ॉल्ट: true संभावित मान: true, false |
| name वैकल्पिक | Scheduled Tweet का नाम। अधिकतम लंबाई: 80 characters। प्रकार: string उदाहरण: Tweet with name |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?as_user_id=756201191646691328&media_keys=3_917438348871983104&scheduled_at=2018-01-01
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| scheduled_tweet_id required | उस Scheduled Tweet का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 870321875435442177 |
| card_uri optional | यदि उपलब्ध हो, तो किसी भी cards रिस्पॉन्स से card_uri मान का उपयोग करके Tweet के साथ एक card संबद्ध करें। Note: बिना मान दिए पैरामीटर निर्दिष्ट करके इसे unset (हटा) सकते हैं। Type: string Example: card://875146925316386347 |
| media_keys optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची निर्दिष्ट करके Tweet के साथ media संबद्ध करें। इसमें अधिकतम 4 images, 1 animated GIF, या 1 video शामिल किया जा सकता है। Note: media asset खाते की Media Library में होना चाहिए। Note: बिना मान दिए पैरामीटर निर्दिष्ट करके इसे unset (हटा) सकते हैं। Type: string Example: 13_1153584529292270722 |
| nullcast optional | क्या nullcasted (या “Promoted-only”) Tweet बनाना है। Type: boolean Possible values: true, false |
| scheduled_at optional | ISO 8601 में व्यक्त वह समय, जब Tweet प्रकाशित होना चाहिए (या live होना चाहिए)। Type: string Example: 2017-12-31T23:59:59Z |
| text optional | आपके status update का टेक्स्ट। Type: string Example: just setting up my twttr |
| name optional | Scheduled Tweet का नाम। अधिकतम लंबाई: 80 characters। Type: string Example: Tweet with name |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875057751231037440?text=winter solstice
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| scheduled_tweet_id required | उस Scheduled Tweet का संदर्भ, जिस पर आप इस अनुरोध में कार्रवाई कर रहे हैं। Type: string Example: 870321875435442177 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875064008595787776
रिस्पॉन्स का उदाहरण
Tweet प्रीव्यू
GET accounts/:account_id/tweet_previews
- एक ही API अनुरोध में एकाधिक Tweet—अधिकतम 200 तक—का पूर्वावलोकन करने का समर्थन करता है
- Tweet लेआउट और शैली की सटीक, अद्यतन रेंडरिंग
- सभी नवीनतम फ़ॉर्मैट और कार्ड type का समर्थन करता है
- एक iframe लौटाता hai
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/tweet_previews
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड अकाउंट के लिए पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tweet_ids required | पहचानकर्ताओं की अल्पविराम से अलग की गई सूची। अधिकतम 200 ID दी जा सकती हैं। नोट: ID, निर्दिष्ट tweet_type से मेल खानी चाहिए। उदाहरण के लिए, यदि कोई Scheduled Tweet ID पास की जाती है और tweet_type=PUBLISHED निर्दिष्ट किया गया है, तो उस ID के लिए प्रीव्यू वापस नहीं किया जाएगा। Type: long Example: 1122911801354510336,1102836745790316550 |
| tweet_type required | निर्दिष्ट tweet_ids के लिए Tweet type। Type: enum Possible values: DRAFT, PUBLISHED, SCHEDULED |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet_previews?tweet_ids=1122911801354510336,1102836745790316550&tweet_type=PUBLISHED
रिस्पॉन्स का उदाहरण
Tweets
GET accounts/:account_id/tweets
user_id पैरामीटर में निर्दिष्ट उपयोगकर्ता के लिए Tweet का विवरण प्राप्त करें। यह खाते के अंतर्गत किसी भी प्रमोटेबल उपयोगकर्ता का हो सकता है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/tweets
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests में एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tweet_type required | निर्दिष्ट tweet_ids के लिए Tweet का type। Type: enum Possible values: DRAFT, PUBLISHED, SCHEDULED |
| count optional | यह निर्दिष्ट करता है कि प्रत्येक अलग request में कितने records प्राप्त करने का प्रयास किया जाए। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: AAAAAFhLRpQLNF-sGBSgAA |
| include_mentions_and_replies optional | उपलब्ध Tweets की सूची से mentions और replies को फ़िल्टर करके हटाना है या नहीं। Type: boolean Default: false Possible values: true, false |
| name optional | name के आधार पर Tweets को सीमित करने के लिए एक वैकल्पिक query। सभी Tweets प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। अधिकतम लंबाई: 80 characters। Note: यह case-insensitive prefix matching करता है। Type: string Example: dtc |
| timeline_type optional | क्या nullcasted (यानी “Promoted-only”) Tweets, organic Tweets, या दोनों लौटाने हैं। Type: enum Default: NULLCAST Possible values: ALL, NULLCAST, ORGANIC |
| trim_user optional | क्या Tweet रिस्पॉन्स में user object को शामिल न किया जाए। सक्षम होने पर, user object का केवल वही भाग लौटाया जाएगा जिसमें Tweet के author की user ID होगी। Type: boolean Default: false Possible values: true, false |
| tweet_ids optional | पहचानकर्ताओं की comma-separated सूची। अधिकतम 200 IDs दी जा सकती हैं। Note: IDs, निर्दिष्ट tweet_type के अनुरूप होनी चाहिए। उदाहरण के लिए, अगर Scheduled Tweet ID दी जाती है, तो उस Tweet को रिस्पॉन्स में लौटाने के लिए tweet_type must SCHEDULED होना चाहिए। Type: long Example: 1122911801354510336,1102836745790316550 |
| user_id optional | यह निर्दिष्ट करता है कि Tweets को किस user तक सीमित करना है। सेट न होने पर, डिफ़ॉल्ट रूप से account पर FULL promotable user का उपयोग किया जाता है। Type: long Example: 756201191646691328 |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets?tweet_ids=1166476031668015104&tweet_type=PUBLISHED&trim_user=true
उदाहरण रिस्पॉन्स
POST accounts/:account_id/tweet
as_user_id पैरामीटर में निर्दिष्ट उपयोगकर्ता के लिए एक Tweet बनाएँ। nullcasted (डिफ़ॉल्ट) और organic, दोनों तरह के Tweet निर्माण का समर्थन किया जाता है। Nullcasted Tweets सार्वजनिक timeline में दिखाई नहीं देते और followers को नहीं दिखाए जाते। दोनों में से किसी भी प्रकार का उपयोग campaigns में किया जा सकता है।
यदि authenticated user इस खाते का FULL promotable user नहीं है, तो GET accounts/:account_id/authenticated_user_access endpoint पर अनुरोध करके यह तय करें कि क्या उसके पास इस user की ओर से Tweet करने की अनुमति है। TWEET_COMPOSER permission यह दर्शाती है कि user इस endpoint का उपयोग FULL promotable user की ओर से nullcasted Tweets बनाने के लिए कर सकता है।
मीडिया के लिए upload.x.com endpoint का उपयोग करते समय, additional_owners पैरामीटर में वही user_id वैल्यू पास करें, जो आप इस endpoint में as_user_id वैल्यू के रूप में पास करते हैं।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/tweet
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| as_user_id required | उस advertiser की user ID, जिसकी ओर से आप Tweet पोस्ट कर रहे हैं। advertiser को ads.x.com के ज़रिए आपके handle (या handles) को अपने ads account का access देना होगा। यह अनुमति आपको advertiser के बजाय अपने handle के OAuth tokens का उपयोग करके API call करने देती है। Type: long Example: 756201191646691328 |
| text sometimes required | आपके status update का टेक्स्ट। अगर media_keys निर्दिष्ट नहीं हैं, तो यह आवश्यक है। Type: string Example: hello, world |
| card_uri optional | यदि उपलब्ध हो, तो किसी भी cards response के card_uri मान का उपयोग करके Tweet के साथ एक card संबद्ध करें। Type: string Example: card://853503245793641682 |
| conversation_settings optional | चुनें कि इस Tweet का जवाब कौन दे सकता है। जिन users का उल्लेख किया गया है, वे हमेशा जवाब दे सकते हैं। Note: यह field POST request के response में वापस नहीं की जाएगी, लेकिन GET request करने पर वापस की जाएगी। Note: यह parameter केवल Ads API v8 और उसके बाद के versions में काम करता है। Type: enum Default: EVERYONE Possible values: EVERYONE, FOLLOWING, MENTIONED_USERS |
| media_keys optional | identifiers की comma-separated सूची देकर Tweet के साथ media संबद्ध करें। इसमें अधिकतम 4 images, 1 animated GIF, या 1 video शामिल किया जा सकता है। Type: string Example: 13_1153584529292270722 |
| name optional | Tweet का नाम। अधिकतम लंबाई: 80 अक्षर। Type: string Example: Tweet with name |
| nullcast optional | क्या nullcasted (या “Promoted-only”) Tweet बनाना है। Note: Organic Tweets (nullcast=false) केवल authenticated user के लिए ही बनाए जा सकते हैं। Type: boolean Default: true Possible values: true, false |
| trim_user optional | क्या Tweet response में user object को शामिल न किया जाए। सक्षम होने पर, user object का केवल Tweet के author की user ID वाला हिस्सा ही वापस किया जाएगा। Type: boolean Default: false Possible values: true, false |
| tweet_mode optional | क्या रिस्पॉन्स compatibility या extended mode में होना चाहिए। अतिरिक्त जानकारी के लिए इसे देखें। Type: string Possible values: compat, extended |
| video_cta optional | video के लिए CTA। Type: enum Possible values: VISIT_SITE, WATCH_NOW |
| video_cta_value optional | video पर संबंधित CTA का मान। Type: string Example: https://dev.x.com |
| video_description optional | video के नीचे दिखाई देने वाला विवरण। अधिकतम लंबाई: 200 अक्षर। Type: string Example: Integrate with the X advertising platform |
| video_title optional | video के नीचे दिखाई देने वाला शीर्षक (headline)। अधिकतम लंबाई: 70 अक्षर। Type: string Example: X Ads API |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet?text=hello, world&as_user_id=756201191646691328&trim_user=true
उदाहरण रिस्पॉन्स
name को अपडेट करें.
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/tweets/:tweet_id/name
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tweet_id required | उस Tweet का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: long Example: 994747471329873920 |
| name optional | Tweet का नाम। अधिकतम लंबाई: 80 वर्ण। Type: string Example: Tweet with name |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets/994747471329873920/name?name=new Tweet name
उदाहरण रिस्पॉन्स
वीडियो कन्वर्सेशन कार्ड
card_uri पैरामीटर का उपयोग करें।
GET accounts/:account_id/cards/video_conversation
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_ids optional | पहचानकर्ताओं की कॉमा-सेपरेटेड सूची देकर रिस्पॉन्स को केवल इच्छित video conversation cards तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 5a86h |
| count optional | हर अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या बताता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor बताता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | name के आधार पर cards को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। अधिकतम लंबाई: 80 वर्ण। Note: यह case-insensitive prefix matching करता है। Type: string Example: night sky |
| sort_by optional | समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक साथ इस्तेमाल नहीं किए जा सकते। Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होती हैं, जो फिलहाल 15 मिनट में 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?card_ids=5a86h
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| card_id required | उस video conversation card का संदर्भ जिसका आप इस अनुरोध में उपयोग कर रहे हैं। Type: string Example: 4i0ya |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h
उदाहरण रिस्पॉन्स
POST accounts/:account_id/cards/video_conversation
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id अनिवार्य | लिंक किए गए account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| first_cta आवश्यक | पहले विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को शामिल नहीं किया गया है)। Type: string उदाहरण: #APIs |
| first_cta_tweet आवश्यक | पहले CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। type: string उदाहरण: Ads API |
| media_key आवश्यक | इस कार्ड में उपयोग किए जाने वाले वीडियो के लिए media key। ध्यान दें: वीडियो खाते की Media Library में होना चाहिए। ध्यान दें: 16:9 का aspect ratio आवश्यक है। प्रकार: string उदाहरण: 13_1168079965037467209 |
| name आवश्यक | कार्ड का नाम। type: string उदाहरण: video conversation card |
| thank_you_text आवश्यक | CTA पर क्लिक करने के बाद प्रदर्शित होने वाला पाठ। अधिकतम लंबाई: 23 वर्ण। Type: string उदाहरण: Build it |
| title कभी-कभी आवश्यक | कार्ड का शीर्षक, जो वीडियो के नीचे और CTA के ऊपर दिखाई देता है। अधिकतम लंबाई: 23 वर्ण। Type: string नोट: यदि second_cta सेट नहीं किया गया है, तो यह आवश्यक है। उदाहरण: Developers |
| second_cta कुछ मामलों में आवश्यक | दूसरे विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string नोट: यदि title सेट नहीं है, तो यह आवश्यक है। उदाहरण: #ShareAgain |
| second_cta_tweet कभी-कभी आवश्यक | दूसरे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet पाठ। नोट: यदि second_cta सेट है, तो यह आवश्यक है। Type: string उदाहरण: I Heart @AdsAPI Again |
| poster_media_key वैकल्पिक | इस कार्ड में उपयोग की जाने वाली पोस्टर छवि के लिए media key। यदि इसे निर्दिष्ट नहीं किया जाता है, तो पहले फ़्रेम का उपयोग किया जाएगा। नोट: वीडियो खाते की Media Library में होना चाहिए। प्रकार: long उदाहरण: 3_882726458191298561 |
| third_cta वैकल्पिक | तीसरे विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string उदाहरण: #ShareMore |
| third_cta_tweet कभी-कभी आवश्यक होता है | तीसरे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। type: string नोट: यदि third_cta सेट है, तो यह आवश्यक है। उदाहरण: I Heart @TwitterDev |
| fourth_cta वैकल्पिक | चौथे विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string उदाहरण: #ShareExtra |
| fourth_cta_tweet कभी-कभी ज़रूरी | चौथे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। Type: string नोट: यदि fourth_cta सेट है, तो यह आवश्यक है। उदाहरण: I Heart @TwitterDev Again |
| thank_you_url वैकल्पिक | धन्यवाद संदेश के साथ प्रदर्शित किया जाने वाला URL। Type: string उदाहरण: https://example.com/thankyou |
| unlocked_image_media_key वैकल्पिक | एक इमेज का media_key, जिसका इस्तेमाल instant unlock परिदृश्य में किया जाएगा। यह केवल-लिखने योग्य फ़ील्ड है। रिस्पॉन्स में, API इस इमेज के लिए एक X URL प्रदान करेगा। नोट: इमेज अकाउंट की media library में होनी चाहिए। Type: string उदाहरण: 3_883112887618682880 |
| unlocked_video_media_key वैकल्पिक | GET accounts/:account_id/media_library endpoint से किसी वीडियो का पहचानकर्ता, जिसका उपयोग instant unlock परिदृश्य में किया जाएगा। Type: string उदाहरण: 13_867520357225418752 |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?first_cta=#APIs&first_cta_tweet=Ads API&name=video conversation card&thank_you_text=Build it&title=Developers&media_key=13_958388276489895936
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | उपयोग में लाए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id आवश्यक | उस वीडियो कन्वरसेशन कार्ड का संदर्भ, जिसके साथ आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 5a86h |
| first_cta वैकल्पिक | पहले विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string उदाहरण: #APIs |
| first_cta_tweet वैकल्पिक | पहले CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। Type: string उदाहरण: Ads API |
| second_cta वैकल्पिक | दूसरे विकल्प के लिए Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string नोट: यदि title सेट नहीं है, तो यह आवश्यक है। उदाहरण: #ShareAgain |
| second_cta_tweet वैकल्पिक | दूसरे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। नोट: यदि second_cta सेट है, तो यह आवश्यक है। Type: string उदाहरण: I Heart @AdsAPI Again |
| third_cta वैकल्पिक | तीसरे विकल्प के लिए कॉल-टू-एक्शन (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string उदाहरण: #ShareMore |
| third_cta_tweet वैकल्पिक | तीसरे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। Type: string नोट: यदि third_cta सेट है, तो यह आवश्यक है। उदाहरण: I Heart @TwitterDev |
| fourth_cta वैकल्पिक | चौथे विकल्प का Call-To-Action (CTA) हैशटैग। अधिकतम लंबाई: 20 वर्ण (# को छोड़कर)। Type: string उदाहरण: #ShareExtra |
| fourth_cta_tweet वैकल्पिक | चौथे CTA पर क्लिक करने पर उपयोग किया जाने वाला Tweet टेक्स्ट। Type: string नोट: यदि fourth_cta सेट है, तो यह आवश्यक है। उदाहरण: I Heart @TwitterDev Again |
| media_key वैकल्पिक | इस कार्ड में उपयोग किए जाने वाले वीडियो के लिए media key। नोट: वीडियो खाते की Media Library में होना चाहिए। नोट: 16:9 का aspect ratio आवश्यक है। प्रकार: string उदाहरण: 13_1168079965037467209 |
| name वैकल्पिक | कार्ड का नाम। Type: string उदाहरण: developers card |
| poster_media_key वैकल्पिक | इस कार्ड में उपयोग की जाने वाली पोस्टर इमेज की मीडिया कुंजी। यदि इसे निर्दिष्ट नहीं किया जाता है, तो पहले फ़्रेम का उपयोग किया जाएगा। नोट: वीडियो खाते की Media Library में होना चाहिए। प्रकार: long उदाहरण: 3_882726458191298561 |
| thank_you_text optional | CTA पर क्लिक करने के बाद प्रदर्शित किया जाने वाला पाठ। अधिकतम लंबाई: 23 वर्ण। Type: string उदाहरण: Build it |
| thank_you_url वैकल्पिक | धन्यवाद टेक्स्ट के साथ प्रदर्शित किया जाने वाला URL। type: string उदाहरण: https://example.com/thankyou |
| title वैकल्पिक | कार्ड का शीर्षक, जो वीडियो के नीचे और CTAs के ऊपर दिखाई देता है। अधिकतम लंबाई: 23 वर्ण। प्रकार: string नोट: यदि second_cta not set है, तो यह आवश्यक है। उदाहरण: Start a conversation |
| unlocked_image_media_key वैकल्पिक | किसी छवि का media_key, जिसका उपयोग इंस्टेंट अनलॉक परिदृश्य में किया जाएगा। यह केवल लिखने के लिए फ़ील्ड है। रिस्पॉन्स में, API इस छवि के लिए एक X URL प्रदान करेगा। नोट: छवि खाते की मीडिया लाइब्रेरी में होनी चाहिए। Type: string उदाहरण: 3_883112887618682880 |
| unlocked_video_media_key वैकल्पिक | GET accounts/:account_id/media_library endpoint से प्राप्त वीडियो का पहचानकर्ता, जिसका उपयोग instant unlock परिदृश्य में किया जाएगा। Type: string Example: 13_867520357225418752 |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h?name=developers card
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आमतौर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| card_id आवश्यक | उस video conversation card का संदर्भ, जिसके साथ आप अनुरोध में काम कर रहे हैं। प्रकार: string उदाहरण: 4i0ya |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/4i0ya