चरण-दर-चरण मार्गदर्शिका

Ads API का एक्सेस कैसे प्राप्त करें

1. डेवलपर खाता के लिए साइन अप करें।
2. एक डेवलपर ऐप बनाएं और अपने टोकन को सुरक्षित रखें।
3. अपने प्रत्येक डेवलपर ऐप के लिए Ads API पहुँच का अनुरोध भेजने हेतु ads.x.com/help पर जाएं।

नोट: अगर आप पहले से ही X Developer Platform पर काम कर रहे हैं और आपके पास डेवलपर खाता है, तो सीधे तीसरे चरण पर जाएं।

चरण एक: डेवलपर खाते के लिए साइन अप करें

X के किसी भी API उत्पाद को अनुरोध भेजने के लिए, आपको पहले एक डेवलपर खाते के लिए साइन अप करना होगा। डेवलपर कंसोल में एक ऐप और डेवलपर ऐप बनाएं। इससे आपको क्रेडेंशियल्स का एक सेट मिलेगा, जिसका उपयोग आप API को भेजे जाने वाले सभी अनुरोधों को प्रमाणित करने के लिए करेंगे।

चरण दो: अपने ऐप की keys और tokens सहेजें और उन्हें सुरक्षित रखें

अपने डेवलपर ऐप में आपको API Keys (जिन्हें Consumer Keys भी कहा जाता है) का एक सेट दिया जाएगा। आपको Access Tokens का एक सेट जनरेट करने का विकल्प भी मिलेगा, जिनका उपयोग आपके व्यक्तिगत X खाते की ओर से अनुरोध करने के लिए किया जा सकता है। साथ ही, आपको एक बेयरर टोकन भी मिलेगा, जिसका उपयोग उन endpoints को प्रमाणित करने के लिए किया जा सकता है जिनके लिए OAuth 2.0 Bearer Token आवश्यक है। चूंकि ये keys और tokens दोबारा जनरेट किए जाने तक समाप्त नहीं होते, इसलिए हम सलाह देते हैं कि आप environment variables बनाएं या किसी सुरक्षित password manager का उपयोग करें।

कृपया अपने ऐप ID को भी नोट कर लें, जो आपके ऐप के details की URL में मिल सकती है। इससे अगले चरण में Ads API का access अनुरोध करना आसान हो जाएगा।

नोट: आपकी keys और tokens डेवलपर कंसोल में केवल एक बार दिखाई देंगी, इसलिए यह ज़रूरी है कि आप इन्हें जनरेट करते ही अपने password management system में सुरक्षित रूप से सहेज लें।

यदि आपकी keys और tokens खो जाएं या आप उन्हें भूल जाएं, तो आपको उन्हें फिर से जनरेट करना होगा। इससे नई keys और tokens बनेंगे और पुराने अमान्य हो जाएंगे। इसका मतलब है कि आपको उन सभी integrations को अपडेट करना होगा जिन्हें आपने अपने पुराने credentials के साथ सेट अप किया है।

हमारी authentication best practices के बारे में और जानें।

चरण तीन: Ads API तक पहुँच के लिए आवेदन करें

इस चरण पर आपके पास X API की बुनियादी पहुँच होगी, लेकिन X Ads API की विशिष्ट सुविधाएँ उपलब्ध नहीं होंगी। इसके बाद, आपको पहुँच का अनुरोध करना होगा और Ads API पहुँच के लिए स्वीकृति लेनी होगी। अपने प्रत्येक डेवलपर ऐप के लिए Ads API पहुँच का अनुरोध सबमिट करने हेतु ads.x.com/help पर जाएँ।

एक्सेस स्तर

आवेदन प्रक्रिया के तहत, आपको यह बताना होगा कि आपको किस स्तर की एक्सेस चाहिए। ऐप-स्तरीय और Ad Account-स्तरीय अनुमतियों के बारे में अधिक जानें।

केवल Conversion

Mobile और Web Conversion endpoints के लिए read & write access.

मानक एक्सेस

Analytics, Campaign Management, Creatives, Custom Audiences, और Conversion endpoints के लिए पढ़ने और लिखने की अनुमति के साथ एक्सेस।

नोट: Ads API पहुँच के लिए आपके ऐप के स्वीकृत होने के बाद, ठीक तरह से authenticated Ads API requests करने के लिए आपको किसी भी user access tokens को फिर से जनरेट करना होगा।

नोट: जिन Ads API developers ने जुलाई 2023 से पहले एक्सेस का अनुरोध किया था, उनके एक्सेस और permissions के स्तर अलग हो सकते हैं, और वे पाँच OAuth tokens तक सीमित हो सकते हैं। अतिरिक्त endpoints का एक्सेस पाने या मौजूदा applications के लिए token limits हटाने के लिए एक्सेस बढ़ाने पर हमारी गाइड देखें।

अपना पहला अनुरोध करें

Ads API तक अपनी पहुँच जाँचने के लिए GET accounts endpoint पर एक अनुरोध करें। यह endpoint उन ad accounts को लौटाता है, जिन तक वर्तमान में अधिकृत उपयोगकर्ता की पहुँच है। किसी खास ad account के लिए डेटा पढ़ने और लिखने हेतु, बाद के API अनुरोधों में इस अनुरोध से प्राप्त ad account IDs का उपयोग करें। कमांड लाइन पर Twurl का उपयोग करने पर यह अनुरोध कुछ इस तरह दिखाई देगा।

उदाहरण अनुरोध

twurl -H ads-api.x.com "/11/accounts"

उदाहरण प्रतिक्रिया

{
  "request": {
    "params": {}
  },
  "data": [
   {
    "name": "Furni",
    "business_name": null,
    "timezone": "America/Los_Angeles",
    "timezone_switch_at": "2016-04-06T07:00:00Z",
    "id": "18ce54ayf0z",
    "created_at": "2016-04-07T14:40:15Z",
    "salt": "b88939e5cabbca720159cb3659d73c06",
    "updated_at": "2017-02-08T08:49:53Z",
    "business_id": null,
    "approval_status": "ACCEPTED",
    "deleted": false
     }
   ]
}

आगे क्या है …

• Ads API दस्तावेज़ की बुनियादी बातें पढ़ें, जैसे वर्ज़निंग और हाइरार्की।
• अपने Ads API इंटीग्रेशन में मदद के लिए उपलब्ध विभिन्न Ads API tools & libraries देखें।
• Ads API पहुँच बढ़ाने के चरणों को समझें।
• उपलब्ध सहायता संसाधनों के बारे में जानें।
• API में बदलावों, सेवा संबंधी समस्याओं, और X के प्रमोटेड प्रोडक्ट्स में सुधारों के लाइव अपडेट के लिए @API को फ़ॉलो करें।