इस गाइड में, सभी एपीआई कॉल के सामान्य स्ट्रक्चर के बारे में बताया गया है.
अगर एपीआई का इस्तेमाल करने के लिए क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो आपको हमें दिए गए अनुरोध की जानकारी के बारे में ज़्यादा जानने की ज़रूरत नहीं है. हालांकि, इनके बारे में थोड़ी-बहुत जानकारी हासिल करने से, जांच और डीबग करने में मदद मिल सकती है.
Google Ads API एक gRPC API है, जिसमें REST बाइंडिंग. इसका मतलब है कि एपीआई को कॉल करने के दो तरीके हैं.
[Preferred] अनुरोध का मुख्य हिस्सा, प्रोटोकॉल बफ़र का इस्तेमाल करके सर्वर पर भेजें एचटीटीपी/2, प्रोटोकॉल के रिस्पॉन्स को डीसीरियलाइज़ करें बफ़र करें और नतीजों को समझें. हमारे ज़्यादातर दस्तावेज़ों में बताया गया है कि जीआरपीसी.
[ज़रूरी नहीं] अनुरोध का मुख्य हिस्सा, JSON ऑब्जेक्ट को कॉपी करने के लिए, इसे एचटीटीपी 1.1 का इस्तेमाल करके सर्वर पर भेजें, रिस्पॉन्स को JSON ऑब्जेक्ट के तौर पर डीसीरियलाइज़ (पार्स) करके, नतीजों को समझें. इससे संदर्भ लें इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, REST इंटरफ़ेस गाइड आराम
संसाधनों के नाम
एपीआई में मौजूद ज़्यादातर ऑब्जेक्ट की पहचान, संसाधन के नाम वाली स्ट्रिंग से की जाती है. ये REST इंटरफ़ेस का इस्तेमाल करते समय, स्ट्रिंग यूआरएल के तौर पर भी काम करती हैं. REST देखें संसाधनों के नाम को प्रोसेस कर दिया है, स्ट्रक्चर.
कंपोज़िट आईडी
अगर किसी ऑब्जेक्ट का आईडी, ग्लोबल तौर पर यूनीक नहीं है, तो उस ऑब्जेक्ट के लिए एक कंपोज़िट आईडी यह अपने पैरंट आईडी और टिल्ड (~) से पहले दिखता है.
उदाहरण के लिए, विज्ञापन ग्रुप का विज्ञापन आईडी पूरी दुनिया में यूनीक नहीं होता, इसलिए हम पैरंट ऑब्जेक्ट (विज्ञापन ग्रुप) आईडी से एक यूनीक कंपोज़िट आईडी बनाता है:
123काAdGroupId+45678का~+AdGroupAdId= मिश्रित विज्ञापन123~45678का ग्रुप विज्ञापन आईडी.
अनुरोध के हेडर
ये एचटीटीपी हेडर (या grpc) हैं मेटाडेटा) जो साथ में अनुरोध में मौजूद मुख्य हिस्सा:
अनुमति देना
आपको इस रूप में OAuth2 ऐक्सेस टोकन को शामिल करना होगा:
Authorization: Bearer YOUR_ACCESS_TOKEN, जो
क्लाइंट या विज्ञापन देने वाले किसी व्यक्ति या कंपनी की तरफ़ से काम करने वाला मैनेजर खाता
खुद ही मैनेज करती हैं. ऐक्सेस टोकन वापस पाने के लिए निर्देश
OAuth2 गाइड में देखा जा सकता है. अगर आप
ऐक्सेस टोकन पाने के एक घंटे बाद तक, वह मान्य होता है; यह कब होगा
की समयसीमा खत्म हो जाती है, तो नया टोकन पाने के लिए ऐक्सेस टोकन को रीफ़्रेश करें. ध्यान दें कि
हमारी क्लाइंट लाइब्रेरी उन टोकन को अपने-आप रीफ़्रेश करती है जिनकी समयसीमा खत्म हो चुकी है.
developer-token
डेवलपर टोकन एक 22-वर्ण की स्ट्रिंग होती है, जो
Google Ads API डेवलपर. डेवलपर टोकन स्ट्रिंग का एक उदाहरण यह है
ABcdeFGH93KL-NOPQ_STUv. डेवलपर टोकन इसमें शामिल होना चाहिए
developer-token : ABcdeFGH93KL-NOPQ_STUv का फ़ॉर्म.
login-customer-id
यह उस ग्राहक का ग्राहक आईडी है जिसे अनुरोध में इस्तेमाल करने की अनुमति है,
हाइफ़न के बिना (-). अगर ग्राहक खाते तक आपको
है, तो यह हेडर ज़रूरी है और इसे इस ग्राहक आईडी पर सेट किया जाना चाहिए:
मैनेजर खाते से लिंक कर सकते हैं.
https://googleads.googleapis.com/v17/customers/1234567890/campaignBudgets:mutate
login-customer-id को सेट करना,
साइन इन करने या सबसे ऊपर अपनी प्रोफ़ाइल इमेज पर क्लिक करने के बाद, Google Ads के यूज़र इंटरफ़ेस (यूआई) की इमेज
दाईं ओर. अगर आप इस हेडर को शामिल नहीं करते हैं, तो यह डिफ़ॉल्ट रूप से ऑपरेटिंग
ग्राहक.
linked-customer-id
इस हेडर का इस्तेमाल तीसरे पक्ष के ऐप्लिकेशन के आंकड़े देने वाली कंपनियां सिर्फ़ तब करती हैं, जब लिंक किए गए Google Ads में कन्वर्ज़न अपलोड करना जोड़ें.
उस स्थिति के बारे में सोचें जिसमें A खाते के उपयोगकर्ता, पढ़ने और बदलाव करने का ऐक्सेस देते हैं
इसकी इकाइयों को B खाते के लिए
ThirdPartyAppAnalyticsLink.
लिंक होने के बाद, B खाते का उपयोगकर्ता, A खाते के लिए एपीआई कॉल कर सकता है,
लिंक से मिली अनुमतियों के हिसाब से सही होती है. इस मामले में, API-कॉलिंग
A खाते की अनुमतियां B खाते से जुड़े तीसरे पक्ष के लिंक के ज़रिए तय की जाती हैं,
का इस्तेमाल नहीं करेगा.
तीसरे पक्ष की ऐप्लिकेशन एनालिटिक्स सेवा देने वाली कंपनी, एपीआई कॉल इस तरह करती है:
linked-customer-id: अपलोड करने वाला तीसरे पक्ष के ऐप्लिकेशन का एनालिटिक्स खाता डेटा (खाताB).customer-id: वह Google Ads खाता, जिसमें डेटा अपलोड किया गया है (खाताA).login-customer-idऔरAuthorizationहेडर: इसके लिए वैल्यू का कॉम्बिनेशन उस उपयोगकर्ता की पहचान करेगा जिसके पासBखाते का ऐक्सेस है.
रिस्पॉन्स हेडर
यहां दिए गए हेडर (या grpc ट्रेलिंग-मेटाडेटा) जवाब के मुख्य हिस्से के साथ लौटाए जाते हैं. हमारा सुझाव है कि आप इन्हें लॉग कर लें डीबग करने के लिए वैल्यू.
अनुरोध-आईडी
request-id एक ऐसी स्ट्रिंग है जिससे इस अनुरोध की खास तौर पर पहचान की जाती है.