अभियान प्रबंधन

Advertiser API

API के इस सूट के माध्यम से X पर अभियान को प्रोग्रामेटिक रूप से शेड्यूल करें और विज्ञापनों का प्रबंधन करें।

आप क्या प्रमोट कर सकते हैं?

प्रचारित विज्ञापन

• प्रचारित विज्ञापन सामान्य विज्ञापन होते हैं, जिन्हें वे विज्ञापनदाता खरीदते हैं जो उपयोगकर्ताओं के बड़े समूह तक पहुँचना चाहते हैं या अपने मौजूदा फ़ॉलोअर्स से अधिक जुड़ाव हासिल करना चाहते हैं।
• जब कोई विज्ञापनदाता X पर उनके प्लेसमेंट के लिए भुगतान करता है, तो प्रचारित विज्ञापनों पर स्पष्ट रूप से Promoted का लेबल दिखता है। बाकी सभी मामलों में, प्रचारित विज्ञापन सामान्य विज्ञापनों की तरह ही काम करते हैं और उन्हें repost, reply, like आदि किया जा सकता है। इन पर सामान्य डिलीवरी नियम लागू होते हैं और इन्हें POST statuses/update का उपयोग करके बनाया जाता है।
• “केवल-प्रचारित” Tweets, जिन्हें POST accounts/:account_id/tweet के माध्यम से बनाया जाता है, Promoted Tweets अभियानों में इस्तेमाल किए जा सकते हैं, लेकिन वे फ़ॉलोअर्स को नहीं दिखेंगे और न ही सार्वजनिक टाइमलाइन पर दिखाई देंगे। किसी विशेष खाते के केवल-प्रचारित tweets की सूची प्राप्त करने के लिए, GET accounts/:account_id/scoped_timeline का उपयोग करें।

प्रमोटेड अकाउंट्स

• प्रमोटेड अकाउंट्स, Who to Follow का हिस्सा हैं, जो ऐसे अकाउंट्स का सुझाव देता है जिन्हें लोग अभी फ़ॉलो नहीं कर रहे हैं और जो उन्हें दिलचस्प लग सकते हैं। प्रमोटेड अकाउंट्स ऐसे अकाउंट्स की और भी व्यापक श्रृंखला से लोगों को परिचित कराने में मदद करते हैं, जिन्हें वे पसंद कर सकते हैं।
• Timeline के लिए प्रमोटेड अकाउंट्स, Promoted Tweet को प्रमोटेड अकाउंट कैंपेन से संबद्ध करते हैं और उपयोगकर्ता की टाइमलाइन में दिखते हैं।

Ads API में प्रमोटेड ट्रेंड्स उपलब्ध नहीं हैं।

अभियान और विज्ञापन समूह (Line Items)

अभियान किसी विज्ञापन की समय-सारणी और बजट तय करते हैं। विज्ञापनदाता दैनिक और कुल बजट निर्दिष्ट करता है। अभियान को किसी विशिष्ट प्रारंभ और समाप्ति समय से जोड़ा जा सकता है, या बजट समाप्त होने तक इसे लगातार चलाया जा सकता है। बजट विज्ञापन खाते के फंडिंग इंस्ट्रूमेंट्स में से किसी एक से आता है। अभियान पहचानकर्ता (:campaign_id), X Ads UI में दिखाए जाने वाले base-10 मान का base-36 निरूपण होते हैं।

विज्ञापन खातों में अधिकतम 200 सक्रिय अभियान हो सकते हैं। अनुरोध पर, विज्ञापनदाता का X Account Manager इस सीमा को मैन्युअल रूप से बढ़ाकर 4,000 सक्रिय अभियानों तक कर सकता है। किसी अभियान को तब तक सक्रिय माना जाता है, जब तक वह अपने समाप्ति समय तक नहीं पहुँच जाता या उसे हटा नहीं दिया जाता। रोके गए अभियान भी अपने निर्धारित समाप्ति समय तक सक्रिय माने जाते हैं।

Line items किसी अभियान द्वारा निर्धारित बजट को खर्च करते हैं। Line items प्रति-एंगेजमेंट बोली, प्रमोट किए जाने वाले Tweet या खाते, और टार्गेटिंग नियमों को एक साथ जोड़ते हैं।

विश्लेषिकी

X Ads API विज्ञापन प्रदर्शन को ट्रैक और ऑप्टिमाइज़ करने के लिए analytics endpoints का एक सेट प्रदान करता है। अधिक जानकारी के लिए कृपया Analytics और Analytics Best Practices देखें।

billing metric के लिए, event के तीन दिन बाद तक डेटा अंतिम रूप से तय नहीं हो सकता। उस समय तक, डेटा को अनुमानित माना जाना चाहिए। अंतिम billable संख्या हमेशा अनुमानित मात्रा से कम होगी। billable संख्या को spam और उससे संबंधित निम्न-गुणवत्ता वाले traffic के अनुसार समायोजित किया जाता है। समय से जुड़ी अन्य बातों के लिए Timezones देखें।

अभियान बनाना - चरण-दर-चरण

निम्न उदाहरण में यह माना गया है कि आपने twurl का उपयोग करके अपने ऐप और उपयोगकर्ता को इंस्टॉल, कॉन्फ़िगर और अधिकृत कर लिया है। twurl, cURL की तरह एक कमांड-लाइन टूल है, जो X OAuth प्रमाणीकरण को आसानी से संभालता है। twurl, Ads API (और REST API) की कार्यक्षमता का तेज़ी से परीक्षण और डीबगिंग करने के लिए एक बेहतरीन टूल है। अनुरोध और रिस्पॉन्स के पूरे हेडर देखने के लिए, कॉल को ट्रेस करने हेतु -t का उपयोग करें, जो लगभग cURL के -v विकल्प के बराबर है।

इस उदाहरण में, हम एक प्रचारित विज्ञापन अभियान बनाएँगे, जिसे keyword के आधार पर लक्षित किया जाएगा।

1. खाते का id प्राप्त करें।

twurl -H ads-api.x.com /9/accounts/

{
  "request": {
    "params": {
    }
  },
  "data": [
    {
      "name": "Test account for @AdsAPI",
      "timezone": "America/Los_Angeles",
      "timezone_switch_at": null,
      "id": "xxxxxx",
      "created_at": "2014-03-09T00:41:49Z",
      "salt": "f9f9d5a5f23075c618da5eb1d1a9df57",
      "updated_at": "2015-01-29T00:41:49Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}

2. फंडिंग इंस्ट्रूमेंट id प्राप्त करें।

पिछले कमांड में प्राप्त अकाउंट id का उपयोग करके GET accounts/:account_id/funding_instruments API को कॉल करें।

twurl -H ads-api.x.com /9/accounts/xxxxxx/funding_instruments

{
  "data": [
    {
      "cancelled": true,
      "created_at": "2014-03-09T00:41:49Z",
      "credit_limit_local_micro": null,
      "currency": "USD",
      "deleted": false,
      "description": null,
      "end_time": null,
      "funded_amount_local_micro": null,
      "id": "yyyy",
      "type": null,
      "updated_at": "2014-05-29T00:41:49Z"
    }
  ],
  "data_type": "funding_instrument",
  "next_cursor": null,
  "request": {
    "params": {
      "account_id": "xxxxxx"
    }
  },
  "total_count": 1
}

3. एक अभियान बनाएँ और उसे फंडिंग इंस्ट्रूमेंट से संबद्ध करें।

अभियान के लिए प्रारंभ समय और बजट निर्धारित करें। इस उदाहरण में, हम $500 का बजट और दैनिक सीमा के लिए $50 का उपयोग करेंगे।

twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=My First Campaign&total_budget_amount_local_micro=500000000&daily_budget_amount_local_micro=50000000" /9/accounts/xxxxxx/campaigns

{
  "data": {
    "created_at": "2015-02-09T00:00:00Z",
    "currency": "USD",
    "daily_budget_amount_local_micro": 50000000,
    "deleted": false,
    "end_time": null,
    "funding_instrument_id": "yyyy",
    "id": "92ph",
    "name": "My First Campaign",
    "entity_status": "PAUSED",
    "standard_delivery": true,
    "total_budget_amount_local_micro": 500000000,
    "updated_at": "2015-02-09T00:00:00Z"
  },
  "data_type": "campaign",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "daily_budget_amount_local_micro": 50000000,
      "funding_instrument_id": "yyyy",
      "name": "My First Campaign",
      "total_budget_amount_local_micro": 500000000
    }
  }
}

4. अभियान से संबद्ध एक line item बनाएँ।

अब जबकि हमारे पास अभियान id है, हम उससे संबद्ध करने के लिए एक line item बना सकते हैं। line item में अभियान का bid price, targeting, और वास्तविक creative भाग शामिल होता है। इस line item के लिए, हम $1.50 की bid के साथ Tweets का प्रचार करेंगे.

twurl -H ads-api.x.com -d "campaign_id=XXXX&bid_amount_local_micro=1500000&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&objective=ENGAGEMENTS&entity_status=PAUSED" /9/accounts/xxxxxxx/line_items

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "Untitled",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "azjx",
    "entity_status": "PAUSED",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:00Z",
    "updated_at": "2015-02-09T00:00:00Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "92ph",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 1500000,
      "product_type": "PROMOTED_TWEETS",
      "entity_status": "PAUSED",
      "account_id": "xxxxxxx",
      "campaign_id": "92ph"
    }
  }
}

5. line item से संबद्ध एक टार्गेटिंग प्रोफ़ाइल बनाएँ।

line item बन जाने के बाद, हम टार्गेटिंग मानदंड सेट कर सकते हैं। हम San Francisco Bay Area लोकेशन में “grumpy cat” वाक्यांश कीवर्ड को टार्गेट करना चाहते हैं। इसके लिए एक location id lookup और दो targeting_criteria POST अनुरोधों की आवश्यकता होगी।

twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"

{
  "data": [
    {
      "name": "San Francisco-Oakland-San Jose CA, US",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  ],
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "location_type": "CITY",
      "q": "San Francisco"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=LOCATION&targeting_value=5122804691e5fecc" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:15Z",
    "deleted": false,
    "id": "2u3be",
    "line_item_id": "yyyy",
    "name": "San Francisco-Oakland-San Jose CA, US",
    "targeting_type": "LOCATION",
    "targeting_value": "5122804691e5fecc",
    "updated_at": "2013-05-30T21:01:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=PHRASE_KEYWORD&targeting_value=grumpy cat" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:20Z",
    "deleted": false,
    "id": "2u3bd",
    "line_item_id": "yyyy",
    "name": "grumpy cat",
    "targeting_type": "PHRASE_KEYWORD",
    "targeting_value": "grumpy cat",
    "updated_at": "2013-05-30T18:05:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "PHRASE_KEYWORD",
      "targeting_value": "grumpy cat"
    }
  }
}

6. अंत में, line item को फिर से सक्रिय करें।

twurl -H ads-api.x.com -X PUT "/9/accounts/xxxxxx/line_items/yyyy/?entity_status=ACTIVE"

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "grumpy cat",
    "placements": [],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "yyyy",
    "entity_status": "ACTIVE",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:20Z",
    "updated_at": "2015-02-09T00:00:20Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "dy1f",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "yyyy",
      "entity_status": "ACTIVE",
      "account_id": "xxxxxx"
    }
  }
}

बस इतना ही! अब हमारे पास एक सक्रिय, लक्षित और वित्तपोषित Promoted Tweets in Timelines अभियान है, जो चल रहा है।

उद्देश्य-आधारित अभियान

उद्देश्य-आधारित अभियान और मूल्य-निर्धारण विज्ञापनदाताओं को उन कार्रवाइयों के लिए भुगतान करने की सुविधा देते हैं जो उनके मार्केटिंग उद्देश्यों के अनुरूप हों। इनके समर्थन के लिए, line items पर उपयुक्त objective सेट करें।

line item write endpoints पर उपयोग किया जाने वाला और read endpoints से लौटाया जाने वाला पैरामीटर objective है। वर्तमान में इस फ़ील्ड के निम्न संभावित मान हैं:

• APP_ENGAGEMENTS
• APP_INSTALLS
• FOLLOWERS
• ENGAGEMENTS
• REACH
• VIDEO_VIEWS
• PREROLL_VIEWS
• WEBSITE_CLICKS

उद्देश्य इस बात को प्रभावित करते हैं कि हम अपने auctions में अभियानों को कैसे ऑप्टिमाइज़ करते हैं और उन अभियानों के लिए बिलिंग कैसे करते हैं। हम उद्देश्य-आधारित मूल्य-निर्धारण सक्षम करते हैं, जैसे APP_ENGAGEMENTS के लिए CPAC, APP_INSTALLS के लिए CPAC या CPI, WEBSITE_CLICKS के लिए CPLC, FOLLOWERS के लिए CPF, ENGAGEMENTS के लिए CPE, और REACH के लिए CPM।

मोबाइल ऐप प्रचार अभियानों में APP_ENGAGEMENTS या APP_INSTALLS में से कोई एक objective होना आवश्यक है।

नोट: एक ही अभियान के अंतर्गत अलग-अलग objectives वाले line items की अनुमति नहीं है।

अभियान उद्देश्य	API objective	Tweets में media	मूल्य-निर्धारण मॉडल
ऐप री-एंगेजमेंट	APP_ENGAGEMENTS	इमेज या वीडियो app download card आवश्यक है।	CPAC
ऐप इंस्टॉल	APP_INSTALLS	इमेज या वीडियो app download card आवश्यक है।	CPAC या CPI (charge_by का उपयोग करके सेट करें)
रीच	REACH	कोई प्रतिबंध नहीं।	CPM
फ़ॉलोअर्स	FOLLOWERS	Tweet आवश्यक नहीं है, लेकिन अनुशंसित है। Followers campaigns के लिए Tweets में media पर कोई प्रतिबंध नहीं है, हालांकि हम केवल टेक्स्ट वाले Tweets की अनुशंसा करते हैं। अधिक जानकारी	CPF
एंगेजमेंट्स	ENGAGEMENTS	कोई प्रतिबंध नहीं।	CPE
वीडियो व्यूज़	VIDEO_VIEWS	वीडियो conversation card, वीडियो, या GIF आवश्यक है।	CPV या 3s/100% view के लिए लागत
प्री-रोल व्यूज़	PREROLL_VIEWS	वीडियो आवश्यक है।	CPV या 3s/100% view के लिए लागत
वेबसाइट क्लिक्स	WEBSITE_CLICKS	Website card अनुशंसित है, लेकिन आवश्यक नहीं है। Tweet में या तो website card होना चाहिए या website link (दोनों नहीं)।	CPLC

फंडिंग इंस्ट्रूमेंट्स

फंडिंग इंस्ट्रूमेंट्स अभियान बजट का स्रोत होते हैं। Ads API के ज़रिए फंडिंग इंस्ट्रूमेंट्स बनाए नहीं जा सकते; उपलब्ध होने के लिए इन्हें पहले से विज्ञापनदाता के X अकाउंट मैनेजर द्वारा (क्रेडिट लाइन के लिए) या ads.x.com के माध्यम से (क्रेडिट कार्ड के लिए) सेट किया गया होना चाहिए।

किसी अकाउंट पर सभी funding_instruments की सूची पाने के लिए GET accounts/:account_id/funding_instruments देखें, और किसी विशिष्ट इंस्ट्रूमेंट का विवरण पाने के लिए GET accounts/:account_id/funding_instruments/:funding_instrument_id देखें।

फंडिंग इंस्ट्रूमेंट एट्रिब्यूट्स

वर्णनात्मक: account_id, फंडिंग इंस्ट्रूमेंट id, फंडिंग इंस्ट्रूमेंट type, description, और io_header (insertion order header ID)। ध्यान दें कि एक ही io_header एक से अधिक फंडिंग इंस्ट्रूमेंट्स से जुड़ा हो सकता है।

फंडिंग क्षमता: able_to_fund और reasons_not_able_to_fund।

समय: created_at, updated_at, start_time, और end_time, जिन्हें एक स्ट्रिंग के रूप में दर्शाया जाता है और जिनका फ़ॉर्मैट “%Y-%m-%dT%l:%M:%S%z” है।

बूलियन स्थिति: paused, deleted, और cancelled (true या false)।

वित्तीय: currency (ISO-4217 फ़ॉर्मैट), credit_limit_local_micro, credit_remaining_local_micro, और funded_amount_local_micro। किसी मुद्रा का मान micro में दर्शाया जाता है। USD के लिए, $5.50 को 5.50*1e6, या 5,500,000 के रूप में एन्कोड किया जाता है। “पूर्ण मान” दर्शाने के लिए, आपको सभी मुद्राओं में local micro को 1e6 (1_000_000) से गुणा करना होगा।

विशेषता विवरण

credit_limit_local_micro केवल CREDIT_CARD या CREDIT_LINE type के वित्तपोषण साधनों के लिए मान्य है और उस instrument की credit limit को दर्शाता है।

funded_amount_local_micro केवल INSERTION_ORDER type के वित्तपोषण साधनों के लिए मान्य है और आवंटित बजट को दर्शाता है।

credit_remaining_local_micro CREDIT_LINE और AGENCY_CREDIT_LINE type के वित्तपोषण साधनों के लिए मान्य है। यह credit_limit_local_micro में से उस वित्तपोषण साधन पर पहले से खर्च की गई राशि घटाने के बाद बची हुई credit को दर्शाता है। यह funded_amount_local_micro और खर्च की गई राशि के बीच का अंतर नहीं दर्शाता। हम credit limit और funded amount के बीच अंतर करते हैं, क्योंकि वे funding के अलग-अलग आधारभूत तरीकों और विज्ञापनदाताओं के साथ हमारे अलग-अलग spending agreements को दर्शाते हैं।

वित्तपोषण साधनों के प्रकार

क्रेडिट कार्ड

आमतौर पर सेल्फ़-सर्व विज्ञापनदाताओं द्वारा उपयोग किए जाते हैं (बिना किसी अकाउंट मैनेजर के)।

क्रेडिट लाइनें

ये insertion orders (IOs) के रूप में होती हैं और इन्हें अकाउंट मैनेजर सेट करते हैं।

मल्टी-हैंडल क्रेडिट लाइनें

इस प्रकार की क्रेडिट लाइन के साथ, विज्ञापनदाता कई हैंडल्स पर अभियानों को वित्तपोषित कर सकते हैं। यह सुविधा उनके X अकाउंट मैनेजर द्वारा सक्षम की जाती है, जो अलग-अलग @handles को किसी विशेष क्रेडिट लाइन से संबद्ध करता है।

उदाहरण के लिए, @NikeSB और @NikeFuel दोनों को @Nike क्रेडिट लाइन का एक्सेस मिल सकता है। यह वित्तपोषण साधन भी अन्य साधनों की तरह उपलब्ध है। आप funding_instrument endpoint पर GET अनुरोध भेजकर डेटा प्राप्त कर सकते हैं। यहां एक नमूना रिस्पॉन्स है (ध्यान दें CREDIT_LINE type पर)।

      GET https://ads-api.x.com/5/accounts/a0b1c3/funding_instruments

{
    "request": {
        "params": {
            "account_id": "a0b1c3"
        }
    },
    "data": [
        {
            "start_time": "2013-05-30T04:00:00Z",
            "description": "FakeNike - Credit Line",
            "credit_limit_local_micro": 150000000000,
            "end_time": null,
            "cancelled": false,
            "id": "i1234",
            "paused": false,
            "account_id": "a0b1c3",
            "reasons_not_able_to_fund": [],
            "io_header": null,
            "currency": "USD",
            "funded_amount_local_micro": 0,
            "created_at": "2013-05-30T18:16:38Z",
            "type": "CREDIT_LINE",
            "able_to_fund": true,
            "updated_at": "2013-05-30T18:16:38Z",
            "credit_remaining_local_micro": 123661919751,
            "deleted": false,
        }
    ],
    "data_type": "funding_instrument",
    "total_count": 1,
    "next_cursor": null
}

इस वित्तपोषण साधन की एकमात्र विशेषता इसका type है और यह कि यह उससे जुड़े सभी accounts के लिए उपलब्ध होता है। स्वाभाविक रूप से, इस instrument से funded सभी campaigns का असर बचे हुए credit पर पड़ता है—उन सभी accounts में जो इसे साझा करते हैं। किसी विशेष credit line से कौन-कौन से accounts जुड़े हैं, इसकी जानकारी API (या ads.x.com) के माध्यम से उपलब्ध नहीं है।

Funding Instrument enumerations के बारे में अधिक जानकारी के लिए, कृपया यहाँ क्लिक करें।

टार्गेटिंग

टार्गेटिंग Ads API की एक मुख्य अवधारणा है। टार्गेटिंग line item स्तर पर सेट किया जाता है, और विकल्प placement के अनुसार अलग-अलग होते हैं। नए टार्गेटिंग मानदंड सेट करने के लिए POST accounts/:account_id/targeting_criteria और उन्हें अपडेट करने के लिए PUT accounts/:account_id/targeting_criteria का उपयोग करें।

सभी line items की सूची के लिए GET accounts/:account_id/line_items का उपयोग करें, और किसी विशिष्ट line item को प्राप्त करने के लिए GET  accounts/:account_id/line_items/:line_item_id का उपयोग करें।

प्लेसमेंट के अनुसार टार्गेटिंग विकल्प

Promoted Tweets और Promoted Accounts उत्पादों को कई तरह के प्लेसमेंट पर उपलब्ध कराया जा सकता है। Promoted Trends (PTr) API के ज़रिए उपलब्ध नहीं हैं।

संभावित प्लेसमेंट संयोजनों के लिए, GET line_items/placements एंडपॉइंट देखें। हर प्लेसमेंट के लिए टार्गेटिंग के विकल्प अलग-अलग होते हैं। Location, Platform और Gender सभी के लिए उपलब्ध हैं। बाकी विकल्प प्लेसमेंट के प्रकार पर निर्भर करते हैं।

• X Search: Age Targeting, Devices, Events, Gender, Keyword Types (All), Language, Locations, Network Activation, Network Operators, Platform, Platform Version, Tailored Audiences, WiFi Only
• X Timeline: Age Targeting, Devices, Events, Followers Of, Similar to Followers Of, Gender, Interest, Language, Locations, Network Activation, Network Operators, Non-exact Keyword Types, Partner Audience Types, Platform, Platform Version, Retargeting Types, Tailored Audiences, TV Targeting Types, WiFi Only
• X Profiles & Tweet Details: Age Targeting, Devices, Events, Followers Of, Similar to Followers Of, Gender, Interest, Language, Locations, Network Activation, Network Operators, Non-exact Keyword Types, Partner Audience Types, Platform, Platform Version, Retargeting Types, Tailored Audiences, TV Targeting Types, WiFi Only

टार्गेटिंग के प्रकारों को समझना

आयु टार्गेटिंग: उपयोगकर्ताओं को विशिष्ट आयु-समूहों के आधार पर टार्गेट करें। आयु-समूह enum की सूची Enumerations पेज पर मिल सकती है।

Events: टार्गेटिंग के लिए एक event निर्दिष्ट करें। टार्गेटिंग के लिए केवल एक event का उपयोग किया जा सकता है (प्रति line item)। टार्गेटिंग के लिए उपलब्ध events खोजने हेतु GET targeting_criteria/events endpoint का उपयोग करें।

Gender: पुरुषों (1) या महिलाओं (2) को टार्गेट करें। सभी को टार्गेट करने के लिए इसे null छोड़ दें।

Installed App Store Categories: इस टार्गेटिंग प्रकार का उपयोग उन उपयोगकर्ताओं को टार्गेट करने के लिए करें जिन्होंने कुछ श्रेणियों के ऐप इंस्टॉल किए हैं या उनमें रुचि दिखाई है। देखें GET targeting_criteria/app_store_categories.

Interests: उपयोगकर्ताओं को उनकी रुचियों के आधार पर टार्गेट करें। रुचियों की सूची GET targeting_criteria/interests से प्राप्त करें। आप अधिकतम 100 रुचियों को टार्गेट कर सकते हैं।

फ़ॉलोअर्स ऑफ़: मौजूदा account के लिए किसी भी पूरी तरह से promotable user के फ़ॉलोअर्स को टार्गेट करें (ध्यान दें, वर्तमान में उस account का केवल primary account holder ही पूरी तरह promotable user होता है)। promotable users की सूची पाने के लिए GET accounts/:account_id/promotable_users का उपयोग करें।

Similar to Followers Of: उन लोगों को टार्गेट करें जिनकी रुचियाँ विशिष्ट उपयोगकर्ताओं के फ़ॉलोअर्स जैसी हों। आप अधिकतम 100 Users का उपयोग कर सकते हैं।

Locations: टार्गेट करने के लिए अधिकतम 2,000 स्थान निर्दिष्ट करें। सूची GET targeting_criteria/locations से प्राप्त करें। कुछ देशों को टार्गेट करने वाले ads के लिए अतिरिक्त आवश्यकताएँ हैं। अधिक जानकारी के लिए Country Targeting and Display Requirements देखें।

Keywords: keyword टार्गेटिंग विकल्प placement के type के अनुसार अलग-अलग होते हैं। आप टार्गेटिंग के लिए अधिकतम 1000 keywords का उपयोग कर सकते हैं (प्रति line item)। विकल्पों के लिए Keyword Types अनुभाग देखें।

Language Targeting: उन उपयोगकर्ताओं को टार्गेट करें जो विशिष्ट भाषाएँ समझते हैं।

Mobile Network Operator Targeting: विज्ञापनदाताओं को mobile carrier के आधार पर उपयोगकर्ताओं को टार्गेट करने में सक्षम बनाता है। इसके लिए GET targeting_criteria/network_operators से टार्गेटिंग type NETWORK_OPERATOR का उपयोग करें।

New Mobile Device Targeting: उपयोगकर्ताओं तक उस तारीख के आधार पर पहुँचें जब उन्होंने पहली बार अपने device से X को access किया था। इसके लिए NETWORK_ACTIVATION_DURATION टार्गेटिंग type का उपयोग करें, जिसमें operator_type के रूप में कम के लिए LT और अधिक या बराबर के लिए GTE इस्तेमाल होता है।

Platforms, Platform Versions, Devices, and Wifi-Only: यह विभिन्न मानदंडों के आधार पर mobile devices को टार्गेट करने की सुविधा देता है। Platforms एक उच्च-स्तरीय टार्गेटिंग प्रकार है, जो फ़ोन की व्यापक श्रेणियों को टार्गेट कर सकता है। उदाहरण के लिए iOS और Android। Devices आपको विशिष्ट mobile devices के उपयोगकर्ताओं को टार्गेट करने देते हैं, जैसे iPhone 5s, Nexus 4, या Samsung Galaxy Note। Platform versions आपको विशिष्ट mobile operating systems के versions के उपयोगकर्ताओं को, point release स्तर तक, टार्गेट करने देते हैं। उदाहरणों में iOS 7.1 और Android 4.4 शामिल हैं। Wifi-Only आपको केवल उन उपयोगकर्ताओं को टार्गेट करने देता है जो अपने devices को WiFi network पर उपयोग कर रहे हैं; यदि यह सेट नहीं है, तो carrier connection के साथ-साथ WiFi का उपयोग करने वाले उपयोगकर्ता भी टार्गेट किए जाएँगे।

• यदि platforms और devices में overlap नहीं है, तो उपयोगकर्ता उन्हें टार्गेट कर सकते हैं। मैं Blackberry को एक platform के रूप में और iPad Air को एक device के रूप में एक साथ टार्गेट कर सकता हूँ।
• उपयोगकर्ता devices और os versions को एक साथ टार्गेट कर सकते हैं। मैं iPad Air और iOS >= 7.0 को टार्गेट कर सकता हूँ।
• उपयोगकर्ता ऐसे platforms को टार्गेट नहीं कर सकते जो devices से अधिक व्यापक हों। मैं iOS और iPad Air को एक साथ टार्गेट नहीं कर सकता।

[Tailored Audiences]/x-ads-api/audiences: ग्राहकों के समूहों को लक्षित करने और X पर उनसे जुड़ने के लिए किसी स्वीकृत विज्ञापन पार्टनर के माध्यम से उपयोगकर्ताओं तक पहुँचें।

TV टार्गेटिंग

TV Show टार्गेटिंग: उन लोगों तक पहुँचें जो खास TV कार्यक्रमों के साथ जुड़ते हैं। इस टार्गेटिंग मानदंड को TV_SHOW टार्गेटिंग type के साथ इस तरह कॉन्फ़िगर किया जा सकता है कि campaign सक्रिय रहने तक लगातार target किया जा सके। उपलब्ध TV shows का पता लगाने के लिए GET targeting_criteria/tv_markets और GET targeting_criteria/tv_shows endpoints का उपयोग करें।

Tweet Engager Retargeting

Tweet engager retargeting विज्ञापनदाताओं को अलग-अलग devices पर उन ऑडियंस को target करने में सक्षम बनाता है, जो पहले X पर उनके promoted या organic Tweets को देख चुके हैं या उनसे जुड़ चुके हैं। इस टार्गेटिंग की मदद से विज्ञापनदाता उन लोगों तक फिर से पहुँच सकते हैं जिन्होंने X पर किसी विज्ञापनदाता का content देखा है या उससे जुड़ाव किया है, और जिनके बाद के संदेशों या offers के साथ आगे भी जुड़ने या convert होने की संभावना सबसे अधिक होती है। उपयोगकर्ता exposure या engagement के कुछ ही मिनटों में targeting के लिए eligible हो जाते हैं और उसके बाद engagements के लिए 90 दिनों तक तथा exposures के लिए 30 दिनों तक eligible बने रहते हैं।

Tweet Engager टार्गेटिंग Types:

• ENGAGEMENT_TYPE जो targeting value के रूप में IMPRESSION या ENGAGEMENT में से किसी एक को स्वीकार करता है। यह बताता है कि आप exposed users (IMPRESSION) को target करना चाहते हैं या engaged users (ENGAGEMENT) को।
• CAMPAIGN_ENGAGEMENT targeting value के रूप में campaign ID का उपयोग करता है। जिन उपयोगकर्ताओं ने इस campaign के साथ जुड़ाव किया है या इसे देखा है (यह ENGAGEMENT_TYPE पर निर्भर करता है), उन्हीं को target किया जाएगा।
• USER_ENGAGEMENT targeting value के रूप में promoted user ID का उपयोग करता है, ताकि उन उपयोगकर्ताओं को target किया जा सके जिन्होंने किसी विज्ञापनदाता के organic content को देखा है या उससे जुड़ाव किया है (यह ENGAGEMENT_TYPE पर निर्भर करता है)। यह Ads account से संबद्ध promoted user ID होना चाहिए।

Note: कम-से-कम एक मान्य CAMPAIGN_ENGAGEMENT या USER_ENGAGEMENT value के साथ ENGAGEMENT_TYPE देना आवश्यक है। दोनों tweet engager targeting types मौजूद हो सकते हैं, और किसी दिए गए line item पर कई campaigns को target किया जा सकता है।

Video Viewer टार्गेटिंग: Video viewer targeting, Tweet engager targeting को आगे बढ़ाता है और विज्ञापनदाताओं को उन ऑडियंस को target करने में सक्षम बनाता है जिन्होंने पहले X पर किसी वीडियो का कुछ हिस्सा या पूरा वीडियो देखा हो। विज्ञापनदाता organic videos, promoted videos, या दोनों को target कर सकते हैं। Promoted videos केवल video view objective campaigns या line items तक सीमित नहीं हैं।

Video Viewer टार्गेटिंग Types:

• VIDEO_VIEW उन उपयोगकर्ताओं के लिए जिन्होंने वीडियो चलाने के लिए क्लिक किया है या autoplay में 3 सेकंड वीडियो देखा है
• VIDEO_VIEW_PARTIAL उन उपयोगकर्ताओं के लिए जिन्होंने वीडियो का 50% देखा है
• VIDEO_VIEW_COMPLETE उन उपयोगकर्ताओं के लिए जिन्होंने वीडियो का कम-से-कम 95% देखा है

Tweet engager targeting की तरह, जब ENGAGEMENT_TYPE का उपयोग किया जाता है, तो line item के टार्गेटिंग मानदंड में निम्न में से एक या दोनों भी मौजूद होने चाहिए:

• CAMPAIGN_ENGAGEMENT targeting value के रूप में campaign ID का उपयोग करता है। जिन उपयोगकर्ताओं ने इस campaign में कोई वीडियो देखा है (यह ENGAGEMENT_TYPE पर आधारित है), उन्हीं को target किया जाएगा।
• USER_ENGAGEMENT targeting value के रूप में promoted user ID का उपयोग करता है, ताकि उन उपयोगकर्ताओं को target किया जा सके जिन्होंने किसी विज्ञापनदाता के organic content में कोई वीडियो देखा हो (यह ENGAGEMENT_TYPE par आधारित है)। यह Ads account से संबद्ध promoted user ID होना चाहिए।

Keyword Types

अवधारणात्मक अवलोकन के लिए keyword टार्गेटिंग पर हमारा support document देखें।

• Broad (डिफ़ॉल्ट मान): क्रम की परवाह किए बिना सभी शब्दों का मिलान करता है। Capitalization, plurals या tense के प्रति संवेदनशील नहीं है। जहाँ संभव हो, इसे अपने-आप विस्तारित किया जाएगा (यानी “car repair” का मिलान “automobile fix” से भी होगा)। यदि आप बिना expansion के target करना चाहते हैं, तो आपको keywords से पहले + चिह्न जोड़ना होगा, जैसे “+boat +jet”। + के बिना keywords का उपयोग करने पर डिफ़ॉल्ट रूप से Broad Match लागू होगा।
• Unordered (deprecated): क्रम की परवाह किए बिना सभी शब्दों का मिलान करता है। Capitalization, plurals या tense के प्रति संवेदनशील नहीं है।
• Phrase: ठीक उसी keywords string का मिलान करता है; अन्य keywords मौजूद हो सकते हैं।
• Exact: केवल ठीक उसी keywords string का मिलान करता है, किसी और का नहीं।
• Negative: उन searches के मिलान से बचें जिनमें query में कहीं भी ये सभी keywords शामिल हों, चाहे उनका क्रम कुछ भी हो, भले ही अन्य शब्द मौजूद हों।
• Negative Phrase: उन searches के मिलान से बचें जिनमें query में कहीं भी यही सटीक keywords string शामिल हो, भले ही अन्य शब्द मौजूद हों।
• Negative Exact: उन searches के मिलान से बचें जो इन keywords से बिल्कुल मेल खाती हों और जिनमें कोई अन्य शब्द न हो।  

इमोजी टार्गेटिंग

कीवर्ड टार्गेटिंग के माध्यम से इमोजी टार्गेटिंग समर्थित है। इमोजी टार्गेटिंग का उपयोग करने के लिए, बस उस इमोजी का प्रतिनिधित्व करने वाले Unicode codepoints के लिए कीवर्ड टार्गेटिंग बनाएं, जैसे ‘खुशी के आँसुओं वाला चेहरा’ इमोजी (😂) के लिए U+1F602 (UTF-8 में xF0x9Fx98x82)। जिन इमोजी को हम स्वीकार करते हैं, उनकी पुष्टि twemoji सूची से की जा सकती है। किसी इमोजी को टार्गेट करने पर उसके सभी वैरिएंट टार्गेट होते हैं।

सभी मानों का सारांश, जिनमें required/optional और प्रत्येक के लिए विशिष्ट विवरण शामिल हैं, के लिए PUT accounts/:account_id/targeting_criteria देखें।

टार्गेटिंग मानदंडों के संयोजन

अपडेट किया गया कैंपेन वर्कफ़्लो

ऐसे कैंपेन बनाएँ जो geo, gender, language, और device/platform मानदंडों के आधार पर व्यापक रूप से टार्गेट करें। इसके बाद विज्ञापनदाता इस व्यापक टार्गेटिंग को अतिरिक्त टार्गेटिंग मानदंडों (जैसे interests, keywords, followers, tailored audiences, TV) के साथ जोड़ सकते हैं। अगर किसी line item के लिए कोई टार्गेटिंग मानदंड निर्दिष्ट नहीं किया गया है, तो वह line item दुनिया भर के सभी उपयोगकर्ताओं को टार्गेट करेगा।

“प्राथमिक” प्रकार	अन्य प्रकार
Followers	लोकेशन
Tailored Audiences	लिंग
Interests	भाषाएँ
Keywords	डिवाइस और प्लेटफ़ॉर्म
TV	आयु

आपके ad group के लिए टार्गेटिंग मानदंड इस प्रकार संयोजित किए जाएँगे:

• “प्राथमिक” टार्गेटिंग प्रकारों को ∪ किया जाएगा (अर्थात उन्हें एक logical union में रखा जाएगा)।
• अन्य टार्गेटिंग प्रकारों को AND किया जाएगा।
• समान प्रकारों को OR किया जाएगा।

कुछ उदाहरण

संक्षेप में: [(Followers) ∪ (Tailored Audiences) ∪ (Interests) ∪ (Keywords)] AND (Location) AND (Gender) AND (Languages) AND (Devices and Platforms)

एक Geo उदाहरण:

मान लीजिए कि हम अपने कैंपेन के लिए ऐसा ad group चाहते हैं जो इन मानदंडों के आधार पर टार्गेट करे:

• U.S., England, और Canada में X उपयोगकर्ता (Location)
• जो महिलाएँ हों (Gender)
• Tailored Audiences सूची से लिए गए (“प्राथमिक”)
• Keywords के साथ (“प्राथमिक”)

टार्गेटिंग मानदंड होंगे:

[US OR GB OR CA] AND [Female] AND [Tailored Audiences ∪ Keyword]

अतिरिक्त उदाहरण

• Gender और Geo चुनें, लेकिन कोई प्राथमिक विकल्प नहीं: (पुरुष) AND (US OR GB)
• Gender, Geo, Interest चुनें: (महिला) AND (CA) AND (Computers OR Technology OR Startups)
• Gender, Geo, Interest, Tailored Audiences, Keywords चुनें: (पुरुष) AND (GB) AND (Cars ∪ CRM के लिए Tailored Audiences ∪ autocross)

बजट पेसिंग

विज्ञापनदाता अब इस बात पर अधिक नियंत्रण रख सकते हैं कि उनके Promoted Tweet और Account अभियानों का दैनिक बजट कितनी तेज़ी से खर्च हो। standard delivery सक्षम करने पर, जो डिफ़ॉल्ट विकल्प है, पूरे दिन खर्च की दर एकसमान बनी रहती है।

standard delivery को off करने पर, हम impressions दिखाएँगे और engagements को यथासंभव तेज़ी से बढ़ाएँगे, जब तक कि आपका दैनिक बजट समाप्त न हो जाए। targeting और competition के आधार पर ऐसा दिन में काफ़ी जल्दी भी हो सकता है। इसे accelerated delivery कहा जाता है।

शुरू करना

standard delivery सभी अभियानों के लिए डिफ़ॉल्ट विकल्प है, इसलिए जब तक आप इसे बंद नहीं करना चाहते, तब तक किसी कार्रवाई की आवश्यकता नहीं है। किसी अभियान का दैनिक बजट यथासंभव तेज़ी से खर्च करने के लिए, pace को accelerated delivery पर सेट करने हेतु standard_delivery पैरामीटर को false पर सेट करें (देखें GET accounts/:account_id/campaigns)।

नोट्स

• “Day” X advertiser account के timezone (उदाहरण के लिए, America/Los_Angeles) के अनुसार निर्धारित होता है।
• शुरुआती नतीजे बताते हैं कि standard delivery विज्ञापनदाताओं के लिए eCPE/CPF में सुधार करेगी और पूरे दिन अधिक सुसंगत कवरेज देगी।

बजट और पेसिंग के बारे में अतिरिक्त जानकारी के लिए कृपया Bidding and Auctions FAQ देखें।

लक्ष्य बोली

अभियान प्रबंधन

बिड रणनीति

हमने अभियान बनाने की प्रक्रिया को सरल बनाने और कई पैरामीटर के संयोजनों को लेकर होने वाले भ्रम को कम करने के लिए बिड रणनीति की अवधारणा शुरू की है।

पैरामीटर के सभी पुराने (legacy के रूप में चिह्नित) संयोजन, समकक्ष goal पैरामीटर सेट करके प्राप्त किए जा सकते हैं। अधिक जानकारी यहाँ दी गई घोषणा में मिल सकती है।

उदाहरण के लिए:

अभियान उद्देश्य	लीगेसी	Ads API v10+
ऐप इंस्टॉल	bid_type= AUTO bid_unit = APP_INSTALLS charge_by = APP_CLICKS	goal = APP_INSTALLS bid_strategy = AUTO
वेबसाइट क्लिक	bid_type = TARGET (नोट: कुछ अभियान उद्देश्यों के लिए bid_unit की आवश्यकता नहीं थी)	bid_strategy = TARGET

लक्ष्य बोली

लक्ष्य बोली का उपयोग करके, आप वह लक्षित लागत तय कर सकते हैं जो आप चुकाना चाहते हैं, और X Ads प्लेटफ़ॉर्म आपकी लक्षित लागत के आसपास या उससे कम रहते हुए आपके अभियान को बेहतर प्रदर्शन के लिए ऑप्टिमाइज़ करेगा।

यह सुविधा आपको लागत पर नियंत्रण बनाए रखते हुए उन उपयोगकर्ताओं तक पहुँचने की लचीलापन देती है जिनके वांछित कार्रवाई करने की अधिक संभावना होती है (जैसे लिंक क्लिक, लीड या फ़ॉलो)। यह उन विज्ञापनदाताओं के लिए एक प्रभावशाली सुविधा है जो अभियान सेटअप और ऑप्टिमाइज़ेशन (बोली विकल्पों सहित) के लिए अधिक विकल्प चाहते हैं।

संगत अभियान उद्देश्यों वाले line items के लिए, हमने bid amount के लिए एक नया प्राइसिंग मेकैनिज़्म पेश किया है, जिससे आप वह लक्षित लागत तय कर सकते हैं जो आप चुकाना चाहते हैं। हमारा विज्ञापन प्लेटफ़ॉर्म आपकी ओर से डायनेमिक रूप से बोली लगाता है, ताकि आपको अधिक परिणाम मिल सकें, साथ ही यह कोशिश करता है कि आपकी औसत लागत आपके तय किए गए लक्ष्य के 20% के भीतर रहे। line items पर bid_strategy सेटिंग को TARGET मान पर सेट करके, प्रासंगिक अभियान उद्देश्यों के लिए लक्ष्य बोली सक्षम की जा सकती है, जैसे:

• WEBSITE_CLICKS
• WEBSITE_CONVERSIONS 
• APP_INSTALLS 
• APP_ENGAGEMENTS
• REACH

देश-आधारित targeting और प्रदर्शन आवश्यकताएँ

अभियान प्रबंधन

देश-विशिष्ट targeting और प्रदर्शन संबंधी आवश्यकताएँ इस पेज पर दी गई हैं। इन आवश्यकताओं का सभी भागीदारों द्वारा पालन किया जाना अनिवार्य है।

रूस

X की Ads Policies विज्ञापनदाताओं को ऐसे विज्ञापनों के साथ रूस को लक्षित करने से रोकती हैं, जो रूसी भाषा में नहीं हैं। जब आपके उपयोगकर्ता विशेष रूप से रूस को लक्षित करते हैं, तो आपको उन्हें निम्नलिखित चेतावनी संदेश दिखाना होगा:

रूस को लक्षित करने वाले विज्ञापन रूसी भाषा में होने चाहिए।

पार्टनर द्वारा प्रबंधित फ़ंडिंग इंस्ट्रूमेंट्स

ऑनबोर्डिंग फ़्लो, X खाते के लिए एक ads.x.com खाता कॉन्फ़िगर करता है, जिसे पार्टनर Ads API के माध्यम से प्रबंधित कर सकता है और जिसका विज्ञापन खर्च पार्टनर से बिल किया जाता है।  

पार्टनर का प्रारंभिक सेट-अप

नए PMFI Ads API पार्टनर का प्रारंभिक सेट-अप करने की प्रक्रिया में, आवश्यक जानकारी के आदान-प्रदान के बाद, अधिकतम 3 सप्ताह लग सकते हैं। प्रक्रिया शुरू करने के लिए, नीचे दी गई जानकारी X में आपके तकनीकी संपर्कों के साथ-साथ उस X संपर्क के साथ भी साझा की जानी चाहिए जो पार्टनर के साथ इंटीग्रेशन का प्रबंधन कर रहा है:

• पार्टनर को अपनी PGP/GPG सार्वजनिक कुंजी साझा करनी होगी। Ads API पार्टनर और X के बीच एक shared secret key का आदान-प्रदान किया जाना आवश्यक है। इसका उपयोग ऑनबोर्डिंग फ़्लो के दौरान डेटा सत्यापित करने के लिए किया जाएगा।
• उस X ऐप का app_id या consumer_secret जिसका उपयोग Ads API एक्सेस के लिए किया जाएगा। यदि आप developer.x.com पर अपने X खाते में लॉग इन हैं, तो आप ऐप डैशबोर्ड के ज़रिए अपने मौजूदा X ऐप देख और संपादित कर सकते हैं। यदि आपको एक X ऐप बनाना है, तो आपके पास स्वीकृत डेवलपर खाता होना चाहिए। X, production+sandbox के लिए एक ऐप और केवल sandbox एक्सेस के लिए एक वैकल्पिक ऐप की अनुमति देता है। X ऐप किसी कॉर्पोरेट, पार्टनर-नियंत्रित X handle पर बनाया जाना चाहिए।  

विज्ञापनदाता ऑनबोर्डिंग फ़्लो

विज्ञापनदाता ऑनबोर्डिंग फ़्लो वेब ब्राउज़र के माध्यम से इस प्रकार होता है:

1. उपयोगकर्ता पार्टनर की वेबसाइट पर ऑनबोर्डिंग फ़्लो शुरू करता है और वह हैंडल दर्ज करता है जिसे वह ऑनबोर्ड करना चाहता है।
2. पार्टनर उपयोगकर्ता को ads.x.com पर signed payload के साथ एक URL पर रीडायरेक्ट करता है। इस payload में पार्टनर का API app_id, उस X हैंडल का X user_id शामिल होता है जिसे ऑनबोर्ड किया जाना है, साथ ही एक callback URL और नीचे प्रलेखित अन्य फ़ील्ड्स भी शामिल होते हैं।
3. उपयोगकर्ता से मानक x.com लॉगिन पेज का उपयोग करके ads.x.com में साइन इन करने के लिए कहा जाता है।
4. उपयोगकर्ता के लॉग इन करने के बाद, ऑनबोर्डिंग प्रक्रिया शुरू हो जाती है। इस चरण में विज्ञापन समीक्षा, अकाउंट सत्यापन और अन्य जाँचें शामिल हैं।
5. सभी ऑनबोर्डिंग कार्य पूरे होने पर, उपयोगकर्ता को उस callback URL पर रीडायरेक्ट कर दिया जाता है जो Ads API पार्टनर ने दिया था। इसके साथ एक payload भी होता है, जो सफलता या विफलता को दर्शाता है। इसमें 3-legged authorization प्रक्रिया शामिल है।  

ऑनबोर्डिंग रीडायरेक्ट पेलोड

रीडायरेक्ट के लिए URL:

https://ads.x.com/link_managed_account

रीडायरेक्ट URL को निम्नलिखित पैरामीटर के साथ कॉल किया जाएगा:

Name	Type	Description
callback_url	URL encoded string	अकाउंट लिंक प्रक्रिया पूरी होने के बाद, परिणाम चाहे जो भी हो, उपयोगकर्ता को इस url पर रीडायरेक्ट किया जाएगा। प्रोटोकॉल विवरण के लिए partner redirect url अनुभाग देखें
client_app_id	integer	X API client app id, जिसका उपयोग managing partner की पहचान के लिए किया जाता है
promotable_user_id	integer	उस @handle का X user_id जिसकी promotions का प्रबंधन managing partner द्वारा किया जाना है। इसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि यह वही उपयोगकर्ता है जो linking प्रक्रिया पूरी करने के लिए ads.x.com में लॉग इन करता है
fi_description	URL encoded String (max 255 characters)	funding instrument का नाम। funding instrument प्राप्त किए जाने पर यह API में description फ़ील्ड में दिखाया जाएगा। यदि funding_instrument description दिया जाता है, तो मौजूदा funding_instrument को pause कर दिया जाएगा, और एक नया managed partner funding instrument सेट अप किया जाएगा। (यदि इसी नाम से कोई पहले से मौजूद है, तो कुछ नहीं होगा)
timezone	String, in Area/Location format	यह वह timezone होगा जिसका उपयोग यह तय करने के लिए किया जाएगा कि daily budgets किस दिन पर लागू होंगे, और charges किस timezone में समेकित किए जाएंगे
currency	ISO 4217 Currency Code	वह मुद्रा जिसका उपयोग bids दर्ज करने के लिए किया जाएगा, और जिसमें charges बिल किए जाएंगे
country	ISO 3166-1 alpha 2 Country Code	अकाउंट के लिए बिलिंग देश
signature	URL encoded, base64 encoded binary code, as explained below	signature, जो call की प्रामाणिकता और पैरामीटर की वैधता सत्यापित करने के लिए एक shared secret और अन्य पैरामीटर को जोड़ता है।

Callback URL payload

बेस redirect URL, account link request में callback_url पैरामीटर का उपयोग करके दिया जाता है (ऊपर देखें)। ads.x.com द्वारा जोड़े गए पैरामीटर ये हैं:

Name	Type	Description
status	string	OK कोई account बनाया गया, या कोई मौजूदा पात्र account मिला। ACCOUNT_INELIGIBLE यदि partner-विशिष्ट प्रतिबंध पूरे नहीं होते हैं USER_MISMATCH ads.x.com में साइन इन करने के लिए उपयोग किया गया X account, account link request में दिए गए promotable_user_id से अलग था INCOMPLETE_SERVING_BILLING_INFO timezone, currency, या country निर्दिष्ट नहीं किए गए थे INVALID_COUNTRY अमान्य country मान दिया गया था INVALID_CURRENCY अमान्य currency मान दिया गया था INVALID_TIMEZONE अमान्य timezone मान दिया गया था
account_id	URL encoded string	linked account का X ads account id
funding_instrument_id	URL encoded string	सक्रिय partner-managed funding instrument की ID
signature	URL encoded, base64 encoded binary code, as explained below	Base64-encoded HMAC-SHA1 signature, जो call की प्रामाणिकता और पैरामीटर की वैधता सत्यापित करने के लिए shared secret और अन्य पैरामीटर को संयोजित करता है, जैसा कि नीचे समझाया गया है। यह सुनिश्चित करने के लिए कि callback URL केवल उसी X user_id के लिए मान्य हो जिसके लिए account link process बनाया गया था, request पर हस्ताक्षर करते समय X user_id को shared secret में (&) का उपयोग करके जोड़ा जाना चाहिए।

यह सुनिश्चित करने के लिए कि callback URL केवल उसी X user_id के लिए मान्य हो जिसके लिए account link process बनाया गया था, request पर हस्ताक्षर करते समय X user_id को shared secret में & का उपयोग करके जोड़ा जाना चाहिए।  

अनुरोध और callback URL पर हस्ताक्षर करना

यह सुनिश्चित करने के लिए कि /link_managed_account और callback url के अनुरोध मान्य हैं, अनुरोधों को स्रोत पर साइन किया जाना चाहिए और उन पर कोई कार्रवाई करने से पहले प्राप्तकर्ता द्वारा सत्यापित किया जाना चाहिए। X और managing partner के बीच साझा किए गए secret से अनुरोध पर हस्ताक्षर करने से यह सुनिश्चित होता है कि हर पक्ष केवल अधिकृत समकक्ष द्वारा भेजे गए अनुरोध ही स्वीकार करे।

हस्ताक्षर जनरेट करने का एल्गोरिदम OAuth में उपयोग किए जाने वाले एल्गोरिदम के समान है।

निम्नानुसार एक signature base string बनाएं:

• HTTP Method को uppercase में बदलें और base string को इसी मान के बराबर सेट करें।
• base string में ‘&’ वर्ण जोड़ें।
• URL (पैरामीटर के बिना) को percent encode करें और उसे base string में जोड़ें।
• base string में ‘&’ वर्ण जोड़ें।
• percent encoded query string जोड़ें, जिसे निम्नानुसार बनाया जाता है:
• हर उस key और value को percent encode करें जिस पर हस्ताक्षर किए जाएंगे।
• पैरामीटर की सूची को key के अनुसार वर्णक्रम में क्रमबद्ध करें।
• हर key/value pair के लिए (और partner redirect url के लिए primary_promotable_user_id के साथ):
• percent encoded key को query string में जोड़ें।
• base string में ‘=’ वर्ण जोड़ें।
• percent encoded value को query string में जोड़ें।
• percent encoded key=value pairs को ‘&’ वर्ण से अलग करें।
• HMAC-SHA1 एल्गोरिदम का उपयोग करें, जिसमें पहले से साझा किया गया shared secret key के रूप में हो और base string value के रूप में, ताकि signature जनरेट किया जा सके।
• Step 2 के आउटपुट को Base64 encode करें, अंत में आने वाले newline वर्ण को हटा दें, Step 3 में जनरेट किए गए signature को percent encode करें, और उसे url में signature पैरामीटर के रूप में जोड़ें  

हस्ताक्षर के उदाहरण

लिंक खाते के अनुरोध पर हस्ताक्षर करना

हस्ताक्षर करने के लिए Url, यह मानते हुए कि यह एक GET अनुरोध है:

https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1

इस url में निम्नलिखित पैरामीटर हैं:

callback_url = https://managingpartner.com/link_account_callback client_app_id = 12345 fi_description = some name promotable_user_id = 1

http method और पैरामीटर के बिना url से बनी base string, चरण a - d, इस प्रकार है:

GET https://ads.x.com/link_managed_account

e के उपचरणों से बनी query string इस प्रकार है:

callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1

ध्यान दें कि key-value युग्म key नाम के अनुसार क्रमबद्ध हैं।

percent-encoded query string इस प्रकार है:

callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1

चरण a - d और e को मिलाकर बनी complete base string:

GET https://ads.x.com/link_managed_account&callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1

hmac-sha1 algorithm का उपयोग करके, हम इस पर key के रूप में “secret” शब्द के साथ हस्ताक्षर करेंगे। परिणाम Base64 encoded है, और इसे अंतिम “\n” के बिना प्रस्तुत किया गया है (चरण 2 और 3): KBxQMMSpKRrtg9aw3qxK4fTXvUc=

फिर इस signature को (percent encoded) मूल url के अंत में signature parameter में जोड़ा जाता है (चरण 4):

https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D

पार्टनर redirect url (account link request callback) पर हस्ताक्षर करना हस्ताक्षर करने के लिए URL, यह मानते हुए कि यह एक GET अनुरोध है:

https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF

इस url में निम्नलिखित पैरामीटर हैं:

account_id = ABC, funding_instrument_id = DEF और status = OK

http method और पैरामीटर के बिना url से बनी base string, चरण a - d, इस प्रकार है:

GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“

e के उपचरणों से बनी query string इस प्रकार है:

account_id=ABC&funding_instrument_id=DEF&status=OK

percent-encoded query string इस प्रकार है:

account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK

चरण a - d और e को मिलाकर बनी complete base string:

GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK

hmac-sha1 algorithm का उपयोग करके, हम इस पर key के रूप में “secret” शब्द और उस X user id, जिसके लिए मूल लिंक अनुरोध किया गया था, 1 (promotable_user_id = 1 from above), यानी “secret&1”, के साथ हस्ताक्षर करेंगे।

परिणाम Base64 encoded है, और इसे अंतिम “\n” के बिना प्रस्तुत किया गया है (चरण 2 और 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM=

इसके बाद इस हस्ताक्षर को (प्रतिशत-एन्कोड करके) मूल url के अंत में signature पैरामीटर में जोड़ा जाता है (चरण 4):

https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D

Shared Key का उपयोग / नवीनीकरण

साइनिंग एल्गोरिदम ऐसा होना चाहिए कि उसे एकाधिक कुंजियों के साथ दोहराया जा सके। इससे कई shared keys का उपयोग किया जा सकेगा, और shared keys को समय-समय पर रोटेट करना संभव होगा।  

partner_managed_funding_instrument का निर्माण

यदि fi_description पैरामीटर दिया गया है और खाते में उसी नाम का कोई मौजूदा partner_managed_funding_instrument नहीं है, तो एक नया partner_managed_funding_instrument बनाया जाएगा और सभी मौजूदा partner_managed_funding_instruments को पॉज़ कर दिया जाएगा।

यदि उसी नाम का कोई partner_managed_funding_instrument मौजूद है, तो नया partner_managed_funding_instrument नहीं बनाया जाएगा।  

ऑन-बोर्डिंग फ़्लो कॉल को दोहराना / टोकन रीफ़्रेश

यदि API access token खो जाए, तो ऑन-बोर्डिंग फ़्लो को दोबारा चलाया जा सकता है। ऑन-बोर्डिंग फ़्लो के कार्यान्वयन के लिए उपयोगकर्ता का लॉग इन होना आवश्यक है। यदि उपयोगकर्ता promotable_user_id से मेल खाता है, संबंधित ads account मिल जाता है, और सब कुछ सही है, तो उपयोगकर्ता को वापस callback url पर रीडायरेक्ट कर दिया जाएगा, और partner access token प्राप्त करने के लिए OAuth फ़्लो शुरू कर सकता है।  

गैर-रीडायरेक्ट किए बिना होने वाला त्रुटि प्रवाह

यदि account link url को अमान्य पैरामीटर के साथ कॉल किया जाता है, तो उपयोगकर्ता को OAuth प्रवाह में अमान्य या समाप्त हो चुके पैरामीटर दिए जाने पर दिखाई जाने वाली स्क्रीन जैसी एक स्क्रीन दिखाई जाएगी।  

PMFI में निरंतर अपडेट

विज्ञापनदाता के ऑनबोर्ड हो जाने के बाद, funding instrument को PUT accounts/:account_id/funding_instruments/:funding_instrument_id endpoint का उपयोग करके केवल वही partner प्रबंधित कर सकता है जो इसका प्रबंधन करता है।

प्लेसमेंट

ऐसी कई जगहें हैं जहाँ X विज्ञापन दिखाए जा सकते हैं। इसे line item में placements पैरामीटर का उपयोग करके सेट किया जाता है। संभावित मान ये हैं:

• ALL_ON_TWITTER
• PUBLISHER_NETWORK
• TWITTER_PROFILE
• TWITTER_SEARCH
• TWITTER_TIMELINE
• SPOTLIGHT
• TREND

line item का product_type और उद्देश्य यह निर्धारित करते हैं कि कौन-से प्लेसमेंट अनुमत हैं। हर product type के लिए मान्य प्लेसमेंट विकल्प प्राप्त करने हेतु GET line_items/placements endpoint का उपयोग किया जा सकता है।

इसके अलावा, नीचे दी गई तालिका मान्य प्लेसमेंट और उद्देश्य संयोजनों को सूचीबद्ध करती है।

Objective	ALL_ON_TWITTER	TWITTER_PROFILE	TWITTER_SEARCH	TWITTER_TIMELINE
APP_ENGAGEMENTS	✔	✔	✔	✔
APP_INSTALLS	✔	✔	✔	✔
REACH	✔	✔	✔	✔
FOLLOWERS	✔	✔	✔	✔
ENGAGEMENTS	✔	✔	✔	✔
VIDEO_VIEWS	✔	✔	✔	✔
PREROLL_VIEWS	✔	✔	✔	✔
WEBSITE_CLICKS	✔	✔	✔	✔

नोट: केवल TWITTER_PROFILE प्लेसमेंट निर्दिष्ट करना संभव नहीं है।

नोट: TWITTER_SEARCH के लिए keyword targeting आवश्यक है।

नोट: REACH उद्देश्य में TWITTER_TIMELINE प्लेसमेंट शामिल होना आवश्यक है। इसमें ALL_ON_TWITTER, प्लेसमेंट का कोई भी ऐसा संयोजन जिसमें TWITTER_TIMELINE शामिल हो, या केवल TWITTER_TIMELINE शामिल हो सकता है।

Ad groups FAQ

यह दस्तावेज़ X के Ads API में Ad Groups के बारे में अक्सर पूछे जाने वाले सवालों का संकलन है।

Ad Group क्या है?

Ad groups, जिन्हें Ads API में line items कहा जाता है, campaigns के अंतर्गत आते हैं और X उपयोगकर्ताओं के एक समूह के लिए targeting और bidding में इस्तेमाल किए जाते हैं। विज्ञापनदाता Tweets या media (जैसे, वे videos जिन्हें In-stream ads के रूप में प्रमोट किया जाता है) को किसी line item से जोड़कर उनका प्रचार करते हैं।

हम एक Ad Group कैसे बनाते हैं?

Ad Groups उसी अभियान ID के लिए POST accounts/:account_id/line_items को कई बार कॉल करके बनाए जाते हैं, और उन line items से जुड़े targeting और Tweets को (जो संभवतः पूरी तरह अलग हो सकते हैं) बनाए रखा जाता है। प्रति अभियान 100 line items की सीमा है, और एक ads account के लिए 200 active अभियानों की सीमा है। सभी अभियानों को मिलाकर, प्रति ads account 8,000 active line items की सीमा है।

हमें Ad Groups के लिए समर्थन क्यों जोड़ना चाहिए?

Ad Groups का उद्देश्य विज्ञापनदाताओं के लिए अपने अभियानों को व्यवस्थित, अनुकूलित और प्रबंधित करना आसान बनाना है।

Ad Groups का मुख्य लाभ यह है कि bid, budget, creative और targeting के आधार पर अलग-अलग रणनीतियों की तुलना और उन पर नियंत्रण किया जा सकता है। जब किसी एक line item से कई Promoted Tweets जुड़े होते हैं, तो auction पहले उस समूह में से सबसे बेहतर Tweet चुनता है और फिर सभी line items में से उस अभियान के लिए सबसे बेहतर Tweet का चयन करता है। यदि आपके पास एक-एक Tweet वाले कई Ad Groups हैं, तो यह व्यवहार में उस Ad Group से ऐसे Tweet का चयन करेगा जिसके बेहतर प्रदर्शन करने की संभावना अधिक हो।

Ad Groups का उपयोग करने से विज्ञापनदाता targeting और bidding को कहीं अधिक संभावित संयोजनों में विभाजित कर सकते हैं, और सामान्यतः targeting को तार्किक समूहों में बाँटना भी संभव होता है।

विशेष रूप से, Ads API tools को Ad Groups के साथ बारीकी से समायोजित optimization नियमों के आधार पर बनाया जा सकता है, जिन्हें line item और creative के बड़े पैमाने पर होने वाले संयोजनों के कारण manual edits के जरिए लागू करना अधिक कठिन होता है।

Ad Groups अभियान में line item बजट, अभियान बजट से कैसे संबंधित है?

किसी line item का total_budget_amount_local_micro, उसके parent अभियान के कुल बजट से अधिक नहीं हो सकता। इसी तरह, line item का bid_amount_local_micro मान, parent अभियान के daily_budget_amount_local_micro या total_budget_amount_local_micro से अधिक नहीं होना चाहिए। इन मानों को गलत तरीके से सेट करने पर पूरा अभियान paused हो सकता है और serve नहीं किया जा सकेगा।

ध्यान दें कि कुल अभियान बजट, उसके child line items के बजटों के योग से कम हो सकता है। line items के बीच बजट का वितरण आंशिक रूप से Ads API tool पर निर्भर करता है, ताकि वह प्रभावी रूप से optimize कर सके और बदलाव कर सके, क्योंकि targeting (line item) का दैनिक प्रदर्शन X की realtime प्रकृति के कारण दिन-प्रतिदिन काफ़ी अलग हो सकता है।

क्या Ad Groups, एकल line items की तुलना में बेहतर प्रदर्शन करते हैं?

किसी अभियान का प्रदर्शन कई कारकों पर निर्भर करता है, और व्यवहार में Tweet ही उसके प्रदर्शन का अंतिम निर्णायक कारक होता है। Line Item को इस बात के एक कारक के रूप में देखा जाता है कि कोई Tweet किसी उपयोगकर्ता को दिखाए जाने की दौड़ में शामिल है या नहीं।

जो line items उपयोगकर्ताओं के समान समूहों को लक्षित करते हैं, उनमें उपयोगकर्ता-ओवरलैप माना जाता है। सर्वोत्तम प्रथा यह है कि line items के बीच targeting के इस ओवरलैप को कम किया जाए, ताकि सबसे अच्छा प्रदर्शन करने वाले उपयोगकर्ता-समूहों की स्पष्ट पहचान की जा सके।

मार्गदर्शिकाएँ

वीडियो व्यूज़ प्रीरोल उद्देश्य

निम्नलिखित मार्गदर्शिका Ads API में PREROLL_VIEWS अभियान सेट अप करने के लिए आवश्यक चरणों की रूपरेखा देती है। सामान्य तौर पर, इन अभियानों को दो प्रकारों में बांटा जाता है: Curated Categories और Content Categories (जिन्हें Ads UI में Standard Categories कहा जाता है)।  

आवश्यक एंडपॉइंट

• Chunked media upload (वीडियो अपलोड के लिए)
• POST accounts/:account_id/media_library (वीडियो को ads account से संबद्ध करने के लिए)
• POST accounts/:account_id/campaigns (campaign बनाने के लिए)
• GET content_categories (content categories और IAB categories के बीच मैपिंग पाने के लिए)
• GET accounts/:account_id/curated_categories
• GET publishers
• POST accounts/:account_id/line_item_curated_categories
• POST accounts/:account_id/line_items (ad group बनाने के लिए)
• POST accounts/:account_id/media_creatives (वीडियो को ad group से संबद्ध करने के लिए)
• POST accounts/:account_id/preroll_call_to_action (CTA और redirect URL सेट करने के लिए)
• POST batch/accounts/:account_id/targeting_criteria (targeting के लिए)

चरण

वीडियो अपलोड करें

वीडियो अपलोड करने की प्रक्रिया में 2 चरण शामिल हैं:

वीडियो मीडिया अपलोड करें

सबसे पहले, Chunked media upload endpoint का उपयोग करके प्रोसेसिंग के लिए वीडियो को X पर अपलोड करें। इस endpoint के साथ शुरुआती INIT के दौरान आपको media_category=amplify_video पास करना होगा। आप वीडियो को कई खंडों में अपलोड करेंगे। STATUS में state का मान succeeded लौटने के बाद, आप अगले चरणों पर आगे बढ़ सकते हैं। chunked endpoint का उपयोग करके मीडिया अपलोड करने के बारे में अधिक जानकारी हमारे Promoted Video Overview में मिल सकती है।

वीडियो को Ads account में जोड़ें

STATUS कमांड का उपयोग करके लौटाई गई state जब succeeded हो जाए, तो उस endpoint से लौटाई गई media_key का इस्तेमाल करके वीडियो को advertiser की media library में जोड़ें। इसके लिए POST accounts/:account_id/media_library endpoint का उपयोग करें।

POST https://ads-api.x.com/8/55w3kv/media\_library?media\_key=3_931236738554519552

{
 "request": {
   "params": {
     "account_id": "55w3kv",
     "media\_key": "3\_931236738554519552"
   }
 },
 "data": {
   "tweeted": false,
   "name": null,
   "file_name": null,
   "media\_url": "https://video.twimg.com/amplify\_video/1059840836186165250/vid/568x320/Gr2l1fB1X7xotKwC.mp4?tag=8",
   "media\_category": "AMPLIFY\_VIDEO",
   "media\_key": "3\_931236738554519552",
   "created_at": "2017-11-16T19:05:14Z",
   "media\_status": "TRANSCODE\_COMPLETED",
   "media_id": 931236738554519552,
   "media_type": "VIDEO",
   "updated_at": "2017-11-16T19:05:23Z",
   "deleted": false
 }
}

अभियान सेट करें

अभियान निर्माण

campaign और लाइन आइटम/ad group बनाएं। लाइन आइटम को objective के लिए VIDEO_VIEWS_PREROLL और product_type के लिए MEDIA के साथ बनाया जाना चाहिए। categories पैरामीटर को भी उपयुक्त विज्ञापनदाता व्यवसाय श्रेणियों पर सेट करना होगा।

POST https://ads-api.x.com/8/accounts/55w3kv/campaigns?name=test-curated-categories-api&funding\_instrument\_id=103hp9&start\_time=2021-02-10&entity\_status=PAUSED&daily\_budget\_amount\_local\_micro=55000000

{
  "request": {
    "params": {
      "name": "test-curated-categories-api",
      "start_time": "2021-02-10T00:00:00Z",
      "daily\_budget\_amount\_local\_micro": 55000000,
      "funding\_instrument\_id": "103hp9",
      "entity_status": "PAUSED",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
      "EXPIRED",
      "PAUSED\_BY\_ADVERTISER",
      "FUNDING_PROBLEM"
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "PAUSED",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "PAUSED",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

लाइन आइटम बनाना

लाइन आइटम में categories पैरामीटर को IAB categories के उपयुक्त सेट पर सेट करना चाहिए, जिसे GET content_categories endpoint के जरिए प्राप्त किया जाता है। इनमें से हर content category एक या अधिक IAB categories से संबद्ध होती है।

इन मानों का उपयोग करने के लिए, partners को उपयुक्त content category चुननी होगी और लाइन आइटम्स endpoint पर categories पैरामीटर सेट करने के लिए रिस्पॉन्स में लौटाए गए iab_categories के पूरे सेट का उपयोग करना होगा। iab_categories का आंशिक रूप से उपयोग करने पर लाइन आइटम पर पूरा समूह सेट हो जाएगा। उदाहरण के लिए,

GET https://ads-api.x.com/8/advertiser\_business\_categories

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": \[
    {
      "id": "1jl",
      "name": "उपभोक्ता पैकेज्ड वस्तुएं",
      "iab_categories": \[
        "IAB9-26",
        "IAB9-18",
        "IAB9-29",
        "IAB9-1",
        "IAB9-8",
        "IAB9-22",
        "IAB6",
        "IAB9-5",
        "IAB9-12",
        "IAB9-11",
        "IAB9-23",
        "IAB9-14",
        "IAB4",
        "IAB9-25",
        "IAB9-17",
        "IAB23",
        "IAB9-24",
        "IAB9-13",
        "IAB16",
        "IAB9-4",
        "IAB9-9",
        "IAB9-20",
        "IAB22",
        "IAB9-28",
        "IAB9-27",
        "IAB9-16",
        "IAB9-31",
        "IAB9-3",
        "IAB9-19",
        "IAB10",
        "IAB9-2",
        "IAB9-6",
        "IAB9-21",
        "IAB9-10",
        "IAB9-15"
      \]
    },
    {
      "id": "1jm",
      "name": "स्वास्थ्य और फार्मा",
      "iab_categories": \[
        "IAB7"
      \]
    },
    {
      "id": "1jn",
      "name": "मदिरा",
      "iab_categories": \[
        "IAB8-5",
        "IAB8-18"
      \]
    },
    {
      "id": "1jo",
      "name": "भोजन",
      "iab_categories": \[
        "IAB8-10",
        "IAB8-8",
        "IAB8-7",
        "IAB8-15",
        "IAB8-3",
        "IAB8-4",
        "IAB8-1",
        "IAB8-16",
        "IAB8-12",
        "IAB8-13",
        "IAB8-17",
        "IAB8-11",
        "IAB8-6",
        "IAB8-9",
        "IAB8-2",
        "IAB8-14"
      \]
    },
    {
      "id": "1jp",
      "name": "वित्तीय सेवाएं",
      "iab_categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \]
    },
    {
      "id": "1jq",
      "name": "खुदरा",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "यात्रा",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "गेमिंग",
      "iab_categories": \[
        "IAB9-30"
      \]
    },
    {
      "id": "1jt",
      "name": "प्रौद्योगिकी",
      "iab_categories": \[
        "IAB19-22",
        "IAB19-13",
        "IAB19-4",
        "IAB19-33",
        "IAB19-26",
        "IAB19-3",
        "IAB19-16",
        "IAB19-9",
        "IAB19-32",
        "IAB19-25",
        "IAB19-30",
        "IAB19-36",
        "IAB19-21",
        "IAB5",
        "IAB19-12",
        "IAB19-28",
        "IAB19-17",
        "IAB19-8",
        "IAB19-7",
        "IAB19-24",
        "IAB15",
        "IAB19-11",
        "IAB19-31",
        "IAB19-20",
        "IAB19-15",
        "IAB19-1",
        "IAB19-35",
        "IAB19-29",
        "IAB19-34",
        "IAB19-23",
        "IAB19-2",
        "IAB19-5",
        "IAB19-14",
        "IAB19-27",
        "IAB19-10",
        "IAB19-19"
      \]
    },
    {
      "id": "1ju",
      "name": "दूरसंचार",
      "iab_categories": \[
        "IAB19-6",
        "IAB19-18"
      \]
    },
    {
      "id": "1jv",
      "name": "ऑटो",
      "iab_categories": \[
        "IAB2"
      \]
    },
    {
      "id": "1jw",
      "name": "मीडिया और मनोरंजन",
      "iab_categories": \[
        "IAB14-8",
        "IAB14-4",
        "IAB1-5",
        "IAB14-7",
        "IAB1-7",
        "IAB17",
        "IAB14-3",
        "IAB1-1",
        "IAB12",
        "IAB1-6",
        "IAB25-1",
        "IAB1-2",
        "IAB14-2",
        "IAB14-6",
        "IAB1-3",
        "IAB1-4",
        "IAB14-5"
      \]
    },
    {
      "id": "1jx",
      "name": "राजनीति",
      "iab_categories": \[
        "IAB11-4"
      \]
    },
    {
      "id": "1jy",
      "name": "जुआ",
      "iab_categories": \[
        "IAB9-7"
      \]
    },
    {
      "id": "1jz",
      "name": "डेटिंग",
      "iab_categories": \[
        "IAB14-1"
      \]
    },
    {
      "id": "1k0",
      "name": "गैर-लाभकारी",
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}

अब, categories पैरामीटर को “Science & Education” पर सेट करने के लिए, iab_categories का पूरा सेट, यानी "IAB5", "IAB15", लाइन आइटम के लिए सेट होना चाहिए, इस प्रकार:

POST https://ads-api.x.com/8/accounts/55w3kv/line\_items?campaign\_id=f2rp3&bid\_amount\_local\_micro=5500000&name=curated-category-line-item&product\_type=MEDIA&placements=ALL\_ON\_TWITTER&objective=PREROLL_VIEWS&categories=IAB3,IAB13,IAB21

{
  "request": {
    "params": {
      "name": "curated-category-line-item",
      "placements": \[
        "ALL\_ON\_TWITTER"
      \],
      "bid\_amount\_local_micro": 5500000,
      "product_type": "MEDIA",
      "objective": "PREROLL_VIEWS",
      "account_id": "55w3kv",
      "categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \],
      "campaign_id": "f2rp3"
    }
  },
  "data": {
    "bid_type": "MAX",
    "advertiser\_user\_id": 312226591,
    "name": "curated-category-line-item",
    "placements": \[
      "ALL\_ON\_TWITTER"
    \],
    "start_time": null,
    "bid\_amount\_local_micro": 5500000,
    "automatically\_select\_bid": false,
    "advertiser_domain": null,
    "target\_cpa\_local_micro": null,
    "raw_categories": \[
      "x",
      "5l",
      "9z"
    \],
    "primary\_web\_event_tag": null,
    "charge\_by": "VIEW\_3S_100PCT",
    "product\_type": "PROMOTED\_TWEETS",
    "end_time": null,
    "duration\_in\_days": null,
    "bid\_unit": "VIEW\_3S_100PCT",
    "total\_budget\_amount\_local\_micro": null,
    "objective": "PREROLL_VIEWS",
    "id": "iqwka",
    "entity_status": "ACTIVE",
    "automatic\_tweet\_promotion": null,
    "optimization": "DEFAULT",
    "frequency_cap": null,
    "android\_app\_store_identifier": null,
    "categories": \[
      "IAB3",
      "IAB13",
      "IAB21"
    \],
    "currency": "USD",
    "created_at": "2021-02-09T00:00:46Z",
    "tracking_tags": \[\],
    "ios\_app\_store_identifier": null,
    "amplify_config": {
      "auto_promote": true,
      "is_open": true
    },
    "updated_at": "2021-02-09T00:00:46Z",
    "campaign_id": "f2rp3",
    "creative_source": "MANUAL",
    "deleted": false
  }
}

Publisher चयन

कोई विज्ञापनदाता नीचे दिए गए अतिरिक्त विवरणों के अनुसार Content Category या Curated Category में से किसी एक को लक्षित करना चुन सकता है। 

नोट:  लाइन आइटम्स, Curated या Content Categories में से केवल किसी एक को लक्षित कर सकते हैं, दोनों को नहीं। 

क्यूरेटेड श्रेणियाँ

क्यूरेटेड श्रेणियाँ विज्ञापनदाताओं को प्रकाशकों के पहले से निर्धारित समूह को लक्षित करने की सुविधा देती हैं, और इन्हें  GET curated_categories endpoint का उपयोग करके प्राप्त किया जा सकता है। ये श्रेणियाँ देश-विशिष्ट होती हैं, इसलिए यह आवश्यक है कि लाइन आइटम, श्रेणी के country_code के आधार पर उपयुक्त देश को लक्षित करे।

इनमें से किसी एक श्रेणी का उपयोग करने के लिए, नीचे दिए गए चरणों का ठीक इसी क्रम में पालन करना आवश्यक है:

1. लाइन आइटम को क्यूरेटेड श्रेणी के country_code के आधार पर उपयुक्त देश को लक्षित करना होगा
2. लाइन आइटम को किसी विशिष्ट curated_category_id से संबद्ध करने के लिए POST line_item_curated_categories endpoint का उपयोग करना होगा। 

ध्यान दें: किसी लाइन आइटम को किसी क्यूरेटेड श्रेणी से संबद्ध करने पर denylist किए जा सकने वाले प्रकाशकों की संख्या भी 5 तक सीमित हो जाएगी। विशिष्ट प्रकाशकों को denylist करने के लिए उपयोग की गई user_id की पूरी सूची GET publishers endpoint से प्राप्त की जा सकती है। इसके अतिरिक्त, कोई भी लाइन आइटम एक समय में एक से अधिक क्यूरेटेड श्रेणी को लक्षित नहीं कर सकता।

निम्न उदाहरण यह दर्शाता है कि curated category id: b0xt, जो केवल US में उपलब्ध है, को पिछले चरण में बनाए गए लाइन आइटम के साथ कैसे संबद्ध किया जाए।

पहले, लाइन आइटम के targeting criteria को 96683cc9126741d मान पर सेट किया जाता है

GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "United States",
      "country_code": "US",
      "location_type": "COUNTRIES",
      "targeting_value": "96683cc9126741d1",
      "targeting_type": "LOCATION"
    }
  \],
  "request": {
    "params": {
      "location_type": "COUNTRIES",
      "country_code": "US"
    }
  },
  "next_cursor": null
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwka",
      "targeting_type": "LOCATION",
      "targeting_value": "96683cc9126741d1",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "United States",
      "raw_negated": false,
      "raw\_targeting\_value": "2",
      "id": "rv9hmc",
      "raw\_targeting\_type": "GEO",
      "raw\_operator\_type": "EQUAL_TO",
      "location_type": "COUNTRIES",
      "operator_type": "EQ",
      "created_at": "2021-02-09T00:06:28Z",
      "targeting_value": "96683cc9126741d1",
      "updated_at": "2021-02-09T00:06:28Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "96683cc9126741d1",
        "targeting_type": "LOCATION"
      },
      "operation_type": "Create"
    }
  \]
}

POST https://ads-api.x.com/8/accounts/55w3kv/line\_item\_curated\_categories?line\_item\_id=iqwka&curated\_category_id=9ddrgesiap6o

{
  "request": {
    "params": {
      "curated\_category\_id": "9ddrgesiap6o",
      "line\_item\_id": "iqwka",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "line\_item\_id": "iqwka",
    "curated\_category\_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

सामग्री श्रेणियाँ

सामग्री श्रेणियाँ, जिन्हें Standard Categories भी कहा जाता है, GET curated_categories endpoint से प्राप्त की जा सकती हैं। इसके बाद इन श्रेणियों को batch targeting criteria endpoints का उपयोग करके लाइन आइटम के लिए target किया जा सकता है। निम्न उदाहरण दिखाता है कि किसी विशेष सामग्री श्रेणी, id: sr, जो “समाचार & समसामयिक घटनाएँ” से मैप होती है, को कैसे चुना जाए और उसे लाइन आइटम पर कैसे लागू किया जाए।

नोट: GET curated_categories रिस्पॉन्स में iab_categories के पूरे सेट को targeting criteria endpoint के माध्यम से target करना आवश्यक है। ऐसा न करने पर validation error होगा। 

GET https://ads-api.x.com/8/content_categories
{
      "name": "News & Current Events",
      "id": "sr",
      "iab_categories": \[
        "IAB12",
        "IAB14"
      \],
      "publishers\_in\_last\_thirty\_days": 124,
      "videos\_monetized\_in\_last\_thirty_days": 5429
    }
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB12",
      "operator_type": "EQ"
    }
  },
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB14",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwls",
      "name": "News",
      "raw_negated": false,
      "raw\_targeting\_value": "5h",
      "id": "saib9p",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB12",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    },
    {
      "line\_item\_id": "iqwls",
      "name": "Society",
      "raw_negated": false,
      "raw\_targeting\_value": "5y",
      "id": "saib9q",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB14",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB12",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB14",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    }
  \]
}

खाते के मीडिया (वीडियो) को लाइन आइटम से संबद्ध करें

वीडियो को विज्ञापन समूह से संबद्ध करने के लिए POST accounts/:account_id/media_creatives endpoint का उपयोग करें।

POST https://ads-api.x.com/8/accounts/55w3kv/media_creatives
line\_item\_id=4bii5&account\_media\_id=knb

{
 "data":{
   "account\_media\_id":"74g",
   "approval_status":"ACCEPTED",
   "created_at":"2016-02-11T22:23:23Z",
   "deleted":false,
   "id":"qeq",
   "landing_url":null,
   "line\_item\_id":"4bii5",
   "serving_status":"ACTIVE",
   "updated_at":"2016-02-11T22:23:23Z"
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "account\_media\_id":"knb"
   }
 }
}

CTA और गंतव्य URL सेट करें

यह ध्यान रखना महत्वपूर्ण है कि X पर अधिकांश अन्य अभियानों के विपरीत, VIDEO_VIEWS_PREROLL उद्देश्य Promoted Tweets या Cards का उपयोग नहीं करता। इसके बजाय, वीडियो क्रिएटिव आपके विज्ञापन समूह (लाइन आइटम) से संबद्ध होता है, और CTA जानकारी preroll_call_to_action एंटिटी से जुड़ी होती है। POST accounts/:account_id/preroll_call_to_action एंडपॉइंट आपको बटन CTA और गंतव्य URL नियंत्रित करने की सुविधा देता है।

POST https://ads-api.x.com/8/accounts/55w3kv/preroll\_call\_to_action
line\_item\_id=4bii5&call\_to\_action=VISIT\_SITE&call\_to\_action\_url=https%3A%2F%2Fx.com%2FAdsAPI

{
 "data":{
   "id":"aaa111",
   "line\_item\_id":"4bii5",
   "call\_to\_action":"WATCH_NOW",
   "call\_to\_action_url":"https://x.com/AdsAPI",
   "created_at":"2016-02-11T22:23:23Z",
   "updated_at":"2016-02-11T22:23:23Z",
   "deleted":false
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "call\_to\_action":"VISIT_SITE",
     "call\_to\_action_url":"https://x.com/AdsAPI"
   }
 }
}

टार्गेटिंग मानदंड सेट करें

प्री-रोल वीडियो विज्ञापनों के लिए इस्तेमाल किया जाने वाला टार्गेटिंग मानदंड केवल हमारे बैच टार्गेटिंग मानदंड endpoint POST batch/accounts/:account_id/targeting_criteria के माध्यम से ही उपलब्ध है।

विज्ञापन को कुछ उपयोगकर्ताओं के साथ पेयर होने से रोकने के लिए CONTENT_PUBLISHER_USER को negated targeting के रूप में इस्तेमाल करें। जिन handles को बाहर रखना है, उनके लिए X user_id या publisher_user_id दें।

सामग्री श्रेणियाँ के लिए बाहर रखे जाने वाले user_id की सूची पाने हेतु GET publishers endpoint का उपयोग किया जा सकता है। GET curated_categories रिस्पॉन्स में लौटाया गया publisher_user_id, क्यूरेटेड श्रेणियाँ के लिए इसी तरह की बहिष्करण सूची प्राप्त करने में इस्तेमाल किया जा सकता है।

नोट: क्यूरेटेड श्रेणियाँ के लिए अधिकतम 5 publisher_user_id और सामग्री श्रेणियाँ के लिए 50 user_id को बाहर रखा जा सकता है।

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "CONTENT\_PUBLISHER_ID",
      "targeting_value": "1917731",
      "operator_type": "NE"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "realsaltlake",
      "raw_negated": true,
      "raw\_targeting\_value": "aajwo",
      "id": "sajk32",
      "raw\_targeting\_type": "CONTENT_PUBLISHER",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "NE",
      "created_at": "2021-03-30T18:02:32Z",
      "targeting_value": 17288520,
      "updated_at": "2021-03-30T18:02:32Z",
      "deleted": false,
      "targeting\_type": "CONTENT\_PUBLISHER_USER"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "NE",
        "targeting_value": "17288520",
        "targeting\_type": "CONTENT\_PUBLISHER_USER"
      },
      "operation_type": "Create"
    }
  \]
}

अभियान लॉन्च करें

जब आप अपना अभियान लॉन्च करने के लिए तैयार हों, तो बस PUT accounts/:account_id/campaigns/:id का उपयोग करके उसका पॉज़ हटाएँ।

PUT https://ads-api.x.com/8/accounts/55w3kv/campaigns/f2rp3? entity_status=ACTIVE

{
  "request": {
    "params": {
      "campaign_id": "f2rp3",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "ACTIVE",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "ACTIVE",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

एनालिटिक्स

VIDEO_VIEWS_PREROLL अभियानों के लिए एनालिटिक्स हमारे stats endpoints का उपयोग करके उपलब्ध है।

Timelines में कीवर्ड टार्गेटिंग

कीवर्ड टार्गेटिंग हमारे Promoted Tweets प्रोडक्ट्स के लिए बुनियादी है, जिससे अभियान की पहुँच बेहतर होती है। टाइमलाइन में कीवर्ड टार्गेटिंग, प्लेटफ़ॉर्म को उपयोगकर्ताओं के हाल के Tweets में मौजूद कीवर्ड के आधार पर X उपयोगकर्ताओं को लक्षित करने में सक्षम बनाती है। उदाहरण के लिए, अगर कोई विज्ञापनदाता बिना क्रम वाले कीवर्ड संयोजन “plan + trip” को लक्षित कर रहा है, और कोई उपयोगकर्ता Tweet करता है, “मैं Cabo की अपनी यात्रा की योजना बनाना शुरू कर रहा हूँ, कोई सुझाव?” तो अभियान चलने के दौरान, उस उपयोगकर्ता को कुछ ही समय बाद विज्ञापनदाता का Promoted Tweet दिख सकता है।

यह कैसे काम करता है?

संक्षेप में: API के नज़रिए से यह बदलाव काफ़ी सरल है: अब आप Timeline में Promoted Tweets के लिए keyword targeting कर सकते हैं। बस लाइन आइटम्स के लिए targeting_type को unordered_keywords या phrase_keywords पर सेट करें।

क्विक स्टार्ट गाइड

• ALL_ON_TWITTER या TWITTER_TIMELINE में से किसी एक को शामिल करने के लिए placement सेट करके एक नया लाइन आइटम बनाएँ POST accounts/:account_id/line_items
• नए बनाए गए इस लाइन आइटम के लिए BROAD_KEYWORD के साथ targeting criteria बनाएँ और अपने keyword value(s) सेट करें। POST accounts/:account_id/targeting_criteria
• आप PUT accounts/:account_id/targeting_criteria का उपयोग करके keywords अपडेट कर सकते हैं
• आपका अभियान चलने के बाद, performance का आकलन करने के लिए अपने लाइन आइटम के stats प्राप्त करें। GET stats/accounts/:account_id

API संदर्भ

अकाउंट्स

GET accounts

उन कुछ या सभी विज्ञापन-सक्षम accounts का विवरण प्राप्त करें, जिन तक प्रमाणित उपयोगकर्ता की पहुँच है।

संसाधन URL

https://ads-api.x.com/12/accounts

पैरामीटर

Name	Description
account_ids optional	अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल इच्छित account IDs तक सीमित करें। Type: string Example: 18ce54d4x5t
count optional	हर अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
q optional	name के आधार पर resource को सीमित करने के लिए एक वैकल्पिक query। Note: यह case-insensitive prefix matching करता है। Type: string Min, Max length: 1, 255
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। Note: यह parameter और cursor एक साथ उपयोग नहीं किए जा सकते। Note: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts?account_ids=18ce54d4x5t

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

       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
           {
             "name": "API McTestface",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": "2016-07-21T07:00:00Z",
             "id": "18ce54d4x5t",
             "created_at": "2016-07-21T22:42:09Z",
             "updated_at": "2017-07-06T16:51:04Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

GET accounts/:account_id

उस विशिष्ट अकाउंट को प्राप्त करें, जिसकी पहुँच प्रमाणीकृत उपयोगकर्ता को है।

रिसोर्स URL

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

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t
with_deleted optional	अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean डिफ़ॉल्ट: false संभव मान: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t

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

       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
           }
         },
         "data": {
           "name": "API McTestface",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TRAVEL",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

POST accounts

नोट: केवल सैंडबॉक्स

सैंडबॉक्स परिवेश में एक ads account बनाएँ।

रिसोर्स URL

https://ads-api-sandbox.x.com/12/accounts

पैरामीटर

कोई नहीं

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

POST https://ads-api-sandbox.x.com/12/accounts

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

       {
         "request": {
           "params": {}
         },
         "next_cursor": null,
         "data": [
           {
             "name": "Sandbox account",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": null,
             "id": "gq12fh",
             "created_at": "2016-07-18T23:02:20Z",
             "updated_at": "2016-07-18T23:02:20Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

PUT accounts/:account_id

खाते का नाम और/या उद्योग प्रकार अपडेट करता है।

रिसोर्स URL

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

पैरामीटर

नाम	विवरण
account_id required	leveraged खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t
name optional	खाते का नाम। Type: string उदाहरण: API McTestface
industry_type optional	वह उद्योग जिससे खाता संबद्ध है। Type: string संभावित मान: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY

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

       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
             "name"": "API McTestface 2",
             "industry_type": "TECHNOLOGY"
           }
         },
         "data": {
           "name": "API McTestface 2",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TECHNOLOGY",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

DELETE accounts/:account_id

नोट: केवल SANDBOX

सैंडबॉक्स परिवेश में किसी विज्ञापन खाते को हटाएँ।

रिसोर्स URL

https://ads-api-sandbox.x.com/12/accounts/:account_id

पैरामीटर

Name	Description
account_id required	लीवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t

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

DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh

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

       {
         "data": {
           "name": "Sandbox account",
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": null,
           "id": "gq12fh",
           "created_at": "2016-07-18T23:02:20Z",
           "updated_at": "2017-08-23T18:21:10Z",
           "approval_status": "ACCEPTED",
           "deleted": true
         },
         "request": {
           "params": {
             "account_id": "gq12fh"
           }
         }
       }

अकाउंट ऐप्स

Postman में चलाएँ ❯

GET account_apps

निर्दिष्ट ad account से संबद्ध सभी मोबाइल ऐप्स का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/account_apps

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	results का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
sort_by optional	समर्थित attribute के अनुसार ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	रिस्पॉन्स में total_count attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps

Example Response

       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
          {
            "app_store_identifier": "com.twitter.android",
            "conversion_tracking_enabled": false,
            "deep_link_pattern": "twitter://",
            "id": "4x",
            "created_at": "2019-06-20T22:36:16Z",
            "updated_at": "2021-10-19T20:05:29Z",
            "os_type": "Android",
            "deleted": false
          }
         ]
       }

खाते का इतिहास

GET accounts/:account_id/account_history

अनुरोध में निर्दिष्ट entity_id में किए गए बदलावों का सारांश प्राप्त करें।

नोट: यह एंडपॉइंट वर्तमान में बीटा में है और इसके लिए allowlisting आवश्यक है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/account_history

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
entity_type required	वह entity type जिसके लिए डेटा प्राप्त करना है। Type: enum Example: PROMOTED_TWEET Possible values: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT
entity_id required	वह विशिष्ट entity जिसके लिए डेटा प्राप्त करना है। Type: string Example: 8u94t
start_time required	प्राप्त किए गए डेटा को निर्दिष्ट प्रारंभ समय से सीमित करता है, जिसे ISO 8601 में व्यक्त किया जाता है। नोट: इसे पूरे घंटों में व्यक्त किया जाना चाहिए (0 मिनट और 0 सेकंड)। Type: string Example: 2017-05-19T07:00:00Z
end_time required	प्राप्त किए गए डेटा को निर्दिष्ट समाप्ति समय तक सीमित करता है, जिसे ISO 8601 में व्यक्त किया जाता है। नोट: इसे पूरे घंटों में व्यक्त किया जाना चाहिए (0 मिनट और 0 सेकंड)। Type: string Example: 2017-05-26T07:00:00Z
user_id optional	रिस्पॉन्स को किसी विशिष्ट उपयोगकर्ता तक सीमित करता है। Type: long Example: 3271358660

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "entity": "CAMPAIGN",
          "entity_id": "fc3h5",
          "count": 1
        }
      },
      "next_cursor": "1r2407sb4lc",
      "data": [
        {
          "change_by": {
            "user_id": "982978172",
            "platform": "API_OTHER"
          },
          "changes": {},
          "change_time": "2021-04-02T20:55:42Z",
          "entity_id": "fc3h5",
          "entity": "CAMPAIGN",
          "entity_data": {
            "name": "test_campaign",
            "start_time": "2021-04-02T18:59:11Z",
            "purchase_order_number": null,
            "daily_budget_amount_local_micro": 100000000,
            "end_time": null,
            "duration_in_days": null,
            "standard_delivery": true,
            "total_budget_amount_local_micro": 100000000,
            "entity_status": "ACTIVE",
            "frequency_cap": null,
            "created_at": "2021-04-02T20:55:42Z",
            "updated_at": "2021-04-02T20:55:42Z",
            "deleted": false
          },
          "change_type": "CREATE"
        }
      ]
    }

विज्ञापनदाता व्यवसाय श्रेणियां

GET advertiser_business_categories

प्रकाशकों को विज्ञापनदाता के ब्रांड का विवरण देने के लिए, Ad Groups (line_items) हेतु मान्य विज्ञापनदाता व्यवसाय categories प्राप्त करें।

ध्यान दें: ये categories केवल PREROLL_VIEWS objective वाले line_items पर लागू होती हैं और targeting criteria के लिए उपयोग की जाने वाली content_categories से अलग हैं।

प्रत्येक advertiser_business_categories, IAB Categories के एक संग्रह को दर्शाता है। PREROLL_VIEWS objective के साथ Ad Group बनाते समय, Ad Group के लिए एक या दो advertiser_business_categories सेट करना आवश्यक है। यह line item endpoint पर categories request parameter का मान, इस endpoint के माध्यम से उपलब्ध संबंधित iab_categories के सेट पर सेट करके किया जा सकता है।

अधिक विवरण Video Views Preroll Objective Guide में उपलब्ध हैं

रिसोर्स URL

https://ads-api.x.com/12/advertiser_business_categories

पैरामीटर

कोई request parameter नहीं

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

GET https://ads-api.x.com/12/advertiser_business_categories

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

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "id": "1jl",
          "name": "उपभोक्ता पैकेज्ड वस्तुएँ",
          "iab_categories": [
            "IAB9-26",
            "IAB9-18",
            "IAB9-29",
            "IAB9-1",
            "IAB9-8",
            "IAB9-22",
            "IAB6",
            "IAB9-5",
            "IAB9-12",
            "IAB9-11",
            "IAB9-23",
            "IAB9-14",
            "IAB4",
            "IAB9-25",
            "IAB9-17",
            "IAB23",
            "IAB9-24",
            "IAB9-13",
            "IAB16",
            "IAB9-4",
            "IAB9-9",
            "IAB9-20",
            "IAB22",
            "IAB9-28",
            "IAB9-27",
            "IAB9-16",
            "IAB9-31",
            "IAB9-3",
            "IAB9-19",
            "IAB10",
            "IAB9-2",
            "IAB9-6",
            "IAB9-21",
            "IAB9-10",
            "IAB9-15"
          ]
        },
        {
          "id": "1jm",
          "name": "स्वास्थ्य एवं फार्मा",
          "iab_categories": [
            "IAB7"
          ]
        },
        {
          "id": "1jn",
          "name": "मदिरा",
          "iab_categories": [
            "IAB8-5",
            "IAB8-18"
          ]
        },
        {
          "id": "1jo",
          "name": "भोजन",
          "iab_categories": [
            "IAB8-10",
            "IAB8-8",
            "IAB8-7",
            "IAB8-15",
            "IAB8-3",
            "IAB8-4",
            "IAB8-1",
            "IAB8-16",
            "IAB8-12",
            "IAB8-13",
            "IAB8-17",
            "IAB8-11",
            "IAB8-6",
            "IAB8-9",
            "IAB8-2",
            "IAB8-14"
          ]
        },
        {
          "id": "1jp",
          "name": "वित्तीय सेवाएँ",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ]
        },
        {
          "id": "1jq",
          "name": "खुदरा",
          "iab_categories": [
            "IAB18"
          ]
        },
        {
          "id": "1jr",
          "name": "यात्रा",
          "iab_categories": [
            "IAB20"
          ]
        },
        {
          "id": "1js",
          "name": "गेमिंग",
          "iab_categories": [
            "IAB9-30"
          ]
        },
        {
          "id": "1jt",
          "name": "प्रौद्योगिकी",
          "iab_categories": [
            "IAB19-22",
            "IAB19-13",
            "IAB19-4",
            "IAB19-33",
            "IAB19-26",
            "IAB19-3",
            "IAB19-16",
            "IAB19-9",
            "IAB19-32",
            "IAB19-25",
            "IAB19-30",
            "IAB19-36",
            "IAB19-21",
            "IAB5",
            "IAB19-12",
            "IAB19-28",
            "IAB19-17",
            "IAB19-8",
            "IAB19-7",
            "IAB19-24",
            "IAB15",
            "IAB19-11",
            "IAB19-31",
            "IAB19-20",
            "IAB19-15",
            "IAB19-1",
            "IAB19-35",
            "IAB19-29",
            "IAB19-34",
            "IAB19-23",
            "IAB19-2",
            "IAB19-5",
            "IAB19-14",
            "IAB19-27",
            "IAB19-10",
            "IAB19-19"
          ]
        },
        {
          "id": "1ju",
          "name": "दूरसंचार",
          "iab_categories": [
            "IAB19-6",
            "IAB19-18"
          ]
        },
        {
          "id": "1jv",
          "name": "ऑटो",
          "iab_categories": [
            "IAB2"
          ]
        },
        {
          "id": "1jw",
          "name": "मीडिया एवं मनोरंजन",
          "iab_categories": [
            "IAB14-8",
            "IAB14-4",
            "IAB1-5",
            "IAB14-7",
            "IAB1-7",
            "IAB17",
            "IAB14-3",
            "IAB1-1",
            "IAB12",
            "IAB1-6",
            "IAB25-1",
            "IAB1-2",
            "IAB14-2",
            "IAB14-6",
            "IAB1-3",
            "IAB1-4",
            "IAB14-5"
          ]
        },
        {
          "id": "1jx",
          "name": "राजनीति",
          "iab_categories": [
            "IAB11-4"
          ]
        },
        {
          "id": "1jy",
          "name": "जुआ",
          "iab_categories": [
            "IAB9-7"
          ]
        },
        {
          "id": "1jz",
          "name": "डेटिंग",
          "iab_categories": [
            "IAB14-1"
          ]
        },
        {
          "id": "1k0",
          "name": "गैर-लाभकारी",
          "iab_categories": [
            "IAB11-1",
            "IAB11-2",
            "IAB11-3",
            "IAB11-5"
          ]
        }
      ]
    }

ऑडियंस का अनुमान

POST accounts/:account_id/audience_estimate

अपने अभियानों के अनुमानित ऑडियंस आकार का पता लगाएँ।

यह endpoint, targeting criteria ऑब्जेक्ट के पैरामीटर वाले JSON ऑब्जेक्ट्स की एक array स्वीकार करता है। आवश्यक और वैकल्पिक targeting criteria पैरामीटर की सूची POST accounts/:account_id/targeting_criteria endpoint पर उपलब्ध है। अनुरोध HTTP POST होने चाहिए और उनमें Content-Type: application/json header के साथ JSON content body होना चाहिए।

नोट: आपको कम से कम एक primary targeting criterion निर्दिष्ट करना अनिवार्य है; सभी primary targeting criteria की सूची आप हमारे campaigns targeting page पर देख सकते हैं।

Resource URL

https://ads-api.x.com/12/accounts/:account_id/audience_estimate

पैरामीटर

Name	Description
account_id required	लीवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account, प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
targeting_criteria required	एक JSON object, जिसमें targeting criteria ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक targeting criteria पैरामीटर की सूची POST accounts/:account_id/targeting_criteria endpoint पर उपलब्ध है।
operator_type optional	targeting criterion के लिए लागू संबंध निर्दिष्ट करें। उदाहरण के लिए, negated targeting सेट करने के लिए operator_type=NE का उपयोग करें। Type: enum Possible values: EQ, NE Default: EQ

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate

    {
        "targeting_criteria": [
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "nba",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "tech",
                "operator_type": "NE"
            },
            {
                "targeting_type": "LOCATION",
                "targeting_value": "96683cc9126741d1",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "14230524"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "90420314"
            }
        ]
    }

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

    {
      "request": {
        "params": {
          "targeting_criteria": null,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "audience_size": {
          "min": 38236294,
          "max": 42261167
        }
      }
    }

प्रमाणीकृत उपयोगकर्ता एक्सेस

GET accounts/:account_id/authenticated_user_access

निर्दिष्ट ads account के संबंध में वर्तमान प्रमाणीकृत उपयोगकर्ता (access_token) की अनुमतियाँ प्राप्त करें। ये अनुमतियाँ ads.x.com पर दिखाई जाने वाली अनुमतियों से मेल खाती हैं।

संभावित मानों में शामिल हैं:

• ACCOUNT_ADMIN: अभियानों में बदलाव करने और आँकड़े देखने की पूर्ण पहुँच, जिसमें उपयोगकर्ताओं को जोड़ने या हटाने और सेटिंग्स बदलने की क्षमता शामिल है
• AD_MANAGER: अभियानों में बदलाव करने और आँकड़े देखने की पूर्ण पहुँच, लेकिन उपयोगकर्ताओं को जोड़ या हटा नहीं सकता और न ही सेटिंग्स बदल सकता है
• CREATIVE_MANAGER: creatives में बदलाव करने और previews देखने की पहुँच, लेकिन अभियान बनाने या उनमें बदलाव करने की पहुँच नहीं
• CAMPAIGN_ANALYST: अभियान और आँकड़े देखने की पहुँच, लेकिन अभियान बनाने या उनमें बदलाव करने की पहुँच नहीं
• ANALYST (“Organic Analyst” ads.x.com पर): organic analytics और audience insights देखने की पहुँच, लेकिन अभियान बनाने, उनमें बदलाव करने या उन्हें देखने की पहुँच नहीं
• PARTNER_AUDIENCE_MANAGER: data partner audiences को देखने और उनमें बदलाव करने के लिए केवल API पहुँच, लेकिन अभियान, creatives या अन्य audience प्रकारों तक पहुँच नहीं।

इसके अलावा, TWEET_COMPOSER अनुमति यह दर्शाती है कि प्रमाणीकृत उपयोगकर्ता विज्ञापनदाता की ओर से nullcasted (या “Promoted-only”) Tweets बना सकता है। यह केवल ACCOUNT_ADMIN, AD_MANAGER या CREATIVE_MANAGER पहुँच वाले उपयोगकर्ताओं के लिए उपलब्ध है।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access

पैरामीटर

कोई नहीं

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access

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

    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

बोली नियम

GET bidding_rules

कुछ या सभी मुद्राओं के लिए बिडिंग नियम प्राप्त करें। रिस्पॉन्स में न्यूनतम और अधिकतम CPE (cost-per-engagement) बिड दर्शाई जाएगी।

हालाँकि ये बिडिंग नियम बहुत कम बदलते हैं, फिर bhi सुझाव दिया जाता है कि आपके सिस्टम कम-से-कम महीने में एक बार इन endpoints से रीफ़्रेश करें।

संसाधन URL

https://ads-api.x.com/12/bidding_rules

पैरामीटर

नाम	विवरण
currency वैकल्पिक	परिणामों को फ़िल्टर करने के लिए मुद्रा का प्रकार, जिसकी पहचान ISO-4217 के अनुसार की जाती है। यह तीन-अक्षरों की string होती है, जैसे “USD” या “EUR”। सभी बिडिंग नियम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। यह authenticated user से संबद्ध है. Type: string Example: USD

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

GET https://ads-api.x.com/12/bidding_rules?currency=USD

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

    {
      "request": {
        "params": {
          "currency": "USD"
        }
      },
      "data_type": "bidding_rule",
      "data": [
        {
          "currency": "USD",
          "minimum_cpe_bid_local_micro": 10000,
          "maximum_cpe_bid_local_micro": 1000000000,
          "minimum_denomination": 10000
        }
      ],
      "total_count": 1
    }

अभियान

GET accounts/:account_id/campaigns

वर्तमान खाते से संबद्ध कुछ या सभी अभियान का विवरण प्राप्त करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/campaigns

पैरामीटर

Name	Description
account_id required	उपयोग में लिए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
campaign_ids optional	अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित अभियान तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8wku2
count optional	प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
funding_instrument_ids optional	अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट funding instruments के अंतर्गत आने वाले अभियान तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi
q optional	name के आधार पर रिसोर्स को सीमित करने के लिए एक वैकल्पिक query। Type: string Min, Max length: 1, 255
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_draft optional	अपनी request में draft अभियान के results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor परस्पर अनन्य हैं। नोट: जिन requests में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

उदाहरण Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "campaign_ids": [
            "8wku2"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "test",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 10000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8wku2",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/campaigns/:campaign_id

वर्तमान खाते से संबद्ध किसी विशिष्ट कैंपेन को प्राप्त करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
campaign_id required	उस कैंपेन का संदर्भ जिसके साथ आप request में कार्य कर रहे हैं। Type: string Example: 8wku2
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false

उदाहरण Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2

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

    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 10000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

POST accounts/:account_id/campaigns

वर्तमान अकाउंट से संबद्ध एक नया अभियान बनाएँ।

नोट: प्रति अकाउंट डिफ़ॉल्ट रूप से 200 सक्रिय अभियान की सीमा होती है। हालांकि, निष्क्रिय अभियान की संख्या पर कोई सीमा नहीं है। इस सीमा को बढ़ाकर 8,000 सक्रिय अभियान तक किया जा सकता है। अधिक सीमा सक्षम करने के लिए, विज्ञापनदाता को अपने X Account Manager से अनुरोध करना होगा।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/campaigns

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे अकाउंट का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
funding_instrument_id required	उस funding instrument का पहचानकर्ता जिसके अंतर्गत अभियान बनाया जाना है। Type: string Example: lygyi
name required	अभियान का नाम। अधिकतम लंबाई: 255 वर्ण। Type: string Example: demo
budget_optimization optional	लागू किए जाने वाले budget optimization के type का चयन करें Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro sometimes required	अभियान के लिए आवंटित की जाने वाली दैनिक budget राशि। निर्दिष्ट funding instrument से संबद्ध currency का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए और अधिकांश Funding Insturment types के लिए आवश्यक है। Type: long Example: 5500000
entity_status optional	अभियान की स्थिति। Type: enum Default: ACTIVE Possible values: ACTIVE, DRAFT, PAUSED
purchase_order_number optional	booking reference number। invoice reconciliation में मदद के लिए इस field का उपयोग करें। अधिकतम लंबाई: 50 वर्ण। Type: string Example: D00805843
standard_delivery optional	standard या accelerated delivery सक्षम करें। standard और accelerated delivery के बारे में अधिक जानकारी के लिए Budget Pacing देखें। यह केवल तब उपलब्ध होता है, जब budget_optimization को CAMPAIGN पर set किया गया हो। Type: boolean Default: true Possible values: true, false
total_budget_amount_local_micro optional	अभियान के लिए आवंटित की जाने वाली कुल budget राशि। निर्दिष्ट funding instrument से संबद्ध currency का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long Example: 37500000

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false

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

    {
      "request": {
        "params": {
          "name": "demo",
          "budget_optimization": "CAMPAIGN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "standard_delivery": false,
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "demo",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "hwtbm",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

POST batch/accounts/:account_id/campaigns

एक ही अनुरोध में नए कैंपेनों का बैच निर्माण करने की अनुमति देता है।

बैच अनुरोध

• वर्तमान अधिकतम बैच आकार 40 है।
• सभी पैरामीटर अनुरोध बॉडी में भेजे जाते हैं और Content-Type के लिए application/json आवश्यक है।
• बैच अनुरोध समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि व सफलता—दोनों स्थितियों में सभी API रिस्पॉन्स प्रारंभिक अनुरोध के आइटम क्रम को बनाए रखते हैं।

बैच रिस्पॉन्स

बैच API रिस्पॉन्स आइटमों का एक क्रमबद्ध संग्रह लौटाते हैं। अन्यथा, उनकी संरचना संबंधित single-item endpoints के समान होती है।

बैच त्रुटियाँ

• अनुरोध-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
• आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक कैंपेन पैरामीटर का न होना) रिस्पॉन्स में operation_errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।

संसाधन URL

https://ads-api.x.com/12/batch/accounts/:account_id/campaigns

पैरामीटर

Name	Description
operation_type required	प्रति आइटम किया जाने वाला operation type. Type: enum संभव मान: Create, Delete, Update
params required	कैंपेन ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल करने वाला एक JSON ऑब्जेक्ट। आवश्यक और वैकल्पिक कैंपेन पैरामीटरों की सूची के लिए, यहाँ देखें।

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

POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns

    [
      {
        "operation_type":"Create",
        "params":{
          "name":"batch campaigns",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]

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

    {
      "data": [
        {
          "name": "batch campaigns",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8yn7m",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "name": "batch campaigns",
            "funding_instrument_id": "lygyi",
            "daily_budget_amount_local_micro": 140000000,
            "entity_status": "PAUSED",
            "budget_optimization":"CAMPAIGN",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        }
      ]
    }

PUT accounts/:account_id/campaigns/:campaign_id

वर्तमान खाते से संबद्ध निर्दिष्ट कैंपेन को अपडेट करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id

पैरामीटर

नाम	विवरण
account_id required	उपयोग किए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t
campaign_id required	अनुरोध में जिस कैंपेन पर आप काम कर रहे हैं, उसका संदर्भ। प्रकार: string उदाहरण: 8wku2
budget_optimization optional	लागू की जाने वाली budget optimization का प्रकार चुनें प्रकार: enum डिफ़ॉल्ट: CAMPAIGN संभावित मान: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro optional	कैंपेन को आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो कैंपेन कुल बजट और कैंपेन की अवधि के आधार पर समान रूप से खर्च करेगा। नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए। प्रकार: long उदाहरण: 5500000
entity_status optional	कैंपेन की स्थिति। प्रकार: enum संभावित मान: ACTIVE, PAUSED
name optional	कैंपेन का नाम। अधिकतम लंबाई: 255 अक्षर। प्रकार: string उदाहरण: demo
purchase_order_number optional	बुकिंग संदर्भ संख्या। इनवॉइस मिलान में सहायता के लिए इस फ़ील्ड का उपयोग करें। अधिकतम लंबाई: 50 अक्षर। प्रकार: string उदाहरण: D00805843
standard_delivery optional	standard या accelerated delivery सक्षम करें। standard और accelerated delivery के बारे में अधिक जानकारी के लिए Budget Pacing देखें। केवल तब उपलब्ध है जब budget_optimization को CAMPAIGN पर सेट किया गया हो। प्रकार: boolean डिफ़ॉल्ट: true संभावित मान: true, false
total_budget_amount_local_micro optional	कैंपेन को आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। प्रकार: long उदाहरण: 140000000

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000

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

    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "daily_budget_amount_local_micro": 140000000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:53:54Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/campaigns/:campaign_id

वर्तमान account से संबंधित निर्दिष्ट campaign हटाएँ।

नोट: किसी campaign को हटाने की कार्रवाई पूर्ववत नहीं की जा सकती. इसके बाद इस resource को हटाने के प्रयासों पर HTTP 404 मिलेगा।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
campaign_id required	request में जिस campaign पर आप काम कर रहे हैं, उसका संदर्भ। Type: string Exampple: 8yn7m

उदाहरण Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m

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

    {
      "request": {
        "params": {
          "campaign_id": "8yn7m",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [],
        "servable": null,
        "purchase_order_number": null,
        "effective_status": "RUNNING",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8yn7m",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:56:35Z",
        "deleted": true
      }
    }

सामग्री श्रेणियां

GET content_categories

लाइन आइटम के लिए targeting_criteria के रूप में सेट की जा सकने वाली मान्य content categories का अनुरोध करें।

हर content_category एक या अधिक IAB Categories से मैप होता है। ऐसा करने के लिए, batch targeting_critera endpoint पर targeting_type को IAB_CATEGORY पर सेट करें, ताकि content_categories अनुरोध से लौटाई गई संबंधित iab_categories का सेट शामिल किया जा सके। ऐसा न करने पर वैलिडेशन त्रुटि मिलेगी।

इनमें से प्रत्येक content category के लिए publisher विवरण GET publishers endpoint का उपयोग करके प्राप्त किए जा सकते हैं।

अधिक जानकारी Video Views Pre-roll Objective Guide में उपलब्ध है।

रिसोर्स URL

https://ads-api.x.com/12/content_categories

पैरामीटर

कोई request पैरामीटर नहीं

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

GET https://ads-api.x.com/12/content_categories

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

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "ऑटोमोटिव (कारें, ट्रक, रेसिंग)",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "कॉमेडी",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "डिजिटल क्रिएटर्स",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "मनोरंजन और पॉप संस्कृति",
          "id": "sm",
          "iab_categories": [
            "IAB1-1",
            "IAB1-2",
            "IAB1-3",
            "IAB1-5"
          ],
          "publishers_in_last_thirty_days": 120,
          "videos_monetized_in_last_thirty_days": 3482
        },
        {
          "name": "वित्तीय और व्यापार समाचार",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "खाना-पीना",
          "id": "so",
          "iab_categories": [
            "IAB8-8",
            "IAB8-12",
            "IAB8-17",
            "IAB8-2",
            "IAB8-3",
            "IAB8-7",
            "IAB8-11",
            "IAB8-4",
            "IAB8-14",
            "IAB8-10",
            "IAB8-15",
            "IAB8-13",
            "IAB8-9",
            "IAB8-16",
            "IAB8-6",
            "IAB8-1"
          ],
          "publishers_in_last_thirty_days": 24,
          "videos_monetized_in_last_thirty_days": 516
        },
        {
          "name": "जीवनशैली (फैशन, यात्रा, वेलनेस)",
          "id": "sp",
          "iab_categories": [
            "IAB16",
            "IAB9-21",
            "IAB9-4",
            "IAB9-25",
            "IAB9-8",
            "IAB4",
            "IAB9-3",
            "IAB9-15",
            "IAB7",
            "IAB6",
            "IAB9-11",
            "IAB9-16",
            "IAB9-7",
            "IAB9-20",
            "IAB9-24",
            "IAB9-17",
            "IAB9-12",
            "IAB9-31",
            "IAB9-27",
            "IAB10",
            "IAB9-10",
            "IAB9-23",
            "IAB9-6",
            "IAB9-18",
            "IAB9-13",
            "IAB9-1",
            "IAB9-28",
            "IAB20",
            "IAB9-5",
            "IAB9-26",
            "IAB22",
            "IAB23",
            "IAB9-9",
            "IAB9-22",
            "IAB18",
            "IAB9-2",
            "IAB9-19",
            "IAB9-14",
            "IAB9-29"
          ],
          "publishers_in_last_thirty_days": 67,
          "videos_monetized_in_last_thirty_days": 2412
        },
        {
          "name": "संगीत",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "समाचार और वर्तमान घटनाएँ",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "राजनीति",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "विज्ञान और शिक्षा",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "खेल",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "टेक्नोलॉजी",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "टेलीविजन",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "ई-स्पोर्ट्स और वीडियो गेम्स",
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

चयनित श्रेणियां

GET accounts/:account_id/curated_categories

दिए गए country_codes के लिए उपलब्ध चयनित श्रेणियां की सूची प्राप्त करें

हर curated_category केवल उन विशिष्ट देशों में उपलब्ध होती है, जिन्हें रिस्पॉन्स में country_codes द्वारा निर्दिष्ट किया गया है।

अधिक जानकारी के लिए Video Views Pre-roll Objective Guide देखें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/curated_categories

पैरामीटर

नाम	विवरण
account_id required	उपयोग में लिए जा रहे लेवरेज्ड खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
country_codes required	दो-अक्षरीय ISO country codes की कॉमा-सेपरेटेड सूची देकर रिस्पॉन्स को केवल इच्छित देशों तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: US
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US

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

{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Basketball",
          "description": "कॉलेज टीमों, पेशेवर टीमों और सीज़न के दौरान व बाद में बास्केटबॉल वीडियो साझा करने वाले शीर्ष खेल मीडिया हैंडल सहित, रोज़मर्रा के बेहतरीन बास्केटबॉल कंटेंट के साथ चलाएं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20265254",
            "378174762",
            "900368808",
            "18939563",
            "18371803",
            "18360370",
            "770658432928079872",
            "11026952",
            "37085464",
            "16212685",
            "57422635",
            "281669945",
            "7117962",
            "23065057",
            "41688179",
            "29779226",
            "900280416",
            "364460082",
            "902030382",
            "19409270",
            "19077044",
            "18139461",
            "14992591",
            "66753565",
            "667563",
            "16727749",
            "40941404",
            "18481113",
            "791598918",
            "16201775",
            "15900167",
            "45891626",
            "191894553",
            "2181233851",
            "34352904",
            "171483987",
            "454122399",
            "57415242",
            "19263978",
            "902089998",
            "423540866",
            "2715223320",
            "22185437",
            "17292143",
            "55590247",
            "66757066",
            "22642626",
            "41604618",
            "87275465",
            "22643259",
            "32414973",
            "73406718",
            "20346956",
            "413422891",
            "45412765",
            "19537303",
            "459511725",
            "30954864",
            "21308488",
            "18552281",
            "19924520",
            "24903350",
            "851142163",
            "26270913",
            "20444254",
            "26074296",
            "6395222",
            "15537451",
            "28672101",
            "38053254",
            "24925573",
            "19564719",
            "18164425",
            "22815383",
            "20196159"
          ],
          "id": "929wbl6ymlfk",
          "created_at": "2019-11-08T21:12:47Z",
          "updated_at": "2021-03-09T20:36:44Z",
          "videos_monetized_in_last_thirty_days": 2446
        },
        {
          "name": "गेमिंग पर्सनैलिटीज़",
          "description": "ऑनलाइन गेमिंग के कुछ सबसे बड़े और सबसे लोकप्रिय डिजिटल क्रिएटर्स की सूची से विशेष रूप से, रोज़मर्रा के बेहतरीन गेमिंग कंटेंट के साथ चलाएं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "90779436",
            "268270621",
            "567167802",
            "246596682",
            "474919140",
            "284422688",
            "185909682",
            "4767225325",
            "2559865245",
            "186888760",
            "161418822",
            "141021153",
            "352881953",
            "1117931702",
            "146556805",
            "357294577",
            "234526497",
            "266687361",
            "214201922",
            "9451052",
            "2163885564",
            "2231422037",
            "116952434",
            "399909209",
            "15993650",
            "974356091193741312",
            "210839744",
            "2313002094",
            "159916388",
            "3258981481",
            "231992478",
            "182236262",
            "386884916",
            "22705686",
            "4140881832",
            "995979576",
            "2244953047",
            "311775629",
            "98821255",
            "2733210014",
            "2741078150"
          ],
          "id": "94ngssfrr01x",
          "created_at": "2019-12-02T20:45:12Z",
          "updated_at": "2021-03-09T20:18:13Z",
          "videos_monetized_in_last_thirty_days": 448
        },
        {
          "name": "Baseball",
          "description": "कॉलेज टीमों, पेशेवर टीमों और प्रमुख बेसबॉल कवरेज साझा करने वाले शीर्ष खेल मीडिया हैंडल सहित, रोज़मर्रा के बेहतरीन बेसबॉल कंटेंट के साथ चलाएं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "22016177",
            "22798877",
            "52803520",
            "20710218",
            "423532170",
            "28603812",
            "41144996",
            "22819823",
            "39389304",
            "252273678",
            "123307490",
            "2319354187",
            "41488578",
            "37947138",
            "302066953",
            "159143990",
            "35006336",
            "53178109",
            "40918816",
            "39682297",
            "39397148",
            "39419180",
            "53197137",
            "52863923",
            "21407926",
            "31164229",
            "19607400",
            "39392910",
            "241544156",
            "43024351",
            "37837907",
            "165764237",
            "69117905",
            "87673496",
            "23043294",
            "52824038",
            "52861612",
            "33137450",
            "30008146",
            "39367703",
            "21436663",
            "188575356",
            "40931019",
            "41468683",
            "40927173",
            "172742915"
          ],
          "id": "9lav5usxfmdc",
          "created_at": "2020-05-18T20:20:27Z",
          "updated_at": "2021-03-09T20:37:46Z",
          "videos_monetized_in_last_thirty_days": 190
        },
        {
          "name": "ई-स्पोर्ट्स टीमें",
          "description": "दुनिया की सर्वश्रेष्ठ ई-स्पोर्ट्स टीमों के कंटेंट के साथ चलाएं, जिसमें इवेंट के दौरान की कवरेज और साल भर की अन्य पूरक प्रोग्रामिंग दोनों शामिल हैं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "759527448757215232",
            "61933836",
            "477213534",
            "907193396049182720",
            "895382891408089089",
            "862708050116976640",
            "115038550",
            "3182089458",
            "4131266472",
            "1145702070961496065",
            "2262070855",
            "920664872786059264",
            "1035653581683220481",
            "14229141",
            "1101275970995027968",
            "20734751",
            "1452520626",
            "720303639277928448",
            "2853641871",
            "912696400571486208",
            "874362688939413504",
            "286505380",
            "892808605170245632",
            "875087838613733376",
            "238431491",
            "867053221940011014",
            "964529942",
            "1172506293174710272",
            "535756639",
            "2255226817",
            "1100825469853696000",
            "1122713320086220803",
            "1124064709295128581",
            "899858978418642944",
            "864977592532688896",
            "864476897106898944",
            "862770685445361665",
            "257268592"
          ],
          "id": "9ys3jz3ktreo",
          "created_at": "2020-10-01T20:02:35Z",
          "updated_at": "2021-03-09T20:36:20Z",
          "videos_monetized_in_last_thirty_days": 169
        },
        {
          "name": "फुटबॉल ",
          "description": "कॉलेज टीमों, पेशेवर टीमों और सीज़न के दौरान व बाद में फुटबॉल वीडियो साझा करने वाले शीर्ष खेल मीडिया हैंडल सहित, रोज़मर्रा के बेहतरीन फुटबॉल कंटेंट के साथ चलाएं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21790466",
            "53103297",
            "23642374",
            "817416193854283776",
            "43403778",
            "24179879",
            "26813914",
            "36375662",
            "33587536",
            "180884045",
            "16332223",
            "27902825",
            "180503626",
            "44468807",
            "18336787",
            "818431566",
            "22146282",
            "31126587",
            "40358743",
            "35865630",
            "16347506",
            "72665816",
            "33583496",
            "389038362",
            "36155311",
            "227342532",
            "2151130166",
            "26791995",
            "44666348",
            "24109979",
            "31504542",
            "713143",
            "423536031",
            "25545388",
            "59471027",
            "706923475",
            "19383279",
            "8824902",
            "1655877529",
            "18734310",
            "240734425",
            "17076218",
            "47964412",
            "2802184770",
            "19426729",
            "56443153",
            "23508439",
            "25084916",
            "764347046",
            "19853312",
            "348590880"
          ],
          "id": "8tujg1lvi8sn",
          "created_at": "2019-08-15T20:48:51Z",
          "updated_at": "2021-03-09T20:34:13Z",
          "videos_monetized_in_last_thirty_days": 254
        },
        {
          "name": "पुरुष संस्कृति + जीवनशैली",
          "description": "फ़ॉलोअर प्रोफ़ाइल के आधार पर चुने गए हैंडल के कंटेंट के साथ चलाएं, जो आपको बहुसंख्यक पुरुष दर्शकों तक पहुँचने में मदद करता है — इसमें तकनीक, समाचार और लाइफस्टाइल कंटेंट साझा करने वाले कुछ शीर्ष हैंडल शामिल हैं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "17764377",
            "61933836",
            "28370738",
            "3224616765",
            "22819823",
            "18927441",
            "734826612684783616",
            "14372486",
            "7157132",
            "15764136",
            "590316679",
            "7302282",
            "895014043932540928",
            "7517222",
            "3489420013",
            "14063426",
            "72665816",
            "214201922",
            "14980903",
            "22199141",
            "21272440",
            "25319414",
            "119593082",
            "4760694445",
            "765905855195803648",
            "238431491",
            "22178780",
            "241544156",
            "25093616",
            "16877611",
            "22146985",
            "368703433",
            "14342661",
            "415605847",
            "2181233851",
            "890891",
            "15764001",
            "614754689",
            "18479513",
            "23508439",
            "348590880"
          ],
          "id": "8tujj1ep7t34",
          "created_at": "2019-08-15T20:49:47Z",
          "updated_at": "2021-03-09T20:39:00Z",
          "videos_monetized_in_last_thirty_days": 1330
        },
        {
          "name": "महिला संस्कृति + जीवनशैली",
          "description": "फ़ॉलोअर प्रोफ़ाइल के आधार पर चुने गए हैंडल के कंटेंट के साथ चलाएं, जो आपको बहुसंख्यक महिला दर्शकों तक पहुँचने में मदद करता है — इसमें पॉप कल्चर, समाचार और लाइफस्टाइल कंटेंट साझा करने वाले कुछ शीर्ष हैंडल शामिल हैं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "23482952",
            "20177423",
            "19074134",
            "15566901",
            "32469566",
            "19784831",
            "16145224",
            "16932962",
            "14934818",
            "29730065",
            "24190981",
            "30278532",
            "15846407",
            "24994219",
            "23993734",
            "40965341",
            "16312576",
            "75094638",
            "549673665",
            "18806753",
            "75306892",
            "1482663290",
            "31181674",
            "971407531972186112",
            "4020532937",
            "25087685",
            "22515362",
            "80943051",
            "19247844",
            "15279429",
            "16824090",
            "20710809",
            "979831113655996416",
            "32432308",
            "19472585",
            "25589776",
            "739963476370673665",
            "20188834",
            "926269727663673349"
          ],
          "id": "8tujl1p3yn0g",
          "created_at": "2019-08-15T20:50:24Z",
          "updated_at": "2021-03-09T20:17:53Z",
          "videos_monetized_in_last_thirty_days": 1365
        },
        {
          "name": "हल्का-फुल्का",
          "description": "उन हैंडल की सूची के साथ चलाएं जिन्हें X पर लगातार सकारात्मक और अच्छा महसूस कराने वाले कंटेंट और बातचीत की मात्रा के आधार पर चुना गया है।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20177423",
            "22449367",
            "9695312",
            "19074134",
            "4805771380",
            "32469566",
            "1212860112047460352",
            "16402507",
            "16932962",
            "14934818",
            "17446621",
            "29730065",
            "15846407",
            "1604444052",
            "180066380",
            "16312576",
            "549673665",
            "18806753",
            "16211434",
            "545336345",
            "971407531972186112",
            "4020532937",
            "833612154",
            "22515362",
            "20710809",
            "32432308",
            "774311630",
            "3073349892",
            "926269727663673349"
          ],
          "id": "9fg8gmz96qdg",
          "created_at": "2020-03-20T19:37:44Z",
          "updated_at": "2021-03-09T19:57:40Z",
          "videos_monetized_in_last_thirty_days": 1395
        },
        {
          "name": "सॉकर",
          "description": "कॉलेज टीमों, पेशेवर टीमों और प्रमुख सॉकर कवरेज साझा करने वाले शीर्ष खेल मीडिया हैंडल सहित, रोज़मर्रा के बेहतरीन सॉकर कंटेंट के साथ चलाएं।",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21677316",
            "20636347",
            "4704552148",
            "14573900",
            "22556296",
            "1415791555",
            "107146095",
            "17288520",
            "213474069",
            "17493398",
            "44990136",
            "452155423",
            "17744542",
            "16303450",
            "2841146601",
            "2413176055",
            "29739264",
            "38580532",
            "953476292913106945",
            "27092557",
            "86356439",
            "34613288",
            "3170659367",
            "119593082",
            "73412535",
            "627586654",
            "15891449",
            "23011345",
            "96951800",
            "15997022",
            "16960789",
            "21919642",
            "102965285",
            "17224076",
            "36432200",
            "1410055968"
          ],
          "id": "9ddrgesiap6o",
          "created_at": "2020-02-28T22:43:26Z",
          "updated_at": "2021-01-26T17:54:55Z",
          "videos_monetized_in_last_thirty_days": 421
        }
      ],
      "total_count": 9
    }

GET accounts/:account_id/curated_categories/:curated_category_id

किसी विशिष्ट curated_category_id का विवरण प्राप्त करें

प्रत्येक curated_category केवल उन विशिष्ट देशों में उपलब्ध है, जिन्हें रिस्पॉन्स में country_codes के जरिए निर्दिष्ट किया गया है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id

पैरामीटर

Name	Description
account_id required	जिस लेवरेज्ड खाते का उपयोग किया जा रहा है, उसका पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API रिक्वेस्ट के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
curated_category_id required	उस Curated Category का संदर्भ, जिसका आप इस रिक्वेस्ट में उपयोग कर रहे हैं। Type: string Example: 9ddrgesiap6o

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o

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

    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "Soccer",
        "description": "Run next to the best of everyday soccer content including college teams, professional teams, and the top sports media handles sharing major soccer coverage.",
        "country_codes": [],
        "publisher_user_ids": [
          "21677316",
          "20636347",
          "4704552148",
          "14573900",
          "22556296",
          "1415791555",
          "107146095",
          "17288520",
          "213474069",
          "17493398",
          "44990136",
          "452155423",
          "17744542",
          "16303450",
          "2841146601",
          "2413176055",
          "29739264",
          "38580532",
          "953476292913106945",
          "27092557",
          "86356439",
          "34613288",
          "3170659367",
          "119593082",
          "73412535",
          "627586654",
          "15891449",
          "23011345",
          "96951800",
          "15997022",
          "16960789",
          "21919642",
          "102965285",
          "17224076",
          "36432200",
          "1410055968"
        ],
        "id": "9ddrgesiap6o",
        "created_at": "2020-02-28T22:43:26Z",
        "updated_at": "2021-01-26T17:54:55Z",
        "videos_monetized_in_last_thirty_days": 421
      }
    }

सुविधाएँ

GET accounts/:account_id/features

इस ads account के लिए उपलब्ध कराई गई फीचर्स की सूची प्राप्त करें। फीचर्स को एक वर्णनात्मक feature key से दर्शाया जाता है और वे इस endpoint पर केवल तभी दिखाए जाते हैं, जब उन्हें beta में पेश किया गया हो या वे किसी अन्य सीमित रिलीज़ का हिस्सा हों और Ads API में उपलब्ध हों। जो फीचर्स इन मानदंडों को पूरा नहीं करते, वे इस endpoint पर प्रदर्शित नहीं किए जाते।

नोट: यह endpoint beta रिलीज़ तक client की पहुँच को अधिक स्पष्ट बनाकर Ads API ecosystem के विकास में सहायता करता है। API डेवलपर किसी विज्ञापनदाता की ओर से फीचर्स तक पहुँच का अनुरोध नहीं कर सकते। ऐसे अनुरोध केवल विज्ञापनदाता ही अपने X account manager से कर सकता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/features

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
feature_keys optional	यह एक वैकल्पिक पैरामीटर है, जो किसी विशेष feature key के लिए query करने की सुविधा देता है। requests में कॉमा से अलग की गई कई keys शामिल हो सकती हैं। नोट: रिस्पॉन्स में केवल वही फीचर्स शामिल होंगे, जो इस account के लिए उपलब्ध हैं। Type: enum Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": [
        "CITY_TARGETING",
        "CONVERSATION_CARD",
        "PROMOTED_MEDIA_POLLS",
        "REACH_AND_FREQUENCY_ANALYTICS",
        "REACH_FREQUENCY_CAP",
        "UNIVERSAL_LOOKALIKE"
      ]
    }

POST accounts/:account_id/features

केवल SANDBOX

sandbox खाते में एक फीचर जोड़ें।

खाते के फीचरों की नवीनतम सूची GET accounts/:account_id/features endpoint के ज़रिए प्राप्त की जा सकती है।

रिसोर्स URL

https://ads-api-sandbox.x.com/12/accounts/:account_id/features

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट खाता authenticated user से संबद्ध होना चाहिए। Type: string Example: gq180y
feature_keys required	खाते में जोड़ने के लिए account फीचर्स की comma-separated सूची। Type: enum Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD

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

POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING

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

    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "VALIDATED_AGE_TARGETING"
          ]
        }
      },
      "data": [
        "ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE",
        "AWARENESS_OBJECTIVE",
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VALIDATED_AGE_TARGETING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

DELETE accounts/:account_id/features

केवल SANDBOX

Sandbox खाते से कोई फीचर हटाएँ।

खाते के फीचरों की नवीनतम सूची GET accounts/:account_id/features एंडपॉइंट से प्राप्त की जा सकती है।

रिसोर्स URL

https://ads-api-sandbox.x.com/12/accounts/:account_id/features

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: gq180y
feature_keys required	खाते से हटाई जाने वाली खाता फीचरों की कॉमा से अलग की गई सूची। Type: enum Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD

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

DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE

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

    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "PREROLL_VIEWS_OBJECTIVE"
          ]
        }
      },
      "data": [
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

फंडिंग इंस्ट्रूमेंट्स

GET accounts/:account_id/funding_instruments

वर्तमान खाते से जुड़े कुछ या सभी फंडिंग इंस्ट्रूमेंट्स का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/funding_instruments

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता authenticated उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
funding_instrument_ids optional	identifiers की comma-separated सूची निर्दिष्ट करके रिस्पॉन्स को केवल इच्छित फंडिंग इंस्ट्रूमेंट्स तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi
sort_by optional	समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "Visa ending in 0650",
          "credit_limit_local_micro": 200000000,
          "end_time": null,
          "id": "lygyi",
          "entity_status": "ACTIVE",
          "account_id": "18ce54d4x5t",
          "reasons_not_able_to_fund": [],
          "io_header": null,
          "currency": "USD",
          "funded_amount_local_micro": 645940000,
          "created_at": "2016-07-22T04:24:04Z",
          "type": "CREDIT_CARD",
          "able_to_fund": true,
          "updated_at": "2017-04-05T00:25:13Z",
          "credit_remaining_local_micro": null,
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/funding_instruments/:funding_instrument_id

वर्तमान खाते से संबद्ध किसी विशिष्ट फंडिंग इंस्ट्रूमेंट को प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id

पैरामीटर

Name	Description
account_id required	लेवरेज्ड खाते का पहचानकर्ता। यह संसाधन के पथ में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
funding_instrument_id required	उस फंडिंग इंस्ट्रूमेंट का संदर्भ जिसे आप इस अनुरोध में उपयोग कर रहे हैं। Type: string Example: lygyi
with_deleted optional	अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi

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

    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "Visa ending in 0650",
        "credit_limit_local_micro": 200000000,
        "end_time": null,
        "id": "lygyi",
        "entity_status": "ACTIVE",
        "account_id": "18ce54d4x5t",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 645940000,
        "created_at": "2016-07-22T04:24:04Z",
        "type": "CREDIT_CARD",
        "able_to_fund": true,
        "updated_at": "2017-04-05T00:25:13Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      }
    }

POST accounts/:account_id/funding_instruments

केवल SANDBOX

sandbox परिवेश में एक फंडिंग इंस्ट्रूमेंट बनाएँ।

sandbox फंडिंग इंस्ट्रूमेंट का उपयोग करते समय कोई लागत लगने का जोखिम नहीं है।

संसाधन URL

https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments

पैरामीटर

Name	Description
account_id required	leveraged account का आइडेंटिफ़ायर। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: gq1844
currency required	ISO-4217 में व्यक्त की गई मुद्रा। Type: string Example: USD
start_time required	वह तारीख जिस पर फंडिंग इंस्ट्रूमेंट सक्रिय और उपयोग के लिए उपलब्ध हो जाता है, जिसे ISO 8601 में व्यक्त किया गया है। Type: string Example: 2017-05-19T07:00:00Z
type required	बनाए जाने वाले फंडिंग इंस्ट्रूमेंट का type। Type: enum Possible values: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED
end_time sometimes required	वह तारीख जिस पर फंडिंग इंस्ट्रूमेंट निष्क्रिय हो जाता है, जिसे ISO 8601 में व्यक्त किया गया है। Type: string Example: 2017-05-26T07:00:00Z
credit_limit_local_micro optional	इस फंडिंग इंस्ट्रूमेंट के लिए उपलब्ध कुल क्रेडिट। नोट: यह केवल कुछ फंडिंग इंस्ट्रूमेंट type पर लागू होता है। Type: long Example: 37500000
funded_amount_local_micro optional	इस फंडिंग इंस्ट्रूमेंट को आवंटित कुल बजट राशि। नोट: यह केवल कुछ फंडिंग इंस्ट्रूमेंट type पर लागू होता है। Type: long Example: 37500000

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

POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000

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

    {
      "data": {
        "start_time": "2017-07-10T00:00:00Z",
        "description": "(no payment method has been set up yet)",
        "credit_limit_local_micro": null,
        "end_time": "2018-01-10T00:00:00Z",
        "id": "hxtet",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 140000000000,
        "created_at": "2017-09-09T05:23:28Z",
        "type": "INSERTION_ORDER",
        "able_to_fund": true,
        "updated_at": "2017-09-09T05:23:28Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      },
      "request": {
        "params": {
          "start_time": "2017-07-10T00:00:00Z",
          "end_time": "2018-01-10T00:00:00Z",
          "account_id": "gq1844",
          "currency": "USD",
          "funded_amount_local_micro": 140000000000,
          "type": "INSERTION_ORDER"
        }
      }
    }

DELETE accounts/:account_id/funding_instruments/:funding_instrument_id

केवल SANDBOX

sandbox परिवेश में किसी फंडिंग इंस्ट्रूमेंट को हटाएँ।

संसाधन URL

https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id

पैरामीटर

Name	Description
account_id required	leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: gq1844
funding_instrument_id required	request में जिस फंडिंग इंस्ट्रूमेंट पर आप कार्रवाई कर रहे हैं, उसका एक reference। Type: string Exampple: hxt82

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

DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82

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

    {
      "data": {
        "start_time": "2017-08-30T19:23:47Z",
        "description": "(no payment method has been set up yet)",
        "credit_limit_local_micro": 500000000,
        "end_time": null,
        "id": "hxt82",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [
          "DELETED"
        ],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": null,
        "created_at": "2017-08-30T19:23:47Z",
        "type": "CREDIT_CARD",
        "able_to_fund": false,
        "updated_at": "2017-09-09T02:08:30Z",
        "credit_remaining_local_micro": null,
        "deleted": true
      },
      "request": {
        "params": {
          "funding_instrument_id": "hxt82",
          "account_id": "gq1844"
        }
      }
    }

IAB श्रेणियाँ

GET iab_categories

विज्ञापन समूहों (line_items) के लिए मान्य ऐप categories का अनुरोध करें।

संसाधन URL

https://ads-api.x.com/12/iab_categories

पैरामीटर

Name	Description
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	categories का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: gc-ddf4a
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक-दूसरे के साथ उपयोग नहीं किए जा सकते। Note: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होती हैं; वर्तमान में यह सीमा 15 मिनट में 200 है। Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/iab_categories?count=2

Example Response

    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "Arts & Entertainment"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "Books & Literature"
        }
      ],
      "next_cursor": "uxa8",
      "request": {
        "params": {
          "count": 2
        }
      }
    }

लाइन आइटम

GET accounts/:account_id/line_items

वर्तमान अकाउंट से संबद्ध कुछ या सभी line items का विवरण प्राप्त करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/line_items

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
campaign_ids optional	अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट campaigns के अंतर्गत आने वाले line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8gdx6
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
funding_instrument_ids optional	अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट funding instruments के अंतर्गत आने वाले line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: lygyi
line_item_ids optional	अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित line items तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8v7jo
q optional	name के आधार पर resource को सीमित करने के लिए एक वैकल्पिक query। Type: string Min, Max length: 1, 255
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने अनुरोध में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_draft optional	अपने अनुरोध में draft campaigns के results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "itttx"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": "li-18",
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2021-02-16T00:00:00Z",
          "bid_amount_local_micro": 320000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "itttx",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2021-02-23T23:37:54Z",
          "ios_app_store_identifier": null,
          "updated_at": "2022-06-01T02:01:18Z",
          "campaign_id": "f4z6x",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/line_items/:line_item_id

वर्तमान खाते से संबद्ध किसी विशिष्ट line item को प्राप्त करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id

पैरामीटर

Name	Description
account_id required	leveraged खाते का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	उस line item का संदर्भ जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8v7jo
with_deleted optional	अपने अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx

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

    {
      "request": {
        "params": {
          "line_item_id": "itttx",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": "li-18",
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2021-02-16T00:00:00Z",
        "bid_amount_local_micro": 320000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "funding_instrument_id": "lygyny",
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "itttx",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2021-02-23T23:37:54Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-01T02:01:18Z",
        "campaign_id": "f4z6x",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

POST accounts/:account_id/line_items

वर्तमान account से संबंधित निर्दिष्ट campaign के लिए एक line item बनाएँ।

किसी campaign के भीतर सभी line items का product_type और objective समान होना चाहिए।

PROMOTED_ACCOUNT product type का उपयोग करते समय, line_item के साथ किसी Tweet को संबद्ध करने पर मानक PROMOTED_ACCOUNT placement के अलावा mobile पर timeline placements भी जुड़ जाएँगे।

android_app_store_identifier या ios_app_store_identifier में से किसी एक को सेट करने पर प्रचारित किए जा रहे mobile app से मेल खाने वाले line item के लिए targeting criteria अपने-आप जुड़ जाएँगे; उदाहरण के लिए, ios_app_store_identifier पास करने पर iOS के लिए PLATFORM targeting criteria जुड़ जाएगा।

नोट: प्रति campaign 100 line items और सभी campaigns में कुल 256 active line items की सीमा है।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/line_items

पैरामीटर

नाम	विवरण
account_id आवश्यक	लेवरेज्ड खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट खाता प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t
campaign_id आवश्यक	जिस अभियान के अंतर्गत लाइन आइटम बनाया जाना है, उसका पहचानकर्ता। प्रकार: string उदाहरण: 8slvg
end_time आवश्यक	वह समय, जिसे ISO 8601 में व्यक्त किया गया है, जब line item की डिलीवरी रुक जाएगी। Type: string उदाहरण: 2017-10-05T00:00:00Z
objective आवश्यक	इस लाइन आइटम के लिए अभियान का उद्देश्य। Type: enum संभावित मान: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS
placements आवश्यक	वे placement स्थान जहाँ यह line item प्रदर्शित होगा। placement मानों की comma-separated सूची निर्दिष्ट करें। Type: enum संभावित मान: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE
product_type आवश्यक	इस line item में शामिल प्रचारित उत्पाद का प्रकार। Type: enum संभावित मान: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
start_time आवश्यक	वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम की डिलीवरी शुरू होगी। Type: string उदाहरण: 2017-07-05T00:00:00Z
advertiser_domain कुछ मामलों में आवश्यक	इस विज्ञापनदाता की वेबसाइट का डोमेन, बिना प्रोटोकॉल विनिर्देशन के. नोट: जब line item का placement PUBLISHER_NETWORK पर सेट किया गया हो, तब यह आवश्यक है. Type: string उदाहरण: x.com
android_app_store_identifier कुछ मामलों में आवश्यक	प्रचारित ऐप्स के लिए Google App Store आइडेंटिफ़ायर। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier। Type: string उदाहरण: com.twitter.android
bid_amount_local_micro कभी-कभी ज़रूरी	इस लाइन आइटम से संबद्ध की जाने वाली बोली राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में प्रदर्शित किया जाता है। नोट: यदि bid_strategy को MAX या TARGET में से किसी एक पर सेट किया गया है, तो यह आवश्यक है नोट: केवल शून्य से अधिक मान ही स्वीकार किए जाते हैं। Type: long उदाहरण: 5500000
categories कुछ मामलों में आवश्यक	इस विज्ञापनदाता के लिए प्रासंगिक IAB श्रेणियां। GET iab_categories देखें। नोट: जब line item का placement PUBLISHER_NETWORK पर सेट हो, तो यह आवश्यक है। type: string उदाहरण: IAB3-1
ios_app_store_identifier कभी-कभी ज़रूरी	प्रचारित ऐप्स के लिए Apple App Store identifier का संख्यात्मक भाग। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier। Type: string उदाहरण: 333903271
primary_web_event_tag कभी-कभी आवश्यक	प्राथमिक वेब इवेंट टैग का पहचानकर्ता। यह इस line item से संबंधित अभियान के लिए एंगेजमेंट की अधिक सटीक ट्रैकिंग सक्षम करता है। नोट: जब line item का goal WEBSITE_CONVERSIONS पर सेट हो, तब यह आवश्यक है। प्रकार: string उदाहरण: nvo4z
advertiser_user_id वैकल्पिक	PREROLL_VIEWS विज्ञापन का प्रमोशन करने वाले हैंडल के लिए X उपयोगकर्ता पहचानकर्ता। केवल कुछ क्लाइंट एप्लिकेशन ही इस पैरामीटर का उपयोग कर सकते हैं। प्रकार: string उदाहरण: 312226591
audience_expansion वैकल्पिक	पहले से लक्षित उपयोगकर्ताओं के समान उपयोगकर्ताओं को लक्षित करके अभियानों की पहुंच बढ़ाने के लिए इसका उपयोग किया जाता है। नोट: डिफ़ॉल्ट रूप से, कोई विस्तार लागू नहीं होगा। Type: enum संभावित मान: BROAD, DEFINED, EXPANDED
bid_strategy वैकल्पिक	बोली लगाने का तंत्र. AUTO दैनिक बजट और अभियान की चलने की तिथियों के आधार पर बोली को अपने-आप अनुकूलित करता है. MAX अधिकतम अनुमत बोली सेट करता है और जब objective REACH या FOLLOWERS पर सेट हो, तब यह उपलब्ध नहीं होता है. TARGET दैनिक औसत बोली को निर्दिष्ट bid_amount_local_micro के 20% के भीतर रखने का प्रयास करता है और जब objective REACH, FOLLOWERS, या WEBSITE_CLICKS पर सेट हो, तब यह उपलब्ध होता है. ध्यान दें: अगर इसे AUTO पर सेट किया गया है, तो bid_amount_local_micro को अनदेखा कर दिया जाएगा. ध्यान दें: डिफ़ॉल्ट मान objective पर आधारित होता है. प्रकार: enum संभावित मान: AUTO, MAX, TARGET
duration_in_days वैकल्पिक	वह समयावधि, जिसके भीतर frequency_cap हासिल किया जाता है। Type: int संभावित मान: 1, 7, 30
entity_status वैकल्पिक	लाइन आइटम की स्थिति। Type: enum डिफ़ॉल्ट: ACTIVE संभावित मान: ACTIVE, DRAFT, PAUSED
frequency_cap वैकल्पिक	किसी उपयोगकर्ता को विज्ञापन अधिकतम कितनी बार दिखाया जा सकता है। ध्यान दें: यह केवल REACH, ENGAGEMENTS, VIDEO_VIEWS, और PREROLL_VIEWS उद्देश्यों के लिए समर्थित है। Type: int उदाहरण: 5
goal वैकल्पिक	इस line item के लिए उपयोग की जाने वाली optimization सेटिंग। APP_PURCHASES विकल्प APP_INSTALL के लिए उपलब्ध है। APP_CLICKS और APP_INSTALLS विकल्प APP_INSTALL और APP_ENGAGEMENTS दोनों उद्देश्यों के लिए उपलब्ध हैं और इनके लिए किसी समर्थित MACT partner का उपयोग करना पड़ सकता है। SITE_VISITS विकल्प केवल WEBSITE_CLICKS objective के साथ उपलब्ध है। नोट: objective के आधार पर डिफ़ॉल्ट। प्रकार: enum संभावित मान: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
name वैकल्पिक	लाइन आइटम का नाम. Type: string उदाहरण: demo न्यूनतम, अधिकतम लंबाई: 1, 255
pay_by वैकल्पिक	इस लाइन आइटम के लिए शुल्क लेने की इकाई। यह सेटिंग केवल APP_INSTALLS objective का उपयोग करने वाले लाइन आइटम्स के लिए ही बदली जा सकती है। नोट: डिफ़ॉल्ट pay_by, campaign objective और लाइन आइटम की bid unit के आधार पर अपने-आप सेट हो जाता है। APP_INSTALLS goal, APP_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है। LINK_CLICKS goal, LINK_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है, लेकिन bid_strategy के लिए TARGET सेट करते समय यह समर्थित नहीं है। SITE_VISITS goal, IMPRESSION मान का समर्थन करता है। Type: enum संभावित मान: APP_CLICK, IMPRESSION, LINK_CLICK
standard_delivery वैकल्पिक	मानक या त्वरित डिलीवरी सक्षम करें। मानक और त्वरित डिलीवरी के बारे में अधिक जानकारी के लिए Budget Pacing देखें। यह केवल तब उपलब्ध है, जब पैरेंट campaign के लिए budget_optimization को LINE_ITEM पर सेट किया गया हो Type: boolean डिफ़ॉल्ट: true संभावित मान: true, false
total_budget_amount_local_micro वैकल्पिक	लाइन आइटम के लिए आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long उदाहरण: 37500000
daily_budget_amount_local_micro कभी-कभी आवश्यक होता है	अभियान को आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो अभियान कुल बजट और अभियान की अवधि के आधार पर समान रूप से खर्च करेगा। यह केवल तब उपलब्ध है, जब मूल अभियान के लिए budget_optimization को LINE_ITEM पर सेट किया गया हो नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए। टाइप: long उदाहरण: 5500000

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15

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

    {
      "request": {
        "params": {
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2022-06-15T00:00:00Z",
          "bid_amount_local_micro": 3210000,
          "daily_budget_amount_local_micro": 1000000,
          "product_type": "PROMOTED_TWEETS",
          "objective": "ENGAGEMENTS",
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t",
          "campaign_id": "hwtq0"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2022-06-15T00:00:00Z",
        "bid_amount_local_micro": 3210000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": 1000000,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": true,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "ml5vs",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2022-06-03T23:47:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:47:20Z",
        "campaign_id": "hwtq0",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

POST batch/accounts/:account_id/line_items

एक ही अनुरोध में नए line items का बैच निर्माण करने की अनुमति देता है।

बैच अनुरोध

• वर्तमान में अधिकतम बैच आकार 40 है।
• सभी पैरामीटर अनुरोध बॉडी में भेजे जाते हैं और application/json का Content-Type आवश्यक है।
• बैच अनुरोध समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि व सफलता दोनों के लिए सभी API रिस्पॉन्स शुरुआती अनुरोध में आइटमों के क्रम को बनाए रखते हैं।

बैच रिस्पॉन्स

बैच API रिस्पॉन्स आइटमों का एक क्रमबद्ध संग्रह लौटाते हैं। इसके अलावा, उनकी संरचना उनके संबंधित single-item endpoint जैसी ही होती है।

बैच त्रुटियाँ

• अनुरोध-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
• आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक line item पैरामीटर का मौजूद न होना) रिस्पॉन्स में operation_errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।

संसाधन URL

https://ads-api.x.com/12/batch/accounts/:account_id/line_items

पैरामीटर

Name	Description
operation_type required	प्रति आइटम निष्पादित किया जा रहा operation type। Type: enum संभावित मान: Create, Delete, Update
params required	एक JSON ऑब्जेक्ट, जिसमें line item ऑब्जेक्ट के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक line item पैरामीटरों की सूची के लिए, यहाँ देखें।

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

POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items

    [
      {
        "operation_type":"Create",
        "params":{
          "campaign_id":"8yn7m",
          "objective":"ENGAGEMENTS",
          "product_type":"PROMOTED_TWEETS",
          "placements":"ALL_ON_TWITTER",
          "bid_amount_local_micro":3210000,
          "entity_status":"PAUSED"
        }
      }
    ]

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

    {
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": null,
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": null,
          "bid_amount_local_micro": 3210000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "9cqi0",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2017-07-07T17:42:20Z",
          "ios_app_store_identifier": null,
          "updated_at": "2017-07-07T17:42:20Z",
          "campaign_id": "8yn7m",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "placements": [
              "ALL_ON_TWITTER"
            ],
            "bid_amount_local_micro": 3210000,
            "product_type": "PROMOTED_TWEETS",
            "objective": "ENGAGEMENTS",
            "entity_status": "PAUSED",
            "account_id": "18ce54d4x5t",
            "campaign_id": "8yn7m"
          },
          "operation_type": "Create"
        }
      ]
    }

PUT accounts/:account_id/line_items/:line_item_id

वर्तमान account से जुड़े निर्दिष्ट line item को अपडेट करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id

पैरामीटर

नाम	विवरण
account_id आवश्यक	लिवरेज्ड खाते के लिए पहचानकर्ता। यह संसाधन के पाथ में दिखाई देता है और GET accounts को छोड़कर आमतौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t
line_item_id आवश्यक	उस line item का संदर्भ जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string उदाहरण: 8v7jo
advertiser_domain वैकल्पिक	इस विज्ञापनदाता की वेबसाइट का डोमेन, बिना प्रोटोकॉल विनिर्देशन के। नोट: जब लाइन आइटम का प्लेसमेंट PUBLISHER_NETWORK पर सेट किया गया हो, तब यह आवश्यक है। Type: string उदाहरण: x.com
advertiser_user_id वैकल्पिक	PREROLL_VIEWS विज्ञापन का प्रचार करने वाले हैंडल के लिए Twitter उपयोगकर्ता पहचानकर्ता। केवल कुछ client applications ही इस parameter का उपयोग कर सकती हैं। Type: string उदाहरण: 312226591
android_app_store_identifier वैकल्पिक	प्रचारित ऐप के लिए Google App Store पहचानकर्ता। नोट: APP_INSTALLS और APP_ENGAGEMENTS उद्देश्यों के लिए कम-से-कम एक app store पहचानकर्ता सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier। Type: string उदाहरण: com.twitter.android
audience_expansion वैकल्पिक	पहले से लक्षित उपयोगकर्ताओं जैसे मिलते-जुलते उपयोगकर्ताओं को लक्षित करके अभियानों की पहुँच बढ़ाने के लिए उपयोग किया जाता है। Type: enum संभावित मान: BROAD, DEFINED, EXPANDED
bid_amount_local_micro वैकल्पिक	इस line item से संबद्ध बोली राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में प्रदर्शित किया जाता है। नोट: यदि bid_strategy को MAX या TARGET में से किसी एक पर सेट किया गया है, तो यह आवश्यक है नोट: केवल शून्य से अधिक मान स्वीकार किए जाते हैं। प्रकार: long उदाहरण: 140000
bid_strategy वैकल्पिक	बोली लगाने की प्रणाली। AUTO दैनिक बजट और अभियान की अवधि के आधार पर बोली को अपने-आप अनुकूलित करता है। MAX अधिकतम अनुमत बोली सेट करता है और जब objective को REACH या FOLLOWERS पर सेट किया गया हो, तब यह उपलब्ध नहीं होता। TARGET दैनिक औसत बोली को निर्दिष्ट bid_amount_local_micro के 20% के भीतर रखने का प्रयास करता है और जब objective को REACH या WEBSITE_CLICKS पर सेट किया गया हो, तब यह उपलब्ध होता है। ध्यान दें: यदि इसे AUTO पर सेट किया गया है, तो bid_amount_local_micro को अनदेखा किया जाएगा। ध्यान दें: डिफ़ॉल्ट मान objective के आधार पर होता है। Type: enum संभावित मान: AUTO, MAX, TARGET
categories वैकल्पिक	इस विज्ञापनदाता के लिए लागू IAB श्रेणियाँ। GET iab_categories देखें। नोट: जब line item का placement PUBLISHER_NETWORK पर सेट हो, तो यह आवश्यक है। प्रकार: string उदाहरण: IAB3-1
duration_in_days वैकल्पिक	वह समय अवधि, जिसके भीतर frequency_cap हासिल किया जाता है। Type: int संभावित मान: 1, 7, 30
entity_status वैकल्पिक	लाइन आइटम की स्थिति. Type: enum संभावित मान: ACTIVE, PAUSED
end_time वैकल्पिक	वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम की डिलीवरी बंद हो जाएगी। Type: string उदाहरण: 2017-10-05T00:00:00Z
frequency_cap वैकल्पिक	किसी उपयोगकर्ता को कोई विज्ञापन अधिकतम कितनी बार दिखाया जा सकता है। नोट: यह केवल REACH, ENGAGEMENTS, VIDEO_VIEWS और PREROLL_VIEWS उद्देश्यों के लिए समर्थित है। प्रकार: int उदाहरण: 5
goal वैकल्पिक	इस line item के साथ उपयोग की जाने वाली optimization setting। APP_PURCHASES विकल्प APP_INSTALL के लिए उपलब्ध है। APP_CLICKS और APP_INSTALLS विकल्प APP_INSTALL और APP_ENGAGEMENTS के लिए उपलब्ध हैं, और इनके लिए किसी समर्थित MACT partner का उपयोग करना आवश्यक हो सकता है। नोट: डिफ़ॉल्ट, objective के आधार पर तय होता है। Type: enum संभावित मान: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
ios_app_store_identifier वैकल्पिक	प्रचारित ऐप्लिकेशन के लिए Apple App Store identifier का संख्यात्मक भाग। नोट: APP_INSTALLS और APP_ENGAGEMENTS objectives के लिए कम से कम एक app store identifier सेट करना आवश्यक है — या तो android_app_store_identifier या ios_app_store_identifier। Type: string उदाहरण: 333903271
name वैकल्पिक	लाइन आइटम का नाम। Type: string उदाहरण: demo
pay_by वैकल्पिक	इस line item के लिए शुल्क लेने की इकाई। यह सेटिंग केवल उन line items के लिए बदली जा सकती है जो APP_INSTALLS objective का उपयोग करते हैं। नोट: डिफ़ॉल्ट pay_by, campaign objective और line item की bid unit के आधार पर अपने आप सेट हो जाता है। APP_INSTALLS goal, APP_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है। LINK_CLICKS goal, LINK_CLICK और IMPRESSION दोनों मानों का समर्थन करता है। IMPRESSION डिफ़ॉल्ट मान है, लेकिन bid_strategy के लिए TARGET सेट करते समय यह समर्थित नहीं है। SITE_VISITS goal, IMPRESSION मान का समर्थन करता है। Type: enum संभावित मान: APP_CLICK, IMPRESSION, LINK_CLICK
start_time वैकल्पिक	वह समय, जो ISO 8601 में व्यक्त किया गया है, जब लाइन आइटम सर्व होना शुरू करेगा। Type: string उदाहरण: 2017-07-05T00:00:00Z
total_budget_amount_local_micro वैकल्पिक	लाइन आइटम के लिए आवंटित की जाने वाली कुल बजट राशि। निर्दिष्ट फंडिंग इंस्ट्रूमेंट से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $37.50 को 37500000 के रूप में दर्शाया जाता है। Type: long उदाहरण: 37500000
daily_budget_amount_local_micro वैकल्पिक	campaign के लिए आवंटित की जाने वाली दैनिक बजट राशि। निर्दिष्ट funding instrument से संबद्ध मुद्रा का उपयोग किया जाएगा। USD के लिए, $5.50 को 5500000 के रूप में दर्शाया जाता है। यदि यह प्रदान नहीं किया जाता है, तो campaign कुल बजट और उसकी चलने की अवधि के आधार पर समान रूप से खर्च करेगा। केवल तब उपलब्ध, जब parent campaign के लिए budget_optimization को LINE_ITEM पर सेट किया गया हो नोट: यह total_budget_amount_local_micro से कम या उसके बराबर होना चाहिए। Type: long उदाहरण: 5500000

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000

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

    {
      "request": {
        "params": {
          "line_item_id": "9cqi0",
          "bid_amount_local_micro": 140000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2017-07-10T00:00:00Z",
        "bid_amount_local_micro": 140000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9cqi0",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2017-07-07T17:42:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:51:36Z",
        "campaign_id": "8yn7m",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

DELETE accounts/:account_id/line_items/:line_item_id

वर्तमान account से संबंधित निर्दिष्ट लाइन आइटम को हटाएँ।

नोट: लाइन आइटम को हटाने की कार्रवाई वापस नहीं ली जा सकती, और इसके बाद इस resource को हटाने के प्रयासों पर HTTP 404 लौटेगा।

नोट: जब किसी लाइन आइटम को हटाया जाता है, तो उसके child promoted_tweets केवल GET accounts/:account_id/promoted_tweets और GET accounts/:account_id/promoted_tweets/:promoted_tweet_id endpoints में तभी लौटाए जाते हैं, जब request में with_deleted=true निर्दिष्ट किया गया हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते (response में "deleted": false)। हम cascade delete नहीं करते।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id

पैरामीटर

Name	Description
account_id required	leveraged account के लिए identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक required parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	request में जिस लाइन आइटम पर आप कार्रवाई कर रहे हैं, उसका reference। Type: string Exampple: 9f2ix

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix

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

    {
      "data": {
        "bid_strategy": "MAX",
        "advertiser_user_id": "756201191646691328",
        "name": "Untitled",
        "placements": [],
        "start_time": null,
        "bid_amount_local_micro": 100000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "pay_by": "ENGAGEMENT",
        "product_type": "PROMOTED_TWEETS",
        "end_time": "2017-07-21T00:00:00Z",
        "duration_in_days": 1,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9f2ix",
        "entity_status": "ACTIVE",
        "goal": "ENGAGEMENT",
        "frequency_cap": 5,
        "categories": [],
        "currency": "USD",
        "created_at": "2017-07-14T00:01:50Z",
        "updated_at": "2017-08-09T07:41:08Z",
        "campaign_id": "90r8n",
        "creative_source": "MANUAL",
        "deleted": true
      },
      "request": {
        "params": {
          "line_item_id": "9f2ix",
          "account_id": "18ce54d4x5t"
        }
      }
    }

लाइन आइटम क्यूरेटेड कैटेगरी

उपयोग से जुड़ी अतिरिक्त जानकारी Video Views Pre-roll Objective Guide में मिल सकती है

GET accounts/:account_id/line_item_curated_categories

वर्तमान account से संबद्ध कुछ या सभी लाइन आइटम curated categories का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories

पैरामीटर

Name	Description
account_id required	leveraged account का आइडेंटिफ़ायर। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	results का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
sort_by optional	समर्थित attribute के आधार पर ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories

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

    {
      "request": {
        "params": {
          "account_id": "abc1"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "by5pw",
          "curated_category_id": "7op29tp2jzeo",
          "id": "1",
          "created_at": "2018-06-29T04:19:53Z",
          "updated_at": "2018-06-29T04:19:53Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

वर्तमान खाते से संबद्ध किसी विशिष्ट लाइन आइटम क्यूरेटेड श्रेणी का विवरण प्राप्त करता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_curated_category_id required	उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 43853bhii885
with_deleted optional	अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav

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

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "yav",
          "account_id": "abc1"
        }
      },
      "data": {
        "line_item_id": "by5pw",
        "curated_category_id": "7op29tp2jzeo",
        "id": "yav",
        "created_at": "2018-06-29T04:19:53Z",
        "updated_at": "2018-06-29T04:19:53Z",
        "deleted": false
      }
    }

POST accounts/:account_id/line_item_curated_categories

निर्दिष्ट लाइन आइटम के साथ एक curated category ऑब्जेक्ट संबद्ध करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, ऑथेंटिकेटेड उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
curated_category_id required	उस curated category entity का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 10miy
line_item_id required	उस लाइन आइटम का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 8v7jo

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o

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

    {
      "request": {
        "params": {
          "curated_category_id": "9ddrgesiap6o",
          "line_item_id": "iqwka",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T17:26:42Z",
        "deleted": false
      }
    }

PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

निर्दिष्ट लाइन आइटम क्यूरेटेड श्रेणी को अपडेट करता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API request के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_curated_category_id required	उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 1bzq3
curated_category_id optional	उस curated category entity का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 10miy
line_item_id optional	उस लाइन आइटम का संदर्भ, जिस पर आप request में काम कर रहे हैं। Type: string Example: 8v7jo

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g

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

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "8tujl1p3yn0g",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

निर्दिष्ट लाइन आइटम क्यूरेटेड श्रेणी को हटाएँ।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API request के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_curated_category_id required	उस लाइन आइटम क्यूरेटेड श्रेणी का संदर्भ, जिस पर आप इस request में कार्रवाई कर रहे हैं। Type: string Example: 1bzq3

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq

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

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

लाइन आइटम प्लेसमेंट

GET line_items/placements

मान्य placement और product_type संयोजन प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/line_items/placements

पैरामीटर

नाम	विवरण
product_type optional	रिस्पॉन्स का दायरा केवल निर्दिष्ट product type के लिए मान्य placements तक सीमित करें। Type: enum संभावित मान: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS

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

GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT

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

    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

मीडिया क्रिएटिव्स

GET accounts/:account_id/media_creatives

वर्तमान account से संबद्ध कुछ या सभी मीडिया क्रिएटिव्स का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/media_creatives

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t
campaign_id optional	रिस्पॉन्स को केवल निर्दिष्ट campaign से संबद्ध मीडिया क्रिएटिव्स तक सीमित करें। प्रकार: string उदाहरण: 8gdx6
count optional	प्रति request पुनर्प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। प्रकार: int डिफ़ॉल्ट: 200 न्यूनतम, अधिकतम: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। प्रकार: string उदाहरण: 8x7v00oow
line_item_ids optional	अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट लाइन आइटम्स से संबद्ध मीडिया क्रिएटिव्स तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। प्रकार: string उदाहरण: 8v7jo
media_creative_ids optional	अल्पविराम से अलग की गई identifiers की सूची देकर रिस्पॉन्स को केवल वांछित मीडिया क्रिएटिव्स तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। प्रकार: string उदाहरण: 1bzq3
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। प्रकार: string उदाहरण: created_at-asc
with_deleted optional	अपने request में deleted results शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह parameter और cursor एक-दूसरे के साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में 15 मिनट में 200 पर सेट हैं। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "media_creative_ids": [
            "1bzq3"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8v7jo",
          "landing_url": "https://dev.x.com",
          "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
          "id": "1bzq3",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T06:00:42Z",
          "account_media_id": "10miy",
          "updated_at": "2019-01-11T20:21:26Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/media_creatives/:media_creative_id

वर्तमान खाते से संबद्ध किसी विशिष्ट मीडिया क्रिएटिव का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id

पैरामीटर

Name	Description
account_id required	उपयोग में लाए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
media_creative_id required	उस मीडिया क्रिएटिव का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: 43853bhii885
with_deleted optional	अपने अनुरोध में हटाए गए परिणामों को शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3

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

    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

POST accounts/:account_id/media_creatives

निर्दिष्ट line item के साथ एक account media ऑब्जेक्ट संबद्ध करें।

Twitter Audience Platform पर in-stream ads (जब account media का creative_type PREROLL हो) या image ads (जैसे BANNER या INTERSTITIAL) को प्रमोट करने के लिए इस endpoint का उपयोग करें।

नोट: Account Media resource में media assets जोड़ने के लिए, POST accounts/:account_id/media_library endpoint का उपयोग करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/media_creatives

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे leveraged account का identifier। यह resource के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API requests में required parameter होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
account_media_id required	request में जिस account media entity के साथ आप काम कर रहे हैं, उसका reference। Type: string Example: 10miy
line_item_id required	request में जिस line item के साथ आप काम कर रहे हैं, उसका reference। Type: string Example: 8v7jo
landing_url sometimes required	उस वेबसाइट का URL, जिस पर उपयोगकर्ता को भेजना है। इसका उपयोग केवल TAP images (या “display creatives”) के साथ किया जाना चाहिए। preroll assets के साथ उपयोग किए जाने पर इस value को अनदेखा कर दिया जाएगा। किसी preroll asset के साथ URL संबद्ध करने के लिए, POST accounts/:account_id/preroll_call_to_actions endpoint का उपयोग करें। नोट: जब line item का objective WEBSITE_CLICKS पर सेट हो, तब यह required होता है। Type: string Example: https://blog.x.com/

उदाहरण request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy

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

    {
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "account_media_id": "10miy",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

DELETE accounts/:account_id/media_creatives/:media_creative_id

वर्तमान खाते से संबंधित निर्दिष्ट मीडिया क्रिएटिव हटाएँ।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
media_creative_id required	उस मीडिया क्रिएटिव का संदर्भ, जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string Example: 1bzq3

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3

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

    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2021-04-16T21:02:55Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      }
    }

Promoted Accounts

GET accounts/:account_id/promoted_accounts

मौजूदा account के अंतर्गत एक या अधिक line item से जुड़े कुछ या सभी promoted account का विवरण प्राप्त करें।

रिस्पॉन्स में user_id से पहचाने गए user account का user data प्राप्त करने के लिए GET users/lookup का उपयोग करें।

अगर निर्दिष्ट line item में से कोई भी promoted account शामिल करने के लिए कॉन्फ़िगर नहीं किया गया है, तो HTTP 400 लौटाया जाएगा।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_accounts

पैरामीटर

Name	Description
account_id required	leveraged account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API request के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	हर अलग request में प्राप्त करने के लिए record की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
line_item_ids optional	comma-separated identifier की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट line item से जुड़े promoted account तक सीमित करता है। अधिकतम 200 ID दिए जा सकते हैं। Type: string Example: 9bpb2
promoted_account_ids optional	comma-separated identifier की सूची देकर रिस्पॉन्स को केवल इच्छित promoted account तक सीमित करता है। अधिकतम 200 ID दिए जा सकते हैं। Type: string Example: 19pl2
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने request में deleted result शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह parameter और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन request में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2

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

    {
      "request": {
        "params": {
          "promoted_account_ids": [
            "19pl2"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "9bpb2",
          "user_id": "756201191646691328",
          "id": "19pl2",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T05:54:13Z",
          "updated_at": "2017-07-05T05:54:13Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/promoted_accounts/:promoted_account_id

वर्तमान account के अंतर्गत किसी line item से संबद्ध account के किसी विशिष्ट reference को पुनर्प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id

पैरामीटर

Name	Description
account_id required	leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
promoted_account_id required	उस promoted account का reference जिसके साथ आप request में काम कर रहे हैं। Type: string Example: 19pl2
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2

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

    {
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

POST accounts/:account_id/promoted_accounts

किसी अकाउंट (user_id) को निर्दिष्ट line item से संबद्ध करें।

यदि निर्दिष्ट line item को Promoted Accounts के साथ संबद्ध होने के लिए कॉन्फ़िगर नहीं किया गया है, तो HTTP 400 INCOMPATIBLE_LINE_ITEM त्रुटि लौटाई जाएगी। यदि निर्दिष्ट उपयोगकर्ता प्रमोशन के लिए अयोग्य है, तो HTTP 400 लौटाया जाएगा और किसी भी उपयोगकर्ता को प्रमोट नहीं किया जाएगा। यदि दिया गया उपयोगकर्ता पहले से ही प्रमोट किया जा चुका है, तो अनुरोध को अनदेखा कर दिया जाएगा।

Promoted Accounts के बारे में अधिक जानकारी के लिए, हमारा campaign management पेज देखें।

नोट: Promoted Accounts एंटिटीज़ को अपडेट (PUT) करना संभव नहीं है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_accounts

पैरामीटर

Name	Description
account_id required	उपयोग में लिए जा रहे leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	उस line item का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। Type: string Example: 9bpb2
user_id required	उस उपयोगकर्ता का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। स्क्रीन नाम के लिए उपयोगकर्ता ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long Example: 756201191646691328

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328

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

    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      },
      "request": {
        "params": {
          "user_id": "756201191646691328",
          "line_item_id": "9bpb2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/promoted_accounts/:promoted_account_id

किसी अकाउंट को निर्दिष्ट line item से असंबद्ध करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
promoted_account_id required	यह पहचानकर्ता किसी line item से संबद्ध Promoted Account के instance को संदर्भित करता है। Type: string Example: 19pl2

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2

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

    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-08-23T18:53:15Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

प्रमोटेड Tweets

GET accounts/:account_id/promoted_tweets

वर्तमान खाते के अंतर्गत line items से संबद्ध Tweets के रेफ़रेंस प्राप्त करें।

Tweet ऑब्जेक्ट्स प्राप्त करने के लिए GET accounts/:account_id/tweets endpoint का उपयोग करें। प्रत्येक promoted_tweets ऑब्जेक्ट के लिए tweet_id मानों का उपयोग करें।

नोट: जब parent line items हटा दिए जाते हैं, तो promoted_tweets केवल तभी लौटाए जाते हैं जब अनुरोध में with_deleted=true निर्दिष्ट हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते ("deleted": false in the response).

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_tweets

पैरामीटर

Name	Description
account_id required	उपयोग में लाए जा रहे खाते की पहचान। यह resource path में दिखाई देती है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होती है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
line_item_ids optional	अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल विशिष्ट line items से संबद्ध Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 96uzp
promoted_tweet_ids optional	अल्पविराम से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित promoted Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 1efwlo
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन अनुरोधों में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo

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

    {
      "request": {
        "params": {
          "promoted_tweet_ids": [
            "1efwlo"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "96uzp",
          "id": "1efwlo",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-29T05:06:57Z",
          "updated_at": "2017-06-29T05:08:46Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "880290790664060928",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

वर्तमान अकाउंट के अंतर्गत किसी line item से संबद्ध Tweet के किसी विशिष्ट रेफ़रंस को प्राप्त करें।

नोट: जब parent line items हटा दिए जाते हैं, तो promoted_tweets केवल तभी लौटाए जाते हैं, जब अनुरोध में with_deleted=true निर्दिष्ट किया गया हो। हालांकि, ये promoted_tweets वास्तव में हटाए नहीं जाते हैं ("deleted": false रिस्पॉन्स में)।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id

पैरामीटर

Name	Description
account_id required	leveraged अकाउंट का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और GET accounts को छोड़कर, आम तौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
promoted_tweet_id required	उस promoted Tweet का रेफ़रंस, जिस पर आप अनुरोध में कार्य कर रहे हैं। Type: string Example: 1efwlo
with_deleted optional	अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo

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

    {
      "request": {
        "params": {
          "promoted_tweet_id": "1efwlo",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "96uzp",
        "id": "1efwlo",
        "entity_status": "ACTIVE",
        "created_at": "2017-06-29T05:06:57Z",
        "updated_at": "2017-06-29T05:08:46Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "880290790664060928",
        "deleted": false
      }
    }

POST accounts/:account_id/promoted_tweets

निर्दिष्ट line item के साथ एक या अधिक Tweets को संबद्ध करें। अभियान के उद्देश्य के आधार पर, सभी Tweets प्रचार के लिए उपयुक्त नहीं होते हैं। अधिक जानकारी के लिए कृपया Objective-based Campaigns देखें।

PROMOTED_ACCOUNT product type का उपयोग करते समय, line_item के साथ किसी Tweet को संबद्ध करने पर मानक PROMOTED_ACCOUNT placement के अलावा mobile पर timeline placements भी जुड़ जाते हैं।

नोट: promoted Tweet entities को update (PUT) करना संभव नहीं है।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/promoted_tweets

पैरामीटर

Name	Description
account_id required	leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 8v7jo
tweet_ids required	विशिष्ट Tweets से संबंधित identifiers की comma-separated सूची। अधिकतम 50 IDs दिए जा सकते हैं। Type: long Example: 822333526255120384

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384

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

    {
      "data": [
        {
          "line_item_id": "8v7jo",
          "id": "1e8i2k",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-24T04:21:36Z",
          "updated_at": "2017-06-24T04:21:36Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "822333526255120384",
          "deleted": false
        }
      ],
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "tweet_ids": [
            822333526255120384
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "total_count": 1
    }

DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

निर्दिष्ट line item से किसी Tweet का संबद्धता हटाएँ।

नोट: हटाई गई promoted_tweets entity ads.x.com UI में “Paused” के रूप में दिखाई देगी। इसी तरह, UI से “pause” करने पर भी Tweet की उसके line item से संबद्धता हट जाएगी।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id

पैरामीटर

Name	Description
account_id required	leveraged account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API request के लिए एक आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
promoted_tweet_id required	यह identifier किसी line item से संबद्ध Promoted Tweet के instance को संदर्भित करता है। यह GET accounts/:account_id/promoted_tweets के किसी response item के id field से आता है, संबंधित Tweet के tweet_id से नहीं। इसे resource के path में दिया जाता है। Type: string Example: 1gp8a5

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5

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

    {
      "data": {
        "line_item_id": "9pl99",
        "id": "1gp8a5",
        "entity_status": "ACTIVE",
        "created_at": "2017-08-17T17:02:21Z",
        "updated_at": "2017-08-18T06:43:48Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "844796297743757315",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_tweet_id": "1gp8a5",
          "account_id": "18ce54d4x5t"
        }
      }
    }

प्रचार-योग्य उपयोगकर्ता

GET accounts/:account_id/promotable_users

वर्तमान खाते से जुड़े कुछ या सभी प्रमोट किए जा सकने वाले उपयोगकर्ताओं का विवरण प्राप्त करें।

प्रमोट किए जा सकने वाले उपयोगकर्ता का प्रकार FULL या RETWEETS_ONLY होता है। यह उस सामग्री के प्रकार को नियंत्रित करता है जिसे खाते द्वारा प्रमोट करने की अनुमति होती है। विज्ञापनदाताओं को किसी अन्य उपयोगकर्ता की सामग्री प्रमोट करने के लिए अनुमति प्राप्त करनी होती है और उन्हें अपने खाते में RETWEETS_ONLY प्रमोट किए जा सकने वाले उपयोगकर्ता के रूप में जोड़ने के लिए Twitter से संपर्क करना होता है।

यदि अनुमतियाँ सही तरीके से सेट हैं, तो आप promoted product endpoints पर ऐसे अनुरोध कर सकते हैं जो सीधे उस Tweet की Tweet ID को संदर्भित करते हैं जिसे आप प्रमोट करना चाहते हैं। आप प्रकाशित Tweets को प्रमोट करने के लिए POST accounts/:account_id/promoted-tweets endpoint का उपयोग कर सकते हैं और किसी अन्य Twitter Ads खाते के Scheduled Tweets को प्रमोट करने के लिए POST accounts/:account_id/scheduled-promoted-tweets endpoint का उपयोग कर सकते हैं।

आपको लक्षित Tweet को retweet करने की आवश्यकता नहीं है। जब आप इस तरीके से किसी Tweet को प्रमोट करते हैं, तो लौटाया गया tweet_id, प्रदान की गई Tweet ID से अलग होगा। पर्दे के पीछे, Tweet को nullcasted Tweet के रूप में retweet किया जाता है और फिर प्रमोट किया जाता है। लौटाया गया tweet_id इसी नए Tweet के अनुरूप होता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promotable_users

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
promotable_user_ids optional	कॉमा से अलग की गई identifiers की सूची निर्दिष्ट करके रिस्पॉन्स को केवल इच्छित प्रमोट किए जा सकने वाले उपयोगकर्ताओं तक सीमित करें। अधिकतम 200 IDs प्रदान की जा सकती हैं। Type: string Example: l310s
sort_by optional	समर्थित attribute के अनुसार आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। Note: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। Note: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s

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

    {
      "request": {
        "params": {
          "promotable_user_ids": [
            "l310s"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "user_id": "756201191646691328",
          "id": "l310s",
          "created_at": "2016-07-21T22:42:09Z",
          "updated_at": "2016-07-21T22:42:09Z",
          "deleted": false,
          "promotable_user_type": "FULL"
        }
      ]
    }

GET accounts/:account_id/promotable_users/:promotable_user_id

वर्तमान account से संबद्ध किसी विशिष्ट प्रमोट किए जा सकने वाला उपयोगकर्ता को पुनर्प्राप्त करें।

प्रमोट किए जा सकने वाला उपयोगकर्ता का type FULL या RETWEETS_ONLY होता है। यह उस सामग्री के type को नियंत्रित करता है जिसे account प्रमोट कर सकता है।

विज्ञापनदाताओं को किसी अन्य user की सामग्री को प्रमोट करने के लिए अनुमति प्राप्त करनी होगी। यदि अनुमतियाँ सही तरीके से सेट हैं, तो आप promoted product endpoints पर ऐसे अनुरोध कर सकते हैं जो सीधे उस Tweet की Tweet ID को संदर्भित करते हैं जिसे आप प्रमोट करना चाहते हैं।

आपको target Tweet को retweet करने की आवश्यकता नहीं है। जब आप इस तरीके से किसी Tweet को प्रमोट करते हैं, तो लौटाया गया tweet_id, दी गई Tweet ID से अलग होगा। पर्दे के पीछे, उस Tweet को nullcasted Tweet के रूप में retweet किया जाता है और फिर प्रमोट किया जाता है। लौटाया गया tweet_id इसी नए Tweet से संबंधित होता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
promotable_user_id optional	उस प्रमोट किए जा सकने वाला उपयोगकर्ता का संदर्भ, जिस पर आप request के भीतर कार्य कर रहे हैं Type: string Example: l310s
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s

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

    {
      "request": {
        "params": {
          "promotable_user_id": "l310s",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "user_id": "2417045708",
        "id": "l310s",
        "created_at": "2017-03-10T17:51:24Z",
        "updated_at": "2017-03-10T17:51:24Z",
        "deleted": false,
        "promotable_user_type": "RETWEETS_ONLY"
      }
    }

पब्लिशर्स

GET publishers

Content Category प्रकाशकों के विवरण की सूची प्राप्त करें

अतिरिक्त जानकारी Video Views Preroll Objective Guide में मिल सकती है

रिसोर्स URL

https://ads-api.x.com/12/publishers

पैरामीटर

कोई अनुरोध पैरामीटर नहीं

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

GET https://ads-api.x.com/12/publishers

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

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "PeoplesSports",
          "user_id": "1353868435021721602",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "NewYork_Jack",
          "user_id": "1331177123436851206",
          "monetization_restricted": true,
          "content_category_ids": [
            "sk"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "twispatv",
          "user_id": "1331165719128461314",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "LAThieves",
          "user_id": "1316808678897455105",
          "monetization_restricted": true,
          "content_category_ids": [
            "s0"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Quicktake_EE",
          "user_id": "1305900477427724290",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "BR"
          ],
          "promotion_eligible_country_codes": [
            "BR"
          ],
          "username": "eufloribella",
          "user_id": "1300812459054436354",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "EG"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "Egypt2021EN",
          "user_id": "1296077573399678977",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "ClubShayShay",
          "user_id": "1283068366706454529",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "hiaahsanshow",
          "user_id": "1253421442143641601",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "TH"
          ],
          "promotion_eligible_country_codes": [
            "TH"
          ],
          "username": "HoneKrasae",
          "user_id": "1240684293719904256",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Sportskind",
          "user_id": "1232708694418300930",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "almeerathShow",
          "user_id": "1229410512762437633",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "SeeYourVoiceFOX",
          "user_id": "1225490734653947904",
          "monetization_restricted": true,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "AUProSports",
          "user_id": "1219303449768185859",
          "monetization_restricted": false,
          "content_category_ids": [
            "se"
          ]
        }
      ]
    }

सिफारिशें

GET accounts/:account_id/recommendations

स्थिति: क्लोज़्ड बीटा

इस ads account से जुड़े campaign recommendations प्राप्त करें। फ़िलहाल, प्रति funding instrument 1 recommendation की सीमा है।

रिसोर्स URL

https://ads-api.x.com/5/accounts/:account_id/recommendations

पैरामीटर

नाम	विवरण
account_id अनिवार्य	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक अनिवार्य parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t

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

GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations

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

    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "Recommendation for testing",
        "created_at": "2016-11-14T23:07:54Z",
        "updated_at": "2016-11-14T23:07:54Z"
      }
    ]

GET accounts/:account_id/recommendations/:recommendation_id

स्थिति: क्लोज़्ड बीटा

इस ads account से जुड़ी किसी विशिष्ट campaign recommendation को प्राप्त करें।

campaign recommendation में campaign structure के लिए सुझाए गए बदलावों का पूरा सेट एक object tree के रूप में शामिल होता है। यह रिस्पॉन्स tree, Batch API endpoints के साथ मिलकर काम करने के लिए बनाया गया है, लेकिन उपयुक्त होने पर इसे single update endpoints से भी मैप किया जा सकता है (POST के लिए Create, PUT के लिए Update, DELETE के लिए Delete)।

रिसोर्स URL

https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह resource path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए एक required parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
recommendation_id required	उस recommendation ID का reference जिस पर आप इस request में काम कर रहे हैं Type: string Example: 62ce8zza1q0w

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

GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w

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

{
    "request": {
      "params": {
        "recommendation_id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t"
      }
    },
    "data_type": "recommendations",
      "data": {
      "changes": [
        {
          "entity_type": "campaigns",
          "params": {
            "start_time": "2016-11-08T22:00:00Z",
            "daily_budget_amount_local_micro": 2200000,
            "end_time": "2016-11-16T07:59:00Z",
            "total_budget_amount_local_micro": 12000000,
            "id": "64m0d"
          },
          "operation_type": "Update",
          "dependent_entities": [
            {
              "entity_type": "line_items",
              "params": {
                "name": "Campaign for recommendations",
                "placements": [
                  "TWITTER_TIMELINE"
                ],
                "bid_amount_local_micro": 1430000,
                "id": "6f5kq",
                "include_sentiment": "ALL"
              },
              "operation_type": "Update",
              "dependent_entities": [
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6p"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "election results",
                    "targeting_value": "election results",
                    "targeting_type": "PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftp"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Male",
                    "targeting_value": 1,
                    "targeting_type": "GENDER"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "San Francisco-Oakland-San Jose CA, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101fto"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "91125952589766656"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Partner audience targeting",
                    "targeting_value": "v2cx",
                    "targeting_type": "NEGATIVE_BEHAVIOR"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "AGE_21_TO_34",
                    "targeting_value": "AGE_21_TO_34",
                    "targeting_type": "AGE"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6o"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991101965843460096"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991127212156096516"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "debate",
                    "targeting_value": "debate",
                    "targeting_type": "NEGATIVE_PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "60004, IL, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6n"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftn"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                }
              ]
            }
          ]
        }
      ],
      "funding_instrument_id": "gpvzb",
      "id": "62ce8zza1q0w",
      "account_id": "18ce54d4x5t",
      "status": "PENDING",
      "message": "Recommendation for testing",
      "created_at": "2016-11-14T23:07:54Z",
      "updated_at": "2016-11-14T23:07:54Z"
      }
    }

शेड्यूल किए गए प्रमोटेड Tweet

GET accounts/:account_id/scheduled_promoted_tweets

वर्तमान अकाउंट से संबद्ध कुछ या सभी शेड्यूल किए गए प्रमोटेड Tweets का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे अकाउंट का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रति अनुरोध प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पृष्ठ प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
line_item_ids optional	कॉमा से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल उन शेड्यूल किए गए Tweets तक सीमित करता है जो विशिष्ट line items से संबद्ध हैं। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8xdpe
scheduled_promoted_tweet_ids optional	कॉमा से अलग की गई पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित शेड्यूल किए गए प्रमोटेड Tweets तक सीमित करता है। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 1xboq
sort_by optional	समर्थित attribute के आधार पर आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
with_deleted optional	अनुरोध में हटाए गए परिणामों को शामिल करता है। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute को शामिल करता है। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन अनुरोधों में total_count शामिल होता है, उन पर कम रेट लिमिट्स लागू होंगी, जो वर्तमान में प्रति 15 मिनट 200 हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq

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

    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_ids": [
            "1xboq"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8xdpe",
          "id": "1xboq",
          "created_at": "2017-06-01T19:53:32Z",
          "updated_at": "2017-06-01T20:00:06Z",
          "scheduled_tweet_id": "870366669373194240",
          "tweet_id": "870369382207070208",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

वर्तमान खाते से संबद्ध किसी विशिष्ट शेड्यूल किए गए प्रमोटेड Tweet को प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

पैरामीटर

नाम	विवरण
account_id required	उपयोग में लाए जा रहे खाते का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और GET accounts को छोड़कर आमतौर पर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता ऑथेंटिकेट किए गए उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t
scheduled_promoted_tweet_id required	उस शेड्यूल किए गए प्रमोटेड Tweet का संदर्भ, जिसका आप इस अनुरोध में उपयोग कर रहे हैं। प्रकार: string उदाहरण: 1xboq
with_deleted optional	अनुरोध में हटाए गए परिणामों को शामिल करें। प्रकार: boolean डिफ़ॉल्ट: false संभावित मान: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq

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

    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xboq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xboq",
        "created_at": "2017-06-01T19:53:32Z",
        "updated_at": "2017-06-01T20:00:06Z",
        "scheduled_tweet_id": "870366669373194240",
        "tweet_id": "870369382207070208",
        "deleted": false
      }
    }

POST accounts/:account_id/scheduled_promoted_tweets

निर्दिष्ट line item के साथ किसी अनुसूचित Tweet को संबद्ध करें।

नोट: शेड्यूल किया गया प्रमोटेड Tweet entities को अपडेट (PUT) करना संभव नहीं है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 8xdpe
scheduled_tweet_id required	request में जिस अनुसूचित Tweet पर आप काम कर रहे हैं, उसका reference। Type: long Example: 870358555227860992

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992

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

    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-08T07:25:26Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": false
      },
      "request": {
        "params": {
          "line_item_id": "8xdpe",
          "scheduled_tweet_id": 870358555227860992,
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

निर्दिष्ट लाइन आइटम से किसी scheduled Tweet का संबद्ध हटाएँ।

नोट: scheduled_promoted_tweets को केवल scheduled Tweet के scheduled_at समय से पहले ही हटाया जा सकता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
scheduled_promoted_tweet_id required	request में जिस scheduled promoted Tweet पर आप कार्य कर रहे हैं, उसका reference। यह GET accounts/:account_id/scheduled_promoted_tweets रिस्पॉन्स ऑब्जेक्ट का id attribute है। Type: string Example: 1xtfl

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl

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

    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-15T05:14:12Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": true
      },
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xtfl",
          "account_id": "18ce54d4x5t"
        }
      }
    }

टार्गेटिंग मानदंड

GET accounts/:account_id/targeting_criteria

वर्तमान अकाउंट के अंतर्गत line items से संबद्ध कुछ या सभी टार्गेटिंग मानदंड का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/targeting_criteria

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_ids required	comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल निर्दिष्ट line items के अंतर्गत आने वाले टार्गेटिंग मानदंड तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 8u94t
count optional	प्रत्येक अलग request में प्राप्त किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	results का अगला page प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
lang optional	एक ISO-639-1 भाषा कोड। इसे पास करने पर, जिन objects के लिए localized name उपलब्ध है, उनके लिए रिस्पॉन्स में अतिरिक्त localized_name attribute लौटाया जाएगा। Type: string Example: fr
sort_by optional	समर्थित attribute के अनुसार ascending या descending क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
targeting_criterion_ids optional	comma-separated पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित टार्गेटिंग मानदंड तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: dpl3a6
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन requests में total_count शामिल होता है, उनकी रेट लिमिट्स कम होंगी, जो वर्तमान में प्रति 15 मिनट 200 निर्धारित हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "Custom audience targeting",
          "id": "dpl3a6",
          "operator_type": "EQ",
          "created_at": "2017-05-26T03:29:35Z",
          "targeting_value": "249yj",
          "updated_at": "2017-05-26T03:29:35Z",
          "deleted": false,
          "targeting_type": "CUSTOM_AUDIENCE"
        }
      ]
    }

GET accounts/:account_id/targeting_criteria/:targeting_criterion_id

वर्तमान खाते से संबद्ध किसी विशिष्ट टार्गेटिंग मानदंड को प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id

पैरामीटर

नाम	विवरण
account_id required	प्रयुक्त खाते का आइडेंटिफ़ायर। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
targeting_criterion_id required	उस टार्गेटिंग मानदंड का संदर्भ, जिस पर आप इस अनुरोध में काम कर रहे हैं। Type: string Example: eijd4y
lang optional	एक ISO-639-1 भाषा कोड। इसे पास करने पर, उन ऑब्जेक्ट्स के लिए रिस्पॉन्स में अतिरिक्त localized_name attribute लौटाया जाएगा, जहाँ कोई localized नाम उपलब्ध हो। Type: string Example: fr
with_deleted optional	अपने अनुरोध में deleted परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y

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

    {
      "request": {
        "params": {
          "targeting_criterion_id": "eijd4y",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "619jl",
        "name": "🤖",
        "id": "eijd4y",
        "created_at": "2017-07-06T16:51:04Z",
        "targeting_value": "🤖",
        "updated_at": "2017-07-06T16:51:04Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      }
    }

POST accounts/:account_id/targeting_criteria

विशिष्ट targeting type के लिए targeting_value खोजने हेतु टार्गेटिंग विकल्प पेज देखें। हम अनुशंसा करते हैं कि आप सभी डेटा को हर सप्ताह रीफ़्रेश करें, ताकि आप targeting type मानों के नवीनतम सेट के साथ काम कर सकें। हम समय-समय पर मानों और उपलब्ध टार्गेटिंग मानदंड में बदलाव करते हैं; इनमें से अधिकांश बार-बार नहीं बदलते, लेकिन कुछ बदलते हैं। इस बात की कोई गारंटी नहीं है कि ये मान अपरिवर्तित रहेंगे।

targeting_value में निर्दिष्ट keywords के साथ BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, या UNORDERED_KEYWORD targeting type का उपयोग करें। keywords को बाहर रखने के लिए operator_type request parameter को NE पर सेट करें। प्रत्येक type का विस्तृत विवरण देखने के लिए targeting keyword types देखें।

नोट: प्रत्येक line item के लिए केवल एक age bucket को target करना संभव है।

नोट: किसी Custom Audience को target करने के लिए, उस audience का targetable होना ज़रूरी है। अर्थात, targerable का मान true होना चाहिए।

नोट: targeting type TV_SHOW का उपयोग करते समय, TV_SHOW targeting सेट करने से पहले line item पर कम-से-कम एक LOCATION टार्गेटिंग मानदंड होना चाहिए, और सभी LOCATION उसी locale के भीतर होने चाहिए जिस TV_SHOW को target किया जा रहा है।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/targeting_criteria

पैरामीटर

Name	Description
account_id required	प्रयुक्त account का identifier। यह resource के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API requests के लिए आवश्यक parameter होता है। निर्दिष्ट account authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	request में जिस line item पर आप काम कर रहे हैं, उसका reference। Type: string Example: 69ob
operator_type required	यह निर्दिष्ट करें कि टार्गेटिंग मानदंड का संबंध क्या होना चाहिए। उदाहरण के लिए, keywords को बाहर रखने के लिए operator_type=NE का उपयोग करें। Type: enum Possible values: EQ, NE, GTE, LT
targeting_type required	targeting का वह type जो इस line item पर लागू किया जाएगा। Possible non-keyword-based values include: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLY नोट: प्रत्येक line item के लिए केवल एक AGE bucket को target करना संभव है। Possible keyword-based values include: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORD Possible custom audience values include: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDED Possible installed app store category values: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKE Possible Twitter Audience Platform (TAP) app exclusion: APP_LIST (operator_type=NE के साथ ही उपयोग किया जा सकता है)
targeting_value required	चयनित targeting_type के आधार पर यह निर्दिष्ट करें कि यह targeting किस user, किस interest, किस location, किस event, किस platform, किस platform version, किस device, किस keyword या phrase, किस gender, किस custom audience, किस app store category, या app list के किस exclusion पर लागू होगी। Type: string Example: 174958347

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology

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

    {
      "data": {
        "line_item_id": "619jl",
        "name": "technology",
        "id": "fbyjlr",
        "created_at": "2017-09-06T07:31:21Z",
        "targeting_value": "technology",
        "updated_at": "2017-09-06T07:31:21Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      },
      "request": {
        "params": {
          "line_item_id": "619jl",
          "targeting_type": "BROAD_KEYWORD",
          "targeting_value": "technology",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST batch/accounts/:account_id/targeting_criteria

एक ही रिक्वेस्ट में नई Targeting Criteria का बैच निर्माण करने की अनुमति देता है।

बैच रिक्वेस्ट

• वर्तमान में अधिकतम बैच आकार 500 है।
• सभी पैरामीटर रिक्वेस्ट बॉडी में भेजे जाते हैं, और application/json का Content-Type आवश्यक है।
• बैच रिक्वेस्ट समूह के रूप में एक साथ विफल या सफल होते हैं, और त्रुटि तथा सफलता दोनों ही स्थितियों में सभी API रिस्पॉन्स प्रारंभिक रिक्वेस्ट के आइटमों का क्रम बनाए रखते हैं।

बैच रिस्पॉन्स

बैच API रिस्पॉन्स आइटमों का एक क्रमबद्ध संग्रह लौटाते हैं। इसके अलावा, उनकी संरचना उनके संबंधित single-item endpoints जैसी ही होती है।

बैच त्रुटियाँ

• रिक्वेस्ट-स्तर की त्रुटियाँ (जैसे, अधिकतम बैच आकार पार हो जाना) रिस्पॉन्स में errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।
• आइटम-स्तर की त्रुटियाँ (जैसे, आवश्यक Targeting Criteria पैरामीटर का अनुपस्थित होना) रिस्पॉन्स में operation_errors ऑब्जेक्ट के अंतर्गत दिखाई जाती हैं।

रिसोर्स URL

https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria

पैरामीटर

Name	Description
operation_type required	प्रति आइटम की जा रही operation type। Type: enum संभावित मान: Create, Delete
params required	एक JSON ऑब्जेक्ट, जिसमें टार्गेटिंग मानदंड ऑब्जेक्ट्स के लिए सभी पैरामीटर शामिल होते हैं। आवश्यक और वैकल्पिक टार्गेटिंग मानदंड पैरामीटरों की सूची के लिए, यहाँ देखें। इसके अतिरिक्त, यह endpoint operator_type पैरामीटर को सपोर्ट करता है, जो कुछ targeting_type मानों के साथ मिलकर काम करता है। इस पैरामीटर के संभावित मान हैं: EQ (बराबर), GTE (बड़ा या बराबर), LT (कम), और NE (बराबर नहीं)।

उदाहरण रिक्वेस्ट

POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria

    [
      {
        "operation_type":"Create",
        "params":{
          "line_item_id":"6f9an",
          "targeting_type":"LOCATION",
          "targeting_value":"5122804691e5fecc"
        }
      },
      {
        "operation_type":"Delete",
        "params":{
          "targeting_criterion_id":"al2rua"
        }
      }
    ]

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

    {
      "data_type": "targeting_criterion",
      "data": [
        {
          "line_item_id": "6f9an",
          "name": "San Francisco-Oakland-San Jose CA, US",
          "id": "al7vt2",
          "location_type": "CITY",
          "operator_type": "EQ",
          "created_at": "2016-11-11T22:59:50Z",
          "targeting_value": "5122804691e5fecc",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": false,
          "targeting_type": "LOCATION"
        },
        {
          "line_item_id": "6keuo",
          "name": "accounts",
          "id": "al2rua",
          "operator_type": "EQ",
          "created_at": "2016-11-11T17:50:19Z",
          "targeting_value": "accounts",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": true,
          "targeting_type": "BROAD_KEYWORD"
        }
      ],
      "request": [
        {
          "params": {
            "line_item_id": "6f9an",
            "targeting_type": "LOCATION",
            "targeting_value": "5122804691e5fecc",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        },
        {
          "params": {
            "targeting_criterion_id": "al2rua",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Delete"
        }
      ]
    }

DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id

वर्तमान खाते से संबंधित निर्दिष्ट टार्गेटिंग मानदंड हटाएँ।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id

पैरामीटर

Name	Description
account_id required	उपयोग किए जा रहे खाते का पहचानकर्ता। यह संसाधन के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
targeting_criterion_id required	उस टार्गेटिंग मानदंड का संदर्भ, जिस पर आप अनुरोध में काम कर रहे हैं। Type: string Example: dpl3a6

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6

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

    {
      "data": {
        "line_item_id": "8u94t",
        "name": "Custom audience targeting",
        "id": "dpl3a6",
        "created_at": "2017-05-26T03:29:35Z",
        "targeting_value": "249yj",
        "updated_at": "2017-08-30T18:38:58Z",
        "deleted": true,
        "targeting_type": "CUSTOM_AUDIENCE"
      },
      "request": {
        "params": {
          "targeting_criterion_id": "dpl3a6",
          "account_id": "18ce54d4x5t"
        }
      }
    }

टार्गेटिंग विकल्प

• ऐप स्टोर श्रेणियाँ
• वार्तालाप
• डिवाइस
• इवेंट
• रुचियाँ
• भाषाएँ
• स्थान
• नेटवर्क ऑपरेटर
• प्लेटफ़ॉर्म संस्करण
• प्लेटफ़ॉर्म
• टीवी बाज़ार
• टीवी शो

GET targeting_criteria/app_store_categories

Promoted Products के लिए उपलब्ध ऐप स्टोर श्रेणी-आधारित टार्गेटिंग मानदंड खोजें। ऐप स्टोर श्रेणियां केवल iOS App Store और Google Play store के लिए उपलब्ध हैं।

इंस्टॉल किए गए ऐप की श्रेणी के आधार पर टार्गेटिंग करने से आप उन उपयोगकर्ताओं को लक्षित कर सकते हैं, जिन्होंने उन श्रेणियों के ऐप इंस्टॉल किए हैं या जिनमें रुचि दिखाई है।

रिसोर्स URL

https://ads-api.x.com/12/targeting_criteria/app_store_categories

पैरामीटर

Name	Description
q optional	टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: music
os_type optional	किसी विशिष्ट ऐप स्टोर के आधार पर परिणामों का दायरा सीमित करें। Type: enum Possible values: ANDROID, IOS

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

GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS

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

    {
      "data": [
        {
          "name": "Games: Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qov2",
          "os_type": "IOS"
        }
      ],
      "request": {
        "params": {
          "q": "music",
          "os_type": "IOS"
        }
      }
    }

GET targeting_criteria/conversations

Promoted Products के लिए उपलब्ध कन्वर्सेशन-आधारित टार्गेटिंग मानदंड खोजें।

रिसोर्स URL

https://ads-api.x.com/12/targeting_criteria/conversations

पैरामीटर

Name	Description
conversation_type optional	किसी विशेष conversation type तक सीमित करने के लिए एक वैकल्पिक क्वेरी। Type: enum Possible values: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES
count optional	प्रत्येक अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow

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

GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2

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

    {
      "request": {
        "params": {
          "count": 2
        }
      },
      "next_cursor": "1f7m7",
      "data": [
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a1",
          "name": "NFL",
          "conversation_type": "SPORTS"
        },
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a2",
          "name": "NBA",
          "conversation_type": "SPORTS"
        }
      ]
    }

GET targeting_criteria/devices

Promoted Products के लिए उपलब्ध डिवाइस-आधारित टार्गेटिंग मानदंड खोजें। Promoted Tweets के लिए डिवाइस टार्गेटिंग उपलब्ध है।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/devices

पैरामीटर

Name	Description
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
q optional	टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: apple

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

GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone

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

    {
      "data": [
        {
          "name": "iPhone 3GS",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1q",
          "targeting_type": "DEVICE"
        },
        {
          "name": "iPhone 4",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1r",
          "targeting_type": "DEVICE"
        }
      ],
      "request": {
        "params": {
          "q": "iphone",
          "count": 2
        }
      }
    }

GET targeting_criteria/events

Promoted Products के लिए उपलब्ध इवेंट-आधारित टार्गेटिंग मानदंड खोजें। प्रत्येक line item के लिए केवल एक इवेंट को टार्गेट किया जा सकता है।

नोट: इवेंट अक्सर अलग-अलग timezones में होते हैं, जिससे cross-timezone परिप्रेक्ष्य से इवेंट समयों पर विचार करते समय जटिलताएँ पैदा होती हैं। इसे सरल बनाने के लिए, इस endpoint पर सभी इवेंट start_time और end_time मान UTC±00:00 में दिखाए जाते हैं, चाहे इवेंट का locale और timezone कुछ भी हो। इवेंट start_time और end_time मानों को query करते समय और उनके साथ काम करते समय इस डिज़ाइन को ध्यान में रखें। उदाहरण के लिए, US के Independence Day को UTC±00:00 में start_time=2017-07-04T00:00:00Z और end_time=2017-07-05T00:00:00Z के रूप में दिखाया जाता है, जिससे US के भीतर कई timezones में इस अवकाश के होने से जुड़ी समस्या से बचा जा सके।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/events

पैरामीटर

Name	Description
event_types required	कुछ विशेष इवेंट प्रकारों तक सीमित करने के लिए एक वैकल्पिक query। Type: enum Possible values: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS
count optional	प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
country_codes optional	2-अक्षरीय ISO country code का उपयोग करके टार्गेटिंग मानदंड खोज को विशेष देशों तक सीमित करने के लिए एक वैकल्पिक query। यदि यह पैरामीटर निर्दिष्ट नहीं किया जाता है, तो सभी इवेंट लौटाए जाते हैं। Type: string
cursor optional	results का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
end_time optional	ISO 8601 में व्यक्त वह समय, जब campaign समाप्त होगा। Type: string Example: 2017-10-05T00:00:00Z
start_time optional	ISO 8601 में व्यक्त वह समय, जब line item serve होना शुरू करेगा। नोट: डिफ़ॉल्ट रूप से यह वर्तमान समय होता है। Type: string Example: 2017-07-05T00:00:00Z

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

GET https://ads-api.x.com/12/targeting_criteria/events?count=1

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

    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "New Year's",
          "start_time": "2017-12-31T00:00:00Z",
          "top_users": [],
          "top_tweets": [],
          "top_hashtags": [],
          "gender_breakdown_percentage": {},
          "end_time": "2018-01-02T00:00:00Z",
          "country_code": null,
          "device_breakdown_percentage": {},
          "targeting_value": "1ex",
          "is_global": true,
          "event_type": "HOLIDAY",
          "country_breakdown_percentage": {}
        }
      ],
      "next_cursor": "uww0"
    }

GET targeting_criteria/interests

Promoted Products के लिए उपलब्ध रुचि-आधारित टार्गेटिंग मानदंड खोजें। रुचियां बहुत कम बदलती हैं, हालांकि हम सुझाव देते हैं कि आप इस सूची को कम से कम सप्ताह में एक बार रीफ़्रेश करें।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/interests

पैरामीटर

Name	Description
count optional	प्रत्येक अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
q optional	किसी टार्गेटिंग मानदंड का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: books

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

GET https://ads-api.x.com/12/targeting_criteria/interests?q=books

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

    {
      "data": [
        {
          "name": "Books and literature/Biographies and memoirs",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "books",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

GET targeting_criteria/languages

टार्गेटिंग के लिए उपलब्ध भाषाएँ जानें।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/languages

पैरामीटर

नाम	विवरण
count optional	प्रत्येक अलग अनुरोध में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
q optional	टार्गेटिंग मानदंड को सीमित करने के लिए एक वैकल्पिक query। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Example: english

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

GET https://ads-api.x.com/12/targeting_criteria/languages?q=english

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

    {
      "data": [
        {
          "name": "English",
          "targeting_type": "LANGUAGE",
          "targeting_value": "en"
        }
      ],
      "request": {
        "params": {
          "q": "english"
        }
      },
      "next_cursor": null
    }

GET targeting_criteria/locations

Promoted Products के लिए उपलब्ध लोकेशन-आधारित टार्गेटिंग मानदंड खोजें। Geo-targeting, Promoted Accounts और Promoted Tweets के लिए देश स्तर, राज्य/क्षेत्र स्तर, शहर स्तर और डाक कोड स्तर पर उपलब्ध है। यदि आप डाक कोड स्तर पर analytics प्राप्त करना चाहते हैं, तो आपको डाक कोड टार्गेटिंग का उपयोग करना होगा।

नोट: San Francisco या New York जैसे विशिष्ट targetable शहरों को प्राप्त करने के लिए, location_type request parameter के साथ CITIES enum का उपयोग करें।

Designated Market Areas (DMAs) को target करने के लिए, METROS enum का उपयोग करें।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/locations

पैरामीटर

Name	Description
count optional	प्रत्येक अलग request में प्राप्त करने के लिए प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
country_code optional	2-अक्षरीय ISO country code के साथ targeting criteria search को किसी विशिष्ट देश तक सीमित करने के लिए एक वैकल्पिक query। सभी देशों के लिए results प्राप्त करने हेतु इस parameter को छोड़ दें। Type: string Example: JP
cursor optional	results का अगला पेज प्राप्त करने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
location_type optional	results को किसी विशिष्ट location प्रकार तक सीमित करें। COUNTRIES की तुलना में अधिक granular targeting सभी locations में उपलब्ध नहीं हो सकती। Type: enum Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES
q optional	targeting criteria search को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने हेतु इस parameter को छोड़ दें। Type: string Example: New York

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

GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles

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

    {
      "data": [
        {
          "name": "Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "3b77caf94bfc81fe",
          "targeting_type": "LOCATION"
        },
        {
          "name": "East Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "67571a7baaa5906b",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Lake Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "ea9bfbd43c93400f",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Gatos, San Francisco-Oakland-San Jose CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "a2de7c70b82b0ca0",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Altos, Monterey-Salinas CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "6a4364ea6f987c10",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Banos, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "b1b6fc646de75904",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Alamitos, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "0799ff0a3c1006e9",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Angeles, US",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "019940ae78c7b3bc",
          "targeting_type": "LOCATION"
        }
      ],
      "request": {
        "params": {
          "location_type": "CITIES",
          "q": "los angeles"
        }
      },
      "next_cursor": null
    }

GET targeting_criteria/network_operators

Promoted Products के लिए उपलब्ध network operator-आधारित टार्गेटिंग मानदंड खोजें।

यह endpoint आपको कई देशों में target किए जा सकने वाले carriers, जैसे AT&T, Verizon, Sprint, T-Mobile आदि, खोजने की सुविधा देता है।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/network_operators

पैरामीटर

Name	Description
count optional	प्रत्येक अलग request में प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
country_code optional	2-अक्षरों वाले ISO country code के साथ टार्गेटिंग मानदंड search को किसी खास देश तक सीमित करने के लिए एक वैकल्पिक query। यदि यह parameter निर्दिष्ट नहीं किया जाता है, तो केवल United States के लिए partner audiences लौटाए जाते हैं। Type: string Default: US
cursor optional	results का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
q optional	टार्गेटिंग मानदंड search को सीमित करने के लिए एक वैकल्पिक query। सभी results प्राप्त करने के लिए इस parameter को छोड़ दें। Type: string Examples: Airpeak

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

GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US

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

    {
      "data": [
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Advantage",
          "targeting_value": "2l"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Aeris",
          "targeting_value": "1b"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airadigm",
          "targeting_value": "2t"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airlink PCS",
          "targeting_value": "14"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airpeak",
          "targeting_value": "1i"
        }
      ],
      "request": {
        "params": {
          "country_code": "US",
          "count": 5
        }
      },
      "next_cursor": "o7x9iet1a5u608olj4"
    }

GET targeting_criteria/platform_versions

Promoted Products के लिए उपलब्ध मोबाइल OS संस्करण-आधारित टार्गेटिंग मानदंड देखें। प्लेटफ़ॉर्म वर्शन टार्गेटिंग, Promoted Accounts और Promoted Tweets के लिए उपलब्ध है। इससे मोबाइल ऑपरेटिंग सिस्टम वर्शन के पॉइंट रिलीज़ स्तर तक टार्गेट किया जा सकता है, जैसे Android 8.0 या iOS 10.0।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/platform_versions

पैरामीटर

Name	Description
q वैकल्पिक	टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string उदाहरण: jelly bean

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

GET https://ads-api.x.com/12/targeting_criteria/platform_versions

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

    {
        "data": [
            {...},
            {
                "name": "Ice Cream Sandwich",
                "number": "4.0",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "17"
            },
            {
                "name": "Jelly Bean",
                "number": "4.1",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "18"
            },
            {...}
        ],
        "data_type": "targeting_criterion",
        "request": {
            "params": {}
        }
    }

GET targeting_criteria/platforms

Promoted Products के लिए उपलब्ध प्लैटफ़ॉर्म-आधारित टार्गेटिंग मानदंड खोजें।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/platforms

पैरामीटर

Name	Description
count optional	प्रत्येक अलग-अलग अनुरोध में प्राप्त करने के लिए रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
q optional	टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक query। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Examples: ios, blackberry
lang optional	ISO-639-1 भाषा कोड का उपयोग करें। यह पास किए जाने पर, रिस्पॉन्स में एक अतिरिक्त localized_name attribute लौटाया जाएगा। Type: int, string Example: fr

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

GET https://ads-api.x.com/12/targeting_criteria/platforms

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

    {
      "data": [
        {
          "name": "iOS",
          "targeting_type": "PLATFORM",
          "targeting_value": "0"
        },
        {
          "name": "Android",
          "targeting_type": "PLATFORM",
          "targeting_value": "1"
        },
        {
          "name": "BlackBerry phones and tablets",
          "targeting_type": "PLATFORM",
          "targeting_value": "2"
        },
        {
          "name": "Mobile web on other devices",
          "targeting_type": "PLATFORM",
          "targeting_value": "3"
        },
        {
          "name": "Desktop and laptop computers",
          "targeting_type": "PLATFORM",
          "targeting_value": "4"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_markets

उपलब्ध TV मार्केट खोजें, जहाँ TV शो को लक्षित किया जा सकता है। यह लोकेल के अनुसार ऐसे मार्केट रिटर्न करता है, जिनका उपयोग GET targeting_criteria/tv_shows एंडपॉइंट को क्वेरी करने के लिए किया जा सकता है।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/tv_markets

पैरामीटर

कोई नहीं

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

GET https://ads-api.x.com/12/targeting_criteria/tv_markets

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

    {
      "data": [
        {
          "name": "France",
          "country_code": "FR",
          "locale": "fr-FR"
        },
        {
          "name": "Chile",
          "country_code": "CL",
          "locale": "es-CL"
        },
        {
          "name": "Germany",
          "country_code": "DE",
          "locale": "de-DE"
        },
        {
          "name": "Netherlands",
          "country_code": "NL",
          "locale": "nl-NL"
        },
        {
          "name": "United States",
          "country_code": "US",
          "locale": "en-US"
        },
        {
          "name": "Venezuela",
          "country_code": "VE",
          "locale": "es-VE"
        },
        {
          "name": "Brazil",
          "country_code": "BR",
          "locale": "pt-BR"
        },
        {
          "name": "Mexico",
          "country_code": "MX",
          "locale": "es-MX"
        },
        {
          "name": "Colombia",
          "country_code": "CO",
          "locale": "es-CO"
        },
        {
          "name": "United Kingdom",
          "country_code": "GB",
          "locale": "en-GB"
        },
        {
          "name": "Argentina",
          "country_code": "AR",
          "locale": "es-AR"
        },
        {
          "name": "Japan",
          "country_code": "JP",
          "locale": "ja-JP"
        },
        {
          "name": "Canada",
          "country_code": "CA",
          "locale": "en-CA"
        },
        {
          "name": "Spain",
          "country_code": "ES",
          "locale": "es-ES"
        },
        {
          "name": "Italy",
          "country_code": "IT",
          "locale": "it-IT"
        },
        {
          "name": "United States - Hispanic",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "Ireland",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_shows

Promoted Products के लिए उपलब्ध TV शो-आधारित टार्गेटिंग मानदंड खोजें। TV शो टार्गेटिंग कुछ बाज़ारों में Promoted Tweets के लिए उपलब्ध है। उपलब्ध बाज़ारों के लिए GET targeting_criteria/tv_markets endpoint देखें।

नोट: 1,000 से कम उपयोगकर्ताओं वाले किसी भी audience के लिए estimated_users का मान 1000 दिखाई देगा।

नोट: TV चैनल और शैली-आधारित टार्गेटिंग विकल्प अब समर्थित नहीं हैं।

संसाधन URL

https://ads-api.x.com/12/targeting_criteria/tv_shows

पैरामीटर

Name	Description
locale required	यह एक आवश्यक पैरामीटर है, जो उपलब्ध TV शो के लिए क्वेरी किए जाने वाले tv_market_locale को निर्दिष्ट करता है। TV मार्केट की क्वेरी GET targeting_criteria/tv_markets से लौटाए गए locale के आधार पर की जाती है। Type: string Example: en-US
count optional	प्रत्येक अलग रिक्वेस्ट में प्राप्त करने का प्रयास किए जाने वाले रिकॉर्ड की संख्या निर्दिष्ट करता है। Type: int Default: 50 Min, Max: 1, 50
cursor optional	परिणामों का अगला पेज पाने के लिए एक cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
q optional	टार्गेटिंग मानदंड खोज का दायरा सीमित करने के लिए एक वैकल्पिक क्वेरी। सभी परिणाम प्राप्त करने के लिए इस पैरामीटर को छोड़ दें। Type: string Examples: ios, blackberry

उदाहरण रिक्वेस्ट

GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1

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

    {
      "data": [
        {
          "name": "NewsWatch",
          "targeting_value": 10027243420,
          "genre": "PAID",
          "locales": [
            {
              "language": "en",
              "country": "US"
            }
          ]
        }
      ],
      "next_cursor": "c-22838-zdQDJrTxSvOYfQOhb2IlGQ",
      "request": {
        "params": {
          "locale": {
            "countryCode": "US",
            "languageCode": "en"
          },
          "count": 1,
          "q": "news"
        }
      }
    }

टार्गेटिंग सुझाव

GET accounts/:account_id/targeting_suggestions

अपने शुरुआती चयन के पूरक के रूप में अधिकतम 50 कीवर्ड या उपयोगकर्ता targeting सुझाव प्राप्त करें।

संसाधन URL

https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions

पैरामीटर

नाम	विवरण
account_id required	उपयोग किए जा रहे account का identifier। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
suggestion_type required	लौटाए जाने वाले सुझावों का type निर्दिष्ट करें। Type: enum Possible values: KEYWORD, USER_ID
targeting_values required	सुझाव तैयार करने के आधार के रूप में उपयोग किए जाने वाले कीवर्ड या user IDs का अल्पविराम-से-अलग किया गया संग्रह। नोट: इन दो प्रकार के सुझावों को एक साथ नहीं मिलाया जा सकता। Example: 756201191646691328
count optional	प्रत्येक अलग अनुरोध के लिए प्राप्त करने का प्रयास किए जाने वाले records की संख्या निर्दिष्ट करता है। Type: int Default: 30 Min, Max: 1, 50

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"

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

    {
      "data": [
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "devs"
        },
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "software"
        }
      ],
      "request": {
        "params": {
          "suggestion_type": "KEYWORD",
          "targeting_values": [
            "developers"
          ],
          "count": 2,
          "account_id": "18ce54d4x5t"
        }
      }
    }

कर सेटिंग

GET accounts/:account_id/tax_settings

वर्तमान खाते से संबद्ध कर सेटिंग का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tax_settings

पैरामीटर

नाम	विवरण
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Inc.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

PUT accounts/:account_id/tax_settings

वर्तमान अकाउंट के लिए टैक्स सेटिंग अपडेट करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tax_settings

पैरामीटर

नाम	विवरण
account_id आवश्यक	उपयोग किए जा रहे खाते का पहचानकर्ता। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। प्रकार: string उदाहरण: 18ce54d4x5t
address_city वैकल्पिक	खाता स्वामी के पते का शहर. Type: string उदाहरण: San Francisco
address_country वैकल्पिक	खाते के स्वामी के पते के लिए दो-अक्षरों का देश कोड। Type: string उदाहरण: US
address_email वैकल्पिक	खाता स्वामी के पते से संबद्ध ईमेल पता। Type: string उदाहरण: [e-mail]
address_first_name वैकल्पिक	खाता स्वामी के पते के लिए पहला नाम। Type: string उदाहरण: API
address_last_name वैकल्पिक	खाता स्वामी के पते के लिए अंतिम नाम। Type: string उदाहरण: McTestface
address_name वैकल्पिक	खाता स्वामी के पते के लिए कंपनी का नाम। Type: string उदाहरण: ABC, Co.
address_postal_code वैकल्पिक	खाता स्वामी के पते का पिन कोड। Type: string उदाहरण: 94102
address_region वैकल्पिक	खाता स्वामी के पते का राज्य/क्षेत्र. Type: string उदाहरण: California
address_street1 वैकल्पिक	खाता स्वामी के पते की सड़क पंक्ति। Type: string उदाहरण: 21 March St
address_street2 वैकल्पिक	खाता स्वामी के पते की दूसरी पंक्ति। Type: string उदाहरण: Suite 99
bill_to वैकल्पिक	वह इकाई जिसे शुल्क लगाया जाता है। Type: enum संभावित मान: ADVERTISER, AGENCY
business_relationship वैकल्पिक	क्या खाता विज्ञापनदाता के स्वामित्व में है या एजेंसी के स्वामित्व में। Type: enum संभावित मान: AGENCY, SELF
client_address_city वैकल्पिक	विज्ञापनदाता के पते का शहर। इसे तब सेट करें, जब ads खाता किसी agency के स्वामित्व में हो। Type: string उदाहरण: Toronto
client_address_country वैकल्पिक	विज्ञापनदाता के पते के लिए दो-अक्षरों का देश कोड। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: CA
client_address_email वैकल्पिक	विज्ञापनदाता के पते से संबद्ध ईमेल पता। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: [e-mail]
client_address_first_name वैकल्पिक	विज्ञापनदाता के पते के लिए पहला नाम. इसे तब सेट करें, जब ads account किसी एजेंसी के स्वामित्व में हो. Type: string उदाहरण: Brand
client_address_last_name वैकल्पिक	विज्ञापनदाता के पते के लिए उपनाम। इसे तब सेट करें जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: Advertiser
client_address_name वैकल्पिक	विज्ञापनदाता के पते के लिए कंपनी का नाम। इसे तब सेट करें, जब ads खाता किसी एजेंसी के स्वामित्व में हो। Type: string उदाहरण: Brand, Inc.
client_address_postal_code वैकल्पिक	विज्ञापनदाता के पते का डाक कोड। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: M5H 2N2
client_address_region वैकल्पिक	विज्ञापनदाता के पते का क्षेत्र. इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो. Type: string उदाहरण: Ontario
client_address_street1 वैकल्पिक	विज्ञापनदाता के पते की सड़क वाली पंक्ति। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: 280 Queen St W
client_address_street2 वैकल्पिक	विज्ञापनदाता के पते की दूसरी स्ट्रीट लाइन। इसे तब सेट करें, जब ads account किसी agency के स्वामित्व में हो। Type: string उदाहरण: The 6
invoice_jurisdiction वैकल्पिक	चालान क्षेत्राधिकार. Type: enum संभावित मान: LOI_SAPIN, NONE, NOT_SET
tax_category वैकल्पिक	यह निर्धारित करता है कि कराधान व्यक्तिगत होगा या व्यावसायिक। प्रकार: enum संभावित मान: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL
tax_exemption_id वैकल्पिक	VAT छूट आईडी. प्रकार: sting उदाहरण: 12345
tax_id वैकल्पिक	VAT पंजीकरण आईडी. प्रकार: string संभावित मान: 67890

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.

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

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "address_name": "ABC Co."
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Co.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

ट्रैकिंग टैग्स

GET accounts/:account_id/tracking_tags

वर्तमान अकाउंट से संबद्ध कुछ या सभी ट्रैकिंग टैग का विवरण प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और आमतौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट अकाउंट प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
count optional	प्रति अनुरोध प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या निर्दिष्ट करता है। Type: int Default: 200 Min, Max: 1, 1000
cursor optional	परिणामों का अगला पेज प्राप्त करने के लिए cursor निर्दिष्ट करता है। अधिक जानकारी के लिए Pagination देखें। Type: string Example: 8x7v00oow
line_item_ids optional	अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल उन ट्रैकिंग टैग तक सीमित करें जो विशिष्ट लाइन आइटम्स से संबद्ध हैं। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 96uzp
sort_by optional	समर्थित attribute के अनुसार आरोही या अवरोही क्रम में sort करता है। अधिक जानकारी के लिए Sorting देखें। Type: string Example: created_at-asc
tracking_tag_ids optional	अल्पविराम से अलग किए गए पहचानकर्ताओं की सूची देकर रिस्पॉन्स को केवल इच्छित ट्रैकिंग टैग तक सीमित करें। अधिकतम 200 IDs दिए जा सकते हैं। Type: string Example: 3m82
with_deleted optional	अपने अनुरोध में हटाए गए परिणाम शामिल करें। Type: boolean Default: false Possible values: true, false
with_total_count optional	total_count रिस्पॉन्स attribute शामिल करें। नोट: यह पैरामीटर और cursor एक साथ उपयोग नहीं किए जा सकते। नोट: जिन अनुरोधों में total_count शामिल होता है, उनकी रेट लिमिट्स कम होती हैं, जो वर्तमान में प्रति 15 मिनट 200 पर सेट हैं। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82

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

    {
      "request": {
        "params": {
          "tracking_tag_ids": [
            "3m82"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "fdwcl",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "tracking_tag_type": "IMPRESSION_TAG",
          "id": "3m82",
          "created_at": "2019-06-26T17:04:26Z",
          "updated_at": "2019-06-26T17:04:26Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/tracking_tags/:tracking_tag_id

मौजूदा account से संबद्ध किसी विशिष्ट ट्रैकिंग टैग को प्राप्त करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id

पैरामीटर

Name	Description
account_id required	leveraged account के लिए identifier। यह resource के path में दिखाई देता है और GET accounts को छोड़कर आम तौर पर सभी Advertiser API requests में एक आवश्यक parameter होता है। निर्दिष्ट account, authenticated user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
tracking_tag_id required	उस ट्रैकिंग टैग का reference जिस पर आप request में काम कर रहे हैं। Type: string Example: 555j
with_deleted optional	अपनी request में deleted results शामिल करें। Type: boolean Default: false Possible values: true, false

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j

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

    {
      "request": {
        "params": {
          "with_deleted": true,
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2020-08-13T23:02:03Z",
        "deleted": false
      }
    }

POST accounts/:account_id/tracking_tags

निर्दिष्ट लाइन आइटम के साथ एक ट्रैकिंग टैग संबद्ध करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags

पैरामीटर

Name	Description
account_id required	leveraged account की पहचान। यह रिसोर्स के path में दिखाई देती है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API requests के लिए एक आवश्यक parameter होती है। निर्दिष्ट अकाउंट प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
line_item_id required	request में जिस लाइन आइटम के साथ आप काम कर रहे हैं, उसका एक reference। Type: string Example: 8v7jo
tracking_tag_type required	ट्रैकिंग टैग का type। Type: enum Possible value: IMPRESSION_TAG, CLICK_TRACKER
tracking_tag_url required	tracking partner द्वारा प्रदान किया गया ट्रैकिंग टैग URL। Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

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

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

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

    {
      "request": {
        "params": {
          "line_item_id": "fdwcl",
          "tracking_tag_type": "IMPRESSION_TAG",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2019-06-26T17:04:26Z",
        "deleted": false
      }
    }

PUT accounts/:account_id/tracking_tags/:tracking_tag_id

निर्दिष्ट लाइन आइटम से एक ट्रैकिंग टैग संबद्ध करें।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के path में दिखाई देता है और सामान्यतः GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक पैरामीटर होता है। निर्दिष्ट account प्रमाणीकृत उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
tracking_tag_url required	tracking partner द्वारा प्रदान किया गया ट्रैकिंग टैग URL। Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

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

    {
      "request": {
        "params": {
          "tracking_tag_id": "3m82",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2022-01-26T17:04:26Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/tracking_tags/:tracking_tag_id

निर्दिष्ट लाइन आइटम से ट्रैकिंग टैग का संबंध हटाएँ।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id

पैरामीटर

नाम	विवरण
account_id required	उपयोग किए जा रहे leveraged account का पहचानकर्ता। यह resource के path में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए एक आवश्यक parameter होता है। निर्दिष्ट account प्रमाणीकृत user से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
tracking_tag_id required	request में उपयोग किए जा रहे ट्रैकिंग टैग का reference। Type: string Example: 555j

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

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j

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

    {
      "request": {
        "params": {
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2021-08-29T17:12:58Z",
        "deleted": true
      }
    }

उपयोगकर्ता सेटिंग्स

(https://app.getpostman.com/run-collection/1d12b9fc623b8e149f87)

GET accounts/:account_id/user_settings/:user_id

उपयोगकर्ता सेटिंग्स प्राप्त करता है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id

पैरामीटर

Name	Description
account_id required	leveraged account का पहचानकर्ता। यह रिसोर्स के पाथ में दिखाई देता है और आम तौर पर GET accounts को छोड़कर सभी Advertiser API अनुरोधों के लिए आवश्यक पैरामीटर होता है। निर्दिष्ट खाता ऑथेंटिकेट किए गए उपयोगकर्ता से संबद्ध होना चाहिए। Type: string Example: 18ce54d4x5t
user_id required	उस उपयोगकर्ता का संदर्भ, जिसके साथ आप इस अनुरोध में काम कर रहे हैं। किसी स्क्रीन नाम के लिए उपयोगकर्ता ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long Example: 756201191646691328

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

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328

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

      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
          }
        },
        "data": {
          "notification_email": "[e-mail]",
          "contact_phone": "",
          "contact_phone_extension": ""
        }
      }

PUT accounts/:account_id/user_settings/:user_id

उपयोगकर्ता सेटिंग्स अपडेट करता है। उपयोगकर्ता कॉन्टेक्स्ट आवश्यक है। यह अकाउंट एडमिन के लिए सुलभ नहीं है।

रिसोर्स URL

https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id

पैरामीटर

Name	Description
account_id required	leveraged account का आइडेंटिफ़ायर। यह रिसोर्स के path और GET accounts में दिखाई देता है। निर्दिष्ट account प्रमाणित उपयोगकर्ता से संबद्ध होना चाहिए। Type: string उदाहरण: 18ce54d4x5t
user_id required	उस उपयोगकर्ता का संदर्भ, जिसके साथ आप request में काम कर रहे हैं। किसी screen name के लिए user ID प्राप्त करने हेतु GET users/lookup का उपयोग करें। Type: long उदाहरण: 756201191646691328
notification_email optional	account सूचनाओं के लिए इस्तेमाल किया जाने वाला ईमेल। Type: string उदाहरण: [e-mail]
contact_phone optional	संपर्क फ़ोन नंबर। Type: string उदाहरण: 202-555-0128
contact_phone_extension optional	contact_phone संपर्क नंबर के लिए एक्सटेंशन। Type: string उदाहरण: 1234

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

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='[e-mail]'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"

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

      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
            "notification_email": "[e-mail]",
            "subscribed_campaign_events": [
              "ACCOUNT_PERFORMANCE",
              "PERFORMANCE_IMPROVEMENT"
            ]
          }
        },
        "data": {
          "notification_email": "[e-mail]",
          "contact_phone": "",
          "Contact_phone_extension": ""
        }
      }