इस्तेमाल करने का तरीका

इस पेज पर, एपीआई का इस्तेमाल करके सामान्य टास्क करने का तरीका बताया गया है.

उपयोगकर्ता बनाना

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

1. [e-mail] जैसे कुछ नए Gmail पते बनाएं. इसके अलावा, Gmail के अलावा किसी मौजूदा पते को नए Google खाते के तौर पर रजिस्टर किया जा सकता है.
2. createUsers को उस नए पते और चुने गए Role पर कॉल करें.
3. OAuth 2.0 का इस्तेमाल करके, उस नए उपयोगकर्ता के तौर पर पुष्टि की जा सकती है जिसका इस्तेमाल करके अपना ऐक्सेस टोकन जनरेट किया जा सकता है.

रूट विज्ञापन यूनिट हासिल करना

आपके खाते के टाइप (छोटा कारोबार या प्रीमियम) के आधार पर, सबसे ऊपर AdUnit, दोनों में चाइल्ड नोड जोड़े जा सकते हैं. साथ ही, हैरारकी की लेवल की अनुमति भी आपके खाते के टाइप पर निर्भर करती है. अपने चाइल्ड नोड में बदलाव करने की सुविधा देने वाले सबसे ऊपरी AdUnit को असरदार रूट AdUnit कहा जाता है.

असरदार रूट को वापस पाने के लिए, NetworkService.getCurrentNetwork() को कॉल करें और मिले Network ऑब्जेक्ट पर effectiveRootAdUnitId फ़ील्ड की जांच करें.

ध्यान दें: अलग-अलग तरह के खाते में, अलग-अलग क्रम के पैटर्न काम करते हैं.

किसी ऑब्जेक्ट के बारे में क्वेरी करना

कई सेवाओं के ज़रिए एक्सपोज़ किए गए getObjectsByStatement() तरीके का इस्तेमाल करके, खोज के लिए शर्तों के हिसाब से ऑब्जेक्ट खोजे जाते हैं. इसमें ऑब्जेक्ट एक खास तरह का ऑब्जेक्ट है. यह तरीका एक PQL क्वेरी लेता है, जो किसी एसक्यूएल क्वेरी से मिलती-जुलती है. इससे खोज करने के लिए फ़ील्ड तय किए जा सकते हैं (जहां फ़ील्ड के नाम ऑब्जेक्ट पर प्रॉपर्टी से मैप होते हैं), खोज के नतीजों को क्रम से लगा सकते हैं, सीमित कर सकते हैं, और उन्हें ऑफ़सेट कर सकते हैं. पीक्यूएल के बारे में ज़्यादा जानने के लिए, पीक्यूएल गाइड देखें. साथ ही, यह भी जानें कि ऑब्जेक्ट के किन फ़ील्ड के हिसाब से फ़िल्टर किया जा सकता है.

ऑर्डर बनाना

ऑर्डर बनाने के लिए, बस एक Order ऑब्जेक्ट बनाएं. इसके बाद, सही उपयोगकर्ताओं के लिए विज्ञापन देने वाले, सेल्सपर्सन, और ट्रैफ़िकर आईडी सेट करें, उन्हें यूनीक नाम असाइन करें, और createOrders() को कॉल करें. नतीजे में, नया बनाया गया Order या कोई गड़बड़ी शामिल होगी.

उदाहरण

ऑर्डर बनाने के लिए JavaScript कोड का उदाहरण देखें.

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

नया लाइन आइटम बनाने का तरीका यहां बताया गया है:

1. कोई नया Order ऑब्जेक्ट बनाएं या पहले से मौजूद ऑब्जेक्ट का इस्तेमाल करें.
2. नया LineItem ऑब्जेक्ट बनाएं. साथ ही, रोटेशन टाइप, क्रिएटिव साइज़ का कलेक्शन, शुरू और खत्म होने की तारीख, और अन्य प्रॉपर्टी सेट करें.
3. एक नया InventoryTargeting ऑब्जेक्ट बनाएं. साथ ही, यह जानकारी दें कि किन Placement या AdUnit ऑब्जेक्ट को टारगेट करना है या बाहर रखना है.
4. अपने InventoryTargeting ऑब्जेक्ट को किसी नए Targeting ऑब्जेक्ट में रैप करें और इसे LineItem की टारगेटिंग प्रॉपर्टी को असाइन करें.
5. अपने नए ऑब्जेक्ट के साथ, लाइनआइटम सेवा के तरीके createLineItems() को कॉल करें. साथ ही, नतीजे की जांच करके देखें कि आपका ऑब्जेक्ट बनाया गया था या नहीं.

उदाहरण

लाइन आइटम बनाने के लिए JavaScript कोड का उदाहरण देखें.

क्रिएटिव बनाना

अलग-अलग तरह के क्रिएटिव अलग-अलग कॉम्पोनेंट के साथ काम करते हैं: उदाहरण के लिए, एक इमेज क्रिएटिव, किसी इमेज के लिए एक ही सोर्स फ़ाइल के साथ काम करता है; फ़्लैश क्रिएटिव दो बुनियादी एसेट फ़ाइलों के साथ काम करता है: फ़्लैश फ़ाइल और बैकअप इमेज फ़ाइल, फ़्लैश फ़ाइल के पेश न होने पर. तीसरे पक्ष की साइटों पर होस्ट किए गए क्रिएटिव के लिए, आपको सिर्फ़ ऐसा एचटीएमएल स्निपेट अपलोड करना होगा जो तीसरे पक्ष के सर्वर की फ़ाइल से जुड़ा हो. अपनी खास Creative सब-क्लास देखें और जानें कि अपना क्रिएटिव बनाने के लिए, आपको किन ऐसेट को अपलोड करना होगा.

उदाहरण

इमेज क्रिएटिव बनाने के लिए JavaScript कोड का उदाहरण देखें.

मौजूदा ऑब्जेक्ट में बदलाव करना

किसी मौजूदा ऑब्जेक्ट में बदलाव करने के लिए, getObjectsByStatement() को कॉल करके अपने ऑब्जेक्ट के लिए क्वेरी करें. इसके बाद, लौटाए गए ऑब्जेक्ट की वैल्यू अपडेट करें और फिर updateObjects() को कॉल करें.

ध्यान दें: अपडेट किए गए ऑब्जेक्ट, मौजूदा ऑब्जेक्ट की जगह ले लेंगे. इसलिए, अगर आपने भेजे जाने वाले ऑब्जेक्ट में प्रॉपर्टी की वैल्यू सेट नहीं की है, तो सेव किए गए ऑब्जेक्ट को उस प्रॉपर्टी के लिए डिफ़ॉल्ट वैल्यू मिलेगी, न कि पिछली वैल्यू.

ऑब्जेक्ट की स्थिति बदलना

आपकी सेवा के ज़रिए दिखाए गए performObjectAction() तरीके को कॉल करने पर, ऑब्जेक्ट की स्थिति बदल जाती है. इस तरीके में दो पैरामीटर लगते हैं:

• ऐक्शन ऑब्जेक्ट का एक इंस्टेंस, जो बताता है कि आपको क्या करना है. उदाहरण के लिए, ऑर्डर सेवा में कई कार्रवाइयां दिखती हैं. इनमें ApproveOrders, PauseOrders, और ArchiveOrders शामिल हैं. कार्रवाई से जुड़े सभी ऑब्जेक्ट, बुनियादी कार्रवाई की क्लास से लिए जाते हैं. ये आपकी सेवा के लिए सही होती हैं.
• पीक्यूएल क्वेरी, जिससे पता चलता है कि कौनसे ऑब्जेक्ट बदलने हैं. एक बार में एक या इससे ज़्यादा ऑब्जेक्ट के स्टेटस में बदलाव किया जा सकता है. इसके लिए, PQL स्टेटमेंट तय किया जा सकता है.

विज्ञापन टैग जनरेट करना

एपीआई का इस्तेमाल करके विज्ञापन टैग जनरेट नहीं किए जा सकते. इसके बजाय, आपको Google Ad Manager की वेबसाइट का इस्तेमाल करना होगा. ज़्यादा जानकारी के लिए, टैग करना सहायता केंद्र सेक्शन देखें.

ज़्यादा उदाहरण

हमारी क्लाइंट लाइब्रेरी सैंपल कोड में, आपको अलग-अलग प्रोग्रामिंग भाषाओं में दिए गए ऐसे और उदाहरण मिल सकते हैं. अपनी प्रोग्रामिंग भाषा में उदाहरणों के लिंक के लिए, क्लाइंट लाइब्रेरी और उदाहरण कोड पेज देखें.