Advertiser API
आप क्या प्रमोट कर सकते हैं?
- प्रचारित विज्ञापन सामान्य विज्ञापन होते हैं, जिन्हें वे विज्ञापनदाता खरीदते हैं जो उपयोगकर्ताओं के बड़े समूह तक पहुँचना चाहते हैं या अपने मौजूदा फ़ॉलोअर्स से अधिक जुड़ाव हासिल करना चाहते हैं।
- जब कोई विज्ञापनदाता X पर उनके प्लेसमेंट के लिए भुगतान करता है, तो प्रचारित विज्ञापनों पर स्पष्ट रूप से Promoted का लेबल दिखता है। बाकी सभी मामलों में, प्रचारित विज्ञापन सामान्य विज्ञापनों की तरह ही काम करते हैं और उन्हें repost, reply, like आदि किया जा सकता है। इन पर सामान्य डिलीवरी नियम लागू होते हैं और इन्हें POST statuses/update का उपयोग करके बनाया जाता है।
- “केवल-प्रचारित” Tweets, जिन्हें POST accounts/:account_id/tweet के माध्यम से बनाया जाता है, Promoted Tweets अभियानों में इस्तेमाल किए जा सकते हैं, लेकिन वे फ़ॉलोअर्स को नहीं दिखेंगे और न ही सार्वजनिक टाइमलाइन पर दिखाई देंगे। किसी विशेष खाते के केवल-प्रचारित tweets की सूची प्राप्त करने के लिए, GET accounts/:account_id/scoped_timeline का उपयोग करें।
- प्रमोटेड अकाउंट्स, Who to Follow का हिस्सा हैं, जो ऐसे अकाउंट्स का सुझाव देता है जिन्हें लोग अभी फ़ॉलो नहीं कर रहे हैं और जो उन्हें दिलचस्प लग सकते हैं। प्रमोटेड अकाउंट्स ऐसे अकाउंट्स की और भी व्यापक श्रृंखला से लोगों को परिचित कराने में मदद करते हैं, जिन्हें वे पसंद कर सकते हैं।
- Timeline के लिए प्रमोटेड अकाउंट्स, Promoted Tweet को प्रमोटेड अकाउंट कैंपेन से संबद्ध करते हैं और उपयोगकर्ता की टाइमलाइन में दिखते हैं।
अभियान और विज्ञापन समूह (Line Items)
विश्लेषिकी
X Ads API विज्ञापन प्रदर्शन को ट्रैक और ऑप्टिमाइज़ करने के लिए analytics endpoints का एक सेट प्रदान करता है। अधिक जानकारी के लिए कृपया Analytics और Analytics Best Practices देखें। billing metric के लिए, event के तीन दिन बाद तक डेटा अंतिम रूप से तय नहीं हो सकता। उस समय तक, डेटा को अनुमानित माना जाना चाहिए। अंतिम billable संख्या हमेशा अनुमानित मात्रा से कम होगी। billable संख्या को spam और उससे संबंधित निम्न-गुणवत्ता वाले traffic के अनुसार समायोजित किया जाता है। समय से जुड़ी अन्य बातों के लिए Timezones देखें।अभियान बनाना - चरण-दर-चरण
-t का उपयोग करें, जो लगभग cURL के -v विकल्प के बराबर है।
इस उदाहरण में, हम एक प्रचारित विज्ञापन अभियान बनाएँगे, जिसे keyword के आधार पर लक्षित किया जाएगा।
- खाते का id प्राप्त करें।
- फंडिंग इंस्ट्रूमेंट id प्राप्त करें।
- एक अभियान बनाएँ और उसे फंडिंग इंस्ट्रूमेंट से संबद्ध करें।
- अभियान से संबद्ध एक line item बनाएँ।
- line item से संबद्ध एक टार्गेटिंग प्रोफ़ाइल बनाएँ।
- अंत में, line item को फिर से सक्रिय करें।
उद्देश्य-आधारित अभियान
objective सेट करें।
line item write endpoints पर उपयोग किया जाने वाला और read endpoints से लौटाया जाने वाला पैरामीटर objective है। वर्तमान में इस फ़ील्ड के निम्न संभावित मान हैं:
APP_ENGAGEMENTSAPP_INSTALLSFOLLOWERSENGAGEMENTSREACHVIDEO_VIEWSPREROLL_VIEWSWEBSITE_CLICKS
APP_ENGAGEMENTS के लिए CPAC, APP_INSTALLS के लिए CPAC या CPI, WEBSITE_CLICKS के लिए CPLC, FOLLOWERS के लिए CPF, ENGAGEMENTS के लिए CPE, और REACH के लिए CPM।
मोबाइल ऐप प्रचार अभियानों में APP_ENGAGEMENTS या APP_INSTALLS में से कोई एक objective होना आवश्यक है।
नोट: एक ही अभियान के अंतर्गत अलग-अलग objectives वाले line items की अनुमति नहीं है।
| अभियान उद्देश्य | API objective | Tweets में media | मूल्य-निर्धारण मॉडल |
|---|---|---|---|
| ऐप री-एंगेजमेंट | APP_ENGAGEMENTS | इमेज या वीडियो app download card आवश्यक है। | CPAC |
| ऐप इंस्टॉल | APP_INSTALLS | इमेज या वीडियो app download card आवश्यक है। | CPAC या CPI (charge_by का उपयोग करके सेट करें) |
| रीच | REACH | कोई प्रतिबंध नहीं। | CPM |
| फ़ॉलोअर्स | FOLLOWERS | Tweet आवश्यक नहीं है, लेकिन अनुशंसित है। Followers campaigns के लिए Tweets में media पर कोई प्रतिबंध नहीं है, हालांकि हम केवल टेक्स्ट वाले Tweets की अनुशंसा करते हैं। अधिक जानकारी | CPF |
| एंगेजमेंट्स | ENGAGEMENTS | कोई प्रतिबंध नहीं। | CPE |
| वीडियो व्यूज़ | VIDEO_VIEWS | वीडियो conversation card, वीडियो, या GIF आवश्यक है। | CPV या 3s/100% view के लिए लागत |
| प्री-रोल व्यूज़ | PREROLL_VIEWS | वीडियो आवश्यक है। | CPV या 3s/100% view के लिए लागत |
| वेबसाइट क्लिक्स | WEBSITE_CLICKS | Website card अनुशंसित है, लेकिन आवश्यक नहीं है। Tweet में या तो website card होना चाहिए या website link (दोनों नहीं)। | CPLC |
फंडिंग इंस्ट्रूमेंट्स
funding_instruments की सूची पाने के लिए GET accounts/:account_id/funding_instruments देखें, और किसी विशिष्ट इंस्ट्रूमेंट का विवरण पाने के लिए GET accounts/:account_id/funding_instruments/:funding_instrument_id देखें।
फंडिंग इंस्ट्रूमेंट एट्रिब्यूट्स
account_id, फंडिंग इंस्ट्रूमेंट id, फंडिंग इंस्ट्रूमेंट type, description, और io_header (insertion order header ID)। ध्यान दें कि एक ही io_header एक से अधिक फंडिंग इंस्ट्रूमेंट्स से जुड़ा हो सकता है।
फंडिंग क्षमता: able_to_fund और reasons_not_able_to_fund।
समय: created_at, updated_at, start_time, और end_time, जिन्हें एक स्ट्रिंग के रूप में दर्शाया जाता है और जिनका फ़ॉर्मैट “%Y-%m-%dT%l:%M:%S%z” है।
बूलियन स्थिति: paused, deleted, और cancelled (true या false)।
वित्तीय: currency (ISO-4217 फ़ॉर्मैट), credit_limit_local_micro, credit_remaining_local_micro, और funded_amount_local_micro। किसी मुद्रा का मान micro में दर्शाया जाता है। USD के लिए, $5.50 को 5.50*1e6, या 5,500,000 के रूप में एन्कोड किया जाता है। “पूर्ण मान” दर्शाने के लिए, आपको सभी मुद्राओं में local micro को 1e6 (1_000_000) से गुणा करना होगा।
विशेषता विवरण
credit_limit_local_micro केवल CREDIT_CARD या CREDIT_LINE type के वित्तपोषण साधनों के लिए मान्य है और उस instrument की credit limit को दर्शाता है।
funded_amount_local_micro केवल INSERTION_ORDER type के वित्तपोषण साधनों के लिए मान्य है और आवंटित बजट को दर्शाता है।
credit_remaining_local_micro CREDIT_LINE और AGENCY_CREDIT_LINE type के वित्तपोषण साधनों के लिए मान्य है। यह credit_limit_local_micro में से उस वित्तपोषण साधन पर पहले से खर्च की गई राशि घटाने के बाद बची हुई credit को दर्शाता है। यह funded_amount_local_micro और खर्च की गई राशि के बीच का अंतर नहीं दर्शाता। हम credit limit और funded amount के बीच अंतर करते हैं, क्योंकि वे funding के अलग-अलग आधारभूत तरीकों और विज्ञापनदाताओं के साथ हमारे अलग-अलग spending agreements को दर्शाते हैं।
वित्तपोषण साधनों के प्रकार
CREDIT_LINE type पर)।
टार्गेटिंग
प्लेसमेंट के अनुसार टार्गेटिंग विकल्प
- X Search: Age Targeting, Devices, Events, Gender, Keyword Types (All), Language, Locations, Network Activation, Network Operators, Platform, Platform Version, Tailored Audiences, WiFi Only
- X Timeline: Age Targeting, Devices, Events, Followers Of, Similar to Followers Of, Gender, Interest, Language, Locations, Network Activation, Network Operators, Non-exact Keyword Types, Partner Audience Types, Platform, Platform Version, Retargeting Types, Tailored Audiences, TV Targeting Types, WiFi Only
- X Profiles & Tweet Details: Age Targeting, Devices, Events, Followers Of, Similar to Followers Of, Gender, Interest, Language, Locations, Network Activation, Network Operators, Non-exact Keyword Types, Partner Audience Types, Platform, Platform Version, Retargeting Types, Tailored Audiences, TV Targeting Types, WiFi Only
टार्गेटिंग के प्रकारों को समझना
NETWORK_OPERATOR का उपयोग करें।
New Mobile Device Targeting: उपयोगकर्ताओं तक उस तारीख के आधार पर पहुँचें जब उन्होंने पहली बार अपने device से X को access किया था। इसके लिए NETWORK_ACTIVATION_DURATION टार्गेटिंग type का उपयोग करें, जिसमें operator_type के रूप में कम के लिए LT और अधिक या बराबर के लिए GTE इस्तेमाल होता है।
Platforms, Platform Versions, Devices, and Wifi-Only: यह विभिन्न मानदंडों के आधार पर mobile devices को टार्गेट करने की सुविधा देता है। Platforms एक उच्च-स्तरीय टार्गेटिंग प्रकार है, जो फ़ोन की व्यापक श्रेणियों को टार्गेट कर सकता है। उदाहरण के लिए iOS और Android। Devices आपको विशिष्ट mobile devices के उपयोगकर्ताओं को टार्गेट करने देते हैं, जैसे iPhone 5s, Nexus 4, या Samsung Galaxy Note। Platform versions आपको विशिष्ट mobile operating systems के versions के उपयोगकर्ताओं को, point release स्तर तक, टार्गेट करने देते हैं। उदाहरणों में iOS 7.1 और Android 4.4 शामिल हैं। Wifi-Only आपको केवल उन उपयोगकर्ताओं को टार्गेट करने देता है जो अपने devices को WiFi network पर उपयोग कर रहे हैं; यदि यह सेट नहीं है, तो carrier connection के साथ-साथ WiFi का उपयोग करने वाले उपयोगकर्ता भी टार्गेट किए जाएँगे।
- यदि platforms और devices में overlap नहीं है, तो उपयोगकर्ता उन्हें टार्गेट कर सकते हैं। मैं Blackberry को एक platform के रूप में और iPad Air को एक device के रूप में एक साथ टार्गेट कर सकता हूँ।
- उपयोगकर्ता devices और os versions को एक साथ टार्गेट कर सकते हैं। मैं iPad Air और iOS >= 7.0 को टार्गेट कर सकता हूँ।
- उपयोगकर्ता ऐसे platforms को टार्गेट नहीं कर सकते जो devices से अधिक व्यापक हों। मैं iOS और iPad Air को एक साथ टार्गेट नहीं कर सकता।
TV_SHOW टार्गेटिंग type के साथ इस तरह कॉन्फ़िगर किया जा सकता है कि campaign सक्रिय रहने तक लगातार target किया जा सके। उपलब्ध TV shows का पता लगाने के लिए GET targeting_criteria/tv_markets और GET targeting_criteria/tv_shows endpoints का उपयोग करें।
Tweet Engager Retargeting
Tweet engager retargeting विज्ञापनदाताओं को अलग-अलग devices पर उन ऑडियंस को target करने में सक्षम बनाता है, जो पहले X पर उनके promoted या organic Tweets को देख चुके हैं या उनसे जुड़ चुके हैं। इस टार्गेटिंग की मदद से विज्ञापनदाता उन लोगों तक फिर से पहुँच सकते हैं जिन्होंने X पर किसी विज्ञापनदाता का content देखा है या उससे जुड़ाव किया है, और जिनके बाद के संदेशों या offers के साथ आगे भी जुड़ने या convert होने की संभावना सबसे अधिक होती है। उपयोगकर्ता exposure या engagement के कुछ ही मिनटों में targeting के लिए eligible हो जाते हैं और उसके बाद engagements के लिए 90 दिनों तक तथा exposures के लिए 30 दिनों तक eligible बने रहते हैं।
Tweet Engager टार्गेटिंग Types:
ENGAGEMENT_TYPEजो targeting value के रूप मेंIMPRESSIONयाENGAGEMENTमें से किसी एक को स्वीकार करता है। यह बताता है कि आप exposed users (IMPRESSION) को target करना चाहते हैं या engaged users (ENGAGEMENT) को।CAMPAIGN_ENGAGEMENTtargeting value के रूप में campaign ID का उपयोग करता है। जिन उपयोगकर्ताओं ने इस campaign के साथ जुड़ाव किया है या इसे देखा है (यहENGAGEMENT_TYPEपर निर्भर करता है), उन्हीं को target किया जाएगा।USER_ENGAGEMENTtargeting value के रूप में promoted user ID का उपयोग करता है, ताकि उन उपयोगकर्ताओं को target किया जा सके जिन्होंने किसी विज्ञापनदाता के organic content को देखा है या उससे जुड़ाव किया है (यहENGAGEMENT_TYPEपर निर्भर करता है)। यह Ads account से संबद्ध promoted user ID होना चाहिए।
CAMPAIGN_ENGAGEMENT या USER_ENGAGEMENT value के साथ ENGAGEMENT_TYPE देना आवश्यक है। दोनों tweet engager targeting types मौजूद हो सकते हैं, और किसी दिए गए line item पर कई campaigns को target किया जा सकता है।
Video Viewer टार्गेटिंग: Video viewer targeting, Tweet engager targeting को आगे बढ़ाता है और विज्ञापनदाताओं को उन ऑडियंस को target करने में सक्षम बनाता है जिन्होंने पहले X पर किसी वीडियो का कुछ हिस्सा या पूरा वीडियो देखा हो। विज्ञापनदाता organic videos, promoted videos, या दोनों को target कर सकते हैं। Promoted videos केवल video view objective campaigns या line items तक सीमित नहीं हैं।
Video Viewer टार्गेटिंग Types:
VIDEO_VIEWउन उपयोगकर्ताओं के लिए जिन्होंने वीडियो चलाने के लिए क्लिक किया है या autoplay में 3 सेकंड वीडियो देखा हैVIDEO_VIEW_PARTIALउन उपयोगकर्ताओं के लिए जिन्होंने वीडियो का 50% देखा हैVIDEO_VIEW_COMPLETEउन उपयोगकर्ताओं के लिए जिन्होंने वीडियो का कम-से-कम 95% देखा है
ENGAGEMENT_TYPE का उपयोग किया जाता है, तो line item के टार्गेटिंग मानदंड में निम्न में से एक या दोनों भी मौजूद होने चाहिए:
CAMPAIGN_ENGAGEMENTtargeting value के रूप में campaign ID का उपयोग करता है। जिन उपयोगकर्ताओं ने इस campaign में कोई वीडियो देखा है (यहENGAGEMENT_TYPEपर आधारित है), उन्हीं को target किया जाएगा।USER_ENGAGEMENTtargeting value के रूप में promoted user ID का उपयोग करता है, ताकि उन उपयोगकर्ताओं को target किया जा सके जिन्होंने किसी विज्ञापनदाता के organic content में कोई वीडियो देखा हो (यहENGAGEMENT_TYPEpar आधारित है)। यह Ads account से संबद्ध promoted user ID होना चाहिए।
- Broad (डिफ़ॉल्ट मान): क्रम की परवाह किए बिना सभी शब्दों का मिलान करता है। Capitalization, plurals या tense के प्रति संवेदनशील नहीं है। जहाँ संभव हो, इसे अपने-आप विस्तारित किया जाएगा (यानी “car repair” का मिलान “automobile fix” से भी होगा)। यदि आप बिना expansion के target करना चाहते हैं, तो आपको keywords से पहले + चिह्न जोड़ना होगा, जैसे “+boat +jet”। + के बिना keywords का उपयोग करने पर डिफ़ॉल्ट रूप से Broad Match लागू होगा।
- Unordered (deprecated): क्रम की परवाह किए बिना सभी शब्दों का मिलान करता है। Capitalization, plurals या tense के प्रति संवेदनशील नहीं है।
- Phrase: ठीक उसी keywords string का मिलान करता है; अन्य keywords मौजूद हो सकते हैं।
- Exact: केवल ठीक उसी keywords string का मिलान करता है, किसी और का नहीं।
- Negative: उन searches के मिलान से बचें जिनमें query में कहीं भी ये सभी keywords शामिल हों, चाहे उनका क्रम कुछ भी हो, भले ही अन्य शब्द मौजूद हों।
- Negative Phrase: उन searches के मिलान से बचें जिनमें query में कहीं भी यही सटीक keywords string शामिल हो, भले ही अन्य शब्द मौजूद हों।
- Negative Exact: उन searches के मिलान से बचें जो इन keywords से बिल्कुल मेल खाती हों और जिनमें कोई अन्य शब्द न हो।
टार्गेटिंग मानदंडों के संयोजन
| “प्राथमिक” प्रकार | अन्य प्रकार |
| Followers | लोकेशन |
| Tailored Audiences | लिंग |
| Interests | भाषाएँ |
| Keywords | डिवाइस और प्लेटफ़ॉर्म |
| TV | आयु |
- “प्राथमिक” टार्गेटिंग प्रकारों को ∪ किया जाएगा (अर्थात उन्हें एक logical union में रखा जाएगा)।
- अन्य टार्गेटिंग प्रकारों को AND किया जाएगा।
- समान प्रकारों को OR किया जाएगा।
- U.S., England, और Canada में X उपयोगकर्ता (Location)
- जो महिलाएँ हों (Gender)
- Tailored Audiences सूची से लिए गए (“प्राथमिक”)
- Keywords के साथ (“प्राथमिक”)
अतिरिक्त उदाहरण
- Gender और Geo चुनें, लेकिन कोई प्राथमिक विकल्प नहीं: (पुरुष) AND (US OR GB)
- Gender, Geo, Interest चुनें: (महिला) AND (CA) AND (Computers OR Technology OR Startups)
- Gender, Geo, Interest, Tailored Audiences, Keywords चुनें: (पुरुष) AND (GB) AND (Cars ∪ CRM के लिए Tailored Audiences ∪ autocross)
बजट पेसिंग
standard_delivery पैरामीटर को false पर सेट करें (देखें GET accounts/:account_id/campaigns)।
नोट्स
- “Day” X advertiser account के timezone (उदाहरण के लिए, America/Los_Angeles) के अनुसार निर्धारित होता है।
- शुरुआती नतीजे बताते हैं कि standard delivery विज्ञापनदाताओं के लिए eCPE/CPF में सुधार करेगी और पूरे दिन अधिक सुसंगत कवरेज देगी।
लक्ष्य बोली
अभियान प्रबंधनबिड रणनीति
goal पैरामीटर सेट करके प्राप्त किए जा सकते हैं। अधिक जानकारी यहाँ दी गई घोषणा में मिल सकती है।
उदाहरण के लिए:
| अभियान उद्देश्य | लीगेसी | Ads API v10+ |
| ऐप इंस्टॉल | bid_type= AUTObid_unit = APP_INSTALLScharge_by = APP_CLICKS | goal = APP_INSTALLSbid_strategy = AUTO |
| वेबसाइट क्लिक | bid_type = TARGET (नोट: कुछ अभियान उद्देश्यों के लिए bid_unit की आवश्यकता नहीं थी) | bid_strategy = TARGET |
लक्ष्य बोली
bid_strategy सेटिंग को TARGET मान पर सेट करके, प्रासंगिक अभियान उद्देश्यों के लिए लक्ष्य बोली सक्षम की जा सकती है, जैसे:
WEBSITE_CLICKSWEBSITE_CONVERSIONSAPP_INSTALLSAPP_ENGAGEMENTSREACH
देश-आधारित targeting और प्रदर्शन आवश्यकताएँ
रूस
पार्टनर द्वारा प्रबंधित फ़ंडिंग इंस्ट्रूमेंट्स
पार्टनर का प्रारंभिक सेट-अप
- पार्टनर को अपनी PGP/GPG सार्वजनिक कुंजी साझा करनी होगी। Ads API पार्टनर और X के बीच एक shared secret key का आदान-प्रदान किया जाना आवश्यक है। इसका उपयोग ऑनबोर्डिंग फ़्लो के दौरान डेटा सत्यापित करने के लिए किया जाएगा।
- उस X ऐप का
app_idयाconsumer_secretजिसका उपयोग Ads API एक्सेस के लिए किया जाएगा। यदि आप developer.x.com पर अपने X खाते में लॉग इन हैं, तो आप ऐप डैशबोर्ड के ज़रिए अपने मौजूदा X ऐप देख और संपादित कर सकते हैं। यदि आपको एक X ऐप बनाना है, तो आपके पास स्वीकृत डेवलपर खाता होना चाहिए। X, production+sandbox के लिए एक ऐप और केवल sandbox एक्सेस के लिए एक वैकल्पिक ऐप की अनुमति देता है। X ऐप किसी कॉर्पोरेट, पार्टनर-नियंत्रित X handle पर बनाया जाना चाहिए।
विज्ञापनदाता ऑनबोर्डिंग फ़्लो
- उपयोगकर्ता पार्टनर की वेबसाइट पर ऑनबोर्डिंग फ़्लो शुरू करता है और वह हैंडल दर्ज करता है जिसे वह ऑनबोर्ड करना चाहता है।
- पार्टनर उपयोगकर्ता को ads.x.com पर signed payload के साथ एक URL पर रीडायरेक्ट करता है। इस payload में पार्टनर का API
app_id, उस X हैंडल का Xuser_idशामिल होता है जिसे ऑनबोर्ड किया जाना है, साथ ही एक callback URL और नीचे प्रलेखित अन्य फ़ील्ड्स भी शामिल होते हैं। - उपयोगकर्ता से मानक x.com लॉगिन पेज का उपयोग करके ads.x.com में साइन इन करने के लिए कहा जाता है।
- उपयोगकर्ता के लॉग इन करने के बाद, ऑनबोर्डिंग प्रक्रिया शुरू हो जाती है। इस चरण में विज्ञापन समीक्षा, अकाउंट सत्यापन और अन्य जाँचें शामिल हैं।
- सभी ऑनबोर्डिंग कार्य पूरे होने पर, उपयोगकर्ता को उस callback URL पर रीडायरेक्ट कर दिया जाता है जो Ads API पार्टनर ने दिया था। इसके साथ एक payload भी होता है, जो सफलता या विफलता को दर्शाता है। इसमें 3-legged authorization प्रक्रिया शामिल है।
ऑनबोर्डिंग रीडायरेक्ट पेलोड
| Name | Type | Description |
| callback_url | URL encoded string | अकाउंट लिंक प्रक्रिया पूरी होने के बाद, परिणाम चाहे जो भी हो, उपयोगकर्ता को इस url पर रीडायरेक्ट किया जाएगा। प्रोटोकॉल विवरण के लिए partner redirect url अनुभाग देखें |
| client_app_id | integer | X API client app id, जिसका उपयोग managing partner की पहचान के लिए किया जाता है |
| promotable_user_id | integer | उस @handle का X user_id जिसकी promotions का प्रबंधन managing partner द्वारा किया जाना है। इसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि यह वही उपयोगकर्ता है जो linking प्रक्रिया पूरी करने के लिए ads.x.com में लॉग इन करता है |
| fi_description | URL encoded String (max 255 characters) | funding instrument का नाम। funding instrument प्राप्त किए जाने पर यह API में description फ़ील्ड में दिखाया जाएगा। यदि funding_instrument description दिया जाता है, तो मौजूदा funding_instrument को pause कर दिया जाएगा, और एक नया managed partner funding instrument सेट अप किया जाएगा। (यदि इसी नाम से कोई पहले से मौजूद है, तो कुछ नहीं होगा) |
| timezone | String, in Area/Location format | यह वह timezone होगा जिसका उपयोग यह तय करने के लिए किया जाएगा कि daily budgets किस दिन पर लागू होंगे, और charges किस timezone में समेकित किए जाएंगे |
| currency | ISO 4217 Currency Code | वह मुद्रा जिसका उपयोग bids दर्ज करने के लिए किया जाएगा, और जिसमें charges बिल किए जाएंगे |
| country | ISO 3166-1 alpha 2 Country Code | अकाउंट के लिए बिलिंग देश |
| signature | URL encoded, base64 encoded binary code, as explained below | signature, जो call की प्रामाणिकता और पैरामीटर की वैधता सत्यापित करने के लिए एक shared secret और अन्य पैरामीटर को जोड़ता है। |
Callback URL payload
callback_url पैरामीटर का उपयोग करके दिया जाता है (ऊपर देखें)। ads.x.com द्वारा जोड़े गए पैरामीटर ये हैं:
| Name | Type | Description |
| status | string | OK कोई account बनाया गया, या कोई मौजूदा पात्र account मिला। ACCOUNT_INELIGIBLE यदि partner-विशिष्ट प्रतिबंध पूरे नहीं होते हैं USER_MISMATCH ads.x.com में साइन इन करने के लिए उपयोग किया गया X account, account link request में दिए गए promotable_user_id से अलग था INCOMPLETE_SERVING_BILLING_INFO timezone, currency, या country निर्दिष्ट नहीं किए गए थे INVALID_COUNTRY अमान्य country मान दिया गया था INVALID_CURRENCY अमान्य currency मान दिया गया था INVALID_TIMEZONE अमान्य timezone मान दिया गया था |
| account_id | URL encoded string | linked account का X ads account id |
| funding_instrument_id | URL encoded string | सक्रिय partner-managed funding instrument की ID |
| signature | URL encoded, base64 encoded binary code, as explained below | Base64-encoded HMAC-SHA1 signature, जो call की प्रामाणिकता और पैरामीटर की वैधता सत्यापित करने के लिए shared secret और अन्य पैरामीटर को संयोजित करता है, जैसा कि नीचे समझाया गया है। यह सुनिश्चित करने के लिए कि callback URL केवल उसी X user_id के लिए मान्य हो जिसके लिए account link process बनाया गया था, request पर हस्ताक्षर करते समय X user_id को shared secret में (&) का उपयोग करके जोड़ा जाना चाहिए। |
user_id के लिए मान्य हो जिसके लिए account link process बनाया गया था, request पर हस्ताक्षर करते समय X user_id को shared secret में & का उपयोग करके जोड़ा जाना चाहिए।
अनुरोध और callback URL पर हस्ताक्षर करना
/link_managed_account और callback url के अनुरोध मान्य हैं, अनुरोधों को स्रोत पर साइन किया जाना चाहिए और उन पर कोई कार्रवाई करने से पहले प्राप्तकर्ता द्वारा सत्यापित किया जाना चाहिए। X और managing partner के बीच साझा किए गए secret से अनुरोध पर हस्ताक्षर करने से यह सुनिश्चित होता है कि हर पक्ष केवल अधिकृत समकक्ष द्वारा भेजे गए अनुरोध ही स्वीकार करे।
हस्ताक्षर जनरेट करने का एल्गोरिदम OAuth में उपयोग किए जाने वाले एल्गोरिदम के समान है।
निम्नानुसार एक signature base string बनाएं:
- HTTP Method को uppercase में बदलें और base string को इसी मान के बराबर सेट करें।
- base string में ‘&’ वर्ण जोड़ें।
- URL (पैरामीटर के बिना) को percent encode करें और उसे base string में जोड़ें।
- base string में ‘&’ वर्ण जोड़ें।
- percent encoded query string जोड़ें, जिसे निम्नानुसार बनाया जाता है:
- हर उस key और value को percent encode करें जिस पर हस्ताक्षर किए जाएंगे।
- पैरामीटर की सूची को key के अनुसार वर्णक्रम में क्रमबद्ध करें।
- हर key/value pair के लिए (और partner redirect url के लिए primary_promotable_user_id के साथ):
- percent encoded key को query string में जोड़ें।
- base string में ‘=’ वर्ण जोड़ें।
- percent encoded value को query string में जोड़ें।
- percent encoded key=value pairs को ‘&’ वर्ण से अलग करें।
- HMAC-SHA1 एल्गोरिदम का उपयोग करें, जिसमें पहले से साझा किया गया shared secret key के रूप में हो और base string value के रूप में, ताकि signature जनरेट किया जा सके।
- Step 2 के आउटपुट को Base64 encode करें, अंत में आने वाले newline वर्ण को हटा दें, Step 3 में जनरेट किए गए signature को percent encode करें, और उसे url में signature पैरामीटर के रूप में जोड़ें
हस्ताक्षर के उदाहरण
KBxQMMSpKRrtg9aw3qxK4fTXvUc=
फिर इस signature को (percent encoded) मूल url के अंत में signature parameter में जोड़ा जाता है (चरण 4):
https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D
पार्टनर redirect url (account link request callback) पर हस्ताक्षर करना हस्ताक्षर करने के लिए URL, यह मानते हुए कि यह एक GET अनुरोध है:
https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF
इस url में निम्नलिखित पैरामीटर हैं:
account_id = ABC, funding_instrument_id = DEF और status = OK
http method और पैरामीटर के बिना url से बनी base string, चरण a - d, इस प्रकार है:
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“
e के उपचरणों से बनी query string इस प्रकार है:
account_id=ABC&funding_instrument_id=DEF&status=OK
percent-encoded query string इस प्रकार है:
account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
चरण a - d और e को मिलाकर बनी complete base string:
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
hmac-sha1 algorithm का उपयोग करके, हम इस पर key के रूप में “secret” शब्द और उस X user id, जिसके लिए मूल लिंक अनुरोध किया गया था, 1 (promotable_user_id = 1 from above), यानी “secret&1”, के साथ हस्ताक्षर करेंगे।
परिणाम Base64 encoded है, और इसे अंतिम “\n” के बिना प्रस्तुत किया गया है (चरण 2 और 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM=
इसके बाद इस हस्ताक्षर को (प्रतिशत-एन्कोड करके) मूल url के अंत में signature पैरामीटर में जोड़ा जाता है (चरण 4):
https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D
साइनिंग एल्गोरिदम ऐसा होना चाहिए कि उसे एकाधिक कुंजियों के साथ दोहराया जा सके। इससे कई shared keys का उपयोग किया जा सकेगा, और shared keys को समय-समय पर रोटेट करना संभव होगा।
partner_managed_funding_instrument का निर्माण
ऑन-बोर्डिंग फ़्लो कॉल को दोहराना / टोकन रीफ़्रेश
गैर-रीडायरेक्ट किए बिना होने वाला त्रुटि प्रवाह
PMFI में निरंतर अपडेट
प्लेसमेंट
placements पैरामीटर का उपयोग करके सेट किया जाता है। संभावित मान ये हैं:
ALL_ON_TWITTERPUBLISHER_NETWORKTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINESPOTLIGHTTREND
product_type और उद्देश्य यह निर्धारित करते हैं कि कौन-से प्लेसमेंट अनुमत हैं। हर product type के लिए मान्य प्लेसमेंट विकल्प प्राप्त करने हेतु GET line_items/placements endpoint का उपयोग किया जा सकता है।
इसके अलावा, नीचे दी गई तालिका मान्य प्लेसमेंट और उद्देश्य संयोजनों को सूचीबद्ध करती है।
| Objective | ALL_ON_TWITTER | TWITTER_PROFILE | TWITTER_SEARCH | TWITTER_TIMELINE |
|---|---|---|---|---|
APP_ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
APP_INSTALLS | ✔ | ✔ | ✔ | ✔ |
REACH | ✔ | ✔ | ✔ | ✔ |
FOLLOWERS | ✔ | ✔ | ✔ | ✔ |
ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
VIDEO_VIEWS | ✔ | ✔ | ✔ | ✔ |
PREROLL_VIEWS | ✔ | ✔ | ✔ | ✔ |
WEBSITE_CLICKS | ✔ | ✔ | ✔ | ✔ |
TWITTER_PROFILE प्लेसमेंट निर्दिष्ट करना संभव नहीं है।
नोट: TWITTER_SEARCH के लिए keyword targeting आवश्यक है।
नोट: REACH उद्देश्य में TWITTER_TIMELINE प्लेसमेंट शामिल होना आवश्यक है। इसमें ALL_ON_TWITTER, प्लेसमेंट का कोई भी ऐसा संयोजन जिसमें TWITTER_TIMELINE शामिल हो, या केवल TWITTER_TIMELINE शामिल हो सकता है।
Ad groups FAQ
Ad Group क्या है?
हम एक Ad Group कैसे बनाते हैं?
हमें Ad Groups के लिए समर्थन क्यों जोड़ना चाहिए?
Ad Groups अभियान में line item बजट, अभियान बजट से कैसे संबंधित है?
क्या Ad Groups, एकल line items की तुलना में बेहतर प्रदर्शन करते हैं?
मार्गदर्शिकाएँ
वीडियो व्यूज़ प्रीरोल उद्देश्य
आवश्यक एंडपॉइंट
- Chunked media upload (वीडियो अपलोड के लिए)
- POST accounts/:account_id/media_library (वीडियो को ads account से संबद्ध करने के लिए)
- POST accounts/:account_id/campaigns (campaign बनाने के लिए)
- GET content_categories (content categories और IAB categories के बीच मैपिंग पाने के लिए)
- GET accounts/:account_id/curated_categories
- GET publishers
- POST accounts/:account_id/line_item_curated_categories
- POST accounts/:account_id/line_items (ad group बनाने के लिए)
- POST accounts/:account_id/media_creatives (वीडियो को ad group से संबद्ध करने के लिए)
- POST accounts/:account_id/preroll_call_to_action (CTA और redirect URL सेट करने के लिए)
- POST batch/accounts/:account_id/targeting_criteria (targeting के लिए)
चरण
वीडियो अपलोड करें
वीडियो मीडिया अपलोड करें
INIT के दौरान आपको media_category=amplify_video पास करना होगा। आप वीडियो को कई खंडों में अपलोड करेंगे। STATUS में state का मान succeeded लौटने के बाद, आप अगले चरणों पर आगे बढ़ सकते हैं। chunked endpoint का उपयोग करके मीडिया अपलोड करने के बारे में अधिक जानकारी हमारे Promoted Video Overview में मिल सकती है।
वीडियो को Ads account में जोड़ें
STATUS कमांड का उपयोग करके लौटाई गई state जब succeeded हो जाए, तो उस endpoint से लौटाई गई media_key का इस्तेमाल करके वीडियो को advertiser की media library में जोड़ें। इसके लिए POST accounts/:account_id/media_library endpoint का उपयोग करें।
अभियान सेट करें
अभियान निर्माण
objective के लिए VIDEO_VIEWS_PREROLL और product_type के लिए MEDIA के साथ बनाया जाना चाहिए। categories पैरामीटर को भी उपयुक्त विज्ञापनदाता व्यवसाय श्रेणियों पर सेट करना होगा।
लाइन आइटम बनाना
categories पैरामीटर को “Science & Education” पर सेट करने के लिए, iab_categories का पूरा सेट, यानी "IAB5", "IAB15", लाइन आइटम के लिए सेट होना चाहिए, इस प्रकार:
Publisher चयन
क्यूरेटेड श्रेणियाँ
- लाइन आइटम को क्यूरेटेड श्रेणी के country_code के आधार पर उपयुक्त देश को लक्षित करना होगा
- लाइन आइटम को किसी विशिष्ट curated_category_id से संबद्ध करने के लिए POST line_item_curated_categories endpoint का उपयोग करना होगा।
सामग्री श्रेणियाँ
नोट: GET curated_categories रिस्पॉन्स में iab_categories के पूरे सेट को targeting criteria endpoint के माध्यम से target करना आवश्यक है। ऐसा न करने पर validation error होगा।
खाते के मीडिया (वीडियो) को लाइन आइटम से संबद्ध करें
CTA और गंतव्य URL सेट करें
VIDEO_VIEWS_PREROLL उद्देश्य Promoted Tweets या Cards का उपयोग नहीं करता। इसके बजाय, वीडियो क्रिएटिव आपके विज्ञापन समूह (लाइन आइटम) से संबद्ध होता है, और CTA जानकारी preroll_call_to_action एंटिटी से जुड़ी होती है। POST accounts/:account_id/preroll_call_to_action एंडपॉइंट आपको बटन CTA और गंतव्य URL नियंत्रित करने की सुविधा देता है।
टार्गेटिंग मानदंड सेट करें
CONTENT_PUBLISHER_USER को negated targeting के रूप में इस्तेमाल करें। जिन handles को बाहर रखना है, उनके लिए X user_id या publisher_user_id दें।
सामग्री श्रेणियाँ के लिए बाहर रखे जाने वाले user_id की सूची पाने हेतु GET publishers endpoint का उपयोग किया जा सकता है। GET curated_categories रिस्पॉन्स में लौटाया गया publisher_user_id, क्यूरेटेड श्रेणियाँ के लिए इसी तरह की बहिष्करण सूची प्राप्त करने में इस्तेमाल किया जा सकता है।
नोट: क्यूरेटेड श्रेणियाँ के लिए अधिकतम 5 publisher_user_id और सामग्री श्रेणियाँ के लिए 50 user_id को बाहर रखा जा सकता है।
अभियान लॉन्च करें
एनालिटिक्स
VIDEO_VIEWS_PREROLL अभियानों के लिए एनालिटिक्स हमारे stats endpoints का उपयोग करके उपलब्ध है।
Timelines में कीवर्ड टार्गेटिंग
यह कैसे काम करता है?
targeting_type को unordered_keywords या phrase_keywords पर सेट करें।
क्विक स्टार्ट गाइड
ALL_ON_TWITTERयाTWITTER_TIMELINEमें से किसी एक को शामिल करने के लिए placement सेट करके एक नया लाइन आइटम बनाएँ POST accounts/:account_id/line_items- नए बनाए गए इस लाइन आइटम के लिए
BROAD_KEYWORDके साथ targeting criteria बनाएँ और अपने keyword value(s) सेट करें। POST accounts/:account_id/targeting_criteria - आप PUT accounts/:account_id/targeting_criteria का उपयोग करके keywords अपडेट कर सकते हैं
- आपका अभियान चलने के बाद, performance का आकलन करने के लिए अपने लाइन आइटम के stats प्राप्त करें। GET stats/accounts/:account_id
API संदर्भ
अकाउंट्स
https://ads-api.x.com/12/accounts
पैरामीटर
| Name | Description |
|---|---|
| account_ids optional | अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल इच्छित account IDs तक सीमित करें। Type: string Example: 18ce54d4x5t |
| count optional | हर अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | name के आधार पर resource को सीमित करने के लिए एक वैकल्पिक query। Note: यह case-insensitive prefix matching करता है। Type: string Min, Max length: 1, 255 |
| 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 |
https://ads-api.x.com/12/accounts/:account_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| with_deleted optional | अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean डिफ़ॉल्ट: false संभव मान: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts
पैरामीटर
कोई नहीं
उदाहरण अनुरोध
POST https://ads-api-sandbox.x.com/12/accounts
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| name optional | खाते का नाम। Type: string उदाहरण: API McTestface |
| industry_type optional | वह उद्योग जिससे खाता संबद्ध है। Type: string संभावित मान: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts/:account_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh
उदाहरण रिस्पॉन्स
अकाउंट ऐप्स
https://ads-api.x.com/12/accounts/:account_id/account_apps
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | results का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| 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 शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps
Example Response
खाते का इतिहास
entity_id में किए गए बदलावों का सारांश प्राप्त करें।
नोट: यह एंडपॉइंट वर्तमान में बीटा में है और इसके लिए allowlisting आवश्यक है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/account_history
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| entity_type required | वह entity type जिसके लिए डेटा प्राप्त करना है। Type: enum Example: PROMOTED_TWEET Possible values: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT |
| entity_id required | वह विशिष्ट entity जिसके लिए डेटा प्राप्त करना है। Type: string Example: 8u94t |
| start_time required | प्राप्त किए गए डेटा को निर्दिष्ट प्रारंभ समय से सीमित करता है, जिसे ISO 8601 में व्यक्त किया जाता है। नोट: इसे पूरे घंटों में व्यक्त किया जाना चाहिए (0 मिनट और 0 सेकंड)। Type: string Example: 2017-05-19T07:00:00Z |
| end_time required | प्राप्त किए गए डेटा को निर्दिष्ट समाप्ति समय तक सीमित करता है, जिसे ISO 8601 में व्यक्त किया जाता है। नोट: इसे पूरे घंटों में व्यक्त किया जाना चाहिए (0 मिनट और 0 सेकंड)। Type: string Example: 2017-05-26T07:00:00Z |
| user_id optional | रिस्पॉन्स को किसी विशिष्ट उपयोगकर्ता तक सीमित करता है। Type: long Example: 3271358660 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1
उदाहरण रिस्पॉन्स
विज्ञापनदाता व्यवसाय श्रेणियां
line_items) हेतु मान्य विज्ञापनदाता व्यवसाय categories प्राप्त करें।
ध्यान दें: ये categories केवल PREROLL_VIEWS objective वाले line_items पर लागू होती हैं और targeting criteria के लिए उपयोग की जाने वाली content_categories से अलग हैं।
प्रत्येक advertiser_business_categories, IAB Categories के एक संग्रह को दर्शाता है। PREROLL_VIEWS objective के साथ Ad Group बनाते समय, Ad Group के लिए एक या दो advertiser_business_categories सेट करना आवश्यक है। यह line item endpoint पर categories request parameter का मान, इस endpoint के माध्यम से उपलब्ध संबंधित iab_categories के सेट पर सेट करके किया जा सकता है।
अधिक विवरण Video Views Preroll Objective Guide में उपलब्ध हैं
रिसोर्स URL
https://ads-api.x.com/12/advertiser_business_categories
पैरामीटर
कोई request parameter नहीं
उदाहरण अनुरोध
GET https://ads-api.x.com/12/advertiser_business_categories
उदाहरण रिस्पॉन्स
ऑडियंस का अनुमान
अपने अभियानों के अनुमानित ऑडियंस आकार का पता लगाएँ।
Content-Type: application/json header के साथ JSON content body होना चाहिए।
नोट: आपको कम से कम एक primary targeting criterion निर्दिष्ट करना अनिवार्य है; सभी primary targeting criteria की सूची आप हमारे campaigns targeting page पर देख सकते हैं।
Resource URL
https://ads-api.x.com/12/accounts/:account_id/audience_estimate
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account, प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| targeting_criteria required | एक JSON object, जिसमें targeting criteria ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक targeting criteria पैरामीटर की सूची POST accounts/:account_id/targeting_criteria endpoint पर उपलब्ध है। |
| operator_type optional | targeting criterion के लिए लागू संबंध निर्दिष्ट करें। उदाहरण के लिए, negated targeting सेट करने के लिए operator_type=NE का उपयोग करें।Type: enum Possible values: EQ, NEDefault: EQ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate
प्रमाणीकृत उपयोगकर्ता एक्सेस
ACCOUNT_ADMIN: अभियानों में बदलाव करने और आँकड़े देखने की पूर्ण पहुँच, जिसमें उपयोगकर्ताओं को जोड़ने या हटाने और सेटिंग्स बदलने की क्षमता शामिल हैAD_MANAGER: अभियानों में बदलाव करने और आँकड़े देखने की पूर्ण पहुँच, लेकिन उपयोगकर्ताओं को जोड़ या हटा नहीं सकता और न ही सेटिंग्स बदल सकता हैCREATIVE_MANAGER: creatives में बदलाव करने और previews देखने की पहुँच, लेकिन अभियान बनाने या उनमें बदलाव करने की पहुँच नहींCAMPAIGN_ANALYST: अभियान और आँकड़े देखने की पहुँच, लेकिन अभियान बनाने या उनमें बदलाव करने की पहुँच नहींANALYST(“Organic Analyst” ads.x.com पर): organic analytics और audience insights देखने की पहुँच, लेकिन अभियान बनाने, उनमें बदलाव करने या उन्हें देखने की पहुँच नहींPARTNER_AUDIENCE_MANAGER: data partner audiences को देखने और उनमें बदलाव करने के लिए केवल API पहुँच, लेकिन अभियान, creatives या अन्य audience प्रकारों तक पहुँच नहीं।
TWEET_COMPOSER अनुमति यह दर्शाती है कि प्रमाणीकृत उपयोगकर्ता विज्ञापनदाता की ओर से nullcasted (या “Promoted-only”) Tweets बना सकता है। यह केवल ACCOUNT_ADMIN, AD_MANAGER या CREATIVE_MANAGER पहुँच वाले उपयोगकर्ताओं के लिए उपलब्ध है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access
पैरामीटर
कोई नहीं
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access
उदाहरण रिस्पॉन्स
बोली नियम
https://ads-api.x.com/12/bidding_rules
पैरामीटर
| नाम | विवरण |
|---|---|
| currency वैकल्पिक | परिणामों को फ़िल्टर करने के लिए मुद्रा का प्रकार, जिसकी पहचान ISO-4217 के अनुसार की जाती है। यह तीन-अक्षरों की string होती है, जैसे “USD” या “EUR”। सभी बिडिंग नियम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। यह authenticated user से संबद्ध है. Type: string Example: USD |
GET https://ads-api.x.com/12/bidding_rules?currency=USD
उदाहरण रिस्पॉन्स
अभियान
https://ads-api.x.com/12/accounts/:account_id/campaigns
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग में लिए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| campaign_ids optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित अभियान तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8wku2 |
| count optional | प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट funding instruments के अंतर्गत आने वाले अभियान तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi |
| q optional | name के आधार पर रिसोर्स को सीमित करने के लिए एक वैकल्पिक query।Type: string Min, Max length: 1, 255 |
| 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_draft optional | अपनी request में draft अभियान के results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor परस्पर अनन्य हैं।नोट: जिन requests में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| campaign_id required | उस कैंपेन का संदर्भ जिसके साथ आप request में कार्य कर रहे हैं। Type: string Example: 8wku2 |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/campaigns
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग किए जा रहे अकाउंट का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| funding_instrument_id required | उस funding instrument का पहचानकर्ता जिसके अंतर्गत अभियान बनाया जाना है। Type: string Example: lygyi |
| name required | अभियान का नाम। अधिकतम लंबाई: 255 वर्ण। Type: string Example: demo |
| budget_optimization optional | लागू किए जाने वाले budget optimization के type का चयन करें Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM |
| daily_budget_amount_local_micro sometimes required | अभियान के लिए आवंटित की जाने वाली दैनिक budget राशि। निर्दिष्ट funding instrument से संबद्ध currency का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए और अधिकांश Funding Insturment types के लिए आवश्यक है।Type: long Example: 5500000 |
| entity_status optional | अभियान की स्थिति। Type: enum Default: ACTIVE Possible values: ACTIVE, DRAFT, PAUSED |
| purchase_order_number optional | booking reference number। invoice reconciliation में मदद के लिए इस field का उपयोग करें। अधिकतम लंबाई: 50 वर्ण। Type: string Example: D00805843 |
| standard_delivery optional | standard या accelerated delivery सक्षम करें। standard और accelerated delivery के बारे में अधिक जानकारी के लिए Budget Pacing देखें। यह केवल तब उपलब्ध होता है, जब budget_optimization को CAMPAIGN पर set किया गया हो।Type: boolean Default: true Possible values: true, false |
| total_budget_amount_local_micro optional | अभियान के लिए आवंटित की जाने वाली कुल budget राशि। निर्दिष्ट funding instrument से संबद्ध currency का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long Example: 37500000 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false
उदाहरण रिस्पॉन्स
- वर्तमान अधिकतम बैच आकार 40 है।
- सभी पैरामीटर अनुरोध बॉडी में भेजे जाते हैं और
Content-Typeके लिएapplication/jsonआवश्यक है। - बैच अनुरोध समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि व सफलता—दोनों स्थितियों में सभी API रिस्पॉन्स प्रारंभिक अनुरोध के आइटम क्रम को बनाए रखते हैं।
- अनुरोध-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में
errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं। - आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक कैंपेन पैरामीटर का न होना) रिस्पॉन्स में
operation_errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
https://ads-api.x.com/12/batch/accounts/:account_id/campaigns
पैरामीटर
| Name | Description |
|---|---|
| operation_type required | प्रति आइटम किया जाने वाला operation type. Type: enum संभव मान: Create, Delete, Update |
| params required | कैंपेन ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल करने वाला एक JSON ऑब्जेक्ट। आवश्यक और वैकल्पिक कैंपेन पैरामीटरों की सूची के लिए, यहाँ देखें। |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग किए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| campaign_id required | अनुरोध में जिस कैंपेन पर आप काम कर रहे हैं, उसका संदर्भ। प्रकार: string उदाहरण: 8wku2 |
| budget_optimization optional | लागू की जाने वाली budget optimization का प्रकार चुनें प्रकार: enum डिफ़ॉल्ट: CAMPAIGN संभावित मान: CAMPAIGN, LINE_ITEM |
| daily_budget_amount_local_micro optional | कैंपेन को आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो कैंपेन कुल बजट और कैंपेन की अवधि के आधार पर समान रूप से खर्च करेगा। नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए।प्रकार: long उदाहरण: 5500000 |
| entity_status optional | कैंपेन की स्थिति। प्रकार: enum संभावित मान: ACTIVE, PAUSED |
| name optional | कैंपेन का नाम। अधिकतम लंबाई: 255 अक्षर। प्रकार: string उदाहरण: demo |
| purchase_order_number optional | बुकिंग संदर्भ संख्या। इनवॉइस मिलान में सहायता के लिए इस फ़ील्ड का उपयोग करें। अधिकतम लंबाई: 50 अक्षर। प्रकार: string उदाहरण: D00805843 |
| standard_delivery optional | standard या accelerated delivery सक्षम करें। standard और accelerated delivery के बारे में अधिक जानकारी के लिए Budget Pacing देखें। केवल तब उपलब्ध है जब budget_optimization को CAMPAIGN पर सेट किया गया हो।प्रकार: boolean डिफ़ॉल्ट: true संभावित मान: true, false |
| total_budget_amount_local_micro optional | कैंपेन को आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। प्रकार: long उदाहरण: 140000000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| campaign_id required | request में जिस campaign पर आप काम कर रहे हैं, उसका संदर्भ। Type: string Exampple: 8yn7m |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m
उदाहरण रिस्पॉन्स
सामग्री श्रेणियां
लाइन आइटम के लिएtargeting_criteria के रूप में सेट की जा सकने वाली मान्य content categories का अनुरोध करें।
हर content_category एक या अधिक IAB Categories से मैप होता है। ऐसा करने के लिए, batch targeting_critera endpoint पर targeting_type को IAB_CATEGORY पर सेट करें, ताकि content_categories अनुरोध से लौटाई गई संबंधित iab_categories का सेट शामिल किया जा सके। ऐसा न करने पर वैलिडेशन त्रुटि मिलेगी।
इनमें से प्रत्येक content category के लिए publisher विवरण GET publishers endpoint का उपयोग करके प्राप्त किए जा सकते हैं।
अधिक जानकारी Video Views Pre-roll Objective Guide में उपलब्ध है।
रिसोर्स URL
https://ads-api.x.com/12/content_categories
पैरामीटर
कोई request पैरामीटर नहीं
उदाहरण अनुरोध
GET https://ads-api.x.com/12/content_categories
उदाहरण रिस्पॉन्स
चयनित श्रेणियां
दिए गएcountry_codes के लिए उपलब्ध चयनित श्रेणियां की सूची प्राप्त करें
हर curated_category केवल उन विशिष्ट देशों में उपलब्ध होती है, जिन्हें रिस्पॉन्स में country_codes द्वारा निर्दिष्ट किया गया है।
अधिक जानकारी के लिए Video Views Pre-roll Objective Guide देखें।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/curated_categories
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग में लिए जा रहे लेवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| country_codes required | दो-अक्षरीय ISO country codes की कॉमा-सेपरेटेड सूची देकर रिस्पॉन्स को केवल इच्छित देशों तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: US |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US
उदाहरण रिस्पॉन्स
curated_category_id का विवरण प्राप्त करें
प्रत्येक curated_category केवल उन विशिष्ट देशों में उपलब्ध है, जिन्हें रिस्पॉन्स में country_codes के जरिए निर्दिष्ट किया गया है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | जिस लेवरेज्ड खाते का उपयोग किया जा रहा है, उसका पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API रिक्वेस्ट के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| curated_category_id required | उस Curated Category का संदर्भ, जिसका आप इस रिक्वेस्ट में उपयोग कर रहे हैं। Type: string Example: 9ddrgesiap6o |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o
उदाहरण रिस्पॉन्स
सुविधाएँ
https://ads-api.x.com/12/accounts/:account_id/features
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| feature_keys optional | यह एक वैकल्पिक पैरामीटर है, जो किसी विशेष feature key के लिए query करने की सुविधा देता है। requests में कॉमा से अलग की गई कई keys शामिल हो सकती हैं। नोट: रिस्पॉन्स में केवल वही फीचर्स शामिल होंगे, जो इस account के लिए उपलब्ध हैं। Type: enum Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts/:account_id/features
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट खाता authenticated user से संबद्ध होना चाहिए। Type: string Example: gq180y |
| feature_keys required | खाते में जोड़ने के लिए account फीचर्स की comma-separated सूची। Type: enum Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD |
POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts/:account_id/features
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: gq180y |
| feature_keys required | खाते से हटाई जाने वाली खाता फीचरों की कॉमा से अलग की गई सूची। Type: enum Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE
उदाहरण रिस्पॉन्स
फंडिंग इंस्ट्रूमेंट्स
https://ads-api.x.com/12/accounts/:account_id/funding_instruments
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता authenticated उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | identifiers की comma-separated सूची निर्दिष्ट करके रिस्पॉन्स को केवल इच्छित फंडिंग इंस्ट्रूमेंट्स तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi |
| 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 शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लेवरेज्ड खाते का पहचानकर्ता। यह संसाधन के पथ में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| funding_instrument_id required | उस फंडिंग इंस्ट्रूमेंट का संदर्भ जिसे आप इस अनुरोध में उपयोग कर रहे हैं। Type: string Example: lygyi |
| with_deleted optional | अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का आइडेंटिफ़ायर। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: gq1844 |
| currency required | ISO-4217 में व्यक्त की गई मुद्रा। Type: string Example: USD |
| start_time required | वह तारीख जिस पर फंडिंग इंस्ट्रूमेंट सक्रिय और उपयोग के लिए उपलब्ध हो जाता है, जिसे ISO 8601 में व्यक्त किया गया है। Type: string Example: 2017-05-19T07:00:00Z |
| type required | बनाए जाने वाले फंडिंग इंस्ट्रूमेंट का type। Type: enum Possible values: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED |
| end_time sometimes required | वह तारीख जिस पर फंडिंग इंस्ट्रूमेंट निष्क्रिय हो जाता है, जिसे ISO 8601 में व्यक्त किया गया है। Type: string Example: 2017-05-26T07:00:00Z |
| credit_limit_local_micro optional | इस फंडिंग इंस्ट्रूमेंट के लिए उपलब्ध कुल क्रेडिट। नोट: यह केवल कुछ फंडिंग इंस्ट्रूमेंट type पर लागू होता है। Type: long Example: 37500000 |
| funded_amount_local_micro optional | इस फंडिंग इंस्ट्रूमेंट को आवंटित कुल बजट राशि। नोट: यह केवल कुछ फंडिंग इंस्ट्रूमेंट type पर लागू होता है। Type: long Example: 37500000 |
POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000
उदाहरण रिस्पॉन्स
https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: gq1844 |
| funding_instrument_id required | request में जिस फंडिंग इंस्ट्रूमेंट पर आप कार्रवाई कर रहे हैं, उसका एक reference। Type: string Exampple: hxt82 |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82
उदाहरण रिस्पॉन्स
IAB श्रेणियाँ
line_items) के लिए मान्य ऐप categories का अनुरोध करें।
संसाधन URL
https://ads-api.x.com/12/iab_categories
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | categories का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें।Type: string Example: gc-ddf4a |
| 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/iab_categories?count=2
Example Response
लाइन आइटम
https://ads-api.x.com/12/accounts/:account_id/line_items
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| campaign_ids optional | अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट campaigns के अंतर्गत आने वाले line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8gdx6 |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट funding instruments के अंतर्गत आने वाले line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi |
| line_item_ids optional | अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8v7jo |
| q optional | name के आधार पर resource को सीमित करने के लिए एक वैकल्पिक query।Type: string Min, Max length: 1, 255 |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपने अनुरोध में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_draft optional | अपने अनुरोध में draft campaigns के results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | उस line item का संदर्भ जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8v7jo |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx
उदाहरण रिस्पॉन्स
product_type और objective समान होना चाहिए।
PROMOTED_ACCOUNT product type का उपयोग करते समय, line_item के साथ किसी Tweet को संबद्ध करने पर मानक PROMOTED_ACCOUNT placement के अलावा mobile पर timeline placements भी जुड़ जाएँगे।
android_app_store_identifier या ios_app_store_identifier में से किसी एक को सेट करने पर प्रचारित किए जा रहे mobile app से मेल खाने वाले line item के लिए targeting criteria अपने-आप जुड़ जाएँगे; उदाहरण के लिए, ios_app_store_identifier पास करने पर iOS के लिए PLATFORM targeting criteria जुड़ जाएगा।
नोट: प्रति campaign 100 line items और सभी campaigns में कुल 256 active line items की सीमा है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/line_items
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| campaign_id आवश्यक | जिस अभियान के अंतर्गत लाइन आइटम बनाया जाना है, उसका पहचानकर्ता। प्रकार: string उदाहरण: 8slvg |
| end_time आवश्यक | वह समय, जिसे ISO 8601 में व्यक्त किया गया है, जब line item की डिलीवरी रुक जाएगी। Type: string उदाहरण: 2017-10-05T00:00:00Z |
| objective आवश्यक | इस लाइन आइटम के लिए अभियान का उद्देश्य। Type: enum संभावित मान: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS |
| placements आवश्यक | वे placement स्थान जहाँ यह line item प्रदर्शित होगा। placement मानों की comma-separated सूची निर्दिष्ट करें। Type: enum संभावित मान: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE |
| product_type आवश्यक | इस line item में शामिल प्रचारित उत्पाद का प्रकार। Type: enum संभावित मान: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS |
| start_time आवश्यक | वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम की डिलीवरी शुरू होगी। Type: string उदाहरण: 2017-07-05T00:00:00Z |
| advertiser_domain कुछ मामलों में आवश्यक | इस विज्ञापनदाता की वेबसाइट का डोमेन, बिना प्रोटोकॉल विनिर्देशन के. नोट: जब line item का placement PUBLISHER_NETWORK पर सेट किया गया हो, तब यह आवश्यक है.Type: string उदाहरण: x.com |
| android_app_store_identifier कुछ मामलों में आवश्यक | प्रचारित ऐप्स के लिए Google App Store आइडेंटिफ़ायर। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier।Type: string उदाहरण: com.twitter.android |
| bid_amount_local_micro कभी-कभी ज़रूरी | इस लाइन आइटम से संबद्ध की जाने वाली बोली राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में प्रदर्शित किया जाता है। नोट: यदि bid_strategy को MAX या TARGET में से किसी एक पर सेट किया गया है, तो यह आवश्यक हैनोट: केवल शून्य से अधिक मान ही स्वीकार किए जाते हैं। Type: long उदाहरण: 5500000 |
| categories कुछ मामलों में आवश्यक | इस विज्ञापनदाता के लिए प्रासंगिक IAB श्रेणियां। GET iab_categories देखें। नोट: जब line item का placement PUBLISHER_NETWORK पर सेट हो, तो यह आवश्यक है।type: string उदाहरण: IAB3-1 |
| ios_app_store_identifier कभी-कभी ज़रूरी | प्रचारित ऐप्स के लिए Apple App Store identifier का संख्यात्मक भाग। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier।Type: string उदाहरण: 333903271 |
| primary_web_event_tag कभी-कभी आवश्यक | प्राथमिक वेब इवेंट टैग का पहचानकर्ता। यह इस line item से संबंधित अभियान के लिए एंगेजमेंट की अधिक सटीक ट्रैकिंग सक्षम करता है। नोट: जब line item का goal WEBSITE_CONVERSIONS पर सेट हो, तब यह आवश्यक है।प्रकार: string उदाहरण: nvo4z |
| advertiser_user_id वैकल्पिक | PREROLL_VIEWS विज्ञापन का प्रमोशन करने वाले हैंडल के लिए X उपयोगकर्ता पहचानकर्ता। केवल कुछ क्लाइंट एप्लिकेशन ही इस पैरामीटर का उपयोग कर सकते हैं।प्रकार: string उदाहरण: 312226591 |
| audience_expansion वैकल्पिक | पहले से लक्षित उपयोगकर्ताओं के समान उपयोगकर्ताओं को लक्षित करके अभियानों की पहुंच बढ़ाने के लिए इसका उपयोग किया जाता है। नोट: डिफ़ॉल्ट रूप से, कोई विस्तार लागू नहीं होगा। Type: enum संभावित मान: BROAD, DEFINED, EXPANDED |
| bid_strategy वैकल्पिक | बोली लगाने का तंत्र.AUTO दैनिक बजट और अभियान की चलने की तिथियों के आधार पर बोली को अपने-आप अनुकूलित करता है.MAX अधिकतम अनुमत बोली सेट करता है और जब objective REACH या FOLLOWERS पर सेट हो, तब यह उपलब्ध नहीं होता है.TARGET दैनिक औसत बोली को निर्दिष्ट bid_amount_local_micro के 20% के भीतर रखने का प्रयास करता है और जब objective REACH, FOLLOWERS, या WEBSITE_CLICKS पर सेट हो, तब यह उपलब्ध होता है.ध्यान दें: अगर इसे AUTO पर सेट किया गया है, तो bid_amount_local_micro को अनदेखा कर दिया जाएगा.ध्यान दें: डिफ़ॉल्ट मान objective पर आधारित होता है. प्रकार: enum संभावित मान: AUTO, MAX, TARGET |
| duration_in_days वैकल्पिक | वह समयावधि, जिसके भीतर frequency_cap हासिल किया जाता है।Type: int संभावित मान: 1, 7, 30 |
| entity_status वैकल्पिक | लाइन आइटम की स्थिति। Type: enum डिफ़ॉल्ट: ACTIVE संभावित मान: ACTIVE, DRAFT, PAUSED |
| frequency_cap वैकल्पिक | किसी उपयोगकर्ता को विज्ञापन अधिकतम कितनी बार दिखाया जा सकता है। ध्यान दें: यह केवल REACH, ENGAGEMENTS, VIDEO_VIEWS, और PREROLL_VIEWS उद्देश्यों के लिए समर्थित है।Type: int उदाहरण: 5 |
| goal वैकल्पिक | इस line item के लिए उपयोग की जाने वाली optimization सेटिंग।APP_PURCHASES विकल्प APP_INSTALL के लिए उपलब्ध है। APP_CLICKS और APP_INSTALLS विकल्प APP_INSTALL और APP_ENGAGEMENTS दोनों उद्देश्यों के लिए उपलब्ध हैं और इनके लिए किसी समर्थित MACT partner का उपयोग करना पड़ सकता है।SITE_VISITS विकल्प केवल WEBSITE_CLICKS objective के साथ उपलब्ध है।नोट: objective के आधार पर डिफ़ॉल्ट। प्रकार: enum संभावित मान: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS |
| name वैकल्पिक | लाइन आइटम का नाम. Type: string उदाहरण: demoन्यूनतम, अधिकतम लंबाई: 1, 255 |
| pay_by वैकल्पिक | इस लाइन आइटम के लिए शुल्क लेने की इकाई। यह सेटिंग केवल APP_INSTALLS objective का उपयोग करने वाले लाइन आइटम्स के लिए ही बदली जा सकती है।नोट: डिफ़ॉल्ट pay_by, campaign objective और लाइन आइटम की bid unit के आधार पर अपने-आप सेट हो जाता है।APP_INSTALLS goal, APP_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है।LINK_CLICKS goal, LINK_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है, लेकिन bid_strategy के लिए TARGET सेट करते समय यह समर्थित नहीं है।SITE_VISITS goal, IMPRESSION मान का समर्थन करता है।Type: enum संभावित मान: APP_CLICK, IMPRESSION, LINK_CLICK |
| standard_delivery वैकल्पिक | मानक या त्वरित डिलीवरी सक्षम करें। मानक और त्वरित डिलीवरी के बारे में अधिक जानकारी के लिए Budget Pacing देखें। यह केवल तब उपलब्ध है, जब पैरेंट campaign के लिए budget_optimization को LINE_ITEM पर सेट किया गया होType: boolean डिफ़ॉल्ट: true संभावित मान: true, false |
| total_budget_amount_local_micro वैकल्पिक | लाइन आइटम के लिए आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long उदाहरण: 37500000 |
| daily_budget_amount_local_micro कभी-कभी आवश्यक होता है | अभियान को आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो अभियान कुल बजट और अभियान की अवधि के आधार पर समान रूप से खर्च करेगा। यह केवल तब उपलब्ध है, जब मूल अभियान के लिए budget_optimization को LINE_ITEM पर सेट किया गया होनोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए।टाइप: long उदाहरण: 5500000 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15
उदाहरण रिस्पॉन्स
- वर्तमान में अधिकतम बैच आकार 40 है।
- सभी पैरामीटर अनुरोध बॉडी में भेजे जाते हैं और
application/jsonकाContent-Typeआवश्यक है। - बैच अनुरोध समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि व सफलता दोनों के लिए सभी API रिस्पॉन्स शुरुआती अनुरोध में आइटमों के क्रम को बनाए रखते हैं।
- अनुरोध-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में
errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं। - आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक line item पैरामीटर का मौजूद न होना) रिस्पॉन्स में
operation_errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
https://ads-api.x.com/12/batch/accounts/:account_id/line_items
पैरामीटर
| Name | Description |
|---|---|
| operation_type required | प्रति आइटम निष्पादित किया जा रहा operation type। Type: enum संभावित मान: Create, Delete, Update |
| params required | एक JSON ऑब्जेक्ट, जिसमें line item ऑब्जेक्ट के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक line item पैरामीटरों की सूची के लिए, यहाँ देखें। |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | लिवरेज्ड खाते के लिए पहचानकर्ता। यह संसाधन के पाथ में दिखाई देता है और GET accounts को छोड़कर आमतौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| line_item_id आवश्यक | उस line item का संदर्भ जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string उदाहरण: 8v7jo |
| advertiser_domain वैकल्पिक | इस विज्ञापनदाता की वेबसाइट का डोमेन, बिना प्रोटोकॉल विनिर्देशन के। नोट: जब लाइन आइटम का प्लेसमेंट PUBLISHER_NETWORK पर सेट किया गया हो, तब यह आवश्यक है।Type: string उदाहरण: x.com |
| advertiser_user_id वैकल्पिक | PREROLL_VIEWS विज्ञापन का प्रचार करने वाले हैंडल के लिए Twitter उपयोगकर्ता पहचानकर्ता। केवल कुछ client applications ही इस parameter का उपयोग कर सकती हैं।Type: string उदाहरण: 312226591 |
| android_app_store_identifier वैकल्पिक | प्रचारित ऐप के लिए Google App Store पहचानकर्ता। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम-से-कम एक app store पहचानकर्ता सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier।Type: string उदाहरण: com.twitter.android |
| audience_expansion वैकल्पिक | पहले से लक्षित उपयोगकर्ताओं जैसे मिलते-जुलते उपयोगकर्ताओं को लक्षित करके अभियानों की पहुँच बढ़ाने के लिए उपयोग किया जाता है। Type: enum संभावित मान: BROAD, DEFINED, EXPANDED |
| bid_amount_local_micro वैकल्पिक | इस line item से संबद्ध बोली राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में प्रदर्शित किया जाता है। नोट: यदि bid_strategy को MAX या TARGET में से किसी एक पर सेट किया गया है, तो यह आवश्यक हैनोट: केवल शून्य से अधिक मान स्वीकार किए जाते हैं। प्रकार: long उदाहरण: 140000 |
| bid_strategy वैकल्पिक | बोली लगाने की प्रणाली।AUTO दैनिक बजट और अभियान की अवधि के आधार पर बोली को अपने-आप अनुकूलित करता है।MAX अधिकतम अनुमत बोली सेट करता है और जब objective को REACH या FOLLOWERS पर सेट किया गया हो, तब यह उपलब्ध नहीं होता।TARGET दैनिक औसत बोली को निर्दिष्ट bid_amount_local_micro के 20% के भीतर रखने का प्रयास करता है और जब objective को REACH या WEBSITE_CLICKS पर सेट किया गया हो, तब यह उपलब्ध होता है।ध्यान दें: यदि इसे AUTO पर सेट किया गया है, तो bid_amount_local_micro को अनदेखा किया जाएगा।ध्यान दें: डिफ़ॉल्ट मान objective के आधार पर होता है। Type: enum संभावित मान: AUTO, MAX, TARGET |
| categories वैकल्पिक | इस विज्ञापनदाता के लिए लागू IAB श्रेणियाँ। GET iab_categories देखें। नोट: जब line item का placement PUBLISHER_NETWORK पर सेट हो, तो यह आवश्यक है।प्रकार: string उदाहरण: IAB3-1 |
| duration_in_days वैकल्पिक | वह समय अवधि, जिसके भीतर frequency_cap हासिल किया जाता है।Type: int संभावित मान: 1, 7, 30 |
| entity_status वैकल्पिक | लाइन आइटम की स्थिति. Type: enum संभावित मान: ACTIVE, PAUSED |
| end_time वैकल्पिक | वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम की डिलीवरी बंद हो जाएगी। Type: string उदाहरण: 2017-10-05T00:00:00Z |
| frequency_cap वैकल्पिक | किसी उपयोगकर्ता को कोई विज्ञापन अधिकतम कितनी बार दिखाया जा सकता है। नोट: यह केवल REACH, ENGAGEMENTS, VIDEO_VIEWS और PREROLL_VIEWS उद्देश्यों के लिए समर्थित है।प्रकार: int उदाहरण: 5 |
| goal वैकल्पिक | इस line item के साथ उपयोग की जाने वाली optimization setting। APP_PURCHASES विकल्प APP_INSTALL के लिए उपलब्ध है। APP_CLICKS और APP_INSTALLS विकल्प APP_INSTALL और APP_ENGAGEMENTS के लिए उपलब्ध हैं, और इनके लिए किसी समर्थित MACT partner का उपयोग करना आवश्यक हो सकता है।नोट: डिफ़ॉल्ट, objective के आधार पर तय होता है। Type: enum संभावित मान: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS |
| ios_app_store_identifier वैकल्पिक | प्रचारित ऐप्लिकेशन के लिए Apple App Store identifier का संख्यात्मक भाग। नोट: APP_INSTALLS और APP_ENGAGEMENTS objectives के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier।Type: string उदाहरण: 333903271 |
| name वैकल्पिक | लाइन आइटम का नाम। Type: string उदाहरण: demo |
| pay_by वैकल्पिक | इस line item के लिए शुल्क लेने की इकाई। यह सेटिंग केवल उन line items के लिए बदली जा सकती है जो APP_INSTALLS objective का उपयोग करते हैं।नोट: डिफ़ॉल्ट pay_by, campaign objective और line item की bid unit के आधार पर अपने आप सेट हो जाता है।APP_INSTALLS goal, APP_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है।LINK_CLICKS goal, LINK_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है, लेकिन bid_strategy के लिए TARGET सेट करते समय यह समर्थित नहीं है।SITE_VISITS goal, IMPRESSION मान का समर्थन करता है।Type: enum संभावित मान: APP_CLICK, IMPRESSION, LINK_CLICK |
| start_time वैकल्पिक | वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम सर्व होना शुरू करेगा। Type: string उदाहरण: 2017-07-05T00:00:00Z |
| total_budget_amount_local_micro वैकल्पिक | लाइन आइटम के लिए आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट फंडिंग इंस्ट्रूमेंट से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long उदाहरण: 37500000 |
| daily_budget_amount_local_micro वैकल्पिक | campaign के लिए आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो campaign कुल बजट और उसकी चलने की अवधि के आधार पर समान रूप से खर्च करेगा। केवल तब उपलब्ध, जब parent campaign के लिए budget_optimization को LINE_ITEM पर सेट किया गया होनोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए।Type: long उदाहरण: 5500000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000
उदाहरण रिस्पॉन्स
with_deleted=true निर्दिष्ट किया गया हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते (response में "deleted": false)। हम cascade delete नहीं करते।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account के लिए identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक required parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | request में जिस लाइन आइटम पर आप कार्रवाई कर रहे हैं, उसका reference। Type: string Exampple: 9f2ix |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix
उदाहरण रिस्पॉन्स
लाइन आइटम क्यूरेटेड कैटेगरी
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का आइडेंटिफ़ायर। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | results का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| 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 शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग किए जा रहे खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 43853bhii885 |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
पैरामीटर
| Name | Description |
|---|---|
account_id required | उपयोग किए जा रहे account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, ऑथेंटिकेटेड उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
curated_category_id required | उस curated category entity का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 10miy |
line_item_id required | उस लाइन आइटम का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8v7jo |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API request के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 1bzq3 |
curated_category_id optional | उस curated category entity का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 10miy |
line_item_id optional | उस लाइन आइटम का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 8v7jo |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API request के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप इस request में कार्रवाई कर रहे हैं। Type: string Example: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq
उदाहरण रिस्पॉन्स
लाइन आइटम प्लेसमेंट
placement और product_type संयोजन प्राप्त करें।
रिसोर्स URL
https://ads-api.x.com/12/line_items/placements
पैरामीटर
| नाम | विवरण |
|---|---|
| product_type optional | रिस्पॉन्स का दायरा केवल निर्दिष्ट product type के लिए मान्य placements तक सीमित करें। Type: enum संभावित मान: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS |
GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT
उदाहरण रिस्पॉन्स
मीडिया क्रिएटिव्स
https://ads-api.x.com/12/accounts/:account_id/media_creatives
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग किए जा रहे account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| campaign_id optional | रिस्पॉन्स को केवल निर्दिष्ट campaign से संबद्ध मीडिया क्रिएटिव्स तक सीमित करें। प्रकार: string उदाहरण: 8gdx6 |
| count optional | प्रति request पुनर्प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। प्रकार: int डिफ़ॉल्ट: 200 न्यूनतम, अधिकतम: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। प्रकार: string उदाहरण: 8x7v00oow |
| line_item_ids optional | अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट लाइन आइटम्स से संबद्ध मीडिया क्रिएटिव्स तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। प्रकार: string उदाहरण: 8v7jo |
| media_creative_ids optional | अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल वांछित मीडिया क्रिएटिव्स तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। प्रकार: string उदाहरण: 1bzq3 |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। प्रकार: string उदाहरण: created_at-asc |
| with_deleted optional | अपने request में deleted results शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह parameter और cursor एक-दूसरे के साथ उपयोग नहीं किए जा सकते।नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 पर सेट हैं।प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग में लाए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| media_creative_id required | उस मीडिया क्रिएटिव का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 43853bhii885 |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
उदाहरण रिस्पॉन्स
creative_type PREROLL हो) या image ads (जैसे BANNER या INTERSTITIAL) को प्रमोट करने के लिए इस endpoint का उपयोग करें।
नोट: Account Media resource में media assets जोड़ने के लिए, POST accounts/:account_id/media_library endpoint का उपयोग करें।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/media_creatives
पैरामीटर
| Name | Description |
|---|---|
account_id required | उपयोग किए जा रहे leveraged account का identifier। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests में required parameter होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
account_media_id required | request में जिस account media entity के साथ आप काम कर रहे हैं, उसका reference। Type: string Example: 10miy |
line_item_id required | request में जिस line item के साथ आप काम कर रहे हैं, उसका reference। Type: string Example: 8v7jo |
landing_url sometimes required | उस वेबसाइट का URL, जिस पर उपयोगकर्ता को भेजना है। इसका उपयोग केवल TAP images (या “display creatives”) के साथ किया जाना चाहिए। preroll assets के साथ उपयोग किए जाने पर इस value को अनदेखा कर दिया जाएगा। किसी preroll asset के साथ URL संबद्ध करने के लिए, POST accounts/:account_id/preroll_call_to_actions endpoint का उपयोग करें। नोट: जब line item का objective WEBSITE_CLICKS पर सेट हो, तब यह required होता है।Type: string Example: https://blog.x.com/ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| media_creative_id required | उस मीडिया क्रिएटिव का संदर्भ, जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string Example: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
उदाहरण रिस्पॉन्स
Promoted Accounts
मौजूदा account के अंतर्गत एक या अधिक line item से जुड़े कुछ या सभी promoted account का विवरण प्राप्त करें। रिस्पॉन्स मेंuser_id से पहचाने गए user account का user data प्राप्त करने के लिए GET users/lookup का उपयोग करें।
अगर निर्दिष्ट line item में से कोई भी promoted account शामिल करने के लिए कॉन्फ़िगर नहीं किया गया है, तो HTTP 400 लौटाया जाएगा।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API request के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | हर अलग request में प्राप्त करने के लिए record की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| line_item_ids optional | comma-separated identifier की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट line item से जुड़े promoted account तक सीमित करता है। अधिकतम 200 ID दिए जा सकते हैं। Type: string Example: 9bpb2 |
| promoted_account_ids optional | comma-separated identifier की सूची देकर रिस्पॉन्स को केवल इच्छित promoted account तक सीमित करता है। अधिकतम 200 ID दिए जा सकते हैं। Type: string Example: 19pl2 |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपने request में deleted result शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह parameter और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन request में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| promoted_account_id required | उस promoted account का reference जिसके साथ आप request में काम कर रहे हैं। Type: string Example: 19pl2 |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
उदाहरण रिस्पॉन्स
user_id) को निर्दिष्ट line item से संबद्ध करें।
यदि निर्दिष्ट line item को Promoted Accounts के साथ संबद्ध होने के लिए कॉन्फ़िगर नहीं किया गया है, तो HTTP 400 INCOMPATIBLE_LINE_ITEM त्रुटि लौटाई जाएगी। यदि निर्दिष्ट उपयोगकर्ता प्रमोशन के लिए अयोग्य है, तो HTTP 400 लौटाया जाएगा और किसी भी उपयोगकर्ता को प्रमोट नहीं किया जाएगा। यदि दिया गया उपयोगकर्ता पहले से ही प्रमोट किया जा चुका है, तो अनुरोध को अनदेखा कर दिया जाएगा।
Promoted Accounts के बारे में अधिक जानकारी के लिए, हमारा campaign management पेज देखें।
नोट: Promoted Accounts एंटिटीज़ को अपडेट (PUT) करना संभव नहीं है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग में लिए जा रहे leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | उस line item का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। Type: string Example: 9bpb2 |
| user_id required | उस उपयोगकर्ता का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। स्क्रीन नाम के लिए उपयोगकर्ता ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long Example: 756201191646691328 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| promoted_account_id required | यह पहचानकर्ता किसी line item से संबद्ध Promoted Account के instance को संदर्भित करता है। Type: string Example: 19pl2 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
उदाहरण रिस्पॉन्स
प्रमोटेड Tweets
tweet_id मानों का उपयोग करें।
नोट: जब parent line items हटा दिए जाते हैं, तो promoted_tweets केवल तभी लौटाए जाते हैं जब अनुरोध में with_deleted=true निर्दिष्ट हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते ("deleted": false in the response).
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग में लाए जा रहे खाते की पहचान। यह resource path में दिखाई देती है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होती है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| line_item_ids optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट line items से संबद्ध Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 96uzp |
| promoted_tweet_ids optional | अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित promoted Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 1efwlo |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन अनुरोधों में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo
उदाहरण रिस्पॉन्स
with_deleted=true निर्दिष्ट किया गया हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते हैं ("deleted": false रिस्पॉन्स में)।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged अकाउंट का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| promoted_tweet_id required | उस promoted Tweet का रेफ़रंस, जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string Example: 1efwlo |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo
उदाहरण रिस्पॉन्स
PROMOTED_ACCOUNT product type का उपयोग करते समय, line_item के साथ किसी Tweet को संबद्ध करने पर मानक PROMOTED_ACCOUNT placement के अलावा mobile पर timeline placements भी जुड़ जाते हैं।
नोट: promoted Tweet entities को update (PUT) करना संभव नहीं है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 8v7jo |
| tweet_ids required | विशिष्ट Tweets से संबंधित identifiers की comma-separated सूची। अधिकतम 50 IDs दिए जा सकते हैं। Type: long Example: 822333526255120384 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API request के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| promoted_tweet_id required | यह identifier किसी line item से संबद्ध Promoted Tweet के instance को संदर्भित करता है। यह GET accounts/:account_id/promoted_tweets के किसी response item के id field से आता है, संबंधित Tweet के tweet_id से नहीं। इसे resource के path में दिया जाता है।Type: string Example: 1gp8a5 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5
उदाहरण रिस्पॉन्स
प्रचार-योग्य उपयोगकर्ता
FULL या RETWEETS_ONLY होता है। यह उस सामग्री के प्रकार को नियंत्रित करता है जिसे खाते द्वारा प्रमोट करने की अनुमति होती है। विज्ञापनदाताओं को किसी अन्य उपयोगकर्ता की सामग्री प्रमोट करने के लिए अनुमति प्राप्त करनी होती है और उन्हें अपने खाते में RETWEETS_ONLY प्रमोट किए जा सकने वाले उपयोगकर्ता के रूप में जोड़ने के लिए Twitter से संपर्क करना होता है।
यदि अनुमतियाँ सही तरीके से सेट हैं, तो आप promoted product endpoints पर ऐसे अनुरोध कर सकते हैं जो सीधे उस Tweet की Tweet ID को संदर्भित करते हैं जिसे आप प्रमोट करना चाहते हैं। आप प्रकाशित Tweets को प्रमोट करने के लिए POST accounts/:account_id/promoted-tweets endpoint का उपयोग कर सकते हैं और किसी अन्य Twitter Ads खाते के Scheduled Tweets को प्रमोट करने के लिए POST accounts/:account_id/scheduled-promoted-tweets endpoint का उपयोग कर सकते हैं।
आपको लक्षित Tweet को retweet करने की आवश्यकता नहीं है। जब आप इस तरीके से किसी Tweet को प्रमोट करते हैं, तो लौटाया गया tweet_id, प्रदान की गई Tweet ID से अलग होगा। पर्दे के पीछे, Tweet को nullcasted Tweet के रूप में retweet किया जाता है और फिर प्रमोट किया जाता है। लौटाया गया tweet_id इसी नए Tweet के अनुरूप होता है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promotable_users
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| promotable_user_ids optional | कॉमा से अलग की गई identifiers की सूची निर्दिष्ट करके रिस्पॉन्स को केवल इच्छित प्रमोट किए जा सकने वाले उपयोगकर्ताओं तक सीमित करें। अधिकतम 200 IDs प्रदान की जा सकती हैं। Type: string Example: l310s |
| 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/promotable_users?promotable_user_ids=l310s
उदाहरण रिस्पॉन्स
FULL या RETWEETS_ONLY होता है। यह उस सामग्री के type को नियंत्रित करता है जिसे account प्रमोट कर सकता है।
विज्ञापनदाताओं को किसी अन्य user की सामग्री को प्रमोट करने के लिए अनुमति प्राप्त करनी होगी। यदि अनुमतियाँ सही तरीके से सेट हैं, तो आप promoted product endpoints पर ऐसे अनुरोध कर सकते हैं जो सीधे उस Tweet की Tweet ID को संदर्भित करते हैं जिसे आप प्रमोट करना चाहते हैं।
आपको target Tweet को retweet करने की आवश्यकता नहीं है। जब आप इस तरीके से किसी Tweet को प्रमोट करते हैं, तो लौटाया गया tweet_id, दी गई Tweet ID से अलग होगा। पर्दे के पीछे, उस Tweet को nullcasted Tweet के रूप में retweet किया जाता है और फिर प्रमोट किया जाता है। लौटाया गया tweet_id इसी नए Tweet से संबंधित होता है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| promotable_user_id optional | उस प्रमोट किए जा सकने वाला उपयोगकर्ता का संदर्भ, जिस पर आप request के भीतर कार्य कर रहे हैं Type: string Example: l310s |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s
उदाहरण रिस्पॉन्स
पब्लिशर्स
https://ads-api.x.com/12/publishers
पैरामीटर
कोई अनुरोध पैरामीटर नहीं
उदाहरण अनुरोध
GET https://ads-api.x.com/12/publishers
उदाहरण रिस्पॉन्स
सिफारिशें
https://ads-api.x.com/5/accounts/:account_id/recommendations
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id अनिवार्य | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक अनिवार्य parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations
उदाहरण रिस्पॉन्स
https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक required parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| recommendation_id required | उस recommendation ID का reference जिस पर आप इस request में काम कर रहे हैं Type: string Example: 62ce8zza1q0w |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w
उदाहरण रिस्पॉन्स
शेड्यूल किए गए प्रमोटेड Tweet
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग किए जा रहे अकाउंट का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रति अनुरोध प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| line_item_ids optional | कॉमा से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल उन शेड्यूल किए गए Tweets तक सीमित करता है जो विशिष्ट line items से संबद्ध हैं। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8xdpe |
| scheduled_promoted_tweet_ids optional | कॉमा से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित शेड्यूल किए गए प्रमोटेड Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 1xboq |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| with_deleted optional | अनुरोध में हटाए गए परिणामों को शामिल करता है। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute को शामिल करता है।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन अनुरोधों में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग में लाए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आमतौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता ऑथेंटिकेट किए गए उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| scheduled_promoted_tweet_id required | उस शेड्यूल किए गए प्रमोटेड Tweet का संदर्भ, जिसका आप इस अनुरोध में उपयोग कर रहे हैं। प्रकार: string उदाहरण: 1xboq |
| with_deleted optional | अनुरोध में हटाए गए परिणामों को शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 8xdpe |
| scheduled_tweet_id required | request में जिस अनुसूचित Tweet पर आप काम कर रहे हैं, उसका reference। Type: long Example: 870358555227860992 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992
उदाहरण रिस्पॉन्स
scheduled_promoted_tweets को केवल scheduled Tweet के scheduled_at समय से पहले ही हटाया जा सकता है।
रिसोर्स URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| scheduled_promoted_tweet_id required | request में जिस scheduled promoted Tweet पर आप कार्य कर रहे हैं, उसका reference। यह GET accounts/:account_id/scheduled_promoted_tweets रिस्पॉन्स ऑब्जेक्ट का id attribute है।Type: string Example: 1xtfl |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl
उदाहरण रिस्पॉन्स
टार्गेटिंग मानदंड
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_ids required | comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट line items के अंतर्गत आने वाले टार्गेटिंग मानदंड तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8u94t |
| count optional | प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | results का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| lang optional | एक ISO-639-1 भाषा कोड। इसे पास करने पर, जिन objects के लिए localized name उपलब्ध है, उनके लिए रिस्पॉन्स में अतिरिक्त localized_name attribute लौटाया जाएगा।Type: string Example: fr |
| sort_by optional | समर्थित attribute के अनुसार ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| targeting_criterion_ids optional | comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित टार्गेटिंग मानदंड तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: dpl3a6 |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 निर्धारित हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | प्रयुक्त खाते का आइडेंटिफ़ायर। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| targeting_criterion_id required | उस टार्गेटिंग मानदंड का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: eijd4y |
| lang optional | एक ISO-639-1 भाषा कोड। इसे पास करने पर, उन ऑब्जेक्ट्स के लिए रिस्पॉन्स में अतिरिक्त localized_name attribute लौटाया जाएगा, जहाँ कोई localized नाम उपलब्ध हो।Type: string Example: fr |
| with_deleted optional | अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y
उदाहरण रिस्पॉन्स
targeting_value खोजने हेतु टार्गेटिंग विकल्प पेज देखें। हम अनुशंसा करते हैं कि आप सभी डेटा को हर सप्ताह रीफ़्रेश करें, ताकि आप targeting type मानों के नवीनतम सेट के साथ काम कर सकें। हम समय-समय पर मानों और उपलब्ध टार्गेटिंग मानदंड में बदलाव करते हैं; इनमें से अधिकांश बार-बार नहीं बदलते, लेकिन कुछ बदलते हैं। इस बात की कोई गारंटी नहीं है कि ये मान अपरिवर्तित रहेंगे।
targeting_value में निर्दिष्ट keywords के साथ BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, या UNORDERED_KEYWORD targeting type का उपयोग करें। keywords को बाहर रखने के लिए operator_type request parameter को NE पर सेट करें। प्रत्येक type का विस्तृत विवरण देखने के लिए targeting keyword types देखें।
नोट: प्रत्येक line item के लिए केवल एक age bucket को target करना संभव है।
नोट: किसी Custom Audience को target करने के लिए, उस audience का targetable होना ज़रूरी है। अर्थात, targerable का मान true होना चाहिए।
नोट: targeting type TV_SHOW का उपयोग करते समय, TV_SHOW targeting सेट करने से पहले line item पर कम-से-कम एक LOCATION टार्गेटिंग मानदंड होना चाहिए, और सभी LOCATION उसी locale के भीतर होने चाहिए जिस TV_SHOW को target किया जा रहा है।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria
पैरामीटर
| Name | Description |
|---|---|
| account_id required | प्रयुक्त account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 69ob |
| operator_type required | यह निर्दिष्ट करें कि टार्गेटिंग मानदंड का संबंध क्या होना चाहिए। उदाहरण के लिए, keywords को बाहर रखने के लिए operator_type=NE का उपयोग करें।Type: enum Possible values: EQ, NE, GTE, LT |
| targeting_type required | targeting का वह type जो इस line item पर लागू किया जाएगा। Possible non-keyword-based values include: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLYनोट: प्रत्येक line item के लिए केवल एक AGE bucket को target करना संभव है।Possible keyword-based values include: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORDPossible custom audience values include: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDEDPossible installed app store category values: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKEPossible Twitter Audience Platform (TAP) app exclusion: APP_LIST (operator_type=NE के साथ ही उपयोग किया जा सकता है) |
| targeting_value required | चयनित targeting_type के आधार पर यह निर्दिष्ट करें कि यह targeting किस user, किस interest, किस location, किस event, किस platform, किस platform version, किस device, किस keyword या phrase, किस gender, किस custom audience, किस app store category, या app list के किस exclusion पर लागू होगी। Type: string Example: 174958347 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology
उदाहरण रिस्पॉन्स
- वर्तमान में अधिकतम बैच आकार 500 है।
- सभी पैरामीटर रिक्वेस्ट बॉडी में भेजे जाते हैं, और
application/jsonकाContent-Typeआवश्यक है। - बैच रिक्वेस्ट समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि तथा सफलता दोनों ही स्थितियों में सभी API रिस्पॉन्स प्रारंभिक रिक्वेस्ट के आइटमों का क्रम बनाए रखते हैं।
- रिक्वेस्ट-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में
errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं। - आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक Targeting Criteria पैरामीटर का अनुपस्थित होना) रिस्पॉन्स में
operation_errorsऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria
पैरामीटर
| Name | Description |
|---|---|
| operation_type required | प्रति आइटम की जा रही operation type। Type: enum संभावित मान: Create, Delete |
| params required | एक JSON ऑब्जेक्ट, जिसमें टार्गेटिंग मानदंड ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक टार्गेटिंग मानदंड पैरामीटरों की सूची के लिए, यहाँ देखें। इसके अतिरिक्त, यह endpoint operator_type पैरामीटर को सपोर्ट करता है, जो कुछ targeting_type मानों के साथ मिलकर काम करता है। इस पैरामीटर के संभावित मान हैं: EQ (बराबर), GTE (बड़ा या बराबर), LT (कम), और NE (बराबर नहीं)। |
POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | उपयोग किए जा रहे खाते का पहचानकर्ता। यह संसाधन के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| targeting_criterion_id required | उस टार्गेटिंग मानदंड का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। Type: string Example: dpl3a6 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6
उदाहरण रिस्पॉन्स
टार्गेटिंग विकल्प
- ऐप स्टोर श्रेणियाँ
- वार्तालाप
- डिवाइस
- इवेंट
- रुचियाँ
- भाषाएँ
- स्थान
- नेटवर्क ऑपरेटर
- प्लेटफ़ॉर्म संस्करण
- प्लेटफ़ॉर्म
- टीवी बाज़ार
- टीवी शो
https://ads-api.x.com/12/targeting_criteria/app_store_categories
पैरामीटर
| Name | Description |
|---|---|
| q optional | टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: music |
| os_type optional | किसी विशिष्ट ऐप स्टोर के आधार पर परिणामों का दायरा सीमित करें। Type: enum Possible values: ANDROID, IOS |
GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/conversations
पैरामीटर
| Name | Description |
|---|---|
| conversation_type optional | किसी विशेष conversation type तक सीमित करने के लिए एक वैकल्पिक क्वेरी। Type: enum Possible values: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES |
| count optional | प्रत्येक अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/devices
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| q optional | टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: apple |
GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone
उदाहरण रिस्पॉन्स
start_time और end_time मान UTC±00:00 में दिखाए जाते हैं, चाहे इवेंट का locale और timezone कुछ भी हो। इवेंट start_time और end_time मानों को query करते समय और उनके साथ काम करते समय इस डिज़ाइन को ध्यान में रखें। उदाहरण के लिए, US के Independence Day को UTC±00:00 में start_time=2017-07-04T00:00:00Z और end_time=2017-07-05T00:00:00Z के रूप में दिखाया जाता है, जिससे US के भीतर कई timezones में इस अवकाश के होने से जुड़ी समस्या से बचा जा सके।
संसाधन URL
https://ads-api.x.com/12/targeting_criteria/events
पैरामीटर
| Name | Description |
|---|---|
| event_types required | कुछ विशेष इवेंट प्रकारों तक सीमित करने के लिए एक वैकल्पिक query। Type: enum Possible values: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS |
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| country_codes optional | 2-अक्षरीय ISO country code का उपयोग करके टार्गेटिंग मानदंड खोज को विशेष देशों तक सीमित करने के लिए एक वैकल्पिक query। यदि यह पैरामीटर निर्दिष्ट नहीं किया जाता है, तो सभी इवेंट लौटाए जाते हैं। Type: string |
| cursor optional | results का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| end_time optional | ISO 8601 में व्यक्त वह समय, जब campaign समाप्त होगा। Type: string Example: 2017-10-05T00:00:00Z |
| start_time optional | ISO 8601 में व्यक्त वह समय, जब line item serve होना शुरू करेगा। नोट: डिफ़ॉल्ट रूप से यह वर्तमान समय होता है। Type: string Example: 2017-07-05T00:00:00Z |
GET https://ads-api.x.com/12/targeting_criteria/events?count=1
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/interests
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | किसी टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: books |
GET https://ads-api.x.com/12/targeting_criteria/interests?q=books
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/languages
पैरामीटर
| नाम | विवरण |
|---|---|
| count optional | प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | टार्गेटिंग मानदंड को सीमित करने के लिए एक वैकल्पिक query। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: english |
GET https://ads-api.x.com/12/targeting_criteria/languages?q=english
उदाहरण रिस्पॉन्स
location_type request parameter के साथ CITIES enum का उपयोग करें।
Designated Market Areas (DMAs) को target करने के लिए, METROS enum का उपयोग करें।
संसाधन URL
https://ads-api.x.com/12/targeting_criteria/locations
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अलग request में प्राप्त करने के लिए प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| country_code optional | 2-अक्षरीय ISO country code के साथ targeting criteria search को किसी विशिष्ट देश तक सीमित करने के लिए एक वैकल्पिक query। सभी देशों के लिए results प्राप्त करने हेतु इस parameter को छोड़ दें। Type: string Example: JP |
| cursor optional | results का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| location_type optional | results को किसी विशिष्ट location प्रकार तक सीमित करें। COUNTRIES की तुलना में अधिक granular targeting सभी locations में उपलब्ध नहीं हो सकती।Type: enum Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES |
| q optional | targeting criteria search को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने हेतु इस parameter को छोड़ दें। Type: string Example: New York |
GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/network_operators
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| country_code optional | 2-अक्षरों वाले ISO country code के साथ टार्गेटिंग मानदंड search को किसी खास देश तक सीमित करने के लिए एक वैकल्पिक query। यदि यह parameter निर्दिष्ट नहीं किया जाता है, तो केवल United States के लिए partner audiences लौटाए जाते हैं। Type: string Default: US |
| cursor optional | results का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | टार्गेटिंग मानदंड search को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने के लिए इस parameter को छोड़ दें। Type: string Examples: Airpeak |
GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/platform_versions
पैरामीटर
| Name | Description |
|---|---|
| q वैकल्पिक | टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string उदाहरण: jelly bean |
GET https://ads-api.x.com/12/targeting_criteria/platform_versions
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/platforms
पैरामीटर
| Name | Description |
|---|---|
| count optional | प्रत्येक अलग-अलग अनुरोध में प्राप्त करने के लिए रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| q optional | टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक query। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Examples: ios, blackberry |
| lang optional | ISO-639-1 भाषा कोड का उपयोग करें। यह पास किए जाने पर, रिस्पॉन्स में एक अतिरिक्त localized_name attribute लौटाया जाएगा। Type: int, string Example: fr |
GET https://ads-api.x.com/12/targeting_criteria/platforms
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/targeting_criteria/tv_markets
पैरामीटर
कोई नहीं
उदाहरण अनुरोध
GET https://ads-api.x.com/12/targeting_criteria/tv_markets
उदाहरण रिस्पॉन्स
estimated_users का मान 1000 दिखाई देगा।
नोट: TV चैनल और शैली-आधारित टार्गेटिंग विकल्प अब समर्थित नहीं हैं।
संसाधन URL
https://ads-api.x.com/12/targeting_criteria/tv_shows
पैरामीटर
| Name | Description |
|---|---|
| locale required | यह एक आवश्यक पैरामीटर है, जो उपलब्ध TV शो के लिए क्वेरी किए जाने वाले tv_market_locale को निर्दिष्ट करता है। TV मार्केट की क्वेरी GET targeting_criteria/tv_markets से लौटाए गए locale के आधार पर की जाती है।Type: string Example: en-US |
| count optional | प्रत्येक अलग रिक्वेस्ट में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 50 Min, Max: 1, 50 |
| cursor optional | परिणामों का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| q optional | टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Examples: ios, blackberry |
GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1
उदाहरण रिस्पॉन्स
टार्गेटिंग सुझाव
https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग किए जा रहे account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| suggestion_type required | लौटाए जाने वाले सुझावों का type निर्दिष्ट करें। Type: enum Possible values: KEYWORD, USER_ID |
| targeting_values required | सुझाव तैयार करने के आधार के रूप में उपयोग किए जाने वाले कीवर्ड या user IDs का अल्पविराम-से-अलग किया गया संग्रह। नोट: इन दो प्रकार के सुझावों को एक साथ नहीं मिलाया जा सकता। Example: 756201191646691328 |
| count optional | प्रत्येक अलग अनुरोध के लिए प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 30 Min, Max: 1, 50 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"
उदाहरण रिस्पॉन्स
कर सेटिंग
https://ads-api.x.com/12/accounts/:account_id/tax_settings
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tax_settings
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id आवश्यक | उपयोग किए जा रहे खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t |
| address_city वैकल्पिक | खाता स्वामी के पते का शहर. Type: string उदाहरण: San Francisco |
| address_country वैकल्पिक | खाते के स्वामी के पते के लिए दो-अक्षरों का देश कोड। Type: string उदाहरण: US |
| address_email वैकल्पिक | खाता स्वामी के पते से संबद्ध ईमेल पता। Type: string उदाहरण: api@mctestface.com |
| address_first_name वैकल्पिक | खाता स्वामी के पते के लिए पहला नाम। Type: string उदाहरण: API |
| address_last_name वैकल्पिक | खाता स्वामी के पते के लिए अंतिम नाम। Type: string उदाहरण: McTestface |
| address_name वैकल्पिक | खाता स्वामी के पते के लिए कंपनी का नाम। Type: string उदाहरण: ABC, Co. |
| address_postal_code वैकल्पिक | खाता स्वामी के पते का पिन कोड। Type: string उदाहरण: 94102 |
| address_region वैकल्पिक | खाता स्वामी के पते का राज्य/क्षेत्र. Type: string उदाहरण: California |
| address_street1 वैकल्पिक | खाता स्वामी के पते की सड़क पंक्ति। Type: string उदाहरण: 21 March St |
| address_street2 वैकल्पिक | खाता स्वामी के पते की दूसरी पंक्ति। Type: string उदाहरण: Suite 99 |
| bill_to वैकल्पिक | वह इकाई जिसे शुल्क लगाया जाता है। Type: enum संभावित मान: ADVERTISER, AGENCY |
| business_relationship वैकल्पिक | क्या खाता विज्ञापनदाता के स्वामित्व में है या एजेंसी के स्वामित्व में। Type: enum संभावित मान: AGENCY, SELF |
| client_address_city वैकल्पिक | विज्ञापनदाता के पते का शहर। इसे तब सेट करें, जब ads खाता किसी agency के स्वामित्व में हो। Type: string उदाहरण: Toronto |
| client_address_country वैकल्पिक | विज्ञापनदाता के पते के लिए दो-अक्षरों का देश कोड। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: CA |
| client_address_email वैकल्पिक | विज्ञापनदाता के पते से संबद्ध ईमेल पता। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: ads@brand.com |
| client_address_first_name वैकल्पिक | विज्ञापनदाता के पते के लिए पहला नाम. इसे तब सेट करें, जब ads account किसी एजेंसी के स्वामित्व में हो. Type: string उदाहरण: Brand |
| client_address_last_name वैकल्पिक | विज्ञापनदाता के पते के लिए उपनाम। इसे तब सेट करें जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: Advertiser |
| client_address_name वैकल्पिक | विज्ञापनदाता के पते के लिए कंपनी का नाम। इसे तब सेट करें, जब ads खाता किसी एजेंसी के स्वामित्व में हो। Type: string उदाहरण: Brand, Inc. |
| client_address_postal_code वैकल्पिक | विज्ञापनदाता के पते का डाक कोड। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: M5H 2N2 |
| client_address_region वैकल्पिक | विज्ञापनदाता के पते का क्षेत्र. इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो. Type: string उदाहरण: Ontario |
| client_address_street1 वैकल्पिक | विज्ञापनदाता के पते की सड़क वाली पंक्ति। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: 280 Queen St W |
| client_address_street2 वैकल्पिक | विज्ञापनदाता के पते की दूसरी स्ट्रीट लाइन। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: The 6 |
| invoice_jurisdiction वैकल्पिक | चालान क्षेत्राधिकार. Type: enum संभावित मान: LOI_SAPIN, NONE, NOT_SET |
| tax_category वैकल्पिक | यह निर्धारित करता है कि कराधान व्यक्तिगत होगा या व्यावसायिक। प्रकार: enum संभावित मान: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL |
| tax_exemption_id वैकल्पिक | VAT छूट आईडी. प्रकार: sting उदाहरण: 12345 |
| tax_id वैकल्पिक | VAT पंजीकरण आईडी. प्रकार: string संभावित मान: 67890 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tracking_tags
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| count optional | प्रति अनुरोध प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow |
| line_item_ids optional | अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल उन ट्रैकिंग टैग तक सीमित करें जो विशिष्ट लाइन आइटम्स से संबद्ध हैं। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 96uzp |
| sort_by optional | समर्थित attribute के अनुसार आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc |
| tracking_tag_ids optional | अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित ट्रैकिंग टैग तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 3m82 |
| with_deleted optional | अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होती हैं, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account के लिए identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests में एक आवश्यक parameter होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tracking_tag_id required | उस ट्रैकिंग टैग का reference जिस पर आप request में काम कर रहे हैं। Type: string Example: 555j |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tracking_tags
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account की पहचान। यह रिसोर्स के path में दिखाई देती है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होती है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| line_item_id required | request में जिस लाइन आइटम के साथ आप काम कर रहे हैं, उसका एक reference। Type: string Example: 8v7jo |
| tracking_tag_type required | ट्रैकिंग टैग का type। Type: enum Possible value: IMPRESSION_TAG, CLICK_TRACKER |
| tracking_tag_url required | tracking partner द्वारा प्रदान किया गया ट्रैकिंग टैग URL। Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tracking_tag_url required | tracking partner द्वारा प्रदान किया गया ट्रैकिंग टैग URL। Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | उपयोग किए जा रहे leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| tracking_tag_id required | request में उपयोग किए जा रहे ट्रैकिंग टैग का reference। Type: string Example: 555j |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
उदाहरण रिस्पॉन्स
उपयोगकर्ता सेटिंग्स
https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता ऑथेंटिकेट किए गए उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| user_id required | उस उपयोगकर्ता का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। किसी स्क्रीन नाम के लिए उपयोगकर्ता ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long Example: 756201191646691328 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328
उदाहरण रिस्पॉन्स
https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged account का आइडेंटिफ़ायर। यह रिसोर्स के path और GET accounts में दिखाई देता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| user_id required | उस उपयोगकर्ता का संदर्भ, जिसके साथ आप request में काम कर रहे हैं। किसी screen name के लिए user ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long उदाहरण: 756201191646691328 |
| notification_email optional | account सूचनाओं के लिए इस्तेमाल किया जाने वाला ईमेल। Type: string उदाहरण: user@domain.com |
| contact_phone optional | संपर्क फ़ोन नंबर। Type: string उदाहरण: 202-555-0128 |
| contact_phone_extension optional | contact_phone संपर्क नंबर के लिए एक्सटेंशन। Type: string उदाहरण: 1234 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"
रिस्पॉन्स का उदाहरण