कन्वर्ज़न API सेट अप
पूर्व-आवश्यकताएँ
Ads API एक्सेस - नए ऐप्लिकेशन
- Conversion API के लिए मुख्य आवश्यकता एक डेवलपर खाता और Ads API एक्सेस होना है। इसकी प्रक्रिया Ads API Getting Started गाइड में दी गई है। कृपया निम्नलिखित बातों पर ध्यान दें:
- डेवलपर खाता के लिए आवेदन करते समय, तुरंत स्वीकृति पाने के लिए हमारी सदस्यता plans में से किसी एक को चुनें।
- नोट: सर्वोत्तम अभ्यास के तौर पर, हम दृढ़ता से सलाह देते हैं कि डेवलपर खाता बनाने और Ads API एक्सेस के लिए आवेदन करने हेतु आप अपनी कंपनी के आधिकारिक X handle का उपयोग करें। यदि डेवलपर खाता किसी डेवलपर handle से जुड़ा है, तो आवश्यकता पड़ने पर उन credentials को ट्रांसफ़र करने का कोई तरीका नहीं है। बेहतर होगा कि इसे निरंतर प्रबंधन के लिए कंपनी खाते के अंतर्गत रखा जाए और आवश्यकता अनुसार Multi-user login का उपयोग किया जाए। अन्यथा, कम से कम खाते को non-default settings (header image, avatar, bio description, और bio URL) के साथ सेट अप किया जाना चाहिए और Two-Factor Authentication का उपयोग होना चाहिए।
- सुनिश्चित करें कि आपके Ads API Application के लिए सही App ID तैयार हो। App ID, डेवलपर कंसोल में Projects & Apps के अंतर्गत मिल सकती है। उदाहरण: 16489123
- अपने X प्रतिनिधि से संपर्क करके Ads API एक्सेस का अनुरोध करें।
Ads API एक्सेस - मौजूदा ऐप्स
- यदि आपके पास पहले से सक्रिय रूप से उपयोग में लाई जा रही कोई Ads API ऐप है, तो उस ऐप और मौजूदा access tokens, दोनों का उपयोग Conversion API के लिए किया जा सकता है।
एक्सेस टोकन
- Ads API ऐप के स्वामी उपयोगकर्ता हैंडल के लिए User Access Tokens सीधे डेवलपर कंसोल से जनरेट और प्राप्त किए जा सकते हैं। इसे आपका “personal access token” कहा जाता है, क्योंकि इसका उपयोग आपके अपने X हैंडल के लिए किया जाना होता है। प्रमाणीकरण और डेवलपर कंसोल के बारे में सामान्य जानकारी यहाँ उपलब्ध है।
- Ads API ऐप के स्वामी हैंडल के अलावा अन्य उपयोगकर्ता हैंडल के लिए User Access Tokens, 3-legged OAuth flow का उपयोग करके जनरेट किए जाने चाहिए। 3-legged OAuth के साथ Access Token जनरेट करने के विकल्पों में शामिल हैं:
- Conversion API के साथ उपयोग किए जाने वाले किसी भी user token ऐसे उपयोगकर्ताओं के लिए होने चाहिए जिनके पास AD_MANAGER या ACCOUNT_ADMIN access level हो। इसे authenticated_user_access endpoint के माध्यम से जाँचा जा सकता है।
- नोट: टोकन स्वयं (ऊपर बताए अनुसार बनाए जाने के बाद) उपयोग के लिए ऐसे उपयोगकर्ताओं के साथ साझा किए जा सकते हैं जिनके पास AD_MANAGER या ACCOUNT_ADMIN access level नहीं है।
चरण
Conversion API इवेंट बनाना
विकल्प 1: Ads Manager में किसी मौजूदा Conversion Event का उपयोग करना
conversion_id के रूप में)। अधिक जानकारी के लिए section d. Testing Events and Deduplication देखें।
विकल्प 2: Ads Manager में नया Conversion Event बनाना:
- ads.x.com पर जाएँ
- ऊपर बाईं ओर Tools सेक्शन में जाएँ और Events Manager पर क्लिक करें
- ऊपर दाईं ओर Add event source चुनें, अगर आपके बाएँ साइडबार में अभी तक X pixel event source नहीं है
- X pixel event source की ID आपकी Pixel ID है
- X pixel event source के अंदर, दाईं ओर Add events चुनें
- Conversion API के साथ Install चुनें
- आपको इस event की Pixel ID और Event ID दिखाई देंगी, जिनका उपयोग API में किया जाएगा
- event की ID आपकी Event ID है
- Save पर क्लिक करें, और आपका conversion event बन जाएगा तथा उपयोग के लिए तैयार होगा
कन्वर्ज़न ईवेंट के लिए पहचानकर्ता तैयार करना
twclid), ईमेल पता या फ़ोन नंबर। यदि आप IP पता या user agent का उपयोग कर रहे हैं, तो सही कन्वर्ज़न मिलान के लिए दूसरा पहचानकर्ता भी भेजना होगा।
ज़्यादा पहचानकर्ता भेजने से कन्वर्ज़न मिलान दर बेहतर होती है।
| ग्राहक मिलान फ़ील्ड | फ़ॉर्मैट | हैशिंग आवश्यक है? |
| X Click ID | X द्वारा जनरेट किया गया (और जानें) | नहीं |
| ईमेल पता | शुरुआत और अंत के रिक्त स्थान हटाएँ | आवश्यक (SHA256) |
| फ़ोन नंबर | E164 Standard | आवश्यक (SHA256) |
| IP पता | शुरुआत और अंत के रिक्त स्थान हटाएँ | नहीं |
| User Agent | शुरुआत और अंत के रिक्त स्थान हटाएँ | नहीं |
1. X Click ID पहचानकर्ता तैयार करें
twclid क्वेरी स्ट्रिंग पैरामीटर उपलब्ध हो, तो उससे Click ID पार्स किया जाना चाहिए।
बुनियादी JavaScript कोड उदाहरण:
-
जब भी URL क्वेरी पैरामीटर में
twclidमान मौजूद हो, उसे हमेशा पार्स करें। - डेटा को संबंधित फ़ॉर्म फ़ील्ड्स या conversion event की जानकारी के साथ संग्रहीत करें।
2. ईमेल पहचानकर्ता तैयार करें
3. फ़ोन पहचानकर्ता तैयार करें
4. IP Address पहचानकर्ता तैयार करें
5. यूज़र एजेंट पहचानकर्ता तैयार करें
कन्वर्ज़न इवेंट अनुरोध तैयार करना
POST: version/measurement/conversions/:pixel_id
किसी विशेष विज्ञापन खाते के लिए कन्वर्ज़न इवेंट भेजें। सफलता सुनिश्चित करने के लिए रिस्पॉन्स कोड (HTTP 200 OK) की जांच करें। यह अनुशंसा की जाती है कि त्रुटि कोड लौटने की स्थिति में पुनः प्रयास की व्यवस्था और बुनियादी लॉगिंग मौजूद हो।
एंडपॉइंट के URL और POST बॉडी पैरामीटर के बारे में विस्तृत जानकारी के लिए, कृपया API संदर्भ अनुभाग देखें।
उदाहरण अनुरोध (पठनीयता के लिए स्वरूपित)
उदाहरण रिस्पॉन्स
रेट लिमिट
- हर इवेंट के लिए सही कन्वर्ज़न डेटा भेजने हेतु उपयोगकर्ता कार्रवाइयों का इंस्ट्रूमेंटेशन (लॉगिंग)
- उन उपयोगकर्ताओं के कन्वर्ज़न इवेंट्स को फ़िल्टर करने के लिए आवश्यक लॉजिक, जिन्होंने संबंधित गोपनीयता विकल्प चुने हैं - उदाहरण के लिए, अगर उन्होंने विज्ञापनदाता की वेबसाइट पर ट्रैकिंग या अपनी व्यक्तिगत जानकारी की बिक्री से बाहर निकलने का विकल्प चुना है
- इवेंट्स को कैप्चर करने और कन्वर्ज़न भेजने के लिए इवेंट ट्रिगर्स और पेजों के साथ इंटीग्रेशन
इवेंट्स का परीक्षण और डीडुप्लिकेशन
इवेंट का परीक्षण
- Ads Manager data export (Website Conversion Tracking के लिए Analytics सहायता पेज)
- Ads API के ज़रिए data export करना (segmentation_type=CONVERSION_TAGS)
Pixel और Conversion API के बीच डुप्लिकेशन
कन्वर्ज़न ट्रैकिंग (अवलोकन)
सारांश
- साइट विज़िट: उपयोगकर्ता विज्ञापनदाता की साइट पर किसी लैंडिंग पेज पर जाता है
- खरीदारी: उपयोगकर्ता विज्ञापनदाता की साइट पर किसी उत्पाद या सेवा की खरीद पूरी करता है
- डाउनलोड: उपयोगकर्ता विज्ञापनदाता की साइट से कोई फ़ाइल, जैसे श्वेतपत्र या सॉफ़्टवेयर पैकेज, डाउनलोड करता है
- साइन अप: उपयोगकर्ता विज्ञापनदाता की सेवा, न्यूज़लेटर या ईमेल संचार के लिए साइन अप करता है
- कस्टम: यह ऐसी कस्टम कार्रवाई के लिए एक व्यापक श्रेणी है, जो ऊपर दी गई श्रेणियों में से किसी में नहीं आती
अक्सर पूछे जाने वाले प्रश्न
कन्वर्ज़न ट्रैकिंग टैग कैसे काम करता है?
कन्वर्ज़न ट्रैकिंग टैग कैसे काम करता है?
सबसे पहले, कोई विज्ञापनदाता एक कन्वर्ज़न टैग बनाता है, जो X द्वारा दिया गया कोड का एक स्निपेट होता है, और उसे अपनी वेबसाइट पर जोड़ता है। इसके बाद, जब कोई उपयोगकर्ता दी गई कार्रवाई पूरी करता है, तो यह टैग कन्वर्ज़न मापने के लिए तैयार हो जाता है।इसके बाद उपयोगकर्ताओं को X क्लाइंट पर विज्ञापनदाता का विज्ञापन दिखाया जाता है, जो उन्हें विज्ञापनदाता की वेबसाइट और उस कार्रवाई तक ले जाता है जिसे टैग किया गया है। अगर उपयोगकर्ता टैग सेटअप के दौरान विज्ञापनदाता द्वारा निर्दिष्ट एट्रिब्यूशन विंडो के भीतर वह कार्रवाई पूरी करता है, तो टैग पहचान लेता है कि उपयोगकर्ता ने पहले X विज्ञापन के साथ इंटरैक्ट किया था। इसके बाद टैग “fire” होता है, यानी X के सर्वरों को एक सूचना भेजता है, ताकि उस विज्ञापन को कन्वर्ज़न का श्रेय दिया जा सके जिसने कन्वर्ज़न उत्पन्न किया।
क्या campaign setup प्रक्रिया के भीतर ऐसा कोई तरीका है जो उपयोगकर्ता को यह चुनने देता हो कि उस campaign के लिए कौन-से tracking pixels प्रासंगिक हैं?
क्या campaign setup प्रक्रिया के भीतर ऐसा कोई तरीका है जो उपयोगकर्ता को यह चुनने देता हो कि उस campaign के लिए कौन-से tracking pixels प्रासंगिक हैं?
नहीं, हमारा product इस तरह से सेट नहीं किया गया है कि specific conversion tags को specific campaigns से जोड़ा जा सके। इसके बजाय, एक बार टैग सेट हो जाने पर, system अपने-आप यह ट्रैक करता है कि किस विज्ञापन ने किसी खास टैग पर कन्वर्ज़न लाए।
कन्वर्ज़न टैग्स के लिए हमारी default attribution window settings क्या हैं?
कन्वर्ज़न टैग्स के लिए हमारी default attribution window settings क्या हैं?
Default post-view attribution window: 1 दिनDefault post-engagement attribution: 14 दिनइन defaults को conversion tag setup के दौरान या tag बन जाने के बाद किसी भी समय बदला जा सकता है। post-engagement attribution windows के विकल्प 1, 7, 14, 30, 60, और 90 दिन हैं। post-view attribution windows के विकल्प none, 1, 7, 14, 30, 60, और 90 दिन हैं।
प्रभावी DR creatives और strategies के लिए कुछ ऐसे विचार क्या हैं जो प्रभावी रूप से conversions बढ़ाएँ?
प्रभावी DR creatives और strategies के लिए कुछ ऐसे विचार क्या हैं जो प्रभावी रूप से conversions बढ़ाएँ?
हालाँकि हर client के लक्ष्य, स्थिति, और रणनीतियाँ अलग होती हैं, यहाँ कुछ विचार दिए गए हैं जो उन clients के लिए कारगर रहे जिन्होंने conversion tracking alpha या beta में भाग लिया:Creative:
- ऑफ़र: कार्रवाई में अधिक रुचि पैदा करने के लिए Promoted Tweet के साथ discount, promotion, या free shipping offer जोड़ें
- Sweepstakes और contests: खास तौर पर प्रसिद्ध brands के लिए, sweepstakes और contests ने conversions बढ़ाए
- Tweet copy experimentation: सभी अक्षर बड़े लिखने बनाम छोटे अक्षरों में लिखने का परीक्षण (FREE बनाम free या NOW बनाम now)
- समय-सीमाएँ: लोगों को तुरंत कार्रवाई करने के लिए प्रोत्साहित करने हेतु एक अंतिम तिथि दें (Offer Expires December 12!)
- आकर्षक फ़ोटो जोड़ना: यह जाँचना उपयोगी है कि Tweet creative में दृश्य रूप से आकर्षक फ़ोटो conversions बढ़ाने में प्रभावी हैं या नहीं; नतीजे अलग-अलग हो सकते हैं या client offering के अनुसार विशिष्ट हो सकते हैं।
- @handle targeting और interest category targeting: Tweet copy और @handles का Tweet की इच्छित audience के साथ करीबी मेल conversions बढ़ाने में सहायक रहा
- niche लेकिन high volume keywords का उपयोग: concert space में, artist/musician से जुड़े keywords (जैसे उनका नाम) का उपयोग प्रभावी साबित हुआ।
- Tailored audiences: जिन clients ने TA web और conversion tracking का एक साथ उपयोग किया, उन्होंने अन्य targeting का उपयोग करने वाले control groups की तुलना में कम CPAs हासिल किए
Conversion API के लिए समस्या निवारण और सहायता
त्रुटि प्रबंधन और व्याख्या
X Ads API त्रुटि कोड का अवलोकन
जब HTTP कोड 400-सीरीज़ का हो, तो सामान्य स्थितियाँ ये हैं
- 400 Bad Request (अनुरोध मानकों के अनुरूप नहीं है)
- 401 Unauthorized (प्रमाणीकरण संबंधी समस्याएँ)
- 403 Forbidden (उस डेवलपर खाते से जुड़ी API ऐक्सेस समस्याएँ)
- 404 Not Found (हो सकता है कि एंडपॉइंट के लिए URL या params सही न हों)
Conversion API के त्रुटि कोड
400 Bad Request की स्थितियाँ
| कारण | Type | त्रुटि संदेश |
|---|---|---|
| पहचानकर्ता अनुपस्थित होने की त्रुटि (वर्तमान में hashed email या X click ID - twclid) | 400 Bad Request | कम से कम एक उपयोगकर्ता पहचानकर्ता प्रदान किया जाना चाहिए |
| अमान्य hashed email | 400 Bad Request | Hashed_email मान्य SHA-256 hash नहीं है |
| event_id का type एकल event tag (SET) नहीं है | 400 Bad Request | Event_id (<event_id>) एकल event tag (SET) नहीं है |
| अनुरोधित conversion events सीमा से अधिक हैं (वर्तमान में प्रति अनुरोध 500 events) | 400 Bad Request | Conversion count सीमा 500 है |
| Event ID अनुपस्थित है | 400 Bad Request | Event ID नहीं मिला |
JSON त्रुटि कोड का उदाहरण
अनुरोध:
POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"o6dkt", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
त्रुटि संदेश:
{"errors":[{"code":"INVALID_PARAMETER","message":"event_id (o6dkt) is not a single event tag (SET)","parameter":"event_id"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
अनुरोध:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"o6dl3", "identifiers": [{"twclid": ""}]}]}' --header 'Content-Type: application/json'
त्रुटि संदेश:
{"errors":[{"code":"INVALID_PARAMETER","message":"At least one user identifier must be provided","parameter":""}],"request":{"params":{"account_id":"18ce552mlaq"}}}
अनुरोध:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"o6dl3", "identifiers": [{"hashed_email": "abc"}]}]}' --header 'Content-Type: application/json'
त्रुटि संदेश:
{"errors":[{"code":"INVALID_PARAMETER","message":"hashed_email (abc) is not a valid SHA-256 hash","parameter":"hashed_email"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
अनुरोध:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603", "event_id":"o6dl3", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
त्रुटि संदेश:
{"errors":[{"code":"INVALID_PARAMETER","message":"Expected Time in yyyy-MM-ddTHH:mm:ss.SSSZ, got \"2022-06-16T01:14:00.603\" for conversion_time","parameter":"conversion_time"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
कारण: प्रमाणीकरण क्रेडेंशियल मौजूद नहीं हैं या गलत हैं
समाधान: 3 प्रमाणीकरण विधियों में से किसी एक का उपयोग करके Set Up दस्तावेज़ में दिए गए प्रमाणीकरण चरणों का पालन करें:
Ads API ऐप के स्वामी वाले हैंडल के अलावा अन्य उपयोगकर्ता हैंडल के लिए User Access Tokens, 3-legged OAuth flow का उपयोग करके जनरेट किए जाने चाहिए. 3-legged OAuth के साथ Access Token जनरेट करने के विकल्पों में शामिल हैं
- twurl utility के माध्यम से वेब-आधारित ऑथराइज़ेशन के साथ Command Line
- PIN-आधारित ऑथराइज़ेशन के साथ Command Line
- 3-legged OAuth pattern को लागू करने वाला कस्टम web flow
403 एक्सेस निषिद्ध
| कारण | type | त्रुटि संदेश |
|---|---|---|
| आप जिस डेवलपर खाते का उपयोग कर रहे हैं, उसके पास Ads API का एक्सेस नहीं है। एक्सेस के लिए यहाँ आवेदन करें. | 403 अनधिकृत Client | यह अनुरोध करने वाले id <> वाले क्लाइंट ऐप्लिकेशन के पास X Ads API का एक्सेस नहीं है। सुनिश्चित करें कि आपके ऐप्लिकेशन के पास advertiser-api access हो। आप जिस ऐप्लिकेशन का उपयोग कर रहे हैं उसे बदलने के लिए ‘twurl accounts’ और ‘twurl set default <username> <key>’ का उपयोग करें। |
404 Not Found
| कारण | type | त्रुटि संदेश |
|---|---|---|
| एंडपॉइंट के लिए अनुरोध URL या params सही नहीं हैं | 404 Route Not Found | The requested resource could not be found |
| आपके पास उस खाते की पहुँच नहीं है, जिसका pixel_id/Universal website tag है | 404 Not Found | User <user_id> does not have access to account <account_id>. Type ‘sn <user_id>’ to get the handle of the user. Use ‘twurl accounts’ and ‘twurl set default \u003Cusername\u003E’ to change the user you’re using. |
| event id, pixel ID (UWT ID) से जुड़े दिए गए खाते का हिस्सा नहीं है | 404 Not Found | event_id <event_id> does not belong to provided account |
JSON त्रुटि कोड का उदाहरण
अनुरोध:
twurl_ads -X POST '/11/measurement/conversions/o8z6j' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"abc", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
त्रुटि संदेश:
{"errors":[{"code":"NOT_FOUND","message":"event_id (abc) does not belong to provided account","parameter":"event_id"},{"code":"INVALID_PARAMETER","message":"event_id (abc) is not a single event tag (SET)","parameter":"event_id"}],"request":{"params":{"account_id":"18ce55gze09"}}}
API संदर्भ सूचकांक
वेब कन्वर्ज़न
| कन्वर्ज़न API | measurement/conversions/:pixel_id |
| वेब इवेंट टैग | accounts/:account_id/web_event_tags |
वेब कन्वर्ज़न
POST version/measurement/conversions/:pixel_id
एक Event Tag ID के लिए वेबसाइट कन्वर्ज़न इवेंट भेजें।
सफलता सुनिश्चित करने के लिए रिस्पॉन्स कोड (HTTP 200 OK) की जाँच करें। यदि त्रुटि कोड लौटें, तो पुनःप्रयास की व्यवस्था और बुनियादी लॉगिंग रखना अनुशंसित है।
रेट लिमिट प्रति खाते 15 मिनट के अंतराल में 100,000 अनुरोध है (प्रत्येक अनुरोध में 500 इवेंट की अनुमति है)।
संसाधन URL
https://ads-api.x.com/12/measurement/conversions/:pixel_id
अनुरोध URL पैरामीटर
| Name | Description |
|---|---|
| pixel_id required | किसी विज्ञापन खाते की Base Tag ID। यह किसी विज्ञापन खाते की Base Tag ID के लिए base36-एन्कोड किया गया मान दर्शाता है। Type: string Example: o8z6j |
| conversions required | API अनुरोध की POST body में मौजूद ऑब्जेक्ट। यह रूपांतरण ईवेंट्स की सूची है। अधिकतम 500 रूपांतरण ईवेंट्स दिए जा सकते हैं। समर्थित फ़ील्ड्स के लिए नीचे दी गई तालिका देखें। Type: array Example: "conversions":[{"conversion_time": "2022-02-18T01:14:00.603Z", "event_id":"o87ne", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}], "conversion_id": "23294827"}] |
conversions ऑब्जेक्ट
| नाम | विवरण |
|---|---|
| conversion_time required | ISO 8601 में व्यक्त समय। Type: string Example: 2017-10-05T00:00:00Z |
| event_id required | किसी विशिष्ट इवेंट का base-36 ID। यह इस ad account में शामिल पहले से कॉन्फ़िगर किए गए इवेंट से मेल खाता है। Events Manager में संबंधित इवेंट में इसे ID कहा जाता है। Type: string Example: o87ne or tw-o8z6j-o87ne (tw-pixel_id-event-id) both accepted |
| identifiers required | conversion इवेंट का मिलान करने के लिए identifier ऑब्जेक्ट्स की एक सूची। समर्थित फ़ील्ड्स नीचे दी गई तालिका में सूचीबद्ध हैं। कम से कम एक identifier ऑब्जेक्ट आवश्यक है। यदि IP address या user agent का उपयोग किया जा रहा है, तो सही conversion मिलान के लिए दूसरा identifier भेजना आवश्यक है। Type: array Example: "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"},{"hashed_email": "e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8"}] |
| number_items optional | इवेंट में खरीदी जा रही वस्तुओं की संख्या। यह शून्य से बड़ी धनात्मक संख्या होनी चाहिए। Type: integer Example: 4 |
| price_currency optional | इवेंट में खरीदी जा रही वस्तुओं की मुद्रा, जिसे ISO-4217 में व्यक्त किया जाता है। विस्तृत जानकारी के लिए Currency देखें। Type: string Default: USDExample: JPY |
| value optional | इवेंट में खरीदी जा रही वस्तुओं का मूल्य, जिसे price_currency मुद्रा में दर्शाया गया है।Type: double Example: 100.00 |
| conversion_id optional | pixel और Conversion API conversions के बीच deduplication के लिए। conversion इवेंट का एक identifier, जिसका उपयोग same event tag में Web Pixel और Conversion API conversions के बीच de-duplication के लिए किया जा सकता है। अधिक जानकारी के लिए Conversions Guide के Testing Events and Deduplication अनुभाग को देखें। Type: string Example: 23294827 |
| description optional | conversions से संबंधित किसी भी अतिरिक्त जानकारी का विवरण। Type: string Example: test conversion |
| contents optional | अधिक विस्तृत जानकारी देने के लिए किसी विशिष्ट product/content से संबंधित विवरणों की सूची। समर्थित फ़ील्ड्स के लिए नीचे दी गई तालिका देखें। Type: array Example: contents": [{"content_id": "1", "content_name": "Blankets", "content_type": "home improvement", "content_price": 100.99, "num_items": 1, "content_group_id": "123"}, {"content_id": "2"}] |
identifiers ऑब्जेक्ट
| नाम | विवरण |
|---|---|
| twclid कभी-कभी आवश्यक | क्लिक-थ्रू URL से पार्स किया गया Click ID। यदि कोई अन्य पहचानकर्ता नहीं जोड़ा गया है, तो यह आवश्यक है। Type: string उदाहरण: 26l6412g5p4iyj65a2oic2ayg2 |
| hashed_email कभी-कभी आवश्यक | SHA256 से हैश किया गया ईमेल पता। हैश करने से पहले टेक्स्ट लोअरकेस में होना चाहिए और शुरुआत या अंत के सभी स्पेस हटा देने चाहिए। यदि कोई अन्य पहचानकर्ता नहीं जोड़ा गया है, तो यह आवश्यक है। Type: string उदाहरण: test-email@test.com के लिए = e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8 |
| hashed_phone_number कभी-कभी आवश्यक | E164 फ़ॉर्मैट में फ़ोन नंबर, जिसे SHA256 से हैश किया गया हो। हैश करने से पहले फ़ोन नंबर E164 फ़ॉर्मैट में होना चाहिए। यदि कोई अन्य पहचानकर्ता नहीं जोड़ा गया है, तो यह आवश्यक है। Type: string उदाहरण: +11234567890 के लिए = 1fa6b8d986d9b9cd01bf36951815158bbde9f520c0567c835dfe34783d0a4231 |
| ip_address कभी-कभी आवश्यक | यह मान डॉटेड-डेसिमल नोटेशन में लिखा जाता है, जिसमें चार संख्याएँ पूर्णविराम से अलग होती हैं। IP पता किसी अन्य पहचानकर्ता (twclid, ईमेल पता, फ़ोन नंबर या user agent) के साथ देना आवश्यक है। Type: string उदाहरण: 8.25.197.25 |
| **user_agent ** कभी-कभी आवश्यक | यह पहचानकर्ता सर्वर को अनुरोध करने वाले user agent के एप्लिकेशन, ऑपरेटिंग सिस्टम, वेंडर और/या वर्शन की पहचान करने में सक्षम बनाता है। User Agent को किसी अन्य पहचानकर्ता (twclid, ईमेल पता, फ़ोन नंबर या IP पता) के साथ देना आवश्यक है। Type: string उदाहरण: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36. |
contents ऑब्जेक्ट
| नाम | विवरण |
|---|---|
| content_id वैकल्पिक | SKU या GTIN; वह पहचानकर्ता जो इस आइटम को दर्शाता है। type: string उदाहरण: jhp |
| content_group_id वैकल्पिक | उत्पाद वैरिएंट के समूह से संबद्ध ID type: integer उदाहरण: group 1 |
| content_name वैकल्पिक | उत्पाद या सेवा का नाम। type: string उदाहरण: radio flyer |
| content_price वैकल्पिक | उत्पाद या सेवा की कीमत। type: double उदाहरण: 5.00 |
| content_type वैकल्पिक | खरीदे गए उत्पाद की श्रेणी। type: string उदाहरण: clothes |
| num_items वैकल्पिक | खरीदे गए उत्पादों की संख्या type: integer उदाहरण: 1 |
रिस्पॉन्स पैरामीटर
| Name | Description |
|---|---|
| conversions_processed | सफलतापूर्वक प्रोसेस किए गए कन्वर्ज़न की संख्या Type: integer उदाहरण: 1 |
| debug_id | एक debug UUID, जिसका उपयोग आगे की जांच के लिए किया जा सकता है Type: string उदाहरण: ff02e052-36e4-47d6-bdf0-6d8986446562 |
अनुरोध का उदाहरण
उदाहरण अनुरोध
GET accounts/:account_id/web_event_tags
वर्तमान खाते से जुड़े कुछ या सभी वेब इवेंट टैग्स का विवरण प्राप्त करें।
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| count optional | प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int डिफ़ॉल्ट: 200 न्यूनतम, अधिकतम: 1, 1000 |
| cursor optional | परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string उदाहरण: 8x7v00oow |
| sort_by optional | समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string उदाहरण: created_at-asc |
| web_event_tag_ids optional | कॉमा से अलग की गई identifiers की सूची निर्दिष्ट करके रिस्पॉन्स को केवल इच्छित वेब इवेंट टैग्स तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string उदाहरण: o3bk1 |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
| with_total_count optional | total_count रिस्पॉन्स attribute शामिल करें।नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते।नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।Type: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags?web_event_tag_ids=o3bk1
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड account का पहचानकर्ता। यह resource के path में शामिल होता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| web_event_tag_id required | उस वेब इवेंट टैग का संदर्भ, जिस पर आप request में कार्य कर रहे हैं। Type: string उदाहरण: o3bk1 |
| with_deleted optional | अपनी request में deleted results शामिल करें। Type: boolean डिफ़ॉल्ट: false संभावित मान: true, false |
उदाहरण अनुरोध
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags
पैरामीटर
| नाम | विवरण |
|---|---|
| account_id required | लीवरेज्ड account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t |
| click_window required | इस वेब टैग के लिए click window। Note: नीचे सूचीबद्ध संभावित मानों में से केवल इन्हीं को स्वीकार किया जाता है। Type: int Possible values: 1, 7, 14, 30 |
| name required | इस वेब टैग का नाम। Type: string Example: Sample single conversion event |
| retargeting_enabled required | यह बताता है कि इस वेब टैग के लिए retargeting सक्षम होना चाहिए या नहीं। Type: boolean Possible values: true, false |
| type required | इस वेब टैग का type। Type: enum Possible values: ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, CUSTOM, DOWNLOAD, PRODUCT_CUSTOMIZATION,PURCHASE, SEARCH, SIGN_UP, SITE_VISIT, START_TRIAL, SUBSCRIBE(UI में, SITE_VISIT को “Page view” और SIGN_UP को “Lead” के रूप में दिखाया जाता है) |
| view_through_window required | इस वेब टैग के लिए view through window। यह मान हमेशा click_window के मान से कम या उसके बराबर होना चाहिए।Note: नीचे सूचीबद्ध संभावित मानों में से केवल इन्हीं को स्वीकार किया जाता है। Type: int Possible values: 0, 1, 7, 14, 30 |
उदाहरण अनुरोध
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags?click_window=7&name=web event tag&retargeting_enabled=false&type=SITE_VISIT&view_through_window=7
उदाहरण रिस्पॉन्स
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | लीवरेज्ड खाते का पहचानकर्ता। यह संसाधन के पथ में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t |
| web_event_tag_id required | मौजूदा खाते के वेब टैग का पहचानकर्ता। Type: string उदाहरण: o3bk1 |
| click_window optional | इस वेब टैग के लिए क्लिक विंडो। नोट: केवल नीचे सूचीबद्ध संभावित मान स्वीकार किए जाते हैं। Type: int संभावित मान: 1, 7, 14, 30 |
| name optional | वेब टैग का नाम। Type: string उदाहरण: Sample single conversion event |
| retargeting_enabled optional | यह दर्शाता है कि इस वेब टैग के लिए retargeting सक्षम किया जाना चाहिए या नहीं। Type: boolean संभावित मान: true, false |
| type optional | वेब टैग का प्रकार। Type: enum संभावित मान: ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, CUSTOM, DOWNLOAD, PRODUCT_CUSTOMIZATION,PURCHASE, SEARCH, SIGN_UP, SITE_VISIT, START_TRIAL, SUBSCRIBE(UI में, SITE_VISIT को “Page view” और SIGN_UP को “Lead” के रूप में दिखाया जाता है) |
| view_through_window optional | इस वेब टैग के लिए व्यू-थ्रू विंडो। यह मान हमेशा click_window के मान से कम या उसके बराबर होना चाहिए।नोट: केवल नीचे सूचीबद्ध संभावित मान स्वीकार किए जाते हैं। Type: int संभावित मान: 0, 1, 7, 14, 30 |
उदाहरण अनुरोध
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1?type=DOWNLOAD
रिस्पॉन्स का उदाहरण
संसाधन URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
पैरामीटर
| Name | Description |
|---|---|
| account_id required | leveraged खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। type: string उदाहरण: 18ce54d4x5t |
| web_event_tag_id required | मौजूदा खाते पर web tag का पहचानकर्ता। type: string उदाहरण: o3bk1 |
उदाहरण अनुरोध
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1