संस्करण

X Ads API के ऐतिहासिक संस्करणों के बारे में सबसे अद्यतन जानकारी के लिए, कृपया नीचे दी गई जानकारी देखें।

संस्करण	पथ	परिचय की तारीख	अप्रचलित होने की तारीख	समर्थन समाप्ति तिथि
12.0	/12/	27 अक्टूबर, 2022	निर्धारित होना बाकी	निर्धारित होना बाकी
11.0	/11/	31 मार्च, 2022	निर्धारित होना बाकी	निर्धारित होना बाकी
10.0	/10/	31 अगस्त, 2021	31 मार्च, 2022	27 अक्टूबर, 2022
9.0	/9/	2 मार्च, 2021	31 अगस्त, 2021	31 मार्च, 2022
8.0	/8/	8 सितंबर, 2020	2 मार्च, 2021	31 अगस्त, 2021
7.0	/7/	3 मार्च, 2020	1 सितंबर, 2020	2 मार्च, 2021
6.0	/6/	28 अगस्त, 2019	3 मार्च, 2020	1 सितंबर, 2020
5.0	/5/	28 फ़रवरी, 2019	28 अगस्त, 2019	3 मार्च, 2020
4.0	/4/	28 अगस्त, 2018	28 फ़रवरी, 2019	28 अगस्त, 2019
3.0	/3/	1 फ़रवरी, 2018	28 अगस्त, 2018	28 फ़रवरी, 2019
2.0	/2/	10 जुलाई, 2017	1 फ़रवरी, 2018	1 अगस्त, 2018
1.0	/1/	31 मार्च, 2016	7 जुलाई, 2017	10 जनवरी, 2018
0.0	/0/	21 फ़रवरी, 2013	लागू नहीं	31 अक्टूबर, 2016

​

अवलोकन

हर महीने, हम X Ads API में बदलाव करते हैं और कई नई सुविधाएँ जारी करते हैं। ये बदलाव लगभग हमेशा backward compatible होते हैं, हालांकि हर साल कुछ breaking changes भी होते हैं। डेवलपर्स से हमें यह फ़ीडबैक मिला है कि Ads API में तेज़ी से होने वाले बदलाव उनके development cycles को प्रभावित करते हैं, खासकर नई सुविधाएँ लागू करने, deprecations को संभालने और बदलावों की जाँच करने में। हम अपने Ads प्लेटफ़ॉर्म का उपयोग करने वाले डेवलपर्स के अनुभव को बेहतर बनाना चाहते हैं, इसलिए हमने अपने endpoints के लिए versioning की अवधारणा शुरू की।

जिन अवधारणाओं के बारे में हम बात करते हैं, उनकी कुछ परिभाषाएँ:

Version: इससे आशय उस version number से है जो किसी भी Ads API अनुरोध के URL path में होता है, उदाहरण के लिए: GET //accounts.  Versioning की इस शैली को URI versioning कहा जाता है।

Breaking Changes: Breaking changes वे सभी बदलाव हैं जिनके कारण मौजूदा functionality को बनाए रखने के लिए डेवलपर संसाधनों की आवश्यकता होती है। इसमें यह पता लगाने के लिए इस्तेमाल किए जाने वाले संसाधन शामिल हैं कि कौन-से बदलाव करने होंगे, कौन-सी सुविधाएँ/endpoints deprecated हो रहे हैं, और इन सभी बदलावों का अंतिम implementation। Breaking changes के कुछ उदाहरण इस प्रकार हैं:

• API अनुरोध/रिस्पॉन्स से किसी param को हटाना

• किसी param या endpoint के नाम में बदलाव करना

• मानों के निरूपण में बदलाव (preview_url → card_uri)

• endpoints के व्यवहार में बदलाव (उदा.,  async बनाम sync stats)

• वैकल्पिक या आवश्यक params को जोड़ना/बदलना (उदा., अनुरोध में name को एक आवश्यक फ़ील्ड बनाना)

Deprecation: Deprecated versions या products समर्थित नहीं होंगे, और डेवलपर्स को सलाह दी जाती है कि वे इन APIs का उपयोग बंद कर दें।

Sunset: जब किसी product या API को sunset कर दिया जाता है, तो उससे संबंधित endpoints का सेट API के माध्यम से अब उपलब्ध नहीं रहेगा।

​

संस्करण रणनीति

इस रणनीति के मुख्य सिद्धांत ये हैं:

1. सभी ब्रेकिंग चेंज को नए संस्करण में शामिल किया जाएगा

2. जब भी किसी नए संस्करण की घोषणा की जाएगी, मौजूदा संस्करणों के लिए डिप्रिकेशन अवधि 6 महीने होगी

3. किसी भी समय, API एक साथ दो संस्करणों से अनुरोध स्वीकार करेगा, हालांकि इनमें से पुराने संस्करण के लिए समर्थन उपलब्ध नहीं होगा

4. नए प्रोडक्ट को तेजी से अपनाने में मदद के लिए, इन्हें निरंतर आधार पर जारी किया जाएगा (वर्ज़निंग कैडेंस से अलग)

5. सभी API रिस्पॉन्स में x-current-api-version शामिल होगा, जिसे API के वर्तमान संस्करण पर सेट किया जाएगा। इसके अलावा, किसी भी डिप्रिकेटेड API endpoint को कॉल करने पर x-api-warn header भी शामिल होगा।

यदि प्रोडक्ट की मूलभूत आवश्यकताओं में ऐसा कोई परिवर्तन होता है जिसके लिए API में ब्रेकिंग चेंज जरूरी हो (उदाहरण के लिए, multiple age bucket targeting को डिप्रिकेट करना), तो हम इस ब्रेकिंग चेंज की घोषणा के लिए 90 दिन पहले सूचना देंगे, और सूचना जारी होने के कम से कम 90 दिन बाद उस ब्रेकिंग चेंज को लागू किया जाएगा

​

v9

आज, 3 मार्च 2021 को, X Ads API का Version 9 (v9) उपलब्ध हो गया है। इस रिलीज़ का उद्देश्य फ़ीचर समानता बढ़ाना, कैंपेन बनाना सरल करना, और हमारे Cards तथा Mobile App Promotion endpoints में अहम अपडेट पेश करना है।

हमारे पिछले versions की तरह, v9 पर माइग्रेट करने के लिए 6 महीने की संक्रमण अवधि होगी। 31 अगस्त 2021 को, Ads API का मौजूदा version 8 (v8) अब उपलब्ध नहीं रहेगा। हम सभी developers को प्रोत्साहित करते हैं कि किसी भी सेवा बाधा से बचने के लिए वे यथाशीघ्र Ads API के नवीनतम version पर माइग्रेट करें।

नोट: इस रिलीज़ के साथ, Ads API का Version 7 (v7) अपने जीवनचक्र के अंत तक पहुँच चुका है और अब उपलब्ध नहीं है।

पूरी जानकारी के लिए, कृपया developer forum पर घोषणा देखें।

​

v8

आज, 20 सितंबर 2020 को, हम X Ads API का Version 8 पेश कर रहे हैं, जिसे नई Tailored Audiences कार्यक्षमता जोड़ने, ads.x.com के साथ फीचर समानता बढ़ाने और आपके डेवलपर अनुभव को बेहतर बनाने के लिए डिज़ाइन किया गया है।

पिछले versions की तरह, v8 पर माइग्रेट करने के लिए 6 महीने की संक्रमण अवधि होगी। 2021-03-02 को Ads API का version 7 अब उपलब्ध नहीं होगा। हम सभी डेवलपर्स को प्रोत्साहित करते हैं कि किसी भी सेवा बाधा से बचने के लिए वे जल्द से जल्द API के नवीनतम version पर माइग्रेट करें।

पूरी जानकारी के लिए, कृपया developer forum पर घोषणा देखें।

​

v7

आज, 20 मार्च 2020 को, हम X Ads API का Version 7 पेश कर रहे हैं, जिसे ads.x.com के साथ फीचर समानता बढ़ाने के लिए डिज़ाइन किया गया है।

पिछले versions की तरह, v7 पर माइग्रेट करने के लिए 6 महीने की संक्रमण अवधि होगी। 2020-09-01 से Ads API का version 6 अब उपलब्ध नहीं होगा। हम सभी डेवलपरों को प्रोत्साहित करते हैं कि वे किसी भी सेवा व्यवधान से बचने के लिए जल्द से जल्द API के नवीनतम version पर माइग्रेट करें। Ads API का Version 5 अपने जीवनचक्र के अंत तक पहुंच चुका है और अब उपलब्ध नहीं है।

पूरी जानकारी के लिए, कृपया developer forum पर की गई घोषणा देखें।

​

v6

आज, 28 अगस्त 2019 को, X Ads API v6 पेश कर रहा है, जिसमें ऐसे अपडेट शामिल हैं जो एकरूपता पर केंद्रित हैं और डेवलपर अनुभव को बेहतर बनाते हैं।

इस रिलीज़ में Tweets प्राप्त करने के लिए एक नया endpoint, Promoted Accounts के लिए stats, नाम के आधार पर entities खोजने की क्षमता, और वर्तमान में प्रोसेस हो रही asynchronous analytics jobs की संख्या से जुड़ी जानकारी शामिल है। इसके अलावा, हमने media का उपयोग करने वाले endpoints और अपने targeting criteria endpoints में एकरूपता पर केंद्रित अपडेट किए हैं। अंत में, हमने अपने कुछ parameter names और रिस्पॉन्स attributes में छोटे-मोटे अपडेट किए हैं और Scoped Timeline endpoint को deprecated कर रहे हैं।

पूरी जानकारी के लिए, कृपया developer forum पर की गई घोषणा देखें।

​

v5

आज, 28 फ़रवरी 2019 को, X ने Ads API v5 पेश किया, जिसमें ऐसे अपडेट शामिल हैं जिनका फ़ोकस स्केल और दक्षता को बेहतर बनाना है।

इस रिलीज़ में यह निर्धारित करने के लिए एक नया endpoint शामिल है कि किसी निर्धारित समयावधि में कौन-सी entities सक्रिय थीं, Media Creatives के लिए stats (यानी, X Audience Platform पर In-stream videos और images), card URI के आधार पर एकाधिक cards फ़ेच करने की क्षमता, और targeting criteria तथा अन्य entities को पुनर्प्राप्त करने में अधिक लचीलापन। इसके अलावा, हमने कुछ bugs ठीक किए हैं और parameter names तथा रिस्पॉन्स attributes में भी अपडेट किए हैं। अंत में, non-media ऐप cards और POST accounts/:account_id/account_media endpoint को deprecated कर दिया गया है।

पिछले versions की तरह, v5 पर migrate करने के लिए 6 महीने की transition period होगी। 2019-08-28 को Ads API का version 4 अब उपलब्ध नहीं रहेगा। हम सभी partners को प्रोत्साहित करते हैं कि किसी भी service disruption से बचने के लिए वे जल्द से जल्द API के नवीनतम version पर migrate करें। Ads API का Version 3 अपने end of life पर पहुँच चुका है और अब उपलब्ध नहीं है।

​

नया

यह निर्धारित करना कि कौन-सी entities सक्रिय थीं

Active Entities endpoint यह बताता है कि ads entities के लिए analytics metrics में बदलाव हुआ है या नहीं। इसे analytics endpoints के साथ उपयोग करने के लिए डिज़ाइन किया गया है। Active Entities में एक entity type और एक date range—अधिकतम 90 दिनों तक—निर्दिष्ट किया जाता है, और यह entity IDs की एक array लौटाता है जिनके लिए आपके platform को analytics का अनुरोध करना चाहिए। लौटाए गए IDs के अलावा अन्य IDs को बाद के analytics requests में query नहीं किया जाना चाहिए।

यह endpoint निम्नलिखित entity types का समर्थन करता है:CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE, and PROMOTED_TWEET.

MEDIA_CREATIVE आँकड़े

Ads API के analytics endpoints अब Media Creative entities के लिए metrics उपलब्ध कराते हैं। Media Creatives के ज़रिए in-stream ads या X Audience Platform पर images को promote किया जाता है। X Ads UI में Media Creative metrics “In-stream videos” और “Display creatives” tabs के अंतर्गत दिखाए जाते हैं। synchronous और asynchronous analytics endpoints दोनों अब MEDIA_CREATIVE entity enum का समर्थन करते हैं।

एकाधिक cards fetch करें

card URI value के आधार पर एक single card retrieve करने के लिए बनाए गए endpoint के v3 release को आगे बढ़ाते हुए, अब GET accounts/:account_id/cards/all endpoint का उपयोग करके multiple cards fetch करना संभव है। अब हर card के लिए अलग-अलग request करने के बजाय, आप एक ही request में 200 तक cards retrieve कर सकते हैं।

ध्यान देने योग्य दो बातें:

1. URL path अब accounts/:account_id/cards/all है। (पिछला path अब उपलब्ध नहीं है।) ऐसा इसलिए किया गया है ताकि card को ID के आधार पर retrieve करने के लिए बनाए गए endpoint के साथ एकरूपता बनी रहे।
2. आवश्यक request parameter का नाम अब card_uris (plural) है।

retrieve करने में लचीलापन

GET accounts/:account_id/targeting_criteria endpoint अब एकाधिक line item IDs का समर्थन करता है। line_item_ids parameter, जो 200 तक IDs स्वीकार करता है, आवश्यक है। पहले केवल एक single line item स्वीकार किया जाता था, जिससे syncing कठिन हो जाती थी। इस बदलाव के साथ, अब कम समय में अधिक targeting retrieve करना संभव है।

निम्नलिखित endpoints अब एकाधिक line item IDs का भी समर्थन करते हैं, हालांकि इनके लिए line_item_ids parameter optional है।

• GET accounts/:account_id/line_item_apps
• GET accounts/:account_id/media_creatives
• GET accounts/:account_id/promoted_accounts
• GET accounts/:account_id/preroll_call_to_actions

​

बदला गया

ड्राफ़्ट campaign और line item प्राप्त करना

ड्राफ़्ट campaign और line item प्राप्त करने के तरीके को अपडेट किया गया है। अब, with_draft(boolean) पैरामीटर को true पर सेट करने पर ड्राफ़्ट और non-draft, दोनों entities लौटती हैं। यह deleted entities को प्राप्त करने के तरीके के अनुरूप है (यानी, with_deleted का उपयोग करके)। पहले, ड्राफ़्ट और non-draft दोनों entities फ़ेच करने के लिए कम से कम दो requests की आवश्यकता होती थी। अब, यह एक ही API call में किया जा सकता है।

| v4 | v5 | | :--- | :--- | :--- | | draft_only | with_draft | |

Network activation duration targeting

Ads API में एक display समस्या को ठीक किया गया है, जिसमें Network Activation Duration targeting जोड़ने के बाद रिस्पॉन्स में targeting type के साथ _IN_SEC suffix शामिल हो जाता था। seconds का संदर्भ भ्रम पैदा करता था, क्योंकि Network Activation Duration हमेशा months में दर्शाया जाता है। यह सुधार representation को सुसंगत बनाता है और भ्रम कम करता है।

| v4 | v5 | | :--- | :--- | :--- | | NETWORK_ACTIVATION_DURATION_IN_SEC | NETWORK_ACTIVATION_DURATION | |

कुल counts और cursors

v5 में, with_total_count और cursor परस्पर अनन्य हैं। किसी request में दोनों को निर्दिष्ट करने पर EXCLUSIVE_PARAMETERS error code लौटेगा। v5 से पहले, cursor निर्दिष्ट होने पर with_total_count को अनदेखा कर दिया जाता था। यह परिवर्तन इस संबंध को स्पष्ट बनाता है।

​

हटाया गया

Ads API रिस्पॉन्स से तीन फ़ील्ड्स हटाए जा रहे हैं: preview_url, account_id, और parent_ids। इन तीनों के लिए इंजीनियरिंग प्रयास न्यूनतम है।

• v4 में यह घोषित किया गया था कि cards के लिए preview_url रिस्पॉन्स पैरामीटर हमेशा null रहता था। इस migration का अंतिम चरण सभी cards रिस्पॉन्स से preview_url को हटाना है।
• account_id रिस्पॉन्स एट्रिब्यूट को निम्नलिखित resources के लिए हटाया जा रहा है, क्योंकि ads account ID पहले से ही URL और request.params, दोनों में मौजूद है। (इस सूची में funding instruments को शामिल न करना जानबूझकर है, क्योंकि जहाँ संभव हो, parent IDs रिस्पॉन्स ऑब्जेक्ट्स में मौजूद होने चाहिए, और account IDs, funding instruments की parent entities हैं।)
  • Account media
  • ऐप event providers
  • ऐप event tags
  • Campaigns
  • Cards
  • Line items
  • Promotable users
  • Targeting criteria
• GET accounts/:account_id/targeting_criteria requests के लिए, अब हम parent_ids फ़ील्ड नहीं लौटाते, क्योंकि यह हमेशा एक खाली array होता था।

गैर-मीडिया ऐप कार्ड्स

v5 में, गैर-मीडिया ऐप कार्ड्स अब समर्थित नहीं हैं। पहले, गैर-मीडिया ऐप कार्ड्स को बनाने या संपादित करने की क्षमता हटा दी गई थी। अब, इस resource के लिए बचे हुए endpoints को अप्रचलित किया जा रहा है।

• नोट: इसका image और video app download cards पर कोई प्रभाव नहीं पड़ता।

Account media creates

POST accounts/:account_id/account_media endpoint अब v5 में उपलब्ध नहीं है। इस resource के अन्य endpoints not प्रभावित हैं। इस बदलाव का कारण यह है कि जब Media Library में media जोड़ा जाता है, तो कुछ मामलों में वे assets स्वचालित रूप से Account Media entities के रूप में जुड़ जाते हैं, और Account Media resource में पहले से मौजूद asset को फिर से जोड़ने की कोशिश करने पर त्रुटि मिलती है। यह निम्नलिखित मामलों में होता है।

• Media Library में जोड़े गए AMPLIFY_VIDEO assets, PREROLL creative type के साथ स्वचालित रूप से Account Media asset के रूप में जोड़ दिए जाते हैं।
• Media Library में जोड़ी गई विशिष्ट dimensions वाली images, स्वचालित रूप से Account Media assets के रूप में जोड़ दी जाती हैं। creative type (उदाहरण के लिए, INTERSTITIAL) image dimensions पर निर्भर करता है। (dimensions के लिए, हमारा Enumerations पृष्ठ देखें।)

​

v4

Ads API का संस्करण 4 आज, 28 अगस्त 2018 को जारी किया जा रहा है।

इस रिलीज़ में हमारे Audiences प्रोडक्ट में सुधार शामिल हैं। इनमें अधिक मज़बूत audience processing backend पर आधारित एक नया API interface भी शामिल है। संस्करण 4 में user, account और tax settings को प्रबंधित करने के लिए endpoints का एक सेट भी शामिल है। इसके अतिरिक्त, accounts/:account_id/videos endpoints को अप्रचलित किया जा रहा है। इस रिलीज़ में कुछ मामूली parameter और रिस्पॉन्स नाम परिवर्तन भी शामिल हैं।

संस्करण 3 की तरह, हम 6 महीने की संक्रमण अवधि प्रदान कर रहे हैं। 2019-02-28 को Ads API का संस्करण 3 अब उपलब्ध नहीं होगा। हम सभी भागीदारों को प्रोत्साहित करते हैं कि किसी भी सेवा व्यवधान से बचने के लिए वे यथाशीघ्र API के नवीनतम संस्करण पर migrate करें। हमारी versioning strategy के विवरण के लिए हमारा Versions पेज देखें।

​

नया

ऑडियंस API

नया Audiences API हमारे नए ऑडियंस प्रोसेसिंग बैकएंड पर आधारित है, जो बेहतर स्थिरता और विश्वसनीयता प्रदान करता है। यह नया एंडपॉइंट पार्टनर्स को एक ही उपयोगकर्ता के लिए कई प्रकार के उपयोगकर्ता पहचानकर्ता उपलब्ध कराने की अनुमति देगा, जिससे हम मिलान के लिए अतिरिक्त संकेतों का उपयोग कर सकेंगे। नए Audience एंडपॉइंट का संदर्भ दस्तावेज़ यहाँ उपलब्ध है। हम इस वर्ष के शेष समय में इस प्रोडक्ट के लिए अपडेट और सुधार जारी करने की योजना बना रहे हैं।

निम्नलिखित एंडपॉइंट v4 में अब उपलब्ध नहीं होंगे, क्योंकि उनकी कार्यक्षमता दोहरावपूर्ण है (वे v3 में अभी भी काम करेंगे और v3 उपलब्ध न रहने पर पूरी तरह बंद कर दिए जाएंगे):

• TON Upload:
  • GET accounts/:account_id/tailored_audience_changes
  • GET accounts/:account_id/tailored_audience_changes/:tailored_audience_change_id
  • POST accounts/:account_id/tailored_audience_changes
  • PUT accounts/:accounti_d/tailored_audiences/global_opt_out
• Real Time Audiences:
  • POST tailored_audience_memberships

अंत में, संस्करण 4 में सभी Tailored Audiences endpoints के अनुरोध और रिस्पॉन्स से list_type पैरामीटर हटा दिया जाएगा।

सेटिंग्स एंडपॉइंट्स

अब हम अकाउंट एडमिनिस्ट्रेटर्स को उपयोगकर्ता, अकाउंट और टैक्स सेटिंग्स सेट करने और अपडेट करने की सुविधा देते हैं। उपयोगकर्ता सेटिंग्स किसी दिए गए विज्ञापन अकाउंट के लिए उपयोगकर्ता-विशिष्ट संपर्क प्राथमिकताओं से संबंधित हैं। PUT accounts/:account_id एंडपॉइंट का उपयोग करके, विज्ञापनदाता अब अपने अकाउंट का नाम और इंडस्ट्री type अपडेट कर सकते हैं। अंत में, टैक्स सेटिंग्स एंडपॉइंट्स उन देशों के विज्ञापनदाताओं को, जहाँ मूल्य वर्धित कर (VAT) लगाया जाता है, कंपनी का नाम, पता, VAT ID, और यह जानकारी कि अकाउंट विज्ञापनदाता के स्वामित्व में है या विज्ञापनदाता की ओर से विज्ञापन करने वाली किसी एजेंसी के स्वामित्व में है, जैसी जानकारियाँ अपडेट करने की अनुमति देते हैं।

​

बदला गया

Universal Lookalike के नामों में बदलाव

हम POST accounts/:account_id/line_items और PUT accounts/:accountit/line_items/:line_item_id एंडपॉइंट्स पर lookalike_expansion पैरामीटर के enum मान अपडेट कर रहे हैं।

v3	v4
NARROW	DEFINED
BALANCED	EXPANDED

हर जगह country_code का उपयोग

Ads API में consistency से जुड़े एक बड़े प्रयास के तहत, हम निम्न एंडपॉइंट्स पर पैरामीटर का नाम app_country_code से बदलकर country_code कर रहे हैं।

• POST accounts/:account_id/cards/image_app_download
• PUT accounts/:account_id/cards/image_app_download/:card_id
• POST accounts/:account_id/cards/video_app_download
• PUT accounts/:account_id/cards/video_app_download/:card_id

इससे इन पैरामीटर के व्यवहार या स्वीकार्य मानों पर कोई असर नहीं पड़ता; यह सिर्फ नाम बदलने का परिवर्तन है।

preview_url हमेशा null

जैसा कि v3 घोषणा में वादा किया गया था, अब सभी मौजूदा cards में card_uri है। इसके परिणामस्वरूप, preview_url का मान हमेशा null रहेगा।

याद दिला दें कि किसी card को उसके card_uri मान का उपयोग करके Tweet से संबद्ध करें। नीचे दिया गया उदाहरण अनुरोध देखें।

$ twurl -X POST -H ads-api.x.com “/4/accounts/18ce54d4x5t/tweet?text=Version 4&card_uri=card://958225772740714496”

​

हटाया गया

वीडियो एंडपॉइंट्स

accounts/:account_id/videos एंडपॉइंट्स v4 में अब उपलब्ध नहीं होंगे। Media Library एंडपॉइंट्स की शुरुआत के बाद यह एंडपॉइंट अप्रचलित हो गया है। नीचे दिया गया उपयोग तुलना देखें।

• v3 videos endpoint: twurl -H ads-api.x.com "/3/accounts/18ce54d4x5t/videos"

• वीडियो के लिए v4 media library endpoint: twurl -H ads-api.x.com "/4/accounts/18ce54d4x5t/media_library?media_type=VIDEO"

Media Library एंडपॉइंट्स, videos एंडपॉइंट्स के पूरी तरह समकक्ष हैं और इमेज व GIFs को संभालने जैसी अतिरिक्त कार्यक्षमता भी सपोर्ट करते हैं। साझेदारों से अनुरोध है कि वे किसी भी मीडिया प्रबंधन के लिए केवल Media Library का उपयोग करें।

Tweet View में as_user_id

GET accounts/:account_id/tweet/preview/:tweet_id एंडपॉइंट पर उपलब्ध as_user_id पैरामीटर अब स्वीकार नहीं किया जाएगा। प्रीव्यू हमेशा Tweet के लेखक के रूप में रेंडर किया जाएगा।

​

v3

Ads API का संस्करण 3 लॉन्च किया गया 1 फ़रवरी 2018 को। Ads API का संस्करण 2, 1 अगस्त 2018 को अपने जीवनचक्र के अंत तक पहुँच जाएगा।

इस रिलीज़ में हमारा नया Audience Intelligence प्रोडक्ट, Media Library तक पहुँच, और बेहतर card workflow शामिल हैं। हम PUT accounts/:account_id/targeting_criteria endpoint के अप्रचलन की भी घोषणा कर रहे हैं। अंत में, संस्करण 3 में parameter और रिस्पॉन्स में कुछ छोटे बदलाव, साथ ही batch size limit में कमी भी शामिल है।

जैसा कि version 2 के साथ था, हम partners को ट्रांज़िशन के लिए **6 months **दे रहे हैं। 2018-08-01 को Ads API का v2 बंद कर दिया जाएगा। हम सभी partners और developers को यथाशीघ्र v3 पर migrate करने के लिए प्रोत्साहित करते हैं।

Audience Intelligence

Audience Intelligence किसी दिए गए X audience के लिए सबसे प्रासंगिक शीर्ष hashtags, @handles, और events के बारे में real-time insights प्रदान करता है। उदाहरण के लिए, US में Male 18-34 दर्ज करें और आप देखेंगे कि इस audience में #nintendoswitch, #cardinal, और @ricegum ट्रेंड कर रहे हैं।

Audience Intelligence endpoints निम्नलिखित कार्यक्षमताएँ प्रदान करेंगे:

• किसी input audience के लिए, सबसे प्रासंगिक hashtags, @handles और events प्राप्त करें।
• किसी input audience के लिए, प्रमुख demographic जानकारी (जैसे age, gender, और household income) प्राप्त करें।
• किसी keyword के लिए, Tweet volume time series प्राप्त करें

Media Library

Media Library ads accounts के लिए images, GIFs, और videos को प्रबंधित करने की सुविधा देती है। इन media objects का उपयोग Tweets में और cards बनाने के लिए किया जा सकता है। इन्हें कई creatives में दोबारा भी इस्तेमाल किया जा सकता है, जिससे एक ही asset को बार-बार upload करने की आवश्यकता समाप्त हो जाती है।

library में objects की पहचान media_key से की जाती है। उदाहरण के लिए, Media keys निम्नलिखित फ़ॉर्मैट में string values होती हैं: 13_875943225764098048। Ads API में, हम सभी media के लिए media keys का उपयोग करने की दिशा में बढ़ रहे हैं।

बेहतर card workflow

अब हमारे सभी cards endpoints media keys का समर्थन करते हैं। इससे Media Library में मौजूद objects का उपयोग cards बनाने या अपडेट करने के लिए किया जा सकता है।

इसके अतिरिक्त, हम card details प्राप्त करने के लिए दो नए endpoints पेश कर रहे हैं। उदाहरण के लिए, इन endpoints का उपयोग Tweets या Scheduled Tweets में इस्तेमाल किए गए cards को खोजने के लिए किया जा सकता है, इसके लिए card_uri या id में से किसी एक को निर्दिष्ट किया जा सकता है। पहले, यह संभव नहीं था।

​

अन्य परिवर्तन

इन नई सुविधाओं के अलावा, हम version 3 में निम्नलिखित परिवर्तन भी शामिल कर रहे हैं।

नया

• GET insights/keywords/search endpoint के रिस्पॉन्स में अब related_keywords attribute शामिल है, जिसमें इनपुट keywords से संबंधित 30 terms होते हैं।

बदला गया

• targeting criteria का अधिकतम batch size अब 500 है।
• card_uri और preview_url रिस्पॉन्स attributes अब परस्पर अनन्य हैं। जब किसी card में card_uri होगा, तो preview_url null होगा। जब किसी card में card_uri नहीं होगा, तो केवल preview_url लौटाया जाएगा।
  • 2018-01-29 से बनाए गए सभी cards में card_uri होगा।
  • version 4 तक, सभी मौजूदा cards में card_uri होगा।
• अब 5:2 images वाले cards को create करना संभव नहीं है। हालांकि existing 5:2 image-based cards अभी भी काम करेंगे, हम partners को प्रोत्साहित करते हैं कि वे बेहतर प्रदर्शन वाले 1.91:1 या 1:1 aspect ratios (जहाँ समर्थित हों) का उपयोग करें।

हटाया गया

• PUT accounts/:account_id/targeting_criteria endpoint अब उपलब्ध नहीं है। हमने यह बदलाव इसलिए किया है क्योंकि इस endpoint के replace behavior से advertisers में भ्रम पैदा होता था, और यह हमारे अन्य PUT endpoints के अनुरूप नहीं था, जो एक समय में केवल एक resource को update करते हैं। इसके बजाय, partners को POST batch/accounts/:account_id/targeting_criteria endpoint का उपयोग करना चाहिए, जो अधिक लचीलापन देता है, जिसमें एक ही request में targeting को जोड़ने और हटाने, दोनों की सुविधा शामिल है।
• funding instruments के लिए paused रिस्पॉन्स attribute अब नहीं लौटाया जाता। इसके बजाय, funding instrument paused है या नहीं, यह निर्धारित करने के लिए entity_status रिस्पॉन्स attribute देखें। इसके अतिरिक्त, क्योंकि paused और cancelled एक ही value के अनुरूप हैं, cancelled भी अब रिस्पॉन्स में नहीं लौटाया जाता।
• हमने GET accounts/:account_id/tweet/preview endpoint से card_id parameter हटा दिया है।
• क्योंकि deleted Scheduled Tweets को retrieve करना संभव नहीं है, with_deleted parameter अब समर्थित नहीं है।
• draft_only parameter को निम्नलिखित endpoints से हटा दिया गया है, क्योंकि ये entities कभी draft state में नहीं हो सकतीं:
  • GET accounts/:account_id/targeting_criteria
  • GET accounts/:account_id/promoted_tweets
  • GET accounts/:account_id/promoted_accounts
  • GET accounts/:account_id/media_creatives
  • GET accounts/:account_id/preroll_call_to_actions

नोट

Video Website Cards और Scheduled Tweets, दोनों अब beta से बाहर हैं। लॉन्च के बाद से Scheduled Tweets में किए गए परिवर्तनों के लिए this thread देखें। इसमें Scheduled Tweets के लिए HTML previews generate करने की क्षमता भी शामिल है।

​

v2

Ads API का संस्करण 2 लॉन्च 10 जुलाई, 2017 को हुआ था। Ads API का संस्करण 1 10 जनवरी, 2018 को अपनी सेवा-समाप्ति पर पहुँच जाएगा।

ब्रेकिंग बदलाव/अप्रचलन¶

• total_count अब एक वैकल्पिक रिस्पॉन्स एट्रिब्यूट है। यह केवल तभी उपलब्ध होगा, जब with_total_count को true पर सेट किया गया हो

• line_items और campaigns request और रिस्पॉन्स ऑब्जेक्ट्स में paused और draft_only फ़ील्ड्स को एकल entity_status पैरामीटर से बदल दिया गया है

• POST accounts/:account_id/tweet और GET accounts/:account_id/tweet/preview endpoints पर status पैरामीटर का नाम बदलकर text कर दिया गया है

• GET targeting_criteria/locations endpoint के location_type enums अब बहुवचन में हैं। COUNTRY अब COUNTRIES है, REGION अब REGIONS है, आदि। एकमात्र अपवाद यह है कि v2 में CITY अब METROS है, ताकि यह सही रूप से दर्शाया जा सके कि location type, Designated Marker Areas (DMAs) या “metros” को संदर्भित करता है।

• PUT accounts/:account_id/promoted_tweets endpoints पर display_properties अब समर्थित नहीं है। यह मान अब रिस्पॉन्स के हिस्से के रूप में भी वापस नहीं किया जाएगा

• पिछले बिंदु के परिणामस्वरूप, अब promoted_tweets entities को update (PUT) करना संभव नहीं है

• GET accounts/:account_id/promoted_tweets endpoint पर line_item_id पैरामीटर हटा दिया गया है

• v2 endpoints पर अब 5:2 Website Cards बनाना संभव नहीं होगा

• data_type रिस्पॉन्स एट्रिब्यूट अब वापस नहीं किया जाता

नई सुविधाएँ¶

1. Cards v2
2. Draft campaigns/line item creations and activations
3. Scheduled Tweets
4. Async Job Summaries

Cards v2¶

• किसी कार्ड को Tweet से संबद्ध करते समय, Tweet text में preview_url जोड़ने के बजाय card_uri request पैरामीटर का उपयोग किया जाना चाहिए
• अगर रिस्पॉन्स में card_uri param वापस नहीं मिलता है (card creation step के दौरान), तो preview_url का उपयोग करें
• सभी नए card formats API में मूल रूप से उपलब्ध होंगे और card_uri पैरामीटर का लाभ उठाएँगे।

नए Card Formats:¶

• Video Website Cards:

  • GET accounts/:account_id/cards/video_website
  • GET accounts/:account_id/cards/video_website/:card_id
  • POST accounts/:account_id/cards/video_website
  • PUT accounts/:account_id/cards/video_website/:card_id
  • DELETE accounts/:account_id/cards/video_webiste/:card_id

Draft Campaigns¶

Draft Campaigns को GET accounts/:account_id/camapaigns endpoint के ज़रिए देखा जा सकता था। v2 के साथ, अब API के माध्यम से draft campaigns बनाना और सक्रिय करना भी संभव है।

• POST accounts/:account_id/line_items और POST accounts/:account_id/campaigns endpoints पर entity_status पैरामीटर का मान DRAFT पर सेट किया जा सकता है, ताकि नए draft campaign या line item बनाए जा सकें।
• नए बनाए गए draft के लिए आवश्यक पैरामीटरों का सेट:

Draft Campaign	Draft Line Item
funding_instrument_id	campaign_id
name	objective
start_time	product_type
	placements

नोट्स¶

• Draft line items या campaigns को केवल entity_status के DRAFT से PAUSED या ACTIVE में बदला जा सकता है
• पूरे campaign को सक्रिय करने के लिए (जिसमें कई line items हों), campaign के अंतर्गत प्रत्येक line item के साथ-साथ स्वयं campaign का entity_status भी ACTIVE पर सेट होना चाहिए।
• किसी भी campaign या line item का entity_status बदलने के लिए, संबंधित PUT endpoint का उपयोग करें।

अनुसूचित Tweets¶

• अनुसूचित Tweets के लिए निम्नलिखित नए endpoints उपलब्ध हैं

• अनुसूचित Tweets:

  • GET accounts/:account_id/scheduled_tweets
  • GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
  • POST accounts/:account_id/scheduled_tweets
  • PUT accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
  • DELETE accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

• Campaign Management:

  • GET accounts/:account_id/scheduled_promoted_tweets
  • GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
  • POST accounts/:account_id/scheduled_promoted_tweets
  • DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

• नए अनुसूचित Tweets को भविष्य की किसी भी तारीख के लिए शेड्यूल किया जा सकता है

• वर्तमान में, किसी अनुसूचित Tweet का पूर्वावलोकन करने की सुविधा उपलब्ध नहीं है

• केवल SCHEDULED स्थिति में मौजूद अनुसूचित Tweets को संपादित/हटाया जा सकता है

• scheduled_at दिनांक/समय तक अनुसूचित Tweets enterprise Firehose या किसी अन्य data API में नहीं भेजे जाते हैं।

​

v1

Ads API का संस्करण 1, 31 मार्च 2016 को लॉन्च किया गया था और 10 जनवरी 2018 को इसका जीवनचक्र समाप्त हो जाएगा।

संस्करण 1 में बदलाव:¶

• संस्करण समर्थन
• CUSTOM उद्देश्य अब समर्थित नहीं है
• बैच एंडपॉइंट्स अब व्यापक रूप से उपलब्ध हैं
• अनुमानित पहुंच में बदलाव:
• बेहतर पहुँच अनुमान प्रदान करने के लिए, एंडपॉइंट अब बजट-अवेयर है। अब निम्नलिखित पैरामीटर आवश्यक हैं:
  • [नया] campaign_daily_budget_amount_local_micro
  • currency
  • bid
  • objective
• रिस्पॉन्स ऑब्जेक्ट बदल गया है, और अब यह रिस्पॉन्स मानों के लिए रेंज लौटाता है।
• इसके उद्देश्य को लेकर होने वाले भ्रम से बचने के लिए infinite_count का नाम बदलकर infinite_bid_count कर दिया गया है
• count और infinite_bid_count के अलावा, ये नए डेटा पॉइंट अब लौटाए जाएंगे:
  • impressions
  • engagements
  • estimated_daily_spend_local_micro
• टेलर्ड ऑडियंस के लिए डेटा type में बदलाव
• Tailored Audiences के लिए data_type को हमारे सभी रिस्पॉन्स में tailored_audiences से बदलकर tailored_audience कर दिया गया है।
• शेयर्ड Tailored Audiences अब सिर्फ़ API बीटा के रूप में उपलब्ध हैं। शेयर्ड tailored audiences की मदद से एक ही audience का उपयोग कई ads accounts में किया जा सकता है। जिन tailored audience को आप ads accounts के बीच साझा करना चाहते हैं, उनकी permissions प्रबंधित करने के लिए POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions (और संबंधित) endpoint का उपयोग करें।
• विज्ञापनदाता खातों के लिए प्रदर्शन एनालिटिक्स एकत्र करने के तरीके में महत्वपूर्ण सुधार:
• हमारी सर्वोत्तम प्रथाओं के अनुरूप, अब हम synchronous stats endpoints के लिए अधिकतम 7 दिनों तक का डेटा ही प्राप्त करने की अनुमति देंगे।
• मेट्रिक्स प्राप्त करने की प्रक्रिया को सरल बनाने के लिए, हमने metrics पैरामीटर को नए metric_groups पैरामीटर से बदल दिया है। अब डेवलपर्स को केवल यह बताना होता है कि किसी दिए गए अनुरोध के लिए वे मेट्रिक्स के कौन-कौन से समूह लौटाना चाहते हैं।
  • किसी दिए गए एंटिटी के लिए उपयुक्त नहीं होने वाले मेट्रिक्स के अनुरोधों को रिस्पॉन्स से बाहर रखा जाएगा और उन्हें null मानों के रूप में दिखाया जाएगा। ये मेट्रिक्स आपकी analytics cost limit में नहीं गिने जाएंगे।
• रिस्पॉन्स को काफ़ी सरल बनाया गया है, और अब यह हमारे UI में metrics दिखाए जाने के तरीके के ज़्यादा अनुरूप होगा।
  • पहले हम हर placement location के लिए अलग metric उपलब्ध कराते थे (Search में Promoted Tweets, Timelines में Promoted Tweets, Profiles & Tweet Details में Promoted Tweets, X Audience Platform)। अब हम इनमें से प्रत्येक के लिए metrics का एक मानकीकृत सेट लौटाएँगे (promoted_tweet_timeline_impressions, promoted_tweet_search_impressions, promoted_tweets_profile_impressions, promoted_tweets_tpn_impressions के बजाय)। अब अनुरोध किए जाने पर इन्हें निम्न में से किसी एक श्रेणी में एकल metric impressions के रूप में उपलब्ध कराया जाएगा (यह सभी metrics पर लागू होता है):
  • ALL_ON_TWITTER
  • PUBLISHER_NETWORK
  • जब आप कोई अनुरोध करेंगे, तो हमारी UI में मानों का मिलान आसान बनाने के लिए आपको एकल impressions metric मिलेगा।
  • ALL_ON_TWITTER और PUBLISHER_NETWORK दोनों का डेटा प्राप्त करने के लिए आपको दो queries करनी होंगी, क्योंकि इन्हें संयोजित नहीं किया जा सकता।
• असिंक्रोनस स्टैट्स एंडपॉइंट्स अब हमारे डेवलपर्स से मिले फ़ीडबैक के आधार पर उपलब्ध हैं!
  • ऐसे डेटा के लिए, जिसकी आपको तुरंत आवश्यकता नहीं है, या पुराने डेटा को खींचने के लिए, असमकालिक रूप से stats का अनुरोध करने हेतु endpoints का एक नया सेट।
  • एक नए single endpoint का उपयोग करके stats job को queue करें। संसाधन उपलब्ध होने पर, हम आपके अनुरोध किए गए डेटा को pull करेंगे।
  • डेटा उपलब्ध है या नहीं, यह जानने के लिए आप job status endpoint को query कर सकते हैं।
  • डेटा उपलब्ध होने पर, JSON रिस्पॉन्स डाउनलोड करने के लिए हम आपको एक pick-up ID देंगे, जो synchronous endpoint के रिस्पॉन्स जैसा ही होगा।
  • एक single job में अधिकतम 20 entities के लिए 90 days तक का डेटा query करें।
• हमारी analytics v1 माइग्रेशन गाइड देखें, जिसमें v0 metrics से v1 metrics का मैपिंग दिया गया है
• Sandbox में सुधार * अब आप Sandbox environment में कई test ads accounts बना सकते हैं। * अब आप केवल Sandbox environment में किसी test ads account के लिए कई funding instruments बना सकते हैं। इससे आप हमारे सभी funding instrument types का परीक्षण कर सकते हैं। पहले परीक्षण के लिए केवल CREDIT_CARD funding source ही उपलब्ध था। * क्या आप किसी beta feature का परीक्षण करना चाहते हैं? अब आप अपनी परीक्षण आवश्यकताओं के अनुसार Sandbox environment में किसी account के लिए features को on/off कर सकते हैं।

​

v0

Ads API का संस्करण 0 आधिकारिक तौर पर 21 फ़रवरी 2013 को लॉन्च किया गया था और 31 अक्टूबर 2016 तक समर्थित रहा।

संस्करण 0 के सभी analytics endpoint अब अप्रचलित हैं और 31 अक्टूबर 2016 के बाद मौजूद नहीं रहेंगे। इन endpoint को संस्करण 1 में 3 analytics endpoint से बदल दिया गया है।

संस्करण 1 में reach estimation endpoint का व्यवहार बदल गया है।