मुख्य सामग्री पर जाएं

​
कस्टम ऑडियंस

​
अवलोकन

पार्टनर कस्टम ऑडियंस बनाने के कई तरीके हैं। कृपया ध्यान दें कि आप टार्गेटिंग से lookalike custom audiences को बाहर नहीं कर सकते। इसके अलावा, आप एक ही ad line item (ad group) में custom audience और custom audience lookalike, दोनों को टार्गेट नहीं कर सकते। ऑडियंस प्रबंधन ऑडियंस का प्रबंधन audience partners और Ads API partners के ज़रिए किया जा सकता है। हम API में custom audiences तक पहुँचने और उनका रखरखाव करने के लिए endpoints की एक शृंखला उपलब्ध कराते हैं। custom audience की जानकारी के लिए, हम 2 endpoints उपलब्ध कराते हैं: ऑडियंस को अपलोड और प्रबंधित करने के बारे में अधिक जानकारी के लिए, Audience API guide देखें। प्रोसेसिंग समय सामान्यतः, ऑडियंस में किए गए बदलाव बैचों में प्रोसेस होते हैं, जो हर 6-8 घंटे में चलते हैं। जब कोई ऑडियंस परिवर्तन प्रोसेस हो रहा होता है, तब अपडेट की जाने वाली मौजूदा ऑडियंस प्रभावित नहीं होती। हम अनुशंसा नहीं करते कि इस समयावधि के भीतर प्रति ऑडियंस additions के लिए एक से अधिक अपडेट और removals के लिए एक से अधिक अपडेट किए जाएँ। टार्गेटिंग किसी ऑडियंस को केवल तभी टार्गेट किया जा सकता है, जब वह X के स्वामित्व वाले और संचालित क्लाइंट्स पर पिछले 90 दिनों में सक्रिय कम-से-कम 100 उपयोगकर्ताओं से मेल खाती हो। GET accounts/:account_id/custom_audiences/:custom_audience_id यह बताएगा कि यदि कोई ऑडियंस बहुत कम उपयोगकर्ताओं से मेल खाती है, तो उसे टार्गेट नहीं किया जा सकता। Audience API (CRM)
image2
Audience या API partners hashed identifiers की एक सूची उपलब्ध कराते हैं, और X उनका मिलान करके ऐसे segments बनाता है जो X पर media buying के लिए उपलब्ध कराए जाते हैं। पार्टनर इन ऑडियंस को Audience API की मदद से बना सकते हैं। यह कैसे काम करता है?
image3
वेब MPP audience partners के साथ काम करते समय, हम X पर media buying के लिए टार्गेट किए जाने वाले segments की पहचान हेतु एक मानक cookie matching process उपलब्ध कराते हैं। इसके अलावा, advertisers वेबसाइट उपयोगकर्ता डेटा एकत्र करने और उससे संबंधित Custom Audience बनाने के लिए X Web Event Tag सेट अप कर सकते हैं। सेटअप चरण
image0
यह कैसे काम करता है?
image1
मोबाइल विस्तृत जानकारी के लिए कृपया the Custom Audiences from Mobile Apps blog post देखें। फ्लेक्सिबल Flexible audiences advertisers को मौजूदा custom audiences या उनके subsets के आधार पर ऑडियंस संयोजन बनाने और सहेजने की सुविधा देती हैं। custom audience के सदस्यों के subsets को interaction की recency और frequency के आधार पर टार्गेट किया जा सकता है। कस्टम ऑडियंस के लिए प्रतिबंधित उपयोग के मामले प्रतिबंधों के बारे में और पढ़ें

​
ऑडियंस FAQ

प्रश्न: हमने बहुत अधिक मात्रा में डेटा पुश किया, फिर भी ऑडियंस का आकार TOO_SMALL क्यों दिख रहा है? उत्तर: अभी डेटा को रीयल-टाइम में ऑडियंस में जोड़ा जा रहा है, लेकिन ऑडियंस का आकार बताने के लिए डेटा को प्रोसेस करने वाला जॉब कुछ समय बाद ही चलता है। सही ऑडियंस आकार कुछ घंटों के भीतर UI में दिखाई देना चाहिए। प्रश्न: हमने ऑडियंस डेटा भेजना पूरा कर लिया है और 24 घंटे या उससे अधिक इंतज़ार भी किया है, लेकिन फिर भी हम उस ऑडियंस को target नहीं कर पा रहे हैं — ऐसे में हमें आगे क्या करना चाहिए? उत्तर: कृपया निम्नलिखित बातों की पुष्टि करें:
  • पास किया जा रहा user ID सही है और malformed नहीं है।
  • पास किए जा रहे ऑडियंस नाम सही हैं और पिछले membership updates से मेल खाते हैं।
  • कृपया POST commands से मिले रिस्पॉन्स की पुष्टि करें।
  • कृपया पुष्टि करें कि ID Sync pixel सही तरीके से लागू किया गया है, और ID Sync process में बताए अनुसार संबंधित साइट पर इतने उपयोगकर्ता आ चुके हैं कि users को map किया जा सके। membership updates में जो उपयोगकर्ता unmapped रह जाते हैं, उन्हें target किए जा सकने वाले users में नहीं बदला जाएगा।
यदि यह सब सही हो और अपेक्षित रूप से काम कर रहा हो, तो कृपया यथासंभव विस्तृत जानकारी के साथ X product contacts से संपर्क करें (वांछित जानकारी के उदाहरण के लिए Guide to Partner Inbounds देखें)। प्रश्न: हम endpoint को कितनी बार call कर सकते हैं, और किस algorithm के साथ? उत्तर: हम दृढ़ता से सलाह देते हैं कि आप हमारे सिस्टम को incremental deltas के साथ call करें, और complete audience memberships को दोबारा कभी न भेजें। सिस्टम का परीक्षण किया जा चुका है, और इसमें दुनिया की कुछ सबसे बड़ी websites के incremental data updates को प्रोसेस करने लायक पर्याप्त throughput है। ऑडियंस का शुरुआती upload सावधानी से throttled होना चाहिए, और पहले upload को पूरा होने में काफ़ी समय लगने की अपेक्षा है। प्रश्न: targeting के लिए उपयोग की जाने वाली किसी ऑडियंस का न्यूनतम आकार क्या है?
  • targeting के लिए किसी ऑडियंस का न्यूनतम आकार 100 उपयोगकर्ता है (post match)। यदि 500 से कम उपयोगकर्ताओं वाली किसी ऑडियंस का match हो जाता है, तो वह X Ads UI में targeting के लिए उपलब्ध नहीं होगी।
प्रश्न: ऑडियंस फ़ाइलों को प्रोसेस होने में कितना समय लगेगा? और ऑडियंस फ़ाइलों को X User Interface में उपलब्ध होने में कितना समय लगेगा?
  • आम तौर पर ऑडियंस फ़ाइलों को प्रोसेस होने में 4-6 घंटे लगते हैं, लेकिन यह फ़ाइल के आकार पर निर्भर करता है। फ़ाइल प्रोसेस हो जाने के बाद ऑडियंस X Ads UI में उपलब्ध हो जाती हैं।
प्रश्न: match rate की गणना कैसे की जाती है?
  • Match Rate = 90 day active X users / प्रदान किए गए उपयोगकर्ताओं की संख्या
प्रश्न: हम कैसे जाँचें कि कोई ऑडियंस फ़ाइल सही तरीके से काम कर रही है?
  • आप एक test audience file दे सकते हैं और advertiser handle के रूप में “keltonlynn” का उपयोग कर सकते हैं। इसके बाद हम सत्यापित कर सकते हैं कि फ़ाइल को सही तरीके से ingest करके X UI में load किया जा सकता है।
प्रश्न: partner user identifier (p_user_id) क्या है?
  • यह वह identifier है जिसका उपयोग आपकी company अपने प्रत्येक ग्राहक की विशिष्ट पहचान के लिए करती है।
प्रश्न: standard ID क्या है?
  • यह एक email address, device ID, X @handle या ID हो सकता है।
प्रश्न: मुझे HMAC Key कैसे मिलेगी?
  • यह आपको एक encrypted email के माध्यम से प्रदान की जाएगी। कृपया अपनी public PGP key mpp-inquiry@x.com पर भेजें, और हम आपको एक test email भेजेंगे ताकि यह सत्यापित किया जा सके कि सब कुछ सही तरह से काम कर रहा है। सत्यापन के बाद, हम आपको HMAC Key भेज देंगे।
प्रश्न: मैं यह कैसे सत्यापित करूँ कि दिए गए HMAC Key का उपयोग करके hashing process सही तरीके से काम किया?
  • X एक test file (जिसमें sample email addresses, device IDs आदि होंगे) और एक resulting hash file उपलब्ध कराएगा, जिसके साथ आप अपने results को verify कर सकते हैं।
प्रश्न: क्या full data match file के लिए file size limitation है?
  • नहीं, full data match file के लिए कोई size limitation नहीं है।
प्रश्न: full data match file को प्रोसेस होने में कितना समय लगेगा?
  • X को फ़ाइल मिल जाने के बाद, उसे प्रोसेस होने में लगभग 1 दिन लगेगा।

​
CRM

image0
यह दस्तावेज़ कस्टम ऑडियंस CRM पार्टनरों के लिए फ़ाइल फ़ॉर्मैट और डेटा एक्सचेंज प्रक्रिया सहित इंटीग्रेशन विवरणों का वर्णन करता है। सारांश कंपनी, किसी ग्राहक की ओर से, हैश किए गए सामान्य उपयोगकर्ता पहचानकर्ताओं (जैसे, ई-मेल पते) या पार्टनर उपयोगकर्ता ID की एक सूची X को उपलब्ध कराएगी, ताकि ब्लाइंड मैच किया जा सके और टार्गेटिंग के लिए X User ID की एक सूची तैयार की जा सके। टार्गेटिंग के लिए सेगमेंट, ads.x.com कैंपेन सेटअप में फ़ाइलनाम द्वारा निर्दिष्ट विज्ञापनदाता के विशेष @handle के लिए उपलब्ध कराए जाएंगे। कंपनी की सभी फ़ाइलें, X द्वारा कंपनी को प्रदान किए गए एक विशिष्ट अकाउंट के माध्यम से, IronBox (www.golockbox.com) पर एक सुरक्षित पैकेज के जरिए X को उपलब्ध कराई जाएंगी। X, IronBox तक पहुँच प्रदान करेगा। IronBox APIs का दस्तावेज़ https://secure.goironcloud.com/Docs/Help/ पर उपलब्ध है।

​
पार्टनर ID मिलान आवश्यकताएँ

यदि कंपनी उपयोगकर्ताओं को ट्रैक करने के लिए अपनी स्वयं की मानक ID प्रणाली का उपयोग करती है (अर्थात ईमेल पते, device ids, X user ID आदि जैसे सामान्य उपयोगकर्ता पहचानकर्ता नहीं), तो यह अनुशंसित प्रक्रिया है। 1. पूर्ण डेटा मिलान शुरुआत में, कंपनी एक ही फ़ाइल में सभी उपयोगकर्ता रिकॉर्ड की एक विस्तृत सूची प्रदान करेगी, जिसमें X के साथ साझा एक अद्वितीय सामान्य उपयोगकर्ता पहचानकर्ता शामिल होगा, ताकि पूर्ण डेटा मिलान किया जा सके और X द्वारा संग्रहीत Partner IDs (p_user_id) से X IDs (tw_id) का एक मैपिंग तैयार किया जा सके। उचित रखरखाव सुनिश्चित करने के लिए यह प्रक्रिया नियमित रूप से हर 2-3 महीने में की जाएगी। मिलान पूरा होने के बाद, X इस फ़ाइल से प्राप्त आधारभूत मिलान दर कंपनी के साथ e-mail के माध्यम से साझा करेगा। इस फ़ाइल का प्रारूप इस प्रकार होना चाहिए: नामकरण परंपरा: FullDataMatch.[CompanyName].txt Hashing Algorithm: HMAC_SHA-256 प्रारूप: कॉलम 1: सामान्य identifiers का HMAC hashed मान कॉलम 2: Partner User ID (प्रति उपयोगकर्ता अद्वितीय, फ़ाइल में अद्वितीय नहीं) कॉलम विभाजक (CSV): hashed सामान्य उपयोगकर्ता पहचानकर्ता को Partner ID से अलग करने के लिए commas का उपयोग किया जाएगा पंक्ति-विभाजित मान
  • उदाहरण: यदि user record A का Partner User ID 1 है और common identifier 1, 2 और 3 हैं:
सामान्य उपयोगकर्ता पहचानकर्ता 1p_user_1
सामान्य उपयोगकर्ता पहचानकर्ता 2p_user_1
सामान्य उपयोगकर्ता पहचानकर्ता 3p_user_1
*सामान्य उपयोगकर्ता पहचानकर्ताओं के लिए नीचे दिया गया Hashing Directions अनुभाग देखें 2. कस्टम सेगमेंट सूचियाँ X पर targeting के लिए ग्राहकों हेतु custom audiences बनाने के लिए कंपनी p_user_id के रूप में उपयोगकर्ताओं की सूचियाँ प्रदान करेगी।
  • पंक्ति-विभाजित मान
  • p_user_id
    • (ऊपर दिए गए 1. Full Data Match अनुभाग में जैसा प्रदान किया गया है, वैसा ही। यदि full data match में दिया गया मान hashed है, तो कंपनी audience file में वही hashed मान प्रदान करेगी। यदि दिया गया मान hashed नहीं है, तो कंपनी unhashed मान प्रदान करेगी।)

​
मानक मिलान आवश्यकताएँ

यदि कंपनी सभी ग्राहक उपयोगकर्ता पहचानकर्ताओं के मैपिंग के लिए किसी मानक id का उपयोग नहीं करती है, तो यह अनुशंसित प्रक्रिया है। कस्टम सेगमेंट सूचियाँ कंपनी, ग्राहकों की ओर से कस्टम ऑडियंस बनाने के लिए, हैश किए गए सामान्य उपयोगकर्ता पहचानकर्ताओं की सूचियाँ सीधे X को प्रदान करेगी। इस फ़ाइल का प्रारूप इस प्रकार होना चाहिए:
  • पंक्ति-आधारित मान
  • हैश किया गया सामान्य उपयोगकर्ता पहचानकर्ता (अर्थात ईमेल पता)
  • नीचे दी गई फ़ाइल-नामकरण परंपराओं का पालन करें
  • नीचे ईमेल पतों के लिए दिए गए हैशिंग निर्देशों का पालन करें (Hashing Directions में)

​
Custom Segment सूची फ़ाइल नामकरण और संचालन

किसी फ़ाइल पर कौन-सा संचालन लागू होगा, यह उसके नाम से निर्धारित होगा। उपलब्ध संचालन और सामान्य फ़ाइल-नामकरण परंपरा इस प्रकार है: audiencename_partnername.handle.operation.filetype
  • audiencename: Custom Audience का नाम। यह वही नाम है जो ads.x.com campaign setup UI में audience चुनते समय दिखाई देगा, उदाहरण के लिए brand_loyalty_card_holders।
  • partnername: विज्ञापनदाता की ओर से डेटा उपलब्ध कराने वाली कंपनी का नाम, उदाहरण के लिए company_name।
  • handle: वह X Account (@handle) जिसे Custom Audiences का access होगा, उदाहरण के लिए @pepsi, @dietpepsi
  • operation: new, add, remove, removeall, replace (विवरण नीचे)
  • : सेकंड में मानक Unix epoch time, जिसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि अपलोड की गई हर audience फ़ाइल अद्वितीय हो
  • filetype: फ़ाइल *.txt format में होनी चाहिए

​
ऑडियंस बनाना और अपडेट करना

एक नई ऑडियंस एकल फ़ाइल के साथ बनाएँ, उदाहरण के लिए loyalty_card_holders_partnername.pepsi.new.txt Add - किसी सूची के मिलानों को किसी मौजूदा ऑडियंस में जोड़ें, उदाहरण के लिए loyalty_card_holders_partnername.pepsi.add..txt Remove - किसी सूची के मिलानों को किसी मौजूदा ऑडियंस से हटाएँ। उदाहरण: loyalty_card_holders_partnername.pepsi.remove..txt Remove All - नियमित रूप से अपडेट की जाने वाली संचयी सूची से प्राप्त मिलानों को उस Client की सभी ऑडियंस से हटाएँ (अर्थात Client की Opt Out सूची)। उदाहरण: partnername.pepsi.removeall.txt
  • इसका उपयोग उन उपयोगकर्ताओं की व्यापक सूची के लिए किया जा सकता है जिन्होंने Advertiser से ऑप्ट-आउट किया है।
  • X इस फ़ाइल में दी गई केवल नवीनतम सूची को ही मान्य करेगा, और इसे मेल खाने वाले
X उपयोगकर्ताओं के लिए, इस फ़ाइल के प्रदान और संसाधित किए जाने के समय मौजूद सभी वर्तमान और भविष्य की ऑडियंस पर लागू करेगा। Replace - किसी मौजूदा ऑडियंस को हटाकर उसे नई ऑडियंस सूची से बदलें। उदाहरण: loyalty_card_holders_partnername.pepsi.replace..txt Overall Company Opt-Out - कंपनी, कंपनी की Opt-Out नीति के अनुसार ऑप्ट-आउट कर चुके उपयोगकर्ताओं को हटाने के लिए एक संचयी Opt-Out फ़ाइल प्रदान करेगी। X इस Company Opt-Out फ़ाइल में दी गई केवल नवीनतम सूची को ही मान्य करेगा, और इस फ़ाइल के प्रदान और संसाधित किए जाने के समय मेल खाने वाले X उपयोगकर्ताओं के लिए इसे सभी वर्तमान और भविष्य की ऑडियंस पर लागू करेगा। Company Opt-Out फ़ाइल का प्रारूप इस प्रकार होगा: उदाहरण: partnername.removeall.txt Delete - ऑडियंस की वर्तमान सूची से किसी मौजूदा ऑडियंस को हटाएँ, उदाहरण: loyalty_card_holders_partnername.pepsi.delete.txt

​
हैशिंग निर्देश

सामान्य उपयोगकर्ता पहचानकर्ताओं (अर्थात ईमेल पते) की हैशिंग के लिए X, PGP के माध्यम से base64-एन्कोडेड प्रोडक्शन key सुरक्षित रूप से साझा करेगा। कंपनी, इस key को base64 डिकोड करके 32-byte key तैयार करेगी, जिसका उपयोग हैशिंग करने के लिए किया जाएगा। उदाहरण base64-एन्कोडेड key: BrQvOg+dACBUmKjRiNxZgJLh6zydjS0ZOv80FelTNzM= उदाहरण Base64-डिकोडेड key: /:� TшY सामान्यीकरण: कंपनी, हैशिंग से पहले सामान्य उपयोगकर्ता पहचानकर्ताओं पर बुनियादी सामान्यीकरण करेगी (Device IDs को छोड़कर; Device ID सामान्यीकरण section देखें)।

​
E-mail का सामान्यीकरण

अर्थात, शुरुआत और अंत के रिक्त स्थान हटा दें और ईमेल पते को लोअरकेस में कर दें। उदा.: कच्चा e-mail पता: testemail_Organisational_baseball+884@It92I6Ev2B.Com सामान्यीकरण के बाद: testemail_organisational_baseball+884@it92i6ev2b.com हैश किया गया मान: 74d9584eded0ad1e5572a1c1849f3716751d371d6117a6155dad5363f4b4fbec नोट: एन्कोड किए गए hmac और key, दोनों के वर्णों की संख्या इनपुट और एन्कोडिंग के आधार पर अलग-अलग हो सकती है।

​
डिवाइस ID सामान्यीकरण

डिवाइस IDs की हैशिंग के लिए भी वही आवश्यकताएँ लागू होंगी: SHA-256 hashing algorithm और एक common salt का उपयोग, जो हम data partners को प्रदान करते हैं। हम spaces को वैसे ही हटा देते हैं जैसे email addresses के साथ करते हैं, लेकिन IDFAs/Android IDs के लिए lowercase normalization नहीं किया जाता और IDFA/Android ID का सटीक format ही इस्तेमाल किया जाना चाहिए। नीचे iOS और Android के लिए pre-hashing डिवाइस IDs के raw format के उदाहरण दिए गए हैं: iOS IDFA: DD99CFF7-6186-4602-9DF2-ED3FD0B2D431 Android ID: b5bf2122961b3595 Hashed iOS IDFA: 134fb8cd95c7fd42e2793f469a447198ca5f990968db2dbadad70e723ed9750b Hashed Android ID: 130dddff1939f229476f50bc8adab8fcb7e3525b0e9604fe8effc15e68cee4a4

​
X User ID सामान्यीकरण

X IDs को अब भी hash किया जाएगा, क्योंकि डेटा का समूह — यानी @handles की Customer List — विज्ञापनदाता के लिए निजी होता है, भले ही वह PII न हो। X IDs की hashing के लिए वही आवश्यकताएँ लागू होंगी: SHA-256 hashing algorithm और एक common salt का उपयोग, जो हम data partners को प्रदान करते हैं। X ID/@username दोनों में से spaces हटा दिए जाने चाहिए, लेकिन User IDs के लिए सामान्यीकरण की आवश्यकता नहीं है। सामान्यीकरण के लिए @usernames को lowercase में होना चाहिए। साथ ही, username के हिस्से के रूप में @ symbol शामिल नहीं होना चाहिए। raw ID format होगा:
  • User ID: 27674040
  • @username: testusername
Hashed User ID: bf6b57d4e861e83bea8bbed2b800b251a64c95468ee6e8cb07c3368c9ed45e85 Hashed @username: 12201ae78ad1afa907c7112d17f498154ffb0bf9ea523f5390e072a06d7d9812

​
ID Sync एकीकरण

p_id के साथ डेटा भेजने वाले पार्टनरों को विज्ञापनदाता या पार्टनर के user ids को X user ids से मैप करने के लिए ID Sync प्रक्रिया से गुजरना होगा। इससे विज्ञापनदाता X पर सीधे अपने user segments को लक्षित कर सकते हैं। पार्टनरों को अपने membership updates भेजते समय param user_identifier_type का मान TALIST_PARTNER_USER_ID या TAWEB_PARTNER_USER_ID में से किसी एक पर सेट करना भी होगा।
  • केवल वेब: यह विज्ञापनदाता की साइट पर एक pixel लगाकर किया जा सकता है, जैसा कि नीचे बताया गया है।
  • सूची: यह CRM पेज पर बताई गई किसी भी विधि का उपयोग करके किया जा सकता है।

​
पिक्सेल URL

बेस URL
https://analytics.x.com/i/adsct

​
पिक्सेल पैरामीटर

पैरामीटरविवरण
p_idX द्वारा असाइन की गई आपकी पार्टनर id
p_user_idपार्टनर सिस्टम में उपयोगकर्ता की id

​
ID Sync पिक्सेल:

partner id के उदाहरण 111 और p_user_id के उदाहरण abc का उपयोग करने पर, तैयार किया गया पिक्सेल इस प्रकार होगा: 
    <pre class="brush: xml">
    <img height="1" width="1" src="https://analytics.x.com/i/adsct?p_id=111&p_user_id=abc" style="display:none" />
    </pre>
ऑप्ट-आउट फ़ाइल कॉन्फ़िगरेशन और ऑप्ट-आउट फ़ाइलें भेजना साझेदारों को X को उन उपयोगकर्ताओं की एक सूची देनी चाहिए जिन्होंने, साझेदार की जानकारी के अनुसार, लक्षित विज्ञापन वितरण से ऑप्ट-आउट करने का विकल्प चुना है। फ़ाइल का फ़ॉर्मैट इस प्रकार होना चाहिए:
कॉलम संख्याकॉलम नामकॉलम प्रकारविवरण
1साझेदार IDstring“partner id” वह ID है जो X प्रत्येक साझेदार की विशिष्ट पहचान के लिए उसे प्रदान करता है।
2साझेदार सिस्टम में उपयोगकर्ता की idstringp_user_id वह विशिष्ट ID है जिसका उपयोग साझेदार उपयोगकर्ता की पहचान के लिए करता है। इन ऑप्ट-आउट उपयोगकर्ताओं वाली फ़ाइल को TON upload endpoint का उपयोग करके अपलोड किया जाना चाहिए, और अपलोड किए गए डेटा का path यहाँ दिए गए Global Opt Out endpoint पर भेजा जाना चाहिए: PUT accounts/:account_id/custom_audiences/global_opt_out.
सदस्यता अपडेट भेजना जैसा कि हमारे endpoint दस्तावेज़ में बताया गया है, POST custom_audience_memberships endpoint के माध्यम से उपयोगकर्ताओं को भेजते समय, cookie-आधारित मिलान सक्षम करने के लिए आपको customer ID भेजनी चाहिए। p_id के साथ डेटा भेजने वाले साझेदारों को user_identifier_type को अनिवार्य रूप से TALIST_PARTNER_USER_ID या TAWEB_PARTNER_USER_ID पर सेट करना होगा। बाकी सभी चरण Real-Time Audience API Integration Guide में दिए गए चरणों के समान रहेंगे

​
Custom Audiences उपयोगकर्ता डेटा

यह दस्तावेज़ [Custom Audience]/x-ads-api/audiences उपयोगकर्ता डेटा के फ़ॉर्मैट की रूपरेखा बताता है। डेटा सामान्यीकरण डिवाइस IDs:
  • IDFA - डैश सहित लोअरकेस; उदाहरण: 4b61639e-47cc-4056-a16a-c8217e029462
  • AdID - डिवाइस पर जैसा मूल फ़ॉर्मैट है, वही आवश्यक है; डैश सहित, बड़े अक्षरों में नहीं; उदाहरण: 2f5f5391-3e45-4d02-b645-4575a08f86e
  • Android id - डिवाइस पर जैसा मूल फ़ॉर्मैट है, वही आवश्यक है; बिना डैश या स्पेस के, बड़े अक्षरों में नहीं; उदाहरण: af3802a465767e36
ईमेल पते:
  • लोअरकेस, शुरुआत और अंत के स्पेस हटाकर; उदाहरण: support@x.com
X उपयोगकर्ता नाम:
  • @ के बिना, लोअरकेस में, और शुरुआत व अंत के स्पेस हटाकर; उदाहरण: jack
X उपयोगकर्ता IDs:
  • मानक पूर्णांक; उदाहरण: 143567
डेटा हैशिंग प्रत्येक पंक्ति के डेटा को बिना salt के SHA256 का उपयोग करके hash करना चाहिए। इसके अतिरिक्त, अंतिम आउटपुट hash लोअरकेस में होना चाहिए। उदाहरण के लिए, 49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d और न कि 49E0BE2AECCFB51A8DEE4C945C8A70A9AC500CF6F5CB08112575F74DB9B1470D 
# python का उपयोग करके @AdsAPI उपयोगकर्ता को हैश करना
import hashlib
hashlib.sha256("adsapi".encode()).hexdigest()

#आउटपुट
49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d
हैशिंग के लिए अतिरिक्त कोड नमूने github.com/xdevplatform/ads-platform-tools पर देखे जा सकते हैं।

​
कस्टम ऑडियंस: वेब

info.png
जानकारी पार्टनर, किसी विज्ञापनदाता की ओर से टार्गेट करने के लिए IDs (p_user_ids) की एक सूची भेजेंगे। यह ID Sync प्रक्रिया के ज़रिए किया जाता है, जो p_user_ids और X user ID के बीच एक मैपिंग बनाती है। फिर इस मैपिंग का उपयोग X User IDs की ऐसी सूचियाँ तैयार करने के लिए किया जाता है, जिन्हें टार्गेटिंग के लिए इस्तेमाल किया जा सकता है। ये कस्टम ऑडियंस, ads.x.com Custom Audiences Web campaign setup में लेबल द्वारा निर्दिष्ट विज्ञापनदाता के विशेष @handle पर उपलब्ध कराए जाएँगे। X एक सुरक्षित पिक्सेल उपलब्ध कराएगा, जिसे IDs (p_user_ids) को X user IDs से मैच करने के लिए पार्टनर टैग्स और साइटों पर जोड़ा जा सकता है। ID Sync प्रक्रिया पूरी हो जाने के बाद, targeting files पार्टनर द्वारा बनाई जाएँगी और एक HTTPS endpoint के माध्यम से X को उपलब्ध कराई जाएँगी। इन targeting files को X नियमित रूप से ingest करता है और फिर X UI में उपलब्ध कराता है। X सुरक्षित पिक्सेल X secure पिक्सेल इस प्रकार दिखाई देगा: https://analytics.x.com/i/adsct?p&#95;user&#95;id=xyz&amp;p&#95;id=123 p_user_id - xyz उस पार्टनर user ID को दर्शाता है, जो Partner द्वारा प्रदान की जाती है p_id - 123 Partner के लिए अद्वितीय ID को दर्शाता है (X द्वारा प्रदान की गई) Partner HTTPS Endpoint & Targeting User File पार्टनर को X को एक HTTPS endpoint और credentials (username/password) देने होंगे, जिनका उपयोग targeting file को नियमित रूप से ingest करने के लिए किया जा सके। एक नमूना HTTPS endpoint इस प्रकार दिखाई देगा: 
https://<partnerdomain>/twitter/partner_targeting_%Y-%M-%D.tsv.gz
%Y - वर्ष के लिए फ़ॉर्मैट कोड (YYYY) %M - महीने के लिए फ़ॉर्मैट कोड (MM) %D - दिन के लिए फ़ॉर्मैट कोड (DD) प्रेषित डेटा में निम्नलिखित फ़ाइलें होंगी:
  1. पार्टनर टार्गेटिंग यूज़र फ़ाइल
  2. टार्गेटिंग कन्वर्ज़न फ़ाइल
सभी फ़ाइलें TSV फ़ॉर्मैट में होंगी, जिसमें प्रत्येक पंक्ति के अलग-अलग फ़ील्ड्स एक-दूसरे से टैब कैरेक्टर द्वारा अलग होंगे। वैध फ़ील्ड मानों में कभी भी टैब कैरेक्टर शामिल नहीं होगा। अनुमत X IP रेंज: नीचे IP पतों की वह रेंज दी गई है, जिसे Partner Endpoint तक पहुँच के लिए अनुमति दी जा सकती है।
  • 199.16.156.0/22
  • 199.59.148.0/22
पार्टनर टार्गेटिंग यूज़र फ़ाइल:
कॉलम संख्याकॉलम नामकॉलम typeविवरण
1partner idstring“partner id” वह ID है, जो X पार्टनर को प्रत्येक पार्टनर की विशिष्ट पहचान के लिए प्रदान करता है।
2advertiser idstring“advertiser id” विज्ञापनदाता का @handle है।
3p_user_idstring“p_user_id” वह विशिष्ट ID है, जिसका उपयोग पार्टनर द्वारा उपयोगकर्ता की पहचान करने के लिए किया जाता है।
3confidence scoreinteger“confidence score” वैकल्पिक है। confidence score के लिए हमारी सिफारिश 0-100 का उपयोग करने की है। यदि उपयोग का मामला retargeting का है, तो “100” का confidence score ऐसे उपयोगकर्ता को दर्शाता है जिसे सीधे retarget किया गया है। 0-99 तक का कोई भी स्कोर look-alike के confidence स्तर के अनुरूप होगा।
4segment labelstring“segment label” वैकल्पिक है। उदाहरण के लिए, पार्टनर उत्पाद श्रेणियाँ निर्दिष्ट करने के लिए “segment label” का उपयोग कर सकते हैं। हमारी सिफारिश है कि इस “segment label” का उपयोग किया जाए, क्योंकि ads.x.com UI में Custom Audiences के लिए यही मानव-पठनीय नाम है।
नोट्स: हर बार जब हमें नई पार्टनर टार्गेटिंग फ़ाइल प्राप्त होती है, तो हम अपेक्षा करते हैं कि यह उन उपयोगकर्ताओं की पूरी सूची होगी जिन्हें पार्टनर हमारे लिए टार्गेट करने की सिफारिश करता है, न कि कोई वृद्धिशील सूची, जब तक कि अन्यथा सहमति न हो। हम प्रत्येक पार्टनर के साथ इस पार्टनर टार्गेटिंग फ़ाइल की डिलीवरी की आवृत्ति पर सहमति करेंगे। यदि हमें अपेक्षा के अनुसार पार्टनर टार्गेटिंग फ़ाइल प्राप्त नहीं होती है, तो हम कुछ पूर्वनिर्धारित समाप्ति समय के साथ पिछले संस्करण का उपयोग करेंगे।

​
ऑडियंस API एकीकरण

​
अवलोकन

Audience API को Ads API के v4 के हिस्से के रूप में लॉन्च किया गया था, और इसके साथ पुराने Audiences endpoints में कई सुधार किए गए। यह नया endpoint एक नए Audience processing backend द्वारा समर्थित है और स्थिरता, मजबूती तथा विश्वसनीयता के लिहाज़ से कई सुधार प्रदान करता है। इस गाइड का उद्देश्य Audience API और पुराने Audience upload तथा management प्रक्रियाओं के बीच के अंतर को रेखांकित करना है।  संदर्भ दस्तावेज़ Audience API के reference documentation पेज पर उपलब्ध हैं।  नोट: अपलोड से पहले सभी Audience user data को SHA-256 से hash किया जाना चाहिए। अधिक जानकारी, साथ ही स्वीकार्य user identifier प्रकारों और data normalization का विवरण, user data पेज पर उपलब्ध है। Audience कार्यक्षमता में बदलाव कस्टम ऑडियंस में निम्नलिखित बदलाव v4 से लागू किए गए हैं, और Ads API के v3 के sunset होने के बाद deprecated endpoints अब उपलब्ध नहीं रहेंगे:
  • Deprecated TON Upload:
    • GET accounts/:account_id/custom_audience_changes
    • GET accounts/:account_id/custom_audience_changes/:custom_audience_change_id
    • POST accounts/:account_id/custom_audience_changes
    • PUT accounts/:account_id/custom_audiences/global_opt_out
  • Deprecated Real Time Audiences:
    • POST custom_audience_memberships
  • Custom Audience:
    • सभी Custom Audience endpoints पर request और रिस्पॉन्स से list_type पैरामीटर हटा दिया जाएगा। पहले इस पैरामीटर का उपयोग Audience के user identifier type (जैसे email, X User ID आदि) की पहचान के लिए किया जाता था। हालांकि, अब Audiences एक ही Audience के लिए कई user identifiers स्वीकार कर सकते हैं, इसलिए यह मान अब प्रासंगिक नहीं है।
  • General:
    • Audience lookback window को अपडेट किया गया है ताकि पिछले 90 दिनों के भीतर सक्रिय उपयोगकर्ताओं से मिलान किया जा सके (पहले 30 दिन)
    • किसी audience को targetable बनाने के लिए आवश्यक matched users की न्यूनतम संख्या घटाकर 100 users कर दी गई है (पहले 500 users)
पूर्वापेक्षाएँ
  • Ads API access
  • Audience endpoint तक access के लिए, आपको allowlist में जोड़ा जाना होगा। कृपया यह फ़ॉर्म भरें और नए X Ads Products and Services Agreement को स्वीकार करें, यदि इसे शुरुआत में 2018-08-01 से पहले स्वीकार किया गया था
Audience Upload प्रक्रिया नीचे दी गई तालिका पुराने और नए Audience creation flows के बीच प्रमुख अंतरों को सूचीबद्ध करती है। अधिक विवरण आगे दिए गए हैं:
प्रक्रिया का चरणAudience API(Deprecated) TON Upload
एक shell Audience बनाएँ[POST custom_audience endpoint]/x-ads-api/audiences के माध्यम से बनाया जा सकता है[POST custom_audience endpoint]/x-ads-api/audiences के माध्यम से बनाया जा सकता है
एक नया user जोड़ेंAudience endpoint के साथ operation_type Update का उपयोग करेंPOST custom_audience_changes endpoint के साथ operation ADD का उपयोग करें
एक user हटाएँAudience endpoint के साथ operation_type Delete का उपयोग करेंPOST custom_audience_changes endpoint के साथ operation REMOVE का उपयोग करें
उपयोगकर्ताओं को opt-out करनाAudience endpoint के साथ operation_type Delete और संबंधित custom_audience_ids का उपयोग करें, जिनका user हिस्सा हैGlobal opt-out endpoint का उपयोग करें
नोट TON Upload path के माध्यम से अपडेट या opt-out किए जा रहे किसी भी audience के लिए, TON Upload endpoint के माध्यम से अपलोड की गई एक संबंधित list होनी चाहिए, और उसे custom_audience_changes endpoint का उपयोग करके किसी Audience से संबद्ध किया जाना चाहिए। Rate Limiting Audience API endpoint की rate limit प्रति account 1500/1min है। एक single payload में भेजे जाने वाले users की संख्या पर कोई सीमा नहीं है। payload पर केवल निम्न constraints लागू हैं:
  1. operations की कुल संख्या: 2500 operations
  2. अधिकतम payload size: 5,000,000 bytes
Audience User Management एक नया Audience बनाने के लिए, निम्नलिखित चरण आवश्यक हैं

​
नया Custom Audience बनाएँ

[POST custom_audience]/x-ads-api/audiences endpoint का उपयोग करके नया Custom Audience “shell” बनाएँ और उससे संबंधित Custom Audience id प्राप्त करें। यदि आप शुरुआत से कोई Audience बना रहे हैं, तो यह चरण आवश्यक है। यदि आप किसी मौजूदा Audience को अपडेट कर रहे हैं, तो अगले अनुभाग पर जाएँ

​
किसी Audience में उपयोगकर्ताओं को जोड़ें

Custom Audience id और नीचे दिए गए जैसे एक नमूना payload के साथ POST accounts/:account_id/custom_audiences/:custom_audience_id/users का उपयोग करें: POST https://ads-api.x.com/11/accounts/18ce54d4x5t/custom&#95;audiences/1nmth/users 
    # सभी मानों को हैश किया जाना चाहिए, इस उदाहरण में अनहैश्ड मानों का उपयोग केवल दृष्टांत के उद्देश्य से किया गया है
    [
      {
        "operation_type": "Update",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "abc@x.com"
              ],
              "handle": [
                "x",
                "adsapi"
              ]
            },
            {
              "email": [
                "edf@x.com"
              ],
              "twitter_id": [
                "121291606",
                "17874544"
              ]
            }
          ]
        }
      }
    ]
किसी उपयोगकर्ता को Audience में जोड़ने के लिए, operation_type Update का उपयोग करें। नया Audience interface आपको एक ही उपयोगकर्ता के लिए कई user keys पास करने की सुविधा देता है। JSON objects की array में प्रत्येक object एक उपयोगकर्ता के अनुरूप होता है। ऊपर दिए गए उदाहरण payload का उपयोग करने पर, अनुरोध Audience में दो उपयोगकर्ताओं को जोड़ेगा, एक email और handle के साथ और दूसरा email और twitter_id के साथ।

​
किसी Audience से उपयोगकर्ताओं को हटाएँ

उपयोगकर्ताओं को जोड़ने के लिए बताई गई प्रक्रिया की तरह, किसी Audience से उपयोगकर्ताओं को इस प्रकार हटाया जा सकता है: POST https://ads-api.x.com/11/accounts/18ce54d4x5t/custom&#95;audiences/1nmth/users 
    # सभी मान हैश किए हुए होने चाहिए, इस उदाहरण में अनहैश्ड मानों का उपयोग केवल स्पष्टीकरण के लिए किया गया है
    [
      {
        "operation_type": "Delete",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "abc@x.com"
              ],
              "twitter_id": [
                "783214",
                "1225933934"
              ]
            },
            {
              "email": [
                "edf@x.com"
              ],
              "twitter_id": [
                "121291606",
                "17874544"
              ]
            }
          ]
        }
      }
    ]
operation_type को Delete पर सेट किया जाना चाहिए, और उपयोगकर्ताओं का मिलान उन सभी कुंजियों में से किसी भी कुंजी के आधार पर किया जाएगा जो उपयोगकर्ताओं को audience में जोड़ते समय मौजूद थीं। उदाहरण के लिए, यदि किसी उपयोगकर्ता को email और twitter_id का उपयोग करके किसी audience में जोड़ा गया था, तो उसी उपयोगकर्ता को इनमें से किसी एक कुंजी का उपयोग करके हटाया जा सकता है, यानी email या twitter_id या दोनों। इसके अलावा, एक ही अनुरोध में किसी Audience में उपयोगकर्ताओं को जोड़ना और हटाना दोनों संभव है। यह endpoint प्रति अनुरोध कई operation_type का समर्थन करता है।

​
ऑप्ट-आउट उपयोगकर्ता

ग्लोबल ऑप्ट-आउट endpoint के अप्रचलित होने के बाद, पार्टनर के लिए यह आवश्यक है कि वे उन सभी उपयोगकर्ताओं को Delete करें जिन्होंने किसी भी Audiences से ऑप्ट-आउट किया है। इसे करने के कुछ तरीके हैं:
  1. यह ट्रैक करें कि कौन-से उपयोगकर्ता किन Audiences का हिस्सा हैं, और उन उपयोगकर्ताओं को प्रत्येक Audience से अलग-अलग हटाएँ।
  2. उपयोगकर्ता को किसी Ads account से संबद्ध सभी Audiences से हटा दें।
सामान्य सर्वोत्तम प्रथाएँ
  • हम दृढ़ता से अनुशंसा करते हैं कि इस endpoint को लगभग रीयल-टाइम बैचों में कॉल करें, ताकि अचानक बढ़ने वाली कतारों से बचा जा सके, जिन्हें प्रोसेस होने में अधिक समय लगता है और जो आमतौर पर हमारे सिस्टम पर अनावश्यक लोड डालती हैं। इससे यह भी सुनिश्चित होता है कि उपयोगकर्ता campaign targeting के लिए जल्दी उपलब्ध हो जाएँ।
  • एक सफल API कॉल, अनुरोध में प्राप्त user ऑब्जेक्ट्स की संख्या के अनुरूप success_count और total_count लौटाएगी।
  • यह endpoint स्वभाव से atomic है, अर्थात या तो पूरा अनुरोध सफल होगा, या किसी भी त्रुटि की स्थिति में पूरा अनुरोध विफल हो जाएगा। त्रुटि रिस्पॉन्स मिलने पर, API के उपभोक्ताओं को सलाह दी जाती है कि वे त्रुटि ठीक करें और पूरे payload के साथ अनुरोध को फिर से भेजें। 
  • विफलता होने पर, पार्टनर को retries के साथ exponential backoff approach अपनाने की अनुशंसा की जाती है। उदाहरण के लिए, पहली विफलता पर तुरंत retry करें, दूसरी विफलता के बाद 1 मिनट बाद retry करें, और लगातार तीसरी विफलता के बाद 5 मिनट बाद retry करें, और इसी तरह।

​
API संदर्भ

​
कीवर्ड इनसाइट्स

​
GET insights/keywords/search

कीवर्ड के किसी समूह के लिए, संबंधित Tweet वॉल्यूम और 30 संबंधित कीवर्ड का एक सेट प्राप्त करें। Tweet वॉल्यूम केवल इनपुट कीवर्ड के अनुरूप होता है, संबंधित कीवर्ड के नहीं। अधिकतम 7 दिनों की समय-सीमा (end_time - start_time) की अनुमति है। कृपया ध्यान दें कि परिणाम केवल एक geo (देश) तक सीमित होते हैं। रिसोर्स URL https://ads-api.x.com/12/insights/keywords/search पैरामीटर
NameDescription
granularity
required		start_time और end_time द्वारा निर्दिष्ट समय-सीमा के लिए लौटाए गए डेटा की ग्रैन्युलैरिटी बताता है। उदाहरण के लिए, जब इसे HOUR पर सेट किया जाता है, तो start_time और end_time के बीच प्रत्येक घंटे के लिए एक डेटा पॉइंट दिखाया जाएगा।

Type: enum

Possible values: DAY, HOUR
keywords
required		खोज को सीमित करने के लिए अल्पविराम से अलग की गई कीवर्ड की स्ट्रिंग। सभी कीवर्ड एक-दूसरे के साथ OR किए जाते हैं।

नोट: अधिकतम 10 कीवर्ड (keywords और negative_keywords को मिलाकर) का उपयोग किया जा सकता है।

Type: string

Example: developers
start_time
required		प्राप्त डेटा को start_time और end_time के बीच की समय-विंडो में एकत्र किए गए डेटा तक सीमित करता है। इसे ISO 8601 में व्यक्त किया जाता है।

Type: string

Example: 2017-07-10T00:00:00Z
end_time
optional		प्राप्त डेटा को start_time और end_time के बीच की समय-विंडो में एकत्र किए गए डेटा तक सीमित करता है। इसे ISO 8601 में व्यक्त किया जाता है।

नोट: डिफ़ॉल्ट रूप से वर्तमान समय लिया जाता है।

Type: string

Example: 2017-07-11T00:00:00Z
location
optional		यह एक targeting मान है, जिसे आप GET targeting_criteria/locations endpoint से प्राप्त कर सकते हैं, ताकि परिणामों को उस स्थान के आधार पर सीमित किया जा सके जहाँ अकाउंट का उपयोगकर्ता स्थित है। ध्यान दें कि वर्तमान में केवल देश-स्तर के locations समर्थित हैं।

Type: string

Example: 0ce8b9a7b2742f7e
negative_keywords
optional		बाहर रखने के लिए अल्पविराम से अलग की गई कीवर्ड की स्ट्रिंग। सभी negative keywords एक-दूसरे के साथ OR किए जाते हैं।

नोट: अधिकतम 10 कीवर्ड (keywords और negative_keywords को मिलाकर) का उपयोग किया जा सकता है।

Type: string

Example: rain
अनुरोध का उदाहरण 
GET https://ads-api.x.com/12/insights/keywords/search?end_time=2018-02-02&granularity=DAY&keywords=developers&start_time=2018-02-01
उदाहरण रिस्पॉन्स* 
    {
      "request": {
        "params": {
          "start_time": "2018-02-01T00:00:00Z",
          "end_time": "2018-02-02T00:00:00Z",
          "granularity": "DAY",
          "keywords": [
            "developers"
          ]
        }
      },
      "data": {
        "related_keywords": [
          "dev",
          "developer",
          "coders",
          "mysql",
          "devs",
          "#technology",
          "#developers",
          "security",
          "programmers",
          "#tech",
          "javascript",
          "#iot",
          "#bigdata",
          "cloud",
          "devops",
          "php",
          "developer",
          "programmer",
          "engineer",
          "big data",
          "agile",
          "app",
          "programming",
          "ios",
          "maker",
          "startups",
          "developer's",
          "java",
          "#devops",
          "startup"
        ],
        "tweet_volume": [
          15707
        ]
      }
    }

​
टेलर्ड ऑडियंस अनुमतियाँ

​
GET accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

निर्दिष्ट टेलर्ड ऑडियंस से जुड़ी कुछ या सभी permissions का विवरण प्राप्त करें। संसाधन URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
tailored_audience_id
required		उस टेलर्ड ऑडियंस का संदर्भ, जिस पर आप इस request में काम कर रहे हैं।

Type: string

Example: 1nmth
count
optional		हर अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है।

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		परिणामों का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें।

Type: string

Example: 8x7v00oow
granted_account_ids
optional		identifiers की अल्पविराम-से-अलग की गई सूची देकर रिस्पॉन्स को केवल इच्छित accounts तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं।

Type: string

Example: 18ce54aymz3
sort_by
optional		समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें।

Type: string

Example: created_at-asc
tailored_audience_permission_ids
optional		identifiers की अल्पविराम-से-अलग की गई सूची देकर रिस्पॉन्स को केवल इच्छित tailored audience permissions तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं।

Type: string

Example: ri
with_total_count
optional		total_count रिस्पॉन्स attribute शामिल करें।

Note: यह parameter और cursor एक साथ उपयोग नहीं किए जा सकते।

Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं।

Type: boolean

Default: false
Possible values: true, false
उदाहरण अनुरोध GET https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "tailored_audience_id": "1nmth"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "tailored_audience_id": "1nmth",
          "permission_level": "READ_ONLY",
          "id": "ri",
          "created_at": "2017-06-08T23:17:59Z",
          "granted_account_id": "18ce54aymz3",
          "updated_at": "2017-06-08T23:17:59Z",
          "deleted": false
        }
      ]
    }

​
POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

एक नया permission object बनाएँ, जिससे निर्दिष्ट ऑडियंस को दिए गए अकाउंट के साथ साझा किया जा सके। नोट: किसी tailored audience के लिए permissions बनाने या उनमें बदलाव करने के लिए ज़रूरी है कि वह ऑडियंस उसी अकाउंट के स्वामित्व में हो जो permissions बदलने का प्रयास कर रहा है। किसी tailored audience का स्वामित्व जाँचने के लिए, दिए गए ऑडियंस के रिस्पॉन्स में is_owner रिस्पॉन्स एट्रिब्यूट देखें। नोट: Audiences को केवल उसी business के अंतर्गत आने वाले ads accounts के बीच साझा किया जा सकता है, या फिर तब, जब ऑडियंस के स्वामी ads account में SHARE_AUDIENCE_OUTSIDE_BUSINESS account feature मौजूद हो। संसाधन URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests में एक आवश्यक parameter होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
granted_account_id
required		वह अकाउंट जिसे आप tailored audience permissions देना चाहते हैं।

Type: string

Example: 18ce54aymz3
permission_level
required		tailored audience के लिए वह access level जो granted_account_id के पास होना चाहिए।

Type: enum

Possible values: READ_ONLY, READ_WRITE
tailored_audience_id
required		request में जिस tailored audience पर आप काम कर रहे हैं, उसका reference।

Type: string

Example: 2906h
उदाहरण अनुरोध POST https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "granted_account_id": "18ce54aymz3",
          "permission_level": "READ_ONLY",
          "tailored_audience_id": "2906h"
        }
      },
      "data": {
        "tailored_audience_id": "2906h",
        "permission_level": "READ_ONLY",
        "id": "14m",
        "created_at": "2017-09-12T23:49:34Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-09-12T23:49:34Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id

निर्दिष्ट Tailored Audience साझाकरण अनुमति को निरस्त करें। नोट: किसी tailored audience के लिए अनुमति बनाना या उसमें बदलाव करना तभी संभव है, जब उस audience का स्वामित्व उसी account के पास हो जो अनुमति में बदलाव करने का प्रयास कर रहा है। किसी दिए गए audience के लिए रिस्पॉन्स में is_owner रिस्पॉन्स एट्रिब्यूट देखकर आप tailored audience के स्वामित्व की जांच कर सकते हैं। अनुमति निरस्त होने के बाद, हम यह सुनिश्चित करते हैं कि जिसे access दिया गया account (granted_account_id) भविष्य के campaigns में उस audience को target नहीं कर पाएगा। मौजूदा campaigns साझा audiences के साथ चलते रहेंगे; campaigns बंद नहीं होते और audience को campaign से नहीं हटाया जाता। audience साझाकरण अनुमति निरस्त होने के बाद इस campaign की कॉपी बनाना संभव नहीं है। संसाधन URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
tailored_audience_id
required		request में जिस tailored audience के साथ आप काम कर रहे हैं, उसका reference।

Type: string

Example: 1nmth
tailored_audience_permission_id
required		request में जिस tailored audience permission के साथ आप काम कर रहे हैं, उसका reference।

Type: string

Example: ri
उदाहरण अनुरोध DELETE https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions/ri उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "tailored_audience_permission_id": "ri",
          "tailored_audience_id": "1nmth"
        }
      },
      "data": {
        "tailored_audience_id": "1nmth",
        "permission_level": "READ_ONLY",
        "id": "ri",
        "created_at": "2017-06-08T23:17:59Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-08-30T18:29:35Z",
        "deleted": true
      }
    }

​
लक्षित ऑडियंस

​
GET accounts/:account_id/custom_audiences/:custom_audience_id/targeted

दिए गए custom_audience_id को लक्षित करने वाले सक्रिय या सभी line items और campaigns की सूची प्राप्त करें
NameDescription
account_id
required		उपयोग किए जा रहे account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
custom_audience_id
required		उस कस्टम ऑडियंस का reference जिसके साथ आप इस request में काम कर रहे हैं।

Type: string

Example: 2906h
with_active
optional		जब false हो, तो servable=false status वाले line items भी शामिल किए जाते हैं

Type: boolean

Default: true
Possible values: true, false
cursor
optional		परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें।

Type: string

Example: 8x7v00oow
उदाहरण अनुरोध GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/targeted उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "2906h",
        }
      },
      "next_cursor": null,
      "data": [
        {
          "campaign_id": "59hod",
          "campaign_name": "test-campaign",
          "line_items": [
            {
              "id": "5gzog",
              "name": "test-line-item",
              "servable": true
            }
          ]
        },
        {
          "campaign_id": "arja7",
          "campaign_name": "Untitled campaign",
          "line_items": [
            {
              "id": "bjw1q",
              "name": null,
              "servable": true
            }
          ]
        }
      ]
    }

​
कस्टम ऑडियंस के उपयोगकर्ता

​
POST accounts/:account_id/custom_audiences/:custom_audience_id/users

यह endpoint पार्टनर्स को दिए गए custom_audience_id में उपयोगकर्ताओं को जोड़ने, अपडेट करने और हटाने की अनुमति देता है। यह endpoint प्रति उपयोगकर्ता कई user identifier types भी स्वीकार करता है। request के users फ़ील्ड में दिया गया सारा डेटा, partner_user_id को छोड़कर, SHA256 का उपयोग करके hash किया हुआ होना चाहिए और normalized होना चाहिए। बैच अनुरोध
  • इस endpoint के लिए वर्तमान अधिकतम बैच आकार 2500 है। बैच आकार प्रति request operations (Update/Delete) की संख्या के आधार पर निर्धारित होता है। उदाहरण के लिए, एक array में 2500 से अधिक operation objects ({"operation_type": "Update/Delete", [..] }) होने पर error मिलता है।
  • इस endpoint द्वारा स्वीकार किए जाने वाले request POST body का अधिकतम आकार 5,000,000 bytes है।
  • इस endpoint के लिए रेट लिमिट्स 1 minute window में 1500 हैं।
  • सभी पैरामीटर request body में भेजे जाते हैं और application/json का Content-Type आवश्यक है।
  • बैच requests एक समूह के रूप में साथ-साथ असफल या सफल होते हैं, और error तथा success दोनों के लिए सभी API रिस्पॉन्स शुरुआती request के item order को बनाए रखते हैं।
बैच रिस्पॉन्स Ads API द्वारा लौटाए गए रिस्पॉन्स में दो फ़ील्ड्स होते हैं: success_count और total_count। ये मान हमेशा समान होने चाहिए, और ये request में मौजूद उन records की संख्या बताते हैं जिन्हें backend द्वारा प्रोसेस किया गया है। ऐसी स्थिति, जिसमें request body में भेजे गए records की संख्या success_count और total_count के बराबर नहीं हो, को error condition माना जाना चाहिए और इसके लिए retry आवश्यक है। बैच त्रुटियाँ
  • Request-level errors (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors object के अंतर्गत दिखाए जाते हैं।
  • Item-level errors (जैसे, आवश्यक पैरामीटर का न होना) रिस्पॉन्स में operation_errors object के अंतर्गत दिखाए जाते हैं।
  • operation_errors में error का index input item के index को संदर्भित करता है, साथ में संबंधित error message होता है

​
संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/users

​
पैरामीटर

नामविवरण
operation_type
required		users समूह के लिए किया जा रहा ऑपरेशन type।

Type: enum

संभावित मान: Update, Delete
params
required		एक JSON ऑब्जेक्ट, जिसमें users array और effective_at व expires_at टाइमस्टैम्प शामिल होते हैं।

Type: JSON
users
required		JSON ऑब्जेक्ट्स का एक array, जिसमें किसी एकल उपयोगकर्ता के लिए सभी params शामिल होते हैं।

Type: JSON
effective_at
optional		वह UTC समय जब custom audience association(s) प्रभावी होने चाहिए। इसे ISO 8601 में व्यक्त किया जाता है। डिफ़ॉल्ट रूप से यह वर्तमान दिनांक और समय होता है।

Type: string

उदाहरण: 2017-07-05T07:00:00Z
expires_at
optional		वह UTC समय जब custom audience association(s) की समय-सीमा समाप्त होनी चाहिए। निर्दिष्ट समय effective_at के मान से बाद का होना चाहिए। इसे ISO 8601 में व्यक्त किया जाता है। डिफ़ॉल्ट रूप से यह अनुरोध टाइमस्टैम्प से 13 महीने बाद होता है।

Type: string

उदाहरण: 2017-07-05T07:00:00Z
users ऑब्जेक्ट के बहु-कुंजी दृष्टिकोण को देखते हुए, इस ऑब्जेक्ट के प्रत्येक तत्व का दस्तावेज़ीकरण नीचे किया गया है:
नामविवरण
email
optional		उपयोगकर्ता का/के ईमेल पता/पते।

Type: Array[String]
device_id
optional		IDFA/AdID/Android ID

Type: Array[String]
handle
optional		उपयोगकर्ता से संबद्ध @handle(s)

Type: Array[String]
twitter_id
optional		उपयोगकर्ता से संबद्ध X ID

Type: Array[String]
phone_number
optional		उपयोगकर्ता का/के फ़ोन नंबर।

Type: Array[String]
partner_user_id
optional		पार्टनर के सिस्टम में उपयोगकर्ता की ID।

Type: Array[String]

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/users 
    [
      {
        "operation_type": "Update",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
              ],
              "handle": [
                "7352f353c460e74c7ae226952d04f8aa307b12329c5512ec8cb6f1a0f8f9b2cb",
                "49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d"
              ]
            },
            {
              "email": [
                "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
              ],
              "twitter_id": [
                "34d56c7159a7eea941f359653029410f813f65a1d2d13ecc5ccbdd5a8cb755cf",
                "00e7b76c9739dec57f4c4a20ec021a20ffcf26bd00f519b17ea00f0ed6048f85"
              ]
            }
          ]
        }
      },
      {
        "operation_type": "Delete",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "device_id": [
                "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
              ],
              "email": [
                "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
              ],
              "handle": [
                "461222f5dd690a20651c3d19848015cb0369db3f8e937571ffb775de70750847"
              ],
              "twitter_id": [
                "c623c7e163984493b46c547088542e95d0aaa529bc52bbecce3ff91eb6b7843b"
              ]
            },
            {
              "email": [
                "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
              ],
              "twitter_id": [
                "858cdc7f313f84a3f3c48e9a6323307c1ef1bb7439b8e3623e140454b0fd8fa5",
                "bb074e154657b91d99bd1bb3757409149670e8ae7a0fe9136fae29a26a7881c8"
              ]
            }
          ]
        }
      }
    ]

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "1nmth"
        }
      },
      "data": {
        "success_count": 4,
        "total_count": 4
      }
    }

​
कस्टम ऑडियंस अनुमतियाँ

​
GET accounts/:account_id/custom_audiences/:custom_audience_id/permissions

निर्दिष्ट कस्टम ऑडियंस से संबद्ध कुछ या सभी permissions का विवरण प्राप्त करें। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
custom_audience_id
required		उस कस्टम ऑडियंस का संदर्भ, जिस पर आप इस अनुरोध में कार्य कर रहे हैं।

Type: string

Example: 1nmth
count
optional		प्रत्येक अनुरोध में प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है।

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें।

Type: string

Example: 8x7v00oow
granted_account_ids
optional		identifiers की comma-separated सूची देकर रिस्पॉन्स को केवल इच्छित accounts तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं।

Type: string

Example: 18ce54aymz3
sort_by
optional		समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें।

Type: string

Example: created_at-asc
custom_audience_permission_ids
optional		identifiers की comma-separated सूची देकर रिस्पॉन्स को केवल इच्छित कस्टम ऑडियंस permissions तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं।

Type: string

Example: ri
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/custom_audiences/1nmth/permissions उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "1nmth"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "custom_audience_id": "1nmth",
          "permission_level": "READ_ONLY",
          "id": "ri",
          "created_at": "2017-06-08T23:17:59Z",
          "granted_account_id": "18ce54aymz3",
          "updated_at": "2017-06-08T23:17:59Z",
          "deleted": false
        }
      ]
    }

​
POST accounts/:account_id/custom_audiences/:custom_audience_id/permissions

निर्दिष्ट ऑडियंस को किसी दिए गए अकाउंट के साथ साझा करने की अनुमति देने वाला एक नया permission ऑब्जेक्ट बनाएँ। नोट: किसी कस्टम ऑडियंस के लिए permissions बनाना या उनमें बदलाव करना तभी संभव है, जब उस ऑडियंस का स्वामित्व उसी अकाउंट के पास हो जो permissions में बदलाव करने का प्रयास कर रहा है। किसी दिए गए ऑडियंस के लिए रिस्पॉन्स में is_owner रिस्पॉन्स एट्रिब्यूट देखकर आप कस्टम ऑडियंस के स्वामित्व की जाँच कर सकते हैं। नोट: Audiences केवल उसी business के अंतर्गत आने वाले ads accounts के बीच साझा किए जा सकते हैं, या तब जब ऑडियंस का स्वामी ads account SHARE_AUDIENCE_OUTSIDE_BUSINESS account feature रखता हो। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions पैरामीटर
NameDescription
account_id
required		उपयोग किए जा रहे अकाउंट का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
granted_account_id
required		वह अकाउंट जिसे आप कस्टम ऑडियंस के लिए permissions देना चाहते हैं।

Type: string

Example: 18ce54aymz3
permission_level
required		कस्टम ऑडियंस के लिए वह access type जो granted_account_id के पास होना चाहिए।

Type: enum

Possible values: READ_ONLY, READ_WRITE
custom_audience_id
required		उस कस्टम ऑडियंस का संदर्भ जिस पर आप इस request में काम कर रहे हैं।

Type: string

Example: 2906h
उदाहरण अनुरोध 
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY
उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "granted_account_id": "18ce54aymz3",
          "permission_level": "READ_ONLY",
          "custom_audience_id": "2906h"
        }
      },
      "data": {
        "custom_audience_id": "2906h",
        "permission_level": "READ_ONLY",
        "id": "14m",
        "created_at": "2017-09-12T23:49:34Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-09-12T23:49:34Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/custom_audiences/:custom_audience_id/permissions/:custom_audience_permission_id

निर्दिष्ट कस्टम ऑडियंस साझाकरण अनुमति को निरस्त करता है। नोट: किसी कस्टम ऑडियंस के लिए अनुमतियाँ बनाने या उनमें बदलाव करने के लिए, उस audience का स्वामित्व उसी account के पास होना चाहिए जो अनुमतियों में बदलाव करने का प्रयास कर रहा है। किसी दिए गए audience के लिए रिस्पॉन्स में is_owner रिस्पॉन्स एट्रिब्यूट देखकर आप कस्टम ऑडियंस के स्वामित्व की जाँच कर सकते हैं। अनुमति निरस्त होने पर, हम यह सुनिश्चित करते हैं कि जिसे access दिया गया account (granted_account_id) भविष्य के campaigns में उस audience को target नहीं कर पाएगा। मौजूदा campaigns साझा किए गए audiences के साथ चलते रहेंगे; campaigns बंद नहीं होते हैं और audience campaign से हटाया नहीं जाता। audience साझाकरण अनुमति निरस्त होने के बाद इस campaign की कॉपी बनाना संभव नहीं है। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions/:custom_audience_permission_id पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
custom_audience_id
required		उस कस्टम ऑडियंस का संदर्भ, जिस पर आप request में काम कर रहे हैं।

Type: string

Example: 1nmth
custom_audience_permission_id
required		उस कस्टम ऑडियंस permission का संदर्भ, जिस पर आप request में काम कर रहे हैं।

Type: string

Example: ri
उदाहरण अनुरोध DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/permissions/ri उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_permission_id": "ri",
          "custom_audience_id": "1nmth"
        }
      },
      "data": {
        "custom_audience_id": "1nmth",
        "permission_level": "READ_ONLY",
        "id": "ri",
        "created_at": "2017-06-08T23:17:59Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-08-30T18:29:35Z",
        "deleted": true
      }
    }

​
कस्टम ऑडियंस

​
GET accounts/:account_id/custom_audiences

वर्तमान खाते से संबद्ध कुछ या सभी Custom Audiences का विवरण प्राप्त करें। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences पैरामीटर
NameDescription
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
permission_scope
optional		रिस्पॉन्स को उन सूचियों तक फ़िल्टर करने की अनुमति देता है जो आपकी हैं या जो आपके साथ साझा की गई हैं। डिफ़ॉल्ट रूप से, इस पैरामीटर को निर्दिष्ट किए बिना आपको केवल वही audiences दिखाई देंगी जिनके आप स्वामी हैं।

Type: enum

Default: OWNER
Possible values: OWNER, SHARED
q
optional		name के आधार पर संसाधन को सीमित करने के लिए वैकल्पिक क्वेरी।

नोट: यह केस-इंसेंसिटिव प्रीफ़िक्स मिलान करता है।

Type: string

Min, Max length: 1, 255
sort_by
optional		समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें।

Type: string

Example: created_at-asc
custom_audience_ids
optional		अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित custom audiences तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं।

Type: string

Example: 1nmth
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/custom_audiences?custom_audience_ids=1nmth उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "custom_audience_ids": [
            "1nmth"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "targetable": true,
          "name": "twurl-using-subshell-for-file",
          "targetable_types": [
            "CRM",
            "EXCLUDED_CRM"
          ],
          "audience_type": "CRM",
          "description": null,
          "permission_level": "READ_WRITE",
          "owner_account_id": "18ce54d4x5t",
          "id": "1nmth",
          "reasons_not_targetable": [],
          "created_at": "2017-01-08T08:19:58Z",
          "updated_at": "2017-01-08T16:21:13Z",
          "partner_source": "OTHER",
          "deleted": false,
          "audience_size": 1470
        }
      ]
    }

​
GET accounts/:account_id/custom_audiences/:custom_audience_id

वर्तमान खाते से संबद्ध विशिष्ट Custom Audiences प्राप्त करें। रिसोर्स URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id पैरामीटर
नामविवरण
account_id
आवश्यक		उपयोग में लिए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

उदाहरण: 18ce54d4x5t
custom_audience_id
आवश्यक		उस Custom Audience का संदर्भ जिसके साथ आप इस अनुरोध में काम कर रहे हैं।

Type: string

उदाहरण: 2906h
with_deleted
वैकल्पिक		अपने अनुरोध में हटाए गए परिणामों को शामिल करें।

Type: boolean

डिफ़ॉल्ट: false
संभावित मान: true, false
उदाहरण अनुरोध GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "custom_audience_id": "2906h",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": 140321
      }
    }

​
POST accounts/:account_id/custom_audiences

वर्तमान खाते से संबद्ध एक नया प्लेसहोल्डर Custom Audience बनाएं। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences पैरामीटर
NameDescription
account_id
required		उपयोग किए जा रहे खाते का पहचानकर्ता। यह संसाधन के पथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
name
required		इस ऑडियंस का प्रदर्शित नाम। नाम का मान अद्वितीय होना चाहिए। ऐसा न करने पर त्रुटि होगी।

Type: string

Example: ads api users
description
optional		इस ऑडियंस के लिए एक विवरण।

Type: string

Example: Collection of all users of the Ads API
उदाहरण अनुरोध POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences?name=developers उदाहरण रिस्पॉन्स 
    {
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "name": "developers"
        }
      }
    }

​
PUT accounts/:account_id/custom_audiences/:custom_audience_id

वर्तमान खाते से संबद्ध विशिष्ट Custom Audience को अपडेट करें। रिसोर्स URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id पैरामीटर
NameDescription
account_id
required		उपयोग में लिए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
custom_audience_id
required		उस Custom Audience का संदर्भ जिस पर आप इस अनुरोध में कार्य कर रहे हैं

Type: string

Example: 2906h
name
optional		इस ऑडियंस का प्रदर्शित नाम। नाम का मान अद्वितीय होना चाहिए। ऐसा न करने पर त्रुटि होगी।

Type: string

Example: ads api users
description
optional		इस ऑडियंस का विवरण।

Type: string

Example: Collection of all users of the Ads API
उदाहरण अनुरोध PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h?name=developers_changed उदाहरण रिस्पॉन्स 
    {
      "data": {
        "targetable": false,
        "name": "developers_changed",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "is_owner": true,
        "id": "2906h",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "name": "developers_changed"
        }
      }
    }

​
POST batch/accounts/:account_id/custom_audiences

Custom Audiences के बैच निर्माण की सुविधा देता है। ऑडियंस के बारे में जानकारी के लिए Custom Audiences Overview पेज देखें। नोट: यह बैच endpoint फिलहाल closed beta में है और चुनिंदा विज्ञापनदाताओं के लिए उपलब्ध है। इस beta अवधि के दौरान, केवल mobile custom audiences पर आधारित Flexible Audiences ही बनाए जा सकते हैं। बैच अनुरोध
  • वर्तमान में अधिकतम बैच आकार 10 है।
  • सभी पैरामीटर request body में भेजे जाते हैं और Content-Type का application/json होना आवश्यक है।
  • बैच अनुरोध समूह के रूप में एक साथ विफल या सफल होते हैं, और error तथा success दोनों स्थितियों में सभी API रिस्पॉन्स शुरुआती अनुरोध के आइटम क्रम को बनाए रखते हैं।
बैच रिस्पॉन्स Batch API रिस्पॉन्स आइटमों का क्रमबद्ध संग्रह लौटाते हैं। इसके अलावा, उनकी संरचना उनके संबंधित single-item endpoints जैसी ही होती है। बैच त्रुटियाँ
  • Request-level त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors object के अंतर्गत दिखाई जाती हैं।
  • Item-level त्रुटियाँ (जैसे, आवश्यक पैरामीटर का न होना) रिस्पॉन्स में operation_errors object के अंतर्गत दिखाई जाती हैं।
Flexible Audiences
  • Flexible Audiences एक बार बन जाने के बाद अपरिवर्तनीय होते हैं।
  • Flexible Audiences बनाने के लिए Custom Audiences को boolean logic combinations के साथ tree structure में पास किया जाता है।
  • एक Flexible Audience बनाने के लिए अधिकतम 10 Custom Audiences leaf nodes का उपयोग किया जा सकता है।
संसाधन URL https://ads-api.x.com/12/batch/accounts/:account_id/custom_audiences पैरामीटर
नामविवरण
account_id
required		उपयोग में लिए गए खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक parameter होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
audience_type
required		बनाए जाने वाले ऑडियंस का type।

Type: enum

Possible values: FLEXIBLE, MOBILE_AUDIENCE
child_segments
required		एक array, जिसमें ऐसे objects होते हैं जो Custom Audience के सदस्यों के उस उपसमूह को परिभाषित करते हैं जिसे आप target करना चाहते हैं। प्रत्येक object में custom_audience_id, frequency, frequency_comparator, lookback_window, negate और कुछ मामलों में अतिरिक्त child_segments होने चाहिए।

Type: array
name
required		ऑडियंस का display name। नाम का मान अद्वितीय होना चाहिए। ऐसा न करने पर त्रुटि होगी।

Type: string

Example: my_flexible_audience_name
operation_type
required		प्रत्येक item पर की जा रही operation का type।

Type: enum

Possible values: Create, Update, Delete
boolean_operator
sometimes required		अपने parent (containing) object में child segments के बीच का logical संबंध। यदि parent object के लिए child_segments खाली नहीं है, तो यह आवश्यक है।

Type: enum

Possible values: AND, OR
lookback_window
sometimes required		एक integer मान, जो उन दिनों की सीमा बताता है जिनके भीतर उपयोगकर्ता ने निर्दिष्ट कार्रवाई की है और दिए गए custom audience के लिए qualify किया है।

Type: int

Possible values: 1, 7, 14, 30
segments
sometimes required		एक object, जिसमें boolean_operator और child_segments होते हैं, जो Custom Audience के सदस्यों के उस उपसमूह को परिभाषित करते हैं जिसे आप target करना चाहते हैं।

Type: object
custom_audience_id
sometimes required		child segment के रूप में इस्तेमाल किए जाने वाले custom audience का id।

Type: string

Example: tyfo
frequency
optional		एक integer मान, जो lookback window के भीतर उस आवृत्ति को निर्दिष्ट करता है जिस पर उपयोगकर्ता ने निर्दिष्ट कार्रवाई की है और दिए गए custom audience के for qualify किया है।

Type: int

Default value: 1
frequency_comparator
optional		अनुरोध में भेजे गए frequency के लिए comparator।

Note: नीचे दिए गए मानों में, GTE का अर्थ greater than or equal है, LT का अर्थ less than है, आदि।

Type: string

Possible values: NUM_GTE, NUM_GT, NUM_EQ, NUM_LTE, NUM_LT Default value: NUM_GTE
negate
optional		segment को negate करता है, इसलिए उसे संयोजन से बाहर रखा जाता है।

Type: boolean

Default value: true
Possible values: true, false
उदाहरण अनुरोध POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/custom_audiences 
    [
      {
        "operation_type":"Create",
        "params":{
          "name":"my_flexible_audience_name",
          "audience_type":"FLEXIBLE",
          "segments":{
            "boolean_operator":"AND",
            "child_segments":[
              {
                "custom_audience_id":"TYIF",
                "frequency":1,
                "frequency_comparator":"NUM_GT",
                "lookback_window":30,
                "negate":true,
                "child_segments":[

                ]
              },
              {
                "boolean_operator":"OR",
                "child_segments":[
                  {
                    "custom_audience_id":"TXR1",
                    "lookback_window":30,
                    "child_segments":[

                    ]
                  },
                  {
                    "custom_audience_id":"TYFO",
                    "frequency":1,
                    "frequency_comparator":"NUM_GT",
                    "lookback_window":30,
                    "negate":true,
                    "child_segments":[

                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    ]
उदाहरण रिस्पॉन्स 
    {
      "data": {
        "targetable": false,
        "name": "my_flexible_audience_name",
        "targetable_types": [
          "FLEXIBLE",
          "EXCLUDED_FLEXIBLE"
        ],
        "audience_type": "FLEXIBLE",
        "id": "13ld7",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "metadata": [
          {
            "custom_audience_id": "13ld7",
            "account_id": "qsx3w2",
            "name": "my_flexible_audience_name",
            "audience_source": "FLEXIBLE_AUDIENCE",
            "upload_status": "UPLOADED",
            "segments": {
              "boolean_operator": "AND",
              "frequency": 1,
              "frequency_comparator": "NUM_GTE",
              "negate": false,
              "child_segments": [
                {
                  "custom_audience_id": "tyif",
                  "lookback_window": 30,
                  "frequency": 1,
                  "frequency_comparator": "NUM_GT",
                  "negate": true,
                  "child_segments": [

                  ]
                },
                {
                  "boolean_operator": "OR",
                  "frequency": 1,
                  "frequency_comparator": "NUM_GTE",
                  "negate": false,
                  "child_segments": [
                    {
                      "custom_audience_id": "txr1",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GTE",
                      "negate": false,
                      "child_segments": [

                      ]
                    },
                    {
                      "custom_audience_id": "tyfo",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GT",
                      "negate": true,
                      "child_segments": [

                      ]
                    }
                  ]
                }
              ]
            }
          }
        ],
        "created_at": "2015-11-10T21:26:43Z",
        "updated_at": "2015-11-11T01:11:47Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": [
        {
          "params": {
            "name": "my_flexible_audience_name",
            "audience_type": "FLEXIBLE",
            "segments": {
              "boolean_operator": "AND",
              "child_segments": [
                {
                  "custom_audience_id": "TYIF",
                  "lookback_window": 30,
                  "frequency": 1,
                  "frequency_comparator": "NUM_GT",
                  "negate": true,
                  "child_segments": [

                  ]
                },
                {
                  "boolean_operator": "OR",
                  "child_segments": [
                    {
                      "custom_audience_id": "TXR1",
                      "lookback_window": 30,
                      "child_segments": [

                      ]
                    },
                    {
                      "custom_audience_id": "TYFO",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GT",
                      "negate": true,
                      "child_segments": [

                      ]
                    }
                  ]
                }
              ]
            },
            "account_id": "qsx3w2"
          },
          "operation_type": "Create"
        }
      ]
    }

​
DELETE accounts/:account_id/custom_audiences/:custom_audience_id

वर्तमान खाते से संबंधित निर्दिष्ट Custom Audience को हटाएँ। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id पैरामीटर
NameDescription
account_id
required		leveraged खाते का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता authenticated user से संबद्ध होना चाहिए।

Type: string

उदाहरण: 18ce54d4x5t
custom_audience_id
required		request में जिस custom audience पर आप कार्रवाई कर रहे हैं, उसका reference।

Type: string

उदाहरण: 2906h
उदाहरण अनुरोध DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h उदाहरण रिस्पॉन्स 
    {
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [
          "TOO_SMALL"
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-30T18:09:00Z",
        "partner_source": "OTHER",
        "deleted": true,
        "audience_size": null
      },
      "request": {
        "params": {
          "custom_audience_id": "2906h",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
Do Not Reach सूची

​
GET accounts/:account_id/do_not_reach_lists

वर्तमान खाते से संबद्ध कुछ या सभी Do Not Reach सूचियों का विवरण प्राप्त करें। नोट: किसी account_id से अधिकतम केवल एक Do Not Reach सूची संबद्ध हो सकती है संसाधन URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists पैरामीटर
NameDescription
account_id
required		उपयोग में लिए गए खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
with_deleted
optional		अपने अनुरोध में deleted परिणाम शामिल करें।

Type: boolean

Default: false
Possible values: true, false
उदाहरण अनुरोध GET https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "account_id": "18ce54bgxky"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "targetable": false,
          "name": "Do Not Reach List",
          "description": "test DNRL",
          "id": "4kzrq",
          "reasons_not_targetable": [
            "TOO_SMALL"
          ],
          "created_at": "2021-10-28T22:09:29Z",
          "list_size": null,
          "updated_at": "2021-11-04T03:33:06Z",
          "deleted": false
        }
      ]
    }

​
POST accounts/:account_id/do_not_reach_lists

वर्तमान खाते से संबद्ध एक नई Do Not Reach सूची बनाएँ। नोट: किसी account_id से अधिकतम केवल एक Do Not Reach सूची जुड़ी हो सकती है संसाधन URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists पैरामीटर
NameDescription
account_id
required		उपयोग में लिए जा रहे खाते का पहचानकर्ता। यह संसाधन के पथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
description
optional		इस ऑडियंस का विवरण।

Type: string

Example: A list of users to exclude
उदाहरण अनुरोध POST https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists?description=A list of users to exclude उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "description": "A list of users to exclude",
          "account_id": "18ce54bgxky"
        }
      },
      "data": {
        "targetable": false,
        "name": "Do Not Reach List",
        "description": "A list of users to exclude",
        "id": "4ofrq",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2022-02-08T23:02:48Z",
        "list_size": null,
        "updated_at": "2022-02-08T23:02:48Z",
        "deleted": false
      }
    }

​
POST batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users

यह endpoint उपयोगकर्ताओं को दिए गए do_not_reach_list_id में जोड़ने, अपडेट करने और हटाने की अनुमति देता है। यह endpoint वैध उपयोगकर्ता पहचानकर्ता type के रूप में केवल ईमेल स्वीकार करता है। request के emails फ़ील्ड में दिया गया सारा डेटा SHA256 का उपयोग करके हैश किया जाना चाहिए और normalized होना चाहिए। नोट्स
  • एक account_id में अधिकतम केवल एक Do Not Reach सूची हो सकती है
  • इस सूची में जोड़े गए उपयोगकर्ताओं के लिए expires_at टाइमस्टैम्प वर्तमान टाइमस्टैम्प से 13 महीनों से कम पर सेट होना अनिवार्य है
  • Do Not Reach सूची API effective_at टाइमस्टैम्प स्वीकार नहीं करता और डिफ़ॉल्ट रूप से वर्तमान टाइमस्टैम्प का उपयोग करता है
  • Do Not Reach सूची खाते की किसी एक या सभी Custom Audiences से उपयोगकर्ताओं को नहीं हटाता, बल्कि खाते के लिए serve किए गए सभी campaigns में exclusion targeting के रूप में काम करता है
बैच अनुरोध
  • वर्तमान अधिकतम बैच आकार 2500 है इस endpoint के लिए। बैच आकार प्रति request operations (Update/Delete) की संख्या से निर्धारित होता है। उदाहरण के लिए, एक array में 2500 से अधिक operation objects ({"operation_type": "Update/Delete", [..] }) होने पर error होता है।
  • अधिकतम request POST body आकार जिसे यह endpoint स्वीकार कर सकता है, 5,000,000 bytes है।
  • इस endpoint के लिए रेट लिमिट्स 1 मिनट की window में 1500 हैं
  • सभी पैरामीटर request body में भेजे जाते हैं और application/json का Content-Type आवश्यक है।
  • बैच requests एक समूह के रूप में साथ-साथ विफल या सफल होती हैं, और error तथा success दोनों के लिए सभी API रिस्पॉन्स प्रारंभिक request के item order को बनाए रखते हैं।
बैच रिस्पॉन्स Ads API द्वारा लौटाए गए रिस्पॉन्स में दो फ़ील्ड्स होते हैं, success_count और total_count। ये मान हमेशा समान होने चाहिए, और ये request में मौजूद उन records की संख्या बताते हैं जिन्हें backend द्वारा प्रोसेस किया गया है। ऐसी स्थिति, जहाँ request body में भेजे गए records की संख्या success_count और total_count के बराबर नहीं है, को error condition माना जाना चाहिए, और इसके लिए retry आवश्यक है। बैच त्रुटियाँ
  • request-level errors (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors object के अंतर्गत दिखाए जाते हैं।
  • item-level errors (जैसे, आवश्यक पैरामीटर का न होना) रिस्पॉन्स में operation_errors object के अंतर्गत दिखाए जाते हैं।
  • operation_errors में error का index, संबंधित error message के साथ input item के index को संदर्भित करता है
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users पैरामीटर
NameDescription
account_id
required		leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए।

Type: string

Example: 18ce54d4x5t
do_not_reach_list_id
required		उस Do Not Reach सूची का reference, जिसके साथ आप request में काम कर रहे हैं

Type: string

Example: 2906h
operation_type
required		प्रत्येक users group पर किया जाने वाला operation type।

Type: enum

Possible values: Update, Delete
params
required		एक JSON object जिसमें emails array और expires_at टाइमस्टैम्प शामिल होता है।

Type: JSON
users
required		JSON objects की एक array, जिसमें किसी व्यक्तिगत उपयोगकर्ता के लिए सभी params शामिल होते हैं।

Type: JSON
expires_at
optional		वह UTC समय, जब user association(s) समाप्त हो जानी चाहिए। निर्दिष्ट समय वर्तमान टाइमस्टैम्प के मान से बाद का होना चाहिए। ISO 8601 में व्यक्त। डिफ़ॉल्ट रूप से यह वर्तमान टाइमस्टैम्प से 13 महीने आगे होता है।

Type: string

Example: 2017-07-05T07:00:00Z
users object के multi-key approach को देखते हुए, इस object के प्रत्येक element का दस्तावेज़ीकरण नीचे किया गया है:
नामविवरण
email
वैकल्पिक		उपयोगकर्ता के ईमेल पते।

Type: Array[String]
phone_number
वैकल्पिक		उपयोगकर्ता के फ़ोन नंबर

Type: Array[String]
उदाहरण अनुरोध 
`POST https://ads-api.x.com/12/batch/accounts/18ce54bgxky/do_not_reach_lists/4kzro/users`

    [
      {
        "operation_type": "Update",
        "params": {
          "expires_at": "2023-01-22T00:00:00Z",
          "users": [
            {
              "email": [
                "FEAD76F6ADF99FFFB997AA4E3C8AD38FF531BC4C956DBD03CD0163F744D8AABC"
              ],
              "phone_number": [
                "CCABF1B62A202E0FE28BC6C014983C89A65451DD4482BD66A0ADB65366F38A9A"
              ]
            },
            {
              "email": [
                "FEAD76F6ADF99FFFB997AA4E3C8AD38FF531BC4C956DBD03CD0163F744D8AABA"
              ],
              "phone_number": [
                "CCABF1B62A202E0FE28BC6C014983C89A65451DD4482BD66A0ADB65366F38A9E"
              ]
            }
          ]
        }
      }
    ]
उदाहरण रिस्पॉन्स 
    {
      "data": [
        {
          "success_count": 2,
          "total_count": 2
        }
      ],
      "request": [
        {
          "params": {
            "do_not_reach_list_id": "4ofrq",
            "expires_at": "2023-01-22T00:00:00Z",
            "account_id": "18ce54bgxky"
          },
          "operation_type": "Update"
        }
      ]
    }

​
DELETE accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id

मौजूदा अकाउंट से संबंधित निर्दिष्ट Do Not Reach सूची हटाएँ। संसाधन URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id पैरामीटर कोई नहीं उदाहरण अनुरोध DELETE https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists/4ofrp उदाहरण रिस्पॉन्स 
    {
      "request": {
        "params": {
          "do_not_reach_list_id": "4ofrp",
          "account_id": "18ce54bgxky"
        }
      },
      "data": {
        "targetable": false,
        "name": "Do Not Reach List",
        "description": null,
        "id": "4ofrp",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2022-02-08T23:02:07Z",
        "list_size": null,
        "updated_at": "2022-02-08T23:02:21Z",
        "deleted": true
      }
    }