क्रिएटिव

अवलोकन

क्रिएटिव्स ऐसी कोई भी इकाई हो सकती हैं जिन्हें किसी अभियान में प्रमोट किया जा सकता है। पोस्ट्स में टेक्स्ट, इमेज, GIF, वीडियो या कार्ड्स शामिल हो सकते हैं। कार्ड्स में इमेज या वीडियो शामिल हो सकते हैं। इमेज, GIF या वीडियो क्रिएटिव्स को या तो POST media/upload का उपयोग करके अपलोड किया जाता है — यह एक सरल अपलोड एंडपॉइंट है जो केवल इमेज का समर्थन करता है — या POST media/upload (chunked) एंडपॉइंट्स का उपयोग करके। इन्हें इनमें जोड़ा जा सकता है कार्ड्स:

POST accounts/:account_id/cards Tweets:
POST accounts/:account_id/tweets - Tweets में कार्ड्स जोड़ने के लिए, card_uri पैरामीटर का उपयोग करें। शेड्यूल किए गए Tweets:
POST accounts/:account_id/scheduled_tweets

कार्ड्स के बारे में अतिरिक्त जानकारी के लिए, कृपया Cards पेज देखें। Promoted Video पेज कार्ड्स या Tweets के साथ वीडियो संबद्ध करने के बारे में जानकारी देता है।

कार्ड्स

Ads API कई प्रकार के कार्ड्स का समर्थन करता है, जिनका उपयोग Tweets में किया जा सकता है और फिर उन्हें अभियानों में प्रमोट किया जा सकता है। ध्यान दें: एक बार Tweet किए जाने के बाद, कार्ड का विवरण सार्वजनिक रूप से दिखाई देता है। इसमें उस उपयोगकर्ता की जानकारी भी शामिल हो सकती है, जो कार्ड का स्वामी है।

इमेज

निम्नलिखित इमेज विनिर्देश Cards में उपयोग किए जाने वाले एसेट्स पर लागू होते हैं। इमेज 3MB या उससे कम की होनी चाहिए और उसकी चौड़ाई कम-से-कम 800px होनी चाहिए। इसके अलावा, हम निम्नलिखित चौड़ाई:ऊंचाई आस्पेक्ट रेशियो का समर्थन करते हैं।

वेबसाइट: 1:1 और 1.91:1
इमेज ऐप डाउनलोड: 1:1 और 1.91:1
पोल: 1.91:1
इमेज कन्वर्सेशन: 1.91:1
इमेज डायरेक्ट मैसेज: 1.91:1

हम निम्नलिखित इमेज फ़ॉर्मैट का समर्थन करते हैं: .bmp, .jpeg, और .png.

वीडियो

निम्नलिखित वीडियो विनिर्देश Cards में उपयोग होने वाली एसेट्स पर लागू होते हैं। हम चौड़ाई:ऊँचाई के लिए निम्नलिखित आस्पेक्ट रेशियो का समर्थन करते हैं।

वीडियो वेबसाइट: 16:9 और 1:1
वीडियो ऐप डाउनलोड: 16:9 और 1:1
पोल: 16:9
वीडियो कन्वर्सेशन: 16:9
वीडियो डायरेक्ट मैसेज: 16:9

प्रमोटेड वीडियो

यह दस्तावेज़ Ads API के माध्यम से वीडियो अपलोड करने और उसे प्रमोट करने की प्रक्रिया का संक्षिप्त अवलोकन देता है। Ads API, Tweets और निम्नलिखित कार्डों में Promoted Video का समर्थन करता है:

सबसे पहले, POST media/upload (chunked) एंडपॉइंट का उपयोग करके वीडियो अपलोड करें। media_id का उपयोग करके, POST accounts/:account_id/videos एंडपॉइंट के माध्यम से वीडियो को किसी Ads अकाउंट से संबद्ध करें। वीडियो का id, जिसे कभी-कभी media_key भी कहा जाता है, बाद के अनुरोधों में इस्तेमाल किया जाएगा। यह एक string है जो एक int से शुरू होती है, फिर एक underscore आता है, और अंत में एक long value होती है। उदाहरण के लिए, देखें: 13_875943225764098048.

Tweets में प्रमोटेड वीडियो

Tweet बनाने के लिए, वीडियो के id के साथ POST accounts/:account_id/tweet endpoint का इस्तेमाल करें। इस चरण में, आप वीडियो का शीर्षक, विवरण और कॉल-टू-एक्शन (CTA) भी दे सकते हैं। ये मान उपयोगकर्ताओं को दिखाई देते हैं।

कार्ड में प्रमोटेड वीडियो

Video App Download और Video Conversation कार्ड में पोस्टर इमेज जोड़ने की सुविधा उपलब्ध है। इन कार्ड में उपयोग के लिए इमेज अपलोड करने हेतु POST media/upload endpoint का उपयोग करें। निम्नलिखित endpoints में से किसी एक का उपयोग करके कार्ड बनाएं:

वीडियो के id और वैकल्पिक रूप से इमेज के media_id (पोस्टर इमेज के लिए) का उपयोग करके। अंत में, POST accounts/:account_id/tweet endpoint का उपयोग करके Tweet बनाएं। कार्ड को card_uri parameter का उपयोग करके Tweets से अटैच किया जाता है।

सामान्य जानकारी

API के माध्यम से वीडियो अपलोड करने के बारे में विस्तृत मार्गदर्शन के लिए, कृपया Video Upload Guide देखें। वीडियो को प्री-रोल एसेट के रूप में भी प्रमोट किया जा सकता है। विस्तृत जानकारी के लिए Video Views Pre-roll Objective Guide देखें।

(2015-10-22 से) प्रमोटेड सामग्री में उपयोग के लिए वीडियो अपलोड करते समय, POST media/upload (chunked) endpoint पर सभी INIT कमांड अनुरोधों में media_category पैरामीटर का मान amplify_video होना चाहिए। इस नए पैरामीटर का उपयोग यह सुनिश्चित करता है कि वीडियो का असिंक्रोनस रूप से प्री-प्रोसेसिंग हो और उसे प्रमोटेड सामग्री में उपयोग के लिए तैयार किया जाए। वीडियो अपलोड होने के बाद असिंक्रोनस प्रोसेसिंग पूरी हुई है या नहीं, यह जांचने के लिए STATUS कमांड का उपयोग किया जा सकता है।
वर्तमान में अनुमत प्रमोटेड वीडियो की अधिकतम लंबाई 10 मिनट है, और फ़ाइल का आकार 500MB या उससे कम होना चाहिए।
अपलोड किया गया वीडियो mp4 या mov फ़ॉर्मैट में होना चाहिए।
अपलोड किया गया वीडियो आम तौर पर जल्दी प्रोसेस हो जाता है, लेकिन प्रोसेसिंग में लगने वाला समय वीडियो की लंबाई और फ़ाइल के आकार के अनुसार अलग-अलग हो सकता है।
अपलोड की गई पोस्टर इमेज png या jpg फ़ॉर्मैट में होनी चाहिए। आस्पेक्ट रेशियो या आकार के लिए कोई आवश्यकता नहीं है, लेकिन पोस्टर इमेज को वीडियो प्लेयर के अनुसार समायोजित किया जाएगा।

मार्गदर्शिकाएँ

शेड्यूल किए गए Tweets

परिचय

Scheduled Tweets किसी विज्ञापनदाता या उपयोगकर्ता को ऐसा Tweet बनाने की सुविधा देते हैं, जिसे बाद की किसी तारीख को प्रकाशित होने के लिए शेड्यूल किया जा सके। इन Tweets को बनाने और प्रबंधित करने के अलावा, API इन Tweets को किसी line item से संबद्ध करने की सुविधा भी देता है, ताकि Tweet के लाइव होते ही उसका प्रमोशन किया जा सके। इससे विज्ञापनदाता पहले से नेटिव Tweets तैयार कर सकते हैं और किसी भी प्रमुख पहल से पहले अपने कैंपेन क्रिएटिव्स की योजना बना सकते हैं। उदाहरण के लिए, किसी नए उत्पाद की घोषणा होते ही तुरंत लाइव होने के लिए किसी Tweet creative को पहले से तैयार रखना। Scheduled Tweets API endpoints द्वारा प्रदान की जाने वाली सभी सुविधाएँ नीचे सूचीबद्ध हैं:

नए शेड्यूल किए गए 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, “live” Tweet से अलग इकाइयाँ हैं, इसलिए इनके निर्माण या संपादन पर दो अलग-अलग प्रकार के सत्यापन चलाए जाते हैं। सत्यापन नियमों का पहला सेट शेड्यूल किए गए 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 पर सेट कर दिया जाएगा

कार्यप्रवाह

नया शेड्यूल किया गया Tweet बनाएँ POST accounts/:account_id/scheduled_tweets endpoint का उपयोग करके नया शेड्यूल किया गया Tweet बनाया जा सकता है। इस endpoint के लिए निम्नलिखित पैरामीटर आवश्यक हैं: 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 भर दी जाती है।

twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_tweets" -d 'scheduled_at=2017-12-24T23:59:00Z&text=Happy Holidays!'

इससे निम्नलिखित शेड्यूल किया गया Tweet बनाया जाएगा:

{
  "request": {
    "params": {
      "text": "Happy Holidays!",
      "scheduled_at": "2017-12-24T23:59:00Z"
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "917507899668099072",
    "text": "Happy Holidays!",
    "user_id": "3271358660",
    "scheduled_status": "SCHEDULED",
    "id": 917507899668099100,
    "nullcast": true,
    "created_at": "2017-10-09T21:51:44Z",
    "scheduled_at": "2017-12-24T23:59:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T21:51:44Z",
    "tweet_id": null,
    "media_keys": []
  }
}

जब यह शेड्यूल किया गया Tweet लाइव हो जाएगा, तो tweet_id फ़ील्ड में “live” Tweet की ID भर दी जाएगी। शेड्यूल किया गया Tweet देखें इसके बाद, पिछले चरण के शेड्यूल किए गए Tweet id के साथ GET accounts/:account_id/tweet_previews endpoint का उपयोग करके Tweet का प्रीव्यू जनरेट किया जा सकता है। API रिस्पॉन्स में एक iframe URL शामिल होगा, जो शेड्यूल किए गए Tweet का प्रीव्यू रेंडर करने के लिए तैयार होगा। संबंधित CSS और इमेज सीधे X के माध्यम से सर्व की जाएंगी。

twurl -H ads-api.x.com -X GET "/6/accounts/18ce54bgxky/tweet_previews?tweet_type=SCHEDULED&tweet_ids=917507899668099072

{
  "request": {
    "params": {
      "tweet_type": "SCHEDULED",
      "tweet_ids": [
        "917507899668099072"
      ],
      "account_id": "18ce54bgxky"
    }
  },
  "data": [
    {
      "tweet_id": "1126633863155871744",
      "preview": "<\iframe class='tweet-preview' src='https://ton.smf1.x.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAK1WTW%2FjNhD9Kyyv9dqSZdmOgALJbhJsCyxaIDkUWBUEJY0lNhSpklRSN%2FV%2F71CyZbm297S%2BWJxPzpt5I71T9wbgaELeaW6AOygYxyN9rlryhW9JcEPmUbKIkuiG%2FBjgj8yD8IZOqChoEobz5TKK1ssojOP1KlwtFl7BrDMY4oIW%2FTatlMzB3z7JZ940W%2FJZS1Hwrf0Btc60Kve3oMmGSwsTWgjbSL7tXJjhqgSafA0mYfzHhIJywgmwNHmnFbeV4yU%2Bf0WN3daZlvtDa8Gw2htrdRCZXrlDU92aHIPStA2CKOekMrD5KaWVc02SztIZps%2Bh0rIAg27TXNcpJQYk2ii90VLqt7R3ht%2B4cQoMeVClUIAPd03Th01nvDfx0ClmoJFYk0aouGst82gqROaKskf03KCr7LLvXnXN02K3QTHFaziovYdH0seL5qswitfLZTBq6FGIRfSe9Lm1FTfkY%2BX%2FFcpPAlNRC7eufdFSY1%2BxASh84oo8YitzYXM9IZ%2FuaNcQ1HjMbQc61l0VXDmYlsJVbTYVGq0KwPCi2cf5tQFFnjR2zyDU6YycwX%2Fr3oRzvfKpwTaSZ8NfQUoU%2FUsetanxAV79VElhHbm1oIrSiILcvvgquqSN0Q7y8Uz2TQdjWa5bhZP8IUShEeh8IvIxkVB7SY%2FyKctaIL%2B0kgQrMp8n0SKJ10eWxZ4t%2FBXHUzg4idu6nOnNxsIQ1Yka2D9aDc0sQTNQPJP%2B2sgqvPUrGLERozL68ToNLRELvBj4VuZaOSOy1mmsdAi2dxaWOeyhlRzVl6TYozMnhHIjJLCM5y%2BlwaweHOn96afg%2FuHhnl60ETUvgR1HpJsQntkptrcuO0bOOhuLg1NBPfyH6Swrpw2W9O24rBu8kwH8DuEdns9Kv1hLc5rsxBaTLcN1HIdhHIVRuFov5wtMXH748vO2%2BP0jUzjFXE7%2FbMa3%2BFZl3z1ZxhWyjv2fwlfy9NaY6LhO0lm4WC3WcRSvlqO4UqiXYT7C%2B7vwcT7SWlFAxg3LtMHNfH2ODnZ4kIPVPRo9jnN1r5eDNup%2BIy2y5GxuDrQqYMNb6dje9or44HOyQYTnWs%2FXXoD7%2Ba8WrGO4hwZuK%2B2Qt%2F32tAPhB%2B4xt238qjVQtpIbuuvIP6wbjfAIhStncO3eZ0f9keMHmYHuo%2BCwFoJ%2BDfktdEF0JPfebbxgct30b%2BdhY%2B51u%2FGm2U2IR7rW%2FbJU%2FdcBfpEchHjwoO52%2FwENmVvErwgAAA%3D%3D'>"
    }
  ]
}

नया बनाया गया शेड्यूल किया गया Tweet का एक नमूना दृश्य ऊपर दिखाया गया है किसी शेड्यूल किए गए Tweet को लाइन आइटम से संबद्ध करें हालाँकि शेड्यूल किए गए Tweets का उपयोग ऑर्गेनिक Tweets बनाने के लिए किया जा सकता है, हम भागीदारों को “Promoted-Only” (nullcast=true) Tweet बनाने की भी अनुमति देते हैं। इनमें से किसी एक को लाइन आइटम से संबद्ध किया जा सकता है। इसे संभव बनाने के लिए, हम POST accounts/:account_id/scheduled_promoted_tweets endpoint भी प्रदान करते हैं। यह endpoint एक API कॉल में केवल एक Promoted शेड्यूल किया गया Tweet को किसी लाइन आइटम से संबद्ध करने की अनुमति देता है। एक ही लाइन आइटम से कई शेड्यूल किए गए Tweets को संबद्ध करने के लिए, कई API कॉल करनी होंगी। कृपया ध्यान दें कि किसी मौजूदा Promoted शेड्यूल किया गया Tweet को संशोधित करना संभव नहीं है।

twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_promoted_tweets" -d 'line_item_id=a44qc&scheduled_tweet_id=917507899668099072'

{
  "data": {
    "line_item_id": "a44qc",
    "id": "26576",
    "created_at": "2017-10-09T22:24:16Z",
    "updated_at": "2017-10-09T22:24:16Z",
    "scheduled_tweet_id": "917507899668099072",
    "tweet_id": null,
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "a44qc",
      "scheduled_tweet_id": 917507899668099100,
      "account_id": "aaaaa"
    }
  }
}

यह endpoint केवल दिए गए शेड्यूल किए गए Tweet और किसी line item के बीच एक association बनाता है। जैसे ही campaign/line item की flight dates वर्तमान होती हैं, line item अपने-आप संबंधित “live” Tweet को serve करना शुरू कर देता है। हालांकि इस चरण में हम यह सत्यापित करते हैं कि शेड्यूल किया गया 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 लाइव होता है, तो क्या होता है?

जब कोई शेड्यूल किया गया Tweet लाइव होने वाला होता है, या दूसरे शब्दों में scheduled_at समय पर, तो निम्नलिखित अपडेट किए जाते हैं:

“लाइव” Tweet बनाया जाता है, हालांकि इसमें 1 सेकंड तक की देरी हो सकती है
tweet_id को निम्नलिखित इकाइयों में जोड़ा जाता है:
शेड्यूल किया गया Tweet
Promoted शेड्यूल किया गया Tweet
एक नई Promoted Tweet इकाई बनाई जाती है

सर्वोत्तम प्रथाएँ

शेड्यूल किए गए Tweets बनाते या प्रमोट करते समय निम्नलिखित सर्वोत्तम प्रथाओं का पालन करने की अनुशंसा की जाती है:

शेड्यूल किया गया Tweet बनाते समय सुनिश्चित करें कि Tweet मान्य हो (उदाहरण के लिए, किसी Tweet में केवल Image, Video या Gif में से एक ही हो सकता है, इन तीनों का कोई संयोजन नहीं)
सुनिश्चित करें कि अभियान की flight dates (अर्थात start_time और end_time) शेड्यूल किए गए Tweet के scheduled_at समय के अनुरूप हों
शेड्यूल किए गए Tweets को भविष्य में एक वर्ष (365 दिन) से अधिक आगे के लिए शेड्यूल नहीं किया जाना चाहिए
शेड्यूल किए गए Tweets के लिए फिलहाल Tweet preview समर्थित नहीं है (अर्थात, बनाते समय शेड्यूल किए गए Tweets का पहले से पूर्वावलोकन करने की सुविधा उपलब्ध नहीं है)

मीडिया लाइब्रेरी

परिचय

मीडिया लाइब्रेरी एंडपॉइंट्स X Ads खातों के लिए इमेज, GIF और वीडियो को प्रबंधित करने की सुविधा देते हैं। लाइब्रेरी में मौजूद मीडिया एसेट्स का उपयोग Tweets में और कार्ड बनाने के लिए किया जा सकता है। इन्हें कई creatives में भी दोबारा इस्तेमाल किया जा सकता है, जिससे एक ही एसेट को कई बार अपलोड करने की आवश्यकता नहीं रहती।

API एंडपॉइंट्स

POST media/upload or POST media/upload (chunked) (मीडिया अपलोड करना)
POST accounts/:account_id/media_library (मीडिया को मीडिया लाइब्रेरी में जोड़ना)

लाइब्रेरी में जोड़ना

मीडिया को लाइब्रेरी में जोड़ना दो-चरणों वाली प्रक्रिया है। सबसे पहले, POST media/upload endpoint या POST media/upload (chunked) endpoint के सेट का उपयोग करके एसेट अपलोड करें। (हमारी बहु-भाग अपलोड प्रक्रिया के बारे में अधिक जानकारी के लिए Chunked media upload गाइड देखें।)

twurl -X POST -H upload.x.com "/1.1/media/upload.json?additional_owners=756201191646691328" --file latte.jpeg --file-field "media"

{
   "media_id":966947208837742592,
   "media_id_string":"966947208837742592",
   "size":74194,
   "expires_after_secs":86400,
   "image":{
      "image_type":"image/jpeg",
      "w":800,
      "h":418
   }
}

इसके बाद, media ID का उपयोग करके POST accounts/:account_id/media_library endpoint के जरिए media को ads account की library में जोड़ें।

twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library?file_name=latte.jpeg&media_category=TWEET_IMAGE&media_key=966947208837742592&name=Latte"

{
   "request":{
      "params":{
         "name":"Latte",
         "file_name":"latte.jpeg",
         "media_category":"TWEET_IMAGE",
         "account_id":"18ce54d4x5t",
         "media_key":966947208837742592
      }
   },
   "data":{
      "tweeted":false,
      "name":"Latte",
      "file_name":"latte.jpeg",
      "media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
      "media_category":"TWEET_IMAGE",
      "media_key":"3_966947208837742592",
      "created_at":"2018-02-23T08:05:54Z",
      "media_status":"TRANSCODE_COMPLETED",
      "media_key":"966947208837742592",
      "media_type":"IMAGE",
      "updated_at":"2018-02-23T08:06:17Z",
      "deleted":false
   }
}

नोट: अपलोड के तुरंत बाद छवियों, GIF या वीडियो को Tweet करने पर वे मीडिया लाइब्रेरी में भी जुड़ जाते हैं.

अनुरोध पैरामीटर

सभी मीडिया लाइब्रेरी POST अनुरोधों के लिए एक मीडिया पहचानकर्ता आवश्यक होता है। यह मान अपलोड चरण के दौरान लौटाया जाता है। 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 में यह टेक्स्ट वीडियो के नीचे दिखाई देता है।

विशेषताएँ

मीडिया लाइब्रेरी में media_key की अवधारणा औपचारिक रूप से पेश की गई है। यह लाइब्रेरी में ऑब्जेक्ट्स के लिए एक अद्वितीय पहचानकर्ता है। Media key निम्नलिखित फ़ॉर्मैट में स्ट्रिंग मान होते हैं: 13_875943225764098048। ये हमारे सभी card endpoints में पूरी तरह समर्थित हैं। इसके अलावा, मीडिया लाइब्रेरी रिस्पॉन्स में media_id भी शामिल होता है, जिसे एक स्ट्रिंग के रूप में दर्शाया जाता है। इसे उन resources के लिए शामिल किया जाता है जो फ़िलहाल media key स्वीकार नहीं करते: Tweets, Tweet preview, और Scheduled Tweets। हम हर जगह media key का समर्थन उपलब्ध कराने की दिशा में काम कर रहे हैं। aspect_ratio एट्रिब्यूट GIFs और videos के लिए लौटाया जाता है। इसका उपयोग उन cards में इस्तेमाल के लिए media को फ़िल्टर करने में किया जा सकता है जो केवल विशेष aspect ratios स्वीकार करते हैं। *ये endpoints video_id parameter का समर्थन करते हैं, जो एक media key है।

उपयोग

इस अनुभाग में, निम्नलिखित छवि का उपयोग एक Tweet में और एक वेबसाइट कार्ड बनाने के लिए किया जाएगा।

twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library/3_966947208837742592"

{
   "request":{
      "params":{
         "account_id":"18ce54d4x5t",
         "media_key":"3_966947208837742592"
      }
   },
   "data":{
      "tweeted":false,
      "name":"Latte",
      "file_name":"latte.jpeg",
      "media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
      "media_category":"TWEET_IMAGE",
      "media_key":"3_966947208837742592",
      "created_at":"2018-02-23T08:05:54Z",
      "media_status":"TRANSCODE_COMPLETED",
      "media_key":"966947208837742592",
      "media_type":"IMAGE",
      "updated_at":"2018-02-23T08:06:17Z",
      "deleted":false
   }
}

Tweet हम media_keys का उपयोग करके छवियों को संदर्भित कर Tweet बना सकते हैं।

twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet?text=coffee&media_keys=966947208837742592&as_user_id=756201191646691328&trim_user=true"

{
   "data":{
      "created_at":"Fri Feb 23 08:20:05 +0000 2018",
      "id":966950781302665218,
      "id_str":"966950781302665218",
      "text":"coffee https://t.co/T772Hx5GNT",
      "truncated":false,
      "entities":{
         "hashtags":[

         ],
         "symbols":[

         ],
         "user_mentions":[

         ],
         "urls":[

         ],
         "media":[
            {
               "id":966947208837742592,
               "id_str":"966947208837742592",
               "indices":[
                  7,
                  30
               ],
               "media_url":"http://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
               "media_url_https":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
               "url":"https://t.co/T772Hx5GNT",
               "display_url":"pic.x.com/T772Hx5GNT",
               "expanded_url":"https://x.com/apimctestface/status/966950781302665218/photo/1",
               "type":"photo",
               "sizes":{
                  "thumb":{
                     "w":150,
                     "h":150,
                     "resize":"crop"
                  },
                  "large":{
                     "w":800,
                     "h":418,
                     "resize":"fit"
                  },
                  "medium":{
                     "w":800,
                     "h":418,
                     "resize":"fit"
                  },
                  "small":{
                     "w":680,
                     "h":355,
                     "resize":"fit"
                  }
               }
            }
         ]
      },
      "source":"Ads API Internal Test App",
      "in_reply_to_status_id":null,
      "in_reply_to_status_id_str":null,
      "in_reply_to_user_id":null,
      "in_reply_to_user_id_str":null,
      "in_reply_to_screen_name":null,
      "user":{
         "id":756201191646691328,
         "id_str":"756201191646691328"
      },
      "geo":null,
      "coordinates":null,
      "place":null,
      "contributors":[
         2417045708
      ],
      "retweet_count":0,
      "favorite_count":0,
      "favorited":false,
      "retweeted":false,
      "possibly_sensitive":false,
      "scopes":{
         "followers":false
      },
      "lang":"en"
   },
   "request":{
      "params":{
         "as_user_id":756201191646691328,
         "text":"coffee",
         "account_id":"18ce54d4x5t",
         "media_keys":[
            966947208837742592
         ],
         "trim_user":true
      }
   }
}

वेबसाइट कार्ड हमारे सभी कार्ड एंडपॉइंट मीडिया key को सपोर्ट करते हैं। हम इमेज के media_key का उपयोग करके वेबसाइट कार्ड बनाएँगे।

twurl -X POST -H ads-api.x.com "/11/accounts/18ce54d4x5t/cards"

{
  "name": "components create cards",
  "components": [
    {
      "type": "MEDIA",
      "media_key": "3_1323490622599176192"
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android"
      }
    }
  ]
}

फिर हम इस कार्ड को उसके card_uri का उपयोग करके एक Tweet के साथ संबद्ध करते हैं।

कार्डों की पहचान

परिचय

Cards अनुकूलित किए जा सकने वाले विज्ञापन फ़ॉर्मैट हैं जो मीडिया का उपयोग करते हैं और जिन्हें किसी वेबसाइट, ऐप, या उपयोगकर्ता से खास कार्रवाइयां करवाने वाले call to action के साथ जोड़ा जा सकता है, जैसे Direct Message शुरू करना। इन्हें Tweets, Scheduled Tweets, या Draft Tweets में जोड़ा जा सकता है। Tweet objects में Cards का संदर्भ दो में से किसी एक तरीके से दिया जा सकता है: card के card_uri से या उसके preview_url से। दोनों के उदाहरण मान नीचे दिए गए हैं।

card_uri	preview_url
card://1043282691834048513	https://cards.x.com/cards/18ce54d4x5t/68w3s

नोट: Ads API version 3 से, नए बनाए गए cards के लिए cards रिस्पॉन्स में केवल card_uri जनरेट होकर लौटाया जाता है। नोट: Ads API version 5 से, cards रिस्पॉन्स में preview_url अब लौटाया नहीं जाता। Tweet object रिस्पॉन्स में संदर्भ का type इस बात पर निर्भर करेगा कि Tweet किस तरह बनाया गया था। दूसरे शब्दों में, अगर Tweet को card_uri request parameter का उपयोग करके बनाया गया था, तो रिस्पॉन्स में card URI मान दिखाई देगा। दूसरी ओर, अगर preview_url को Tweet text के हिस्से के रूप में शामिल किया गया था, तो रिस्पॉन्स में preview URL दिखाई देगा।

card_uri के साथ Tweets की पहचान

कार्ड के URI मान का उपयोग करके बनाए गए Tweets के लिए, card_uri रिस्पॉन्स एट्रिब्यूट में कार्ड का संदर्भ ढूंढें। नीचे दिया गया उदाहरण रिस्पॉन्स GET accounts/:account_id/tweets endpoint का उपयोग करता है।

$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweets?trim_user=true&tweet_type=PUBLISHED&tweet_ids=1043551275923591168"
{
  "request": {
    "params": {
      "tweet_ids": [
        "1043551275923591168"
      ],
      "tweet_type": "PUBLISHED",
      "trim_user": true,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "coordinates": null,
      "retweeted": false,
      "source": "Ads API Internal Test App",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        15
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "1043551275923591168",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "scheduled_status": null,
      "id": 1043551275923591168,
      "in_reply_to_status_id": null,
      "nullcast": true,
      "created_at": "Sat Sep 22 17:23:07 +0000 2018",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "card_uri": "card://1043282691834048513",
      "full_text": "Tracking a card",
      "lang": "en",
      "contributors": [
        2417045708
      ],
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "id": 756201191646691328,
        "id_str": "756201191646691328"
      },
      "tweet_id": "1043551275923591168"
    }
  ]
}

यदि आप Standard API का उपयोग कर रहे हैं, तो रिक्वेस्ट में include_card_uri=true का उपयोग करें। किस endpoint का उपयोग किया गया है, इससे कोई फर्क नहीं पड़ता; card_uri रिस्पॉन्स एट्रिब्यूट केवल तभी रेंडर होगा, जब Tweet को card URI का उपयोग करके बनाया गया हो। निर्धारित और ड्राफ्ट Tweet ऑब्जेक्ट्स के लिए, रिस्पॉन्स में card_uri रिस्पॉन्स एट्रिब्यूट हमेशा शामिल होगा।

preview_url वाले Tweets की पहचान

जिन Tweets को उनके text के हिस्से के रूप में preview URL शामिल करके बनाया गया है, उनमें URL entities[“urls”][i][“expanded_url”] में मिल सकता है (text फ़ील्ड में छोटा किया गया t.co URL शामिल होता है), जहाँ i एक array index है (एक Tweet में कई URLs हो सकते हैं)। scheduled और draft Tweet objects में, preview URL हमेशा text फ़ील्ड में दिखाई देगा।

कार्ड फ़ेच करना

किसी विशिष्ट कार्ड के बारे में अतिरिक्त जानकारी प्राप्त करने के लिए, हम दो endpoints प्रदान करते हैं: GET accounts/:account_id/cards/all और GET accounts/:account_id/cards/all/:card_id। पहला endpoint card_uri के आधार पर कार्ड फ़ेच करने की अनुमति देता है और दूसरा कार्ड की ID के आधार पर। कार्ड की ID, preview_url के अंत में मिलती है। ऊपर दिए गए उदाहरण में, ID 68w3s है।

मीडिया की पहचान

परिचय

मीडिया—इमेज, GIFs और वीडियो—को Tweets और cards में जोड़ा जा सकता है। इसके अलावा, वीडियो का उपयोग pre-roll assets के रूप में किया जा सकता है और इमेज को X Audience Platform पर प्रमोट किया जा सकता है। यह अनुभाग बताता है कि इन entities में मीडिया references को कैसे ढूंढें। मीडिया पहचानकर्ता दो प्रकार के होते हैं: IDs और keys। प्रत्येक के उदाहरण नीचे दिए गए हैं।

मीडिया ID	मीडिया key
1029825579531807971	13_1029825579531807971

मीडिया key, ID के साथ एक संख्यात्मक prefix और एक underscore जोड़कर बनती है।

इमेज

निम्न तालिका प्रत्येक इमेज-संबंधित रिसोर्स के रिस्पॉन्स में वर्तमान में उपलब्ध पहचानकर्ता प्रकारों के साथ-साथ संबंधित एट्रिब्यूट नाम भी दिखाती है।

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`

Image cards और Account Media इमेज में किसी भी मीडिया पहचानकर्ता का कोई संदर्भ शामिल नहीं होता। Tweets में केवल media ID शामिल होते हैं। Scheduled और Draft Tweets में media ID और media key दोनों शामिल होते हैं। Media Library भी दोनों लौटाती है। Tweets के लिए, entities[“media”] array के भीतर ऑब्जेक्ट में 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 में एक इमेज है या कई इमेज।

सभी Image cards में एक image रिस्पॉन्स एट्रिब्यूट शामिल होता है, जिसमें X इमेज URL होता है। (Image app download cards के लिए, इसका नाम wide_app_image होता है।) Tweets के लिए, media URL का स्थान media के प्रकार और उपयोग किए जा रहे एंडपॉइंट, दोनों पर निर्भर करता है। एक इमेज वाले Tweets के लिए, URL entities[“media”][0][“media_url”] में पाया जा सकता है। यह Ads API और Standard API, दोनों के लिए सही है। हालांकि, जब Tweets में कई इमेज होती हैं, तो URL केवल extended_entities[“media”][i][“media_url”] में ही मिल सकते हैं। यह केवल Standard API में उपलब्ध है।

वीडियो

निम्न तालिका प्रत्येक वीडियो-संबंधित रिसोर्स के रिस्पॉन्स में वर्तमान में उपलब्ध पहचानकर्ता प्रकारों के साथ-साथ संबंधित एट्रिब्यूट नाम दिखाती है।

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

वीडियो कार्ड्स में क्रमशः .vmap और .m3u8 URL के साथ 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 जोड़ना पड़ता है।

Account Media के साथ इंटरैक्शन ऐसी दो स्थितियाँ हैं जिनमें लाइब्रेरी में जोड़े गए मीडिया एसेट अपने-आप Account Media resource में भी जोड़ दिए जाते हैं।

जब कोई AMPLIFY_VIDEO एसेट मीडिया लाइब्रेरी में जोड़ा जाता है, तो उसे अपने-आप PREROLL creative type वाले Account Media एसेट के रूप में भी जोड़ दिया जाता है।
जब विशिष्ट dimensions वाली images (हमारे enumerations page में “Creative Types” देखें) मीडिया लाइब्रेरी में जोड़ी जाती हैं, तो उन्हें अपने-आप Account Media एसेट्स के रूप में भी जोड़ दिया जाता है। creative type (उदाहरण के लिए, INTERSTITIAL) image dimensions पर निर्भर करता है।

Tweets

परिचय

X Ads API, Tweets के तीन प्रकारों का समर्थन करता है: प्रकाशित, शेड्यूल किए गए और ड्राफ़्ट।

Nullcast किए गए Tweets

Tweets या तो nullcast किए गए (यानी “केवल Promoted”) हो सकते हैं या organic। Nullcast किए गए Tweets, प्रकाशित होने के बाद भी सार्वजनिक होते हैं, लेकिन उपयोगकर्ता की सार्वजनिक timeline में दिखाई नहीं देते। दूसरी ओर, organic Tweets उपयोगकर्ता के followers को दिखाए जाते हैं और उपयोगकर्ता की सार्वजनिक timeline में दिखाई देते हैं। Tweets बनाना तीनों Tweet create endpoints में से हर एक Boolean 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 को प्रमोट करना

केवल प्रकाशित और शेड्यूल किए गए Tweets को ही प्रमोट किया जा सकता है। ये nullcasted या organic, किसी भी प्रकार के हो सकते हैं; इस पर कोई प्रतिबंध नहीं है। कोई विज्ञापनदाता अपने स्वयं के Tweets या किसी अन्य उपयोगकर्ता के Tweets को प्रमोट कर सकता है, बशर्ते उसने ऐसा करने की अनुमति प्राप्त कर ली हो। (अधिक जानकारी के लिए किसी अन्य उपयोगकर्ता के Tweets को प्रमोट करना देखें।) एक ही अभियान में कई Tweets प्रमोट किए जा सकते हैं। इसी तरह, एक ही Tweet को एक या अधिक अभियानों में प्रमोट किया जा सकता है। प्रकाशित Tweets को प्रमोट करने के लिए, POST accounts/:account_id/promoted_tweets एंडपॉइंट का उपयोग करें। यह प्रकाशित Tweets को एक line item से संबद्ध करता है। शेड्यूल किए गए Tweets को प्रमोट करने के लिए, POST accounts/:account_id/scheduled_promoted_tweets एंडपॉइंट का उपयोग करें।

Tweet आईडी

प्रकाशित, शेड्यूल किए गए और ड्राफ़्ट Tweet आईडी संख्यात्मक होते हैं—ये 64-बिट unsigned integer होते हैं। उदाहरण के लिए, नीचे दिए गए प्रकाशित Tweet की आईडी 1166476031668015104 है। जब प्रकाशित या शेड्यूल किए गए Tweets को प्रमोट किया जाता है, तो उससे संबंधित promoted Tweet entity बनाई जाती है। इन entities की अपनी अलग आईडी होती हैं, जो अल्फ़ा-न्यूमेरिक होती हैं और base-36-encoded values के रूप में दर्शाई जाती हैं। उदाहरण के लिए, ऊपर दिए गए प्रकाशित Tweet को प्रमोट करने पर—अर्थात, उसे line item 6c62d से संबद्ध करने पर—निम्न API रिस्पॉन्स मिलता है।

$ twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/promoted_tweets?line_item_id=6c62d&tweet_ids=1166476031668015104"
{
  "request": {
    "params": {
      "tweet_ids": [
        1166476031668015104
      ],
      "line_item_id": "6c62d",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "line_item_id": "6c62d",
      "id": "3qwlq6",
      "entity_status": "ACTIVE",
      "created_at": "2019-09-12T21:39:10Z",
      "updated_at": "2019-09-12T21:39:10Z",
      "approval_status": "ACCEPTED",
      "tweet_id": "1166476031668015104",
      "deleted": false
    }
  ],
  "total_count": 1
}

create request में पास किए गए Tweet ID और line item ID के अलावा, रिस्पॉन्स में id फ़ील्ड भी शामिल होती है, जिसका मान 3qw1q6 है, और यही promoted Tweet ID है।

कैरोसेल

परिचय

X Ads API वीडियो कैरोसेल और इमेज कैरोसेल बनाने और प्राप्त करने का समर्थन करता है। कैरोसेल एक कार्ड type है, जिसमें 2 से 6 मीडिया एसेट हो सकते हैं। कैरोसेल कार्ड उपयोगकर्ता को किसी वेबसाइट पर ले जा सकता है या उन्हें मोबाइल ऐप इंस्टॉल करने के लिए प्रोत्साहित कर सकता है। कैरोसेल, उनके लाभों, सर्वोत्तम प्रथाओं और अक्सर पूछे जाने वाले सवालों के बारे में अधिक जानकारी के लिए, हमारा Carousel Ads on X पेज देखें। किसी भी अन्य कार्ड type की तरह, कैरोसेल का उपयोग Tweets में किया जा सकता है और फिर उन Tweets को प्रमोट किया जा सकता है। वर्कफ़्लो वही है, जिससे आप पहले से परिचित हैं:

मीडिया अपलोड करें
कार्ड बनाएँ
Tweet बनाएँ
Tweet को प्रमोट करें

एकमात्र अंतर कार्ड बनाने के तरीके में है। जहाँ अन्य कार्ड create requests क्वेरी पैरामीटर स्वीकार करते हैं, वहीं कैरोसेल कार्ड create requests केवल JSON POST body स्वीकार करते हैं।

एंडपॉइंट्स

Ads API कैरोसेल बनाने और उन्हें प्राप्त करने का समर्थन करता है। किसी भी प्रकार का कैरोसेल बनाने के लिए POST accounts/:account_id/cards एंडपॉइंट का उपयोग करें। कैरोसेल प्राप्त करने के लिए GET accounts/:account_id/cards एंडपॉइंट का उपयोग करें।

JSON POST बॉडी

कैरोसेल दो कॉम्पोनेंट का उपयोग करके बनाए जाते हैं। पहला उन मीडिया एसेट को निर्दिष्ट करता है जिनका उपयोग किया जाएगा। दूसरा वेबसाइट या ऐप में से किसी एक के बारे में जानकारी निर्दिष्ट करता है। विशेष रूप से, एक कैरोसेल कार्ड निम्नलिखित कॉम्पोनेंट का उपयोग करके, इसी क्रम में, बनाया जाता है:

एक SWIPEABLE_MEDIA कॉम्पोनेंट, जो media keys की एक array स्वीकार करता है
निम्नलिखित में से एक:
वेबसाइट की जानकारी निर्दिष्ट करने के लिए एक DETAILS कॉम्पोनेंट
ऐप की जानकारी निर्दिष्ट करने के लिए एक BUTTON कॉम्पोनेंट

SWIPEABLE_MEDIA कॉम्पोनेंट में एक media_keys array शामिल होना चाहिए, जिसमें आप 2 से 6 images या videos निर्दिष्ट कर सकते हैं। media keys जिस क्रम में पास की जाती हैं, उसी क्रम में वे render की जाएंगी।

{
  "type": "SWIPEABLE_MEDIA",
  "media_keys": [
    "13_1089771253848666112",
    "13_1191948012077092867"
  ]
}

याद रखें, आप GET accounts/:account_id/media_library endpoint पर अनुरोध करके media keys प्राप्त कर सकते हैं। दूसरे component object की संरचना इस बात पर निर्भर करती है कि आप उपयोगकर्ता को किसी वेबसाइट पर भेजना चाहते हैं या उन्हें कोई ऐप इंस्टॉल करने के लिए प्रोत्साहित करना चाहते हैं। नीचे दी गई तालिका इन दोनों विकल्पों का सारांश देती है। (नोट: सूचीबद्ध सभी keys आवश्यक हैं।)

	वेबसाइट	ऐप
component type निर्दिष्ट करें	`"type": "DETAILS"`	`"type": "BUTTON"`
शीर्षक/लेबल	`"title": "X"`	`"label": { "type": "ENUM", "value": "INSTALL" }`
गंतव्य	`"destination": { "type": "WEBSITE", "url": "https://www.x.com" }`	`"destination": { "type": "APP", ... }`

इन सबको मिलाकर, नीचे वेबसाइट कैरोसेल के लिए JSON POST body का एक उदाहरण दिया गया है।

{
  "name": "website carousel",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "13_1089771253848666112",
        "13_1191948012077092867"
      ]
    },
    {
      "type": "DETAILS",
      "title": "X",
      "destination": {
        "type": "WEBSITE",
        "url": "https://www.x.com"
      }
    }
  ]
}

BUTTON कॉम्पोनेंट्स के भीतर ऐप गंतव्य ऑब्जेक्ट्स के लिए एक country code और कम से कम एक ऐप पहचानकर्ता आवश्यक है। वैकल्पिक रूप से, ये deep links भी स्वीकार करते हैं। इन फ़ील्ड्स के विवरण के लिए, reference documentation देखें। इसे मिलाकर, नीचे एक उदाहरण ऐप carousel JSON POST body दिखाई गई है।

{
  "name": "app carousel",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "13_1089771253848666112",
        "13_1191948012077092867"
      ]
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android",
        "iphone_app_id": "333903271"
      }
    }
  ]
}

उदाहरण

यह अनुभाग दिखाता है कि वीडियो वेबसाइट carousel card कैसे बनाया जाता है और उसे Tweet में कैसे इस्तेमाल किया जाता है। जैसा कि ऊपर बताया गया है, कार्यप्रवाह वही है जिससे आप पहले से परिचित हैं: मीडिया अपलोड करें, card बनाएँ, Tweet बनाएँ। फर्क सिर्फ़ इतना है कि card किस तरह बनाया जाता है। मीडिया शुरू करने के लिए, या तो नई मीडिया एसेट्स अपलोड करें या मौजूदा एसेट्स का उपयोग करें। नई मीडिया एसेट्स अपलोड करने और उन्हें Media Library में जोड़ने के तरीके के बारे में जानकारी के लिए, हमारी Media Library Guide देखें। जब आपकी मीडिया एसेट्स Media Library में आ जाएँ, तो उन्हें GET accounts/:account_id/media_library एंडपॉइंट का उपयोग करके प्राप्त करें। नतीजों को किसी खास मीडिया type तक सीमित करने के लिए media_type request parameter का उपयोग करें।

$ twurl -H ads-api.x.com "/10/accounts/18ce54d4x5t/media_library?media_type=VIDEO"

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_type": "VIDEO"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "tweeted": true,
      "duration": 5283,
      "name": "Sunrise",
      "file_name": "sunrise.mp4",
      "description": null,
      "media_url": "https://video.twimg.com/amplify_video/1089771253848666112/vid/1280x720/tyL-pUBP7GgkS9bl.mp4?tag=9",
      "poster_media_key": "3_1089771253848666112",
      "media_key": "13_1089771253848666112",
      "created_at": "2019-01-28T06:24:48Z",
      "media_status": "TRANSCODE_COMPLETED",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1089771253848666112/img/WOYvToSRZFXUSDzd.jpg",
      "title": null,
      "media_type": "VIDEO",
      "aspect_ratio": "16:9",
      "updated_at": "2019-08-23T19:05:33Z",
      "deleted": false
    },
    {
      "tweeted": true,
      "duration": 15248,
      "name": "snow",
      "file_name": "snow.mp4",
      "description": "Two, three, and to the four",
      "media_url": "https://video.twimg.com/amplify_video/1191948012077092867/vid/1280x720/2cOvadcctqqea6Hx.mp4?tag=13",
      "poster_media_key": "3_1191948012077092867",
      "media_key": "13_1191948012077092867",
      "created_at": "2019-11-06T05:18:46Z",
      "media_status": "TRANSCODE_COMPLETED",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1191948012077092867/img/IUbhTRd62SEeIVTf.jpg",
      "title": "One",
      "media_type": "VIDEO",
      "aspect_ratio": "16:9",
      "updated_at": "2020-03-27T22:23:18Z",
      "deleted": false
    }
  ]
}

कैरोसेल बनाना अपना कैरोसेल बनाने के लिए POST accounts/:account_id/cards एंडपॉइंट का उपयोग करें। पिछले अनुरोध से मिली media keys का उपयोग करें। याद रखें, media keys जिस क्रम में भेजी जाती हैं, वे उसी क्रम में रेंडर होती हैं।

$ twurl -A "Content-Type: application/json" -X POST -H ads-api.x.com "/10/accounts/18ce54d4x5t/cards" -d '{"name":"website carousel","components":[{"type": "SWIPEABLE_MEDIA","media_keys":["13_1089771253848666112","13_1191948012077092867"]},{"type": "DETAILS","title": "X","destination":{"type":"WEBSITE", "url":"https://www.x.com"}}]}'

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "website carousel",
    "components": [
      {
        "type": "SWIPEABLE_MEDIA",
        "media_keys": [
          "13_1089771253848666112",
          "13_1191948012077092867"
        ]
      },
      {
        "type": "DETAILS",
        "title": "X",
        "destination": {
          "type": "WEBSITE",
          "url": "https://www.x.com/",
          "tco_url": "https://t.co/dyTMHWKWZb"
        }
      }
    ],
    "id": "ars7m",
    "created_at": "2020-11-11T07:51:47Z",
    "card_uri": "card://1326432421105995776",
    "updated_at": "2020-11-11T07:51:47Z",
    "deleted": false,
    "card_type": "UNIFIED"
  }
}

ध्यान दें कि अन्य कार्डों की तरह, carousel card रिस्पॉन्स में card_uri भी शामिल होता है, जिसका उपयोग Tweet बनाते समय किया जाएगा। Tweet अपना Tweet बनाने के लिए POST accounts/:account_id/tweet endpoint का उपयोग करें। पिछले अनुरोध से मिला card_uri उपयोग करें। (पठनीयता के लिए रिस्पॉन्स को संक्षिप्त किया गया है।)

$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet_previews?tweet_type=PUBLISHED&tweet_ids=1326434098324385792"

{
  "data": {
    "created_at": "Wed Nov 11 07:58:27 +0000 2020",
    "id": 1326434098324385792,
    "id_str": "1326434098324385792",
    "text": "Swipe",
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "Ads API Internal Test App",
    "in_reply_to_status_id": null,
    "in_reply_to_status_id_str": null,
    "in_reply_to_user_id": null,
    "in_reply_to_user_id_str": null,
    "in_reply_to_screen_name": null,
    "user": {
      "id": 756201191646691300,
      "id_str": "756201191646691328",
      ...
    },
    "geo": null,
    "coordinates": null,
    "place": null,
    "contributors": [
      2417045708
    ],
    "retweet_count": 0,
    "favorite_count": 0,
    "favorited": false,
    "retweeted": false,
    "possibly_sensitive": false,
    "scopes": {
      "followers": false
    },
    "lang": "en"
  },
  "request": {
    "params": {
      "text": "Swipe",
      "as_user_id": 756201191646691300,
      "card_uri": "card://1326432421105995776",
      "account_id": "18ce54d4x5t"
    }
  }
}

Tweet पूर्वावलोकन अपना Tweet देखने के लिए GET accounts/:account_id/tweet_previews एंडपॉइंट का उपयोग करें।

क्रिएटिव-मेटाडेटा-टैगिंग

परिचय

यह मार्गदर्शिका creative partners, agencies और creative developers के लिए है, ताकि वे X campaigns में उपयोग की जाने वाली assets को tag कर सकें और हर asset के मूल्य तथा प्रदर्शन को बेहतर ढंग से समझ सकें। नोट: Media assets को केवल वही partner या developer tag करे जो उस media asset को बना रहा है। यदि media asset का उपयोगकर्ता उसका निर्माता नहीं है, तो metadata tagging लागू न करें। Creative Metadata Tagging, Creative Partners द्वारा बनाई गई images और videos के लिए attribution उपलब्ध कराता है, चाहे asset को X पर कहीं भी upload किया गया हो या उसे upload करने वाली entity कोई भी हो। Creative asset और creative partner के बीच संबंध स्थापित करने के लिए XMP standard का उपयोग किया जाता है।

Creative Assets को टैग करना

नीचे दी गई तालिका हर image-related resource के रिस्पॉन्स में वर्तमान में उपलब्ध पहचानकर्ता types और उनके संबंधित attribute name(s) दिखाती है। Creative assets को टैग करने के लिए एक tagging tool की आवश्यकता होती है। ExifTool, जो meta जानकारी को पढ़ने, लिखने और संपादित करने के लिए एक platform-independent Perl library और एक command-line application है, की अनुशंसा की जाती है। सभी समर्थित file types देखें। ExifTool को install करने के लिए दिए गए निर्देशों का पालन करें। Homebrew के software packages भी उपलब्ध हैं, जो macOS और Linux के लिए exiftool install command देकर installation को और आसान बनाते हैं। यह पुष्टि करने के लिए कि आपका tool सही तरीके से install हुआ है, command line में exiftool -ver दर्ज करें, जिससे tool का version number दिखेगा। ExifTool command parameters के बारे में अधिक जानने के लिए ExifTool documentation देखें। Creative partners नए या मौजूदा creative assets पर contributor XMP tag और date tag में अपना X app_id जोड़कर metadata tags असाइन कर सकते हैं। Uploading Media के दौरान creative assets पर मौजूदा size restrictions लागू होंगी। ध्यान दें: contributor XMP tag का X द्वारा उपयोग यह सुनिश्चित करता है कि metadata केवल X पर campaigns के लिए values कैप्चर करे। 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 जोड़ता है:

app_id:858382169

date:2022-03-13

creative_file: eiffel_tower.jpg

exiftool -contributor=858382169 eiffel_tower.jpg

   1 image files updated

exiftool -date=2022-03-13 eiffel_tower.jpg

  1 image files updated

सुनिश्चित करें कि आपकी छवि पर सही तरीके से टैग लगाए गए हैं: exiftool -xmp:all -G1 <filename> उदाहरण: exiftool -xmp:all -G1 eiffel_tower.jpg

[XMP]        XMP Toolkit            : Image::ExifTool 12.30

[XMP]        Contributor            : 858382169

[XMP]        Date                   : 2022:03:13

प्रश्न?

यदि आप यह पुष्टि करना चाहते हैं कि आपकी tagging और attribution सफल रही है, तो कृपया tagged sample assets adsapi-program@x.com पर भेजें, ताकि X का कोई प्रतिनिधि उनकी समीक्षा कर सके।

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

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

{
  "request": {
    "params": {
      "account_media_ids": [
        "3wpx"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_id": "13_771791717175468032",
      "media_url": null,
      "creative_type": "PREROLL",
      "id": "3wpx",
      "created_at": "2016-09-02T19:27:52Z",
      "updated_at": "2016-09-02T19:27:52Z",
      "deleted": false
    }
  ]
}

वर्तमान खाते से संबद्ध किसी विशिष्ट अकाउंट मीडिया ऑब्जेक्ट को प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "account_media_id": "2pnfd",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-07-28T01:44:41Z",
    "deleted": false
  }
}

वर्तमान खाते के निर्दिष्ट मीडिया ऑब्जेक्ट को हटाएँ।

संसाधन 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

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

{
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-08-25T17:16:26Z",
    "deleted": true
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "account_media_id": "2pnfd"
    }
  }
}

कार्ड्स

नोट: किसी कार्ड को Tweet से संबद्ध करने के लिए, POST accounts/:account_id/tweet, POST statuses/update, POST accounts/:account_id/scheduled_tweets, या POST accounts/:account_id/draft_tweets एंडपॉइंट्स में से किसी एक के साथ 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

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

{
  "request": {
    "params": {
      "count": 1,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": "8wzvldqtc",
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

वर्तमान खाते से संबद्ध एक कार्ड का विवरण प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

POST accounts/:account_id/cards

निर्दिष्ट खाते से संबद्ध एक नया कार्ड बनाएँ। कार्ड बनाने के अनुरोध केवल JSON POST body स्वीकार करते हैं। Content-Type को application/json पर सेट किया जाना चाहिए। विस्तृत उपयोग उदाहरण के लिए हमारी Carousels Guide देखें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/cards

पैरामीटर

JSON POST बॉडी में कार्ड का name और components की एक array होना चाहिए। Components को objects के रूप में दर्शाया जाता है और वे कार्ड की विज्ञापनदाता-संबंधी विशेषताओं का वर्णन करते हैं। निम्न उदाहरण payload की सामान्य संरचना दिखाता है (लेकिन इसमें ऐसी जानकारी शामिल है जो काम नहीं करेगी)।

{
  "name": "some name",
  "components": [
    {
      "type": "TYPE_ENUM",
      "key": "value"
    }
  ]
}

घटकों के बारे में अतिरिक्त जानकारी नीचे दी गई है।

नाम	विवरण
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 या image
SWIPEABLE_MEDIA: 2-6 videos या images
विवरण:
DETAILS
BUTTON

हर घटक में आवश्यक फ़ील्ड्स का एक सेट होता है (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 उन स्थानों को दर्शाते हैं जहाँ अधिक जानकारी निर्दिष्ट करने की आवश्यकता होगी।)

{
  "components": [
    {
      "type": "BUTTON",
      "label": {
        ...
      },
      "destination": {
        ...
      }
    }
  ]
}

जिस क्रम में component objects निर्दिष्ट किए जाते हैं, वही ऊपर-से-नीचे का वह क्रम तय करता है जिसमें उन्हें render किया जाएगा। Cards को एक media-based component और 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 दिखाया गया है।

{
  "components": [
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        ...
      }
    }
  ]
}

गंतव्य गंतव्य वे स्थान हैं जहाँ विज्ञापनदाता उपयोगकर्ताओं को भेजना चाहते हैं। ये 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

{
  "name": "components create cards",
  "components": [
    {
      "type": "MEDIA",
      "media_key": "3_1323490622599176192"
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android"
      }
    }
  ]
}

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "components create cards",
    "components": [
      {
        "type": "MEDIA",
        "media_key": "3_1323490622599176192"
      },
      {
        "type": "BUTTON",
        "label": {
          "type": "ENUM",
          "value": "INSTALL"
        },
        "destination": {
          "type": "APP",
          "country_code": "US",
          "googleplay_app_id": "com.twitter.android"
        }
      }
    ],
    "created_at": "2020-11-11T05:42:25Z",
    "card_uri": "card://1326399865065238531",
    "id": "1321554298900107264",
    "updated_at": "2020-11-11T05:42:25Z",
    "deleted": false,
    "card_type": "IMAGE_APP"
  }
}

वर्तमान खाते से संबद्ध निर्दिष्ट संसाधन को अपडेट करें। कार्ड संपादन अनुरोध केवल JSON POST बॉडी स्वीकार करते हैं। Content-Type को application/json पर सेट किया जाना चाहिए।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/cards/1321554298900107264

पैरामीटर

JSON POST बॉडी में उन पैरामीटर को शामिल करना चाहिए जिन्हें अपडेट किया जाना है। अनुरोध, पेलोड में निर्दिष्ट पैरामीटर के अनुसार प्रत्येक फ़ील्ड को प्रतिस्थापित कर देगा। कॉम्पोनेंट को ऑब्जेक्ट के रूप में दर्शाया जाता है और वे कार्ड की विज्ञापनदाता-संबंधी विशेषताओं का वर्णन करते हैं। निम्न उदाहरण पेलोड की सामान्य संरचना दिखाता है (लेकिन इसमें गैर-कार्यशील जानकारी शामिल है)।

{
  "name": "some name",
  "components": [
    {
      "type": "TYPE_ENUM",
      "key": "value"
    }
  ]
}

POST accounts/:account_id/cards में components और slides के बारे में अतिरिक्त जानकारी।

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

{
  "name": "changed name",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "3_1075096386931052545"
      ]
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "OPEN"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android",
        "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
      }
    }
  ]
}

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "changed name",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

वर्तमान खाते का निर्दिष्ट कार्ड हटाएँ.

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": true,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

कार्ड प्राप्त करें

वर्तमान खाते से जुड़े 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

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

{
  "request": {
    "params": {
      "card_uris": [
        "card://1044294149527166979",
        "card://1044301099031658496"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "name": "X App",
      "googleplay_app_id": "com.twitter.android",
      "image_display_height": "836",
      "country_code": "US",
      "id": "692xn",
      "wide_app_image": "https://pbs.twimg.com/media/Dc263l9VwAAAeEH.jpg",
      "created_at": "2018-09-24T18:35:01Z",
      "image_display_width": "1600",
      "card_uri": "card://1044294149527166979",
      "updated_at": "2018-09-24T18:35:01Z",
      "app_cta": "INSTALL",
      "deleted": false,
      "card_type": "IMAGE_APP_DOWNLOAD"
    },
    {
      "video_poster_height": "9",
      "name": "Developer Platform",
      "website_shortened_url": "https://t.co/zadeUSVD18",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/991374284135137280.vmap",
      "content_duration_seconds": "24",
      "video_owner_id": "756201191646691328",
      "video_content_id": "13_991374284135137280",
      "website_display_url": "developer.x.com",
      "id": "6933h",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/991374284135137280/pl/sQrBsE9mFvNep9Cx.m3u8?tag=2",
      "website_dest_url": "https://developer.x.com",
      "created_at": "2018-09-24T19:02:38Z",
      "card_uri": "card://1044301099031658496",
      "title": "Developer Platform",
      "website_url": "https://developer.x.com",
      "updated_at": "2018-09-24T19:02:38Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/991374284135137280/img/YbbGQHvWRjoFgrLz.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_WEBSITE"
    }
  ]
}

वर्तमान खाते से संबद्ध किसी विशिष्ट कार्ड को 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

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

{
  "request": {
    "params": {
      "card_id": "508pf",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "video website card",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/867520357225418752.vmap",
    "content_duration_seconds": "21",
    "video_owner_id": "756201191646691328",
    "video_content_id": "13_867520357225418752",
    "website_display_url": "developer.x.com",
    "id": "508pf",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/867520357225418752/pl/TPHeH5ZlHFCa2TeJ.m3u8",
    "website_dest_url": "https://developer.x.com/en/docs/ads/creatives/api-reference/video-website#post-accounts-account-id-cards-video-website",
    "created_at": "2017-11-10T09:00:35Z",
    "card_uri": "card://928910245920829440",
    "title": "VWC",
    "website_url": "https://t.co/F81hp59pUF",
    "updated_at": "2018-01-05T05:43:31Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/867520357225418752/img/E3pnXM0sCKnRsFih.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_WEBSITE"
  }
}

ड्राफ़्ट Tweets

GET accounts/:account_id/draft_tweets

वर्तमान खाते से जुड़े कुछ या सभी ड्राफ़्ट 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

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

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name" null,
      "text": "hello, world",
      "user_id": "756201191646691328",
      "id": "994791681219231744",
      "nullcast": true,
      "created_at": "2018-05-11T04:09:53Z",
      "card_uri": null,
      "updated_at": "2018-05-11T04:09:53Z",
      "media_keys": []
    }
  ],
  "next_cursor": "c-jh1g0ryb"
}

वर्तमान खाते से संबद्ध किसी विशिष्ट ड्राफ़्ट Tweet को पुनर्प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "draft_tweet_id": "994788364334325760"
    }
  },
  "data": {
    "name": null,
    "text": "#TwitterDev",
    "user_id": "756201191646691328",
    "id": "994788364334325760",
    "nullcast": true,
    "created_at": "2018-05-11T03:56:42Z",
    "card_uri": "card://958225772740714496",
    "updated_at": "2018-05-11T03:56:42Z",
    "media_keys": []
  }
}

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.

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

{
  "request": {
    "params": {
      "text": "Just setting up my X.",
      "as_user_id": "756201191646691328"
    }
  },
  "data": {
    "name": null,
    "text": "Just setting up my X.",
    "user_id": "756201191646691328",
    "id": "994747471329873920",
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:14:13Z",
    "media_keys": []
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट Draft Tweet को अपडेट करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "draft_tweet_id": 994747471329873920,
      "text": "just setting up my twttr"
    }
  },
  "data": {
    "name": null,
    "text": "just setting up my twttr",
    "user_id": "756201191646691328",
    "id": "994747471329873920",
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:16:59Z",
    "media_keys": []
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट Draft Tweet को स्थायी रूप से हटाएँ। नोट: हम दृढ़तापूर्वक अनुशंसा करते हैं कि किसी Tweet या Scheduled Tweet को उसके metadata का उपयोग करके बना लेने के बाद draft को हटा दें। नोट: यह hard delete है। इसलिए, हटाए गए Draft Tweets को पुनर्प्राप्त करना संभव नहीं है।

संसाधन 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

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

{
  "request": {
    "params": {
      "draft_tweet_id": "994787835663155200"
    }
  },
  "data": {
    "name": null,
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": "994787835663155200",
    "nullcast": true,
    "status": "DELETED",
    "created_at": "2018-05-11T03:54:36Z",
    "card_uri": null,
    "updated_at": "2018-05-11T04:07:31Z",
    "media_keys": []
  }
}

POST accounts/:account_id/draft_tweets/preview/:draft_tweet_id

मोबाइल डिवाइस पर किसी ड्राफ्ट Tweet का प्रीव्यू करें। सफल अनुरोध, प्रमाणीकृत उपयोगकर्ता जिन सभी डिवाइसों में लॉग इन है, उन पर एक सूचना भेजता है। सूचना पर क्लिक करने पर एक टाइमलाइन खुलती है, जिससे उपयोगकर्ता ड्राफ्ट Tweet को देख सकता है और उसके साथ इंटरैक्ट कर सकता है। इससे वह auto-play, volume, fullscreen, video website card docking और अन्य व्यवहारों का परीक्षण कर सकता है। ध्यान दें: डिवाइस पर प्रीव्यू केवल उसी उपयोगकर्ता को दिखाई देता है जिसे सूचना मिलती है। ध्यान दें: सूचनाएं केवल X के आधिकारिक ऐप्स पर भेजी जाती हैं।

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "draft_tweet_id": "996132315829948416"
    }
  },
  "message": "See @apimctestface's notifications in the X app to preview your Tweet."
}

इमेज कन्वर्सेशन कार्ड्स

नोट: किसी कार्ड को Tweet से संबद्ध करने के लिए, POST accounts/:account_id/tweet, POST statuses/update, या POST accounts/:account_id/scheduled_tweets endpoint में से किसी एक के साथ 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

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

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_ids": [
        "59woh"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "image conversation card",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "thanks",
      "id": "59woh",
      "first_cta_tweet": "stars",
      "media_key": "3_957113581522141184",
      "created_at": "2018-01-27T04:58:42Z",
      "image_display_width": "1280",
      "card_uri": "card://923498485702009837",
      "title": "Full moon",
      "updated_at": "2018-01-27T04:58:42Z",
      "deleted": false,
      "card_type": "IMAGE_CONVERSATION"
    }
  ]
}

मौजूदा खाते से संबद्ध किसी विशिष्ट इमेज कन्वर्सेशन कार्ड को प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_id": "59woh",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "image conversation card",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "thanks",
    "id": "59woh",
    "first_cta_tweet": "stars",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Full moon",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  }
}

POST accounts/:account_id/cards/image_conversation

निर्दिष्ट खाते से संबद्ध एक नया इमेज कन्वर्सेशन कार्ड बनाएँ। हमारे एंडपॉइंट्स पर इमेज अपलोड करने से संबंधित उपयोगी जानकारी के लिए Uploading Media देखें।

संसाधन 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

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

{
  "data": {
    "name": "image conversation card",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "thanks",
    "id": "59woh",
    "first_cta_tweet": "stars",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Full moon",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "name": "image conversation card",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "thanks",
      "media_key": "3_957113581522141184",
      "account_id": "18ce54d4x5t",
      "first_cta_tweet": "stars",
      "image_display_width": "1280",
      "title": "Full moon",
      "card_type": "IMAGE_CONVERSATION"
    }
  }
}

वर्तमान खाते से जुड़े निर्दिष्ट इमेज कन्वर्सेशन कार्ड को अपडेट करें। हमारे एंडपॉइंट्स पर इमेज अपलोड करने के बारे में उपयोगी जानकारी के लिए Uploading Media देखें।

संसाधन 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

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

{
  "data": {
    "name": "moon card",
    "id": "59woh",
    "created_at": "2018-01-27T04:58:42Z",
    "card_uri": "card://923498485702009837",
    "updated_at": "2018-01-29T21:04:39Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "IMAGE_CONVERSATION",
      "card_id": "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

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

{
  "data": {
    "name": "image conversation card",
    "id": "4i0qe",
    "created_at": "2017-07-07T00:03:01Z",
    "updated_at": "2017-08-23T13:26:23Z",
    "deleted": true,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0qe",
      "card_type": "image_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}

मीडिया लाइब्रेरी

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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "count": 1
    }
  },
  "data": [
    {
      "tweeted": true,
      "name": null,
      "file_name": "coffee https://t.co/4tcPU9XUon",
      "media_url": "https://pbs.twimg.com/media/DJvnJf_UEAAXnzC.jpg",
      "media_category": "TWEET_IMAGE",
      "media_key": "3_908573900237180928",
      "created_at": "2017-09-15T06:11:12Z",
      "media_status": "TRANSCODE_COMPLETED",
      "media_type": "IMAGE",
      "updated_at": "2017-11-16T06:00:01Z",
      "deleted": false
    }
  ],
  "next_cursor": "c-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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "13_909110614026444802"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 39973,
    "name": null,
    "file_name": "buildings https://t.co/xFdzrHM5QG",
    "description": null,
    "media_url": "https://video.twimg.com/amplify_video/909110614026444802/vid/1280x720/mfahmfkKVjjk1nGm.mp4",
    "media_category": "AMPLIFY_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/909110614026444802/img/QZUNoaiCia0UFNrw.jpg",
    "poster_media_key": "3_909110614026444802",
    "media_key": "13_909110614026444802",
    "created_at": "2017-09-16T17:43:55Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "buildings",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-09-27T13:04:00Z",
    "deleted": false
  }
}

वर्तमान खाते के साथ किसी मीडिया ऑब्जेक्ट को संबद्ध करें। अतिरिक्त जानकारी के लिए, कृपया हमारी मीडिया लाइब्रेरी guide देखें। नोट: 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "3_931236738554519552"
    }
  },
  "data": {
    "tweeted": false,
    "name": null,
    "file_name": null,
    "media_url": "https://pbs.twimg.com/media/DOxq4TtV4AAlvh_.jpg",
    "media_category": "TWEET_IMAGE",
    "media_key": "3_931236738554519552",
    "created_at": "2017-11-16T19:05:14Z",
    "media_status": "TRANSCODE_COMPLETED",
    "media_type": "IMAGE",
    "updated_at": "2017-11-16T19:05:23Z",
    "deleted": false
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट मीडिया लाइब्रेरी ऑब्जेक्ट को अपडेट करें.

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "16_844800354743074820",
      "title": "cat GIF",
      "description": "in space"
    }
  },
  "data": {
    "tweeted": true,
    "duration": null,
    "name": null,
    "file_name": null,
    "description": "in space",
    "media_url": "https://video.twimg.com/tweet_video/C7lVclqVwAQqTCZ.mp4",
    "media_category": "TWEET_GIF",
    "poster_media_url": "https://pbs.twimg.com/tweet_video_thumb/C7lVclqVwAQqTCZ.jpg",
    "poster_media_key": "3_844800354743074820",
    "media_key": "16_844800354743074820",
    "created_at": "2017-10-20T09:51:54Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "cat GIF",
    "media_type": "GIF",
    "aspect_ratio": "125:79",
    "updated_at": "2017-10-23T06:37:56Z",
    "deleted": false
  }
}

मौजूदा खाते से संबंधित निर्दिष्ट मीडिया लाइब्रेरी ऑब्जेक्ट को हटाएँ।

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "7_860318603387600896"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 14330,
    "name": "mountains-on-ads.x.com",
    "file_name": "mountains.mp4",
    "description": "",
    "media_url": "https://video.twimg.com/ext_tw_video/860318603387600896/pu/vid/1280x720/xI3DbvWKxdvICsFW.mp4",
    "media_category": "TWEET_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/media/C_B3bTRVYAAFBFt.jpg",
    "poster_media_key": "3_860318839740915712",
    "media_key": "7_860318603387600896",
    "created_at": "2017-05-05T02:21:53Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "uploaded on ads.x.com",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-05-05T02:26:58Z",
    "deleted": true
  }
}

पोल कार्ड

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

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

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_ids": [
        "57i77"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_poster_height": "9",
      "name": "best coast poll",
      "start_time": "2018-01-09T04:51:34Z",
      "first_choice": "East",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
      "content_duration_seconds": "8",
      "second_choice": "West",
      "end_time": "2018-01-16T04:51:34Z",
      "id": "57i77",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
      "created_at": "2018-01-09T04:51:34Z",
      "duration_in_minutes": "10080",
      "card_uri": "card://950590850777497601",
      "updated_at": "2018-01-09T04:51:34Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_POLLS"
    }
  ]
}

मौजूदा खाते से जुड़े किसी विशिष्ट पोल कार्ड को प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_id": "57i8t",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "text only poll",
    "start_time": "2018-01-09T05:03:05Z",
    "first_choice": "Morning",
    "second_choice": "Evening",
    "end_time": "2018-01-11T05:03:05Z",
    "id": "57i8t",
    "created_at": "2018-01-09T05:03:05Z",
    "duration_in_minutes": "2880",
    "card_uri": "card://950593749658189824",
    "updated_at": "2018-01-09T05:03:05Z",
    "deleted": false,
    "card_type": "TEXT_POLLS"
  }
}

POST accounts/:account_id/cards/poll

निर्दिष्ट खाते से संबद्ध एक नया पोल कार्ड बनाएँ। यह endpoint छवि, वीडियो या बिना मीडिया वाले पोल कार्ड बनाने का समर्थन करता है। मीडिया वाले पोल को Media Forward Polls कहा जाता है। नोट: Media Forward Polls उत्पाद beta में है और इसके लिए 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

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

{
  "request": {
    "params": {
      "first_choice": "East",
      "name": "best coast poll",
      "second_choice": "West",
      "media_key": "13_950589518557540353",
      "duration_in_minutes": 10080
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "best coast poll",
    "start_time": "2018-01-09T04:51:34Z",
    "first_choice": "East",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
    "content_duration_seconds": "8",
    "second_choice": "West",
    "end_time": "2018-01-16T04:51:34Z",
    "id": "57i77",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
    "created_at": "2018-01-09T04:51:34Z",
    "duration_in_minutes": "10080",
    "card_uri": "card://950590850777497601",
    "updated_at": "2018-01-09T04:51:34Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_POLLS"
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट poll card को स्थायी रूप से हटाएँ। नोट: यह hard delete है। इसलिए, हटाए गए cards को पुनर्प्राप्त करना संभव नहीं है।

संसाधन 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

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

{
  "data": {
    "name": "poll with image",
    "start_time": "2018-01-09T05:10:51Z",
    "id": "57i9t",
    "created_at": "2018-01-09T05:10:51Z",
    "updated_at": "2018-01-09T05:11:04Z",
    "deleted": true,
    "card_type": "IMAGE_POLLS"
  },
  "request": {
    "params": {
      "card_id": "57i9t",
      "card_type": "poll",
      "account_id": "18ce54d4x5t"
    }
  }
}

प्रीरोल कॉल टू एक्शन

GET accounts/:account_id/preroll_call_to_actions

वर्तमान खाते के अंतर्गत line items से जुड़े कुछ या सभी preroll Call-To-Actions (CTAs) का विवरण प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8v53k"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8v53k",
      "call_to_action_url": "https://www.x.com",
      "call_to_action": "VISIT_SITE",
      "id": "8f0",
      "created_at": "2017-07-07T19:28:40Z",
      "updated_at": "2017-07-07T19:28:40Z",
      "deleted": false
    }
  ]
}

इस खाते से संबद्ध किसी विशिष्ट 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 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

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

{
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  }
}

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

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

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8v53k",
      "call_to_action": "VISIT_SITE",
      "call_to_action_url": "https://www.x.com",
      "account_id": "18ce54d4x5t"
    }
  }
}

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

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

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "WATCH_NOW",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-09-09T05:51:26Z",
    "deleted": false
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "call_to_action": "WATCH_NOW",
      "account_id": "18ce54d4x5t"
    }
  }
}

वर्तमान खाते के लिए निर्दिष्ट preroll Call-to-Action (CTA) हटाएँ।

संसाधन 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

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

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-08-30T06:08:21Z",
    "deleted": true
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  }
}

Scheduled Tweets

GET accounts/:account_id/scheduled_tweets

वर्तमान खाते से संबद्ध कुछ या सभी 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

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

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name": "test name",
      "completed_at": "2017-06-18T22:00:05Z",
      "text": "where you want to be",
      "user_id": "756201191646691328",
      "scheduled_status": "SUCCESS",
      "id": "875828692081037312",
      "nullcast": true,
      "created_at": "2017-06-16T21:33:27Z",
      "scheduled_at": "2017-06-18T22:00:00Z",
      "card_uri": null,
      "updated_at": "2017-06-19T18:02:20Z",
      "tweet_id": "876560168963645440",
      "media_keys": []
    }
  ],
  "next_cursor": "c-j41uw400"
}

वर्तमान खाते से संबद्ध किसी विशिष्ट Scheduled Tweet को प्राप्त करें.

संसाधन 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

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

{
  "request": {
    "params": {
      "scheduled_tweet_id": "917438609065623552"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

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

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

{
  "request": {
    "params": {
      "media_keys": [
        "3_917438348871983104"
      ],
      "scheduled_at": "2018-01-01T00:00:00Z",
      "as_user_id": 756201191646691328
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

वर्तमान खाते के निर्दिष्ट Scheduled Tweet को अपडेट करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "scheduled_tweet_id": "875057751231037440",
      "text": "winter solstice"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "SCHEDULED",
    "text": "winter solstice",
    "user_id": "756201191646691328",
    "id": "875057751231037440",
    "nullcast": true,
    "created_at": "2017-06-14T18:30:00Z",
    "scheduled_at": "2017-12-21T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T18:30:00Z",
    "tweet_id": null,
    "media_keys": []
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट Scheduled Tweet को स्थायी रूप से हटाएँ। नोट: यह हार्ड डिलीट है। इसलिए, हटाए गए Scheduled Tweets को पुनर्प्राप्त करना संभव नहीं है।

संसाधन 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

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

{
  "request": {
    "params": {
      "scheduled_tweet_id": 875064008595787776
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "DELETED",
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": "875064008595787776",
    "nullcast": true,
    "created_at": "2017-06-14T18:54:52Z",
    "scheduled_at": "2017-06-15T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T19:01:16Z",
    "tweet_id": null,
    "media_keys": []
  }
}

Tweet प्रीव्यू

GET accounts/:account_id/tweet_previews

प्रकाशित, शेड्यूल किए गए या ड्राफ़्ट Tweet का पूर्वावलोकन करें।

एक ही 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

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

{
  "request": {
    "params": {
      "tweet_ids": [
        "1122911801354510336",
        "1102836745790316550"
      ],
      "tweet_type": "PUBLISHED",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "tweet_id": "1122911801354510336",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAANVYW2%2FbNhT%2BKwJf59iiZDuSgWLI0suyrUXbZBuGaiAoibbZUKRGUk7TIP99h6Jsy4mdC5CX%2BiUiz%2F0cfueQuUH2ijGLZsENKjSjlpWEwhK9VzI4qXUQpQE%2BnuF4FofBTyH8gijEKRogXqIZxlGUYpyEOJ6MJziM46kjEGM1qNhDBbl5IwSx7JszsuIlU8EVyw23DGhWN7JwPqDZnArDBqjkphb0uhUgmsoFQ7Mv4QDH%2Fw4Qk5Zbzgya3aAlNUtLF%2FD9BSjmusqV6BaNYZpUjlnJ9Zb2xFtgVY0uQCnKmjCMCxosNZu%2FytDS2trMslE2oqU5ojUf2ituLdPDQlUZCjQTwCXVXAmhrjIvzi48T3BSmuBUVbUC214x6PEsLnWSaFYLiEpBqqhtDHHZlJCZA0Sf0fsMbWz7ZTvSIUkD1WaSSFqxNdlJuFw6fceTKdQZp3g6nk5THEdJr7D3iRCU14ROPp4F74sLZuycFi7YHUMIElkVdksVCuoNhQHSOZXBWyhxwU2hBsHpCWoLtfauZKCJ1x3zmbQqcHq4XARUlgHYNSBQa2VZ0T9BvkBMG1KoRsKpO8KwqTmT5c6W4MYd%2Fm7H29xBxMWyCX5rRBDhACezyXQWJVtEtCebruAwwUne0dvYgqj53LCNVssrRr4ruUn8ginCJM1Fz%2B0V03zOexv%2BLOzqFgAI8IxJsF4oaTXPG6sg1LvauCEWUmsEBfK%2BXcjqPSHI5ZwLRnJaXC40WHXZEU4ehe0P7eXhFV0w0lauRZEHUW4cgKpFC59Ry2OykV2yavMXZ6N8MawhpIf1khabnXbzUuotrO%2BFvjeWetfYDi8YA3TE4yTGx%2BNJMgnTJJpko9cXvxefT%2BtzIpWuqBh%2BrftePBTZixvLqZTQGbYxPWjHc3tDdzCfjfAYvqbROMY9%2FYLLy8PnxEDHz6kmudIlePEoHyzEYa52KhykAlrunZ%2FtYGFz2ghLOuZD%2B3ekfDPhDnUeun4D2up%2FDTQjYti2eUhlAcG%2BvZkN9jcoJPa6dh1RukZw2zaBTdtRkB0uofVs5GAIFmxL30J9vadZO8jX3SH07ch1oz1bW4x3Yn3UK2N4DkMCYoGxzFfb6KEv137cbppqRwP%2FC6pLR%2BoafTRJpnEaHuPpDFJZKdLOerKd9f4AOqn2%2FOFwPI5DHKZpGOPpJBmnrqU6cpuouxh0hCNHOALCETdHJas1a%2B8OQy5XVMAQG6CcS8jjgsC68Y539olZKm2ZhN7eKr5BXTXOLz6ffXjnxhZkeC25AxQLAMlG32nJ%2Fjz%2F6zVOXO1cQaDypGy0b6WGwVZpnqA4GjsF7o4DcLjipV0%2BQQjGzVZobZyXT5GMSQroPR5HyRiuZfAVJWFP2ZLxxdI%2BQVHqhFZUcnv9xBSWbMUEHCDdv0k5LeualA5Bzy3HQa1dQOpKdlekR5Xuudb0EiPMs31rj3y%2Fq9KqFnx%2B7bGQje5XAhqvyEbmk%2F7FvEmrt6sPrE5Pvw2ruEl%2Bhuvtq8h5BLde17AedeT1OjXBR%2Bg4cxgG%2FWy%2FdKJBkNHqxXO0qmi9L1NDR%2BiZ9zPUwLzr2z97f%2FLujbtxt9TO%2Bg16ZPjtuEDssqny%2FcUCiWz0T56%2F%2B%2FTr6u%2FPX9Xbhf7jezdvOyxjYBygNayOI1hQ0c2I2zvu%2F7COE0H1j%2Bz%2Btx8wgHY0Pnt49aDbPs14zsglu%2B4mcatvo7xedw2w0P%2BGTsAL1pv18No9qTlqHy3Gv89w7LBJmxLeWTu8cBkom6J9xcF8bopLtonJGd6%2BaG4HAWpvDv5VJv2%2FDIKbzSYsrG7Y7e3%2FCm%2FIC8QQAAA%3D'>"
    },
    {
      "tweet_id": "1102836745790316550",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAO1YbW%2FbNhD%2BK4K%2Bzo3eZdlAMQQttqZrt6FNEXRVIVASJTOhSIWkHDeB%2F%2FuOomXLb%2BuHdQWGzV8s3T13vCOPz539ZKsHjJU9t57sQmCkcJkheLWvO2y9RcJyI8udzkN%2F7ofWDy58LN%2F1ZvbEJqU99zzXT4J4GkbTmRt4cRS5WpFJJcDFCS3YVR2lmcIrvcgNWmJpLZRq5Tx1UkddFDx16mUU8Lv4UhQAV6JjhQ7LnleISjyxSyJbir70PjKBWI3t%2BSd3En2e2JgpogiW9vzJXiC5UKiG50%2BgkV%2BanNPNSyexyBoN5mwQiUHZ4JIgeHwyGbpumLjh1PcDfxZ6XpSE4wyPtXpnWEkKHcSneOLPBpcZLAEmOtk%2B1zaXF%2BqBNDXk3KSOTkY9ZEtSYp6pRdfkqXPCPdh1qQNWYPFz%2BfHls7v7y6s3dZm%2Fci9u29oeLZb1%2B7pZUv6ja%2B5SO3uOw6kZaEsKHYhSWJhQ9rB41SJWQiUe%2BR2boJY0hcJSVajAqSMVUp2EBI6rLnX6FEGnC%2BpLi3UEC644vEryaOqlz18%2FPMCp6zpebL4F1hgwKQRv7bXZ4a4ZoL5rsPE0GmErojRUNojSDTJODDBIgmMgRULX8cblBjn13UMkQCu4pZ3og16vP6%2F1dincb9e4%2FP8v4%2F9EGfeSf2UZm%2BMirOIaj2SLC03nwMlQcV480RVXdr2AZQ2hlEhdx9MYnC2RIIgp2dd3ThSgwHUSQBKgLTiDCwE1Mdqi1Gna8MQR98pzxfQXZQT61IlDdxXEcC7Rm1fsHl96H8sau%2Fer1xew2I%2FQfJ4HsCmjCP0o%2Fr4Rwo6svAQivLvqXn14mRD%2FD%2BnWuX91NkJv%2Bp1D1GWyghJJnbD56HePt%2FjXG%2FJbVd3cHsR4EBFqW0qKvjxSZ%2FWsaXH94d2bbxhdS1Nn5r17CF7cTMurt6%2Ffh7fJRRN0yRDT5wMyntioLIkOCNHM8NdQ3sDLVAetGQTLQpBWw4wANzkuS5RrAEw7MOE0nGFFHo2on3oM0UveiUK7STvXDQpkLQSunqejXFEp9wjJtgSmgGC84pTyh9SY4muDsS5LaXyBqdH0xJ8J3FKYsHhm6CjTPYTB4HZGafrIMaAftE7bblTnLGGPMGYZQw0e1NpC76X2N41iGEO9mReHcTzzAj8ZtbNjJSRlPNmXv19Zb4vrDd1q4hwvZO%2BRMWgpNxUGqveIWT%2FBuFkQWfCJ9eJyKDUT3f6xXjHFLe2HsNqCJmDBuhIMWsEV8NxomjXngoXMCt4xGIqfeSAUBDr6ngjoT8%2FmG4lZc39gX3TW645avmd5yTyK536yG9hjPXijJdQPgajGfjtVZLyqJN56VaTB2SOU4CCogacx09W4C3uJBanISGBqYd83heEcIsPMNnwiSN4pDqkeeiMyA%2F5hkiJQn5LqHnBoBHtZEYqzHBV3tYBV9e5QbW%2B7%2Fcc%2BiSENqvHhFIP2J4oeA01YLXCz%2FfZSJ68vWlZ%2Fxe%2BJgeUbuFdkSwY7%2FclcDqajPSwsBrcjCJPAg8kiidxZ4kep8%2FL6l%2BLdi%2FZ9xriAVr8Zh45W%2Bfoo9vcXyxFjwAyHJH5mHYM2Cx3ceWD2EJ5iPwy8kX9K2N35OpHQE3IkspyLEqL4Kg5e6HlU%2Fwv1rBZuy1H97H7k4gp1VGUb8Dn5gZUhE6Jvnbm6RgC0et8BGWUS78iDcQU32NCb3N797S0c2izTRLDuSWBLOxx2hzCgnq0dzMQF3ul3V32QCdz%2FzzCwg2voSLPRCdHujm%2FMxreeS0lyaBKQi4Rmu9xlD7zcmiF4S6pD%2Bxxz0Xpi6TNouOFTZv6LsJ62QnjRfXi9%2FhONbe6QHREAAA%3D%3D'>"
    }
  ]
}

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

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

{
  "request": {
    "params": {
      "tweet_ids": [
        "1166476031668015104"
      ],
      "tweet_type": "PUBLISHED",
      "trim_user": true,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "coordinates": null,
      "retweeted": false,
      "name": null,
      "source": "<a href="https://ads-api.x.com" rel="nofollow">Ads API Internal Test App</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        9
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "1166476031668015104",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "id": 1166476031668015104,
      "in_reply_to_status_id": null,
      "conversation_settings": "EVERYONE",
      "nullcast": true,
      "created_at": "Tue Aug 27 22:22:12 +0000 2019",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hello, v6",
      "lang": "es",
      "contributors": [
        2417045708
      ],
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "id": 756201191646691328,
        "id_str": "756201191646691328"
      },
      "tweet_id": "1166476031668015104"
    }
  ]
}

POST accounts/:account_id/tweet

खाते के पूर्ण promotable user (डिफ़ॉल्ट) या 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

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

{
  "data": {
    "created_at": "Sat Jun 24 05:08:30 +0000 2017",
    "id": 878479925472251906,
    "id_str": "878479925472251906",
    "text": "hello, world",
    "name": null,
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "<a href='"https://ads-api.x.com"' rel='"nofollow"'>Ads API Internal Test App</a>",
    "in_reply_to_status_id": null,
    "in_reply_to_status_id_str": null,
    "in_reply_to_user_id": null,
    "in_reply_to_user_id_str": null,
    "in_reply_to_screen_name": null,
    "user": {
      "id": 756201191646691328,
      "id_str": "756201191646691328"
    },
    "geo": null,
    "coordinates": null,
    "place": null,
    "contributors": null,
    "retweet_count": 0,
    "favorite_count": 0,
    "favorited": false,
    "retweeted": false,
    "scopes": {
      "followers": false
    },
    "lang": "en"
  },
  "request": {
    "params": {
      "text": "hello, world",
      "trim_user": true,
      "as_user_id": 756201191646691328,
      "account_id": "18ce54d4x5t"
    }
  }
}

मौजूदा खाते के निर्दिष्ट Tweet 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

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

{
  "request": {
    "params": {
      "tweet_id": 994747471329873920,
      "name": "new Tweet name",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
      "coordinates": null,
      "retweeted": false,
      "name": "new Tweet name",
      "conversation_settings": "EVERYONE",
      "source": "<a href="https://ads-api.x.com" rel="nofollow">Ads API Internal Test App</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        5
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "994747471329873920",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "scheduled_status": null,
      "id": 994747471329873920,
      "in_reply_to_status_id": null,
      "nullcast": true,
      "created_at": "Wed Jan 01 00:00:00 +0000 2020",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hello",
      "lang": "en",
      "contributors": null,
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "utc_offset": null,
        "name": "Tushar Bhushan",
        "friends_count": 1065,
        "screen_name": "imit8me",
        "location": "San Francisco, CA",
        "protected": false,
        "url": "https://tushdante.github.io",
        "profile_image_url": "http://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_background_color": "C0DEED",
        "profile_use_background_image": true,
        "is_translator": false,
        "geo_enabled": true,
        "description": "Open Sorcerer / Partner Engineer @twitter / Space Traveller | Former evangelist @sendgrid @keen_io",
        "profile_link_color": "1DA1F2",
        "id_str": "3271358660",
        "listed_count": 31,
        "default_profile_image": false,
        "followers_count": 407,
        "profile_image_url_https": "https://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_sidebar_border_color": "C0DEED",
        "profile_background_image_url": "http://abs.twimg.com/images/themes/theme1/bg.png",
        "favourites_count": 5993,
        "following": null,
        "default_profile": true,
        "withheld_in_countries": [],
        "id": 3271358660,
        "profile_background_tile": false,
        "contributors_enabled": false,
        "follow_request_sent": null,
        "created_at": "Tue Jul 07 22:34:58 +0000 2015",
        "profile_sidebar_fill_color": "DDEEF6",
        "translator_type": "regular",
        "lang": null,
        "profile_text_color": "333333",
        "notifications": null,
        "verified": false,
        "time_zone": null,
        "profile_banner_url": "https://pbs.twimg.com/profile_banners/3271358660/1474853576",
        "statuses_count": 500,
        "profile_background_image_url_https": "https://abs.twimg.com/images/themes/theme1/bg.png",
        "is_translation_enabled": false
      },
      "tweet_id": "994747471329873920"
    }
}

वीडियो कन्वर्सेशन कार्ड

नोट: किसी कार्ड को Tweet से जोड़ने के लिए, POST accounts/:account_id/tweet, POST statuses/update, या POST accounts/:account_id/scheduled_tweets endpoints में से किसी भी एक के साथ 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

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

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_ids": [
        "5a86h"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "id": "5a86h",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "created_at": "2018-01-30T17:53:04Z",
      "card_uri": "card://958397665015775232",
      "title": "Developers",
      "updated_at": "2018-01-30T17:53:04Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "deleted": false,
      "card_type": "VIDEO_CONVERSATION"
    }
  ]
}

वर्तमान खाते से संबद्ध किसी विशिष्ट वीडियो कन्वर्सेशन कार्ड को पुनर्प्राप्त करें।

संसाधन 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

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

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_id": "5a86h",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  }
}

POST accounts/:account_id/cards/video_conversation

निर्दिष्ट खाते से संबद्ध एक नया वीडियो कन्वर्सेशन कार्ड बनाएँ। हमारे endpoints पर छवियाँ अपलोड करने संबंधी उपयोगी जानकारी के लिए मीडिया अपलोड करना देखें।

संसाधन 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

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

{
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "account_id": "18ce54d4x5t",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "title": "Developers",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_CONVERSATION"
    }
  }
}

वर्तमान खाते से संबंधित निर्दिष्ट वीडियो कन्वर्सेशन कार्ड को अपडेट करें। हमारे एंडपॉइंट्स पर छवियाँ अपलोड करने से जुड़ी उपयोगी जानकारी के लिए Uploading Media देखें।

संसाधन 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

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

{
  "data": {
    "name": "developers card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T18:02:15Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_CONVERSATION",
      "card_id": "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

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

{
  "data": {
    "name": "video conversation card",
    "id": "4i0ya",
    "created_at": "2017-07-07T01:36:39Z",
    "updated_at": "2017-08-23T13:29:13Z",
    "deleted": true,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0ya",
      "card_type": "video_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}