SearchPartnerLinksRequest भेजकर, PartnerLink संसाधन वापस पाएं.
अनुरोध का parent फ़ील्ड ज़रूरी है. parent को किसी खाते के संसाधन के नाम पर सेट करें. इसके लिए, इस फ़ॉर्मैट का इस्तेमाल करें:
accountTypes/{account_type}/accounts/{account}
SearchPartnerLinksResponse में, इस्तेमाल के अलग-अलग तरीकों के लिए सभी PartnerLink संसाधन शामिल होते हैं. इनमें अनुरोध में मौजूद parent, इनमें से कोई एक होता है:
owner_accountफ़ील्ड से पहचाना गया खाताpartner_accountफ़ील्ड से पहचाना गया खाता
अगर parent खाते को पार्टनर लिंक, पैरंट Google Ads मैनेजर खाते या पैरंट Display & Video 360 पार्टनर खाते का इस्तेमाल करके ऐक्सेस किया जा रहा है, तो अनुरोध हेडर सेट करें.
नतीजों को फ़िल्टर करें, ताकि जवाब में सिर्फ़ खास एट्रिब्यूट वाले संसाधन शामिल हों.
Search तरीके से, नतीजों के पेज दिखाए जाते हैं. किसी अनुरोध के लिए सभी संसाधन वापस पाने के लिए, next_page_token और नतीजों को पेज में बांटें को देखें.
अनुरोध के हेडर सेट करना
Search तरीके में, login-account और linked-account हेडर काम करते हैं. इनकी मदद से, अनुरोध में parent खाते के क्रेडेंशियल का ऐक्सेस पाथ तय किया जाता है. अलग-अलग ऐक्सेस के लिए हेडर सेट करने के बारे में जानकारी और निर्देश पाने के लिए, डेस्टिनेशन और हेडर देखें.
फ़िल्टर के नतीजे
किसी खास पार्टनर लिंक को वापस पाने के लिए, अनुरोध के filter फ़ील्ड का इस्तेमाल करें. filter फ़ील्ड एक स्ट्रिंग है. यह उन शर्तों के सेट के बारे में बताती है जिन्हें आपको लागू करना है. साथ ही, यह भी बताती है कि एपीआई को AND या OR का इस्तेमाल करके शर्तों को जोड़ना चाहिए या नहीं.
AIP-160: फ़िल्टर करना में, फ़िल्टर करने के विकल्पों और सिंटैक्स के बारे में ज़्यादा पढ़ें.
मालिक के खाते या पार्टनर खाते के account_id का इस्तेमाल करके, filter को तय किया जा सकता है:
owning_account.account_id: मालिकाना हक वाले खाते काaccount_id.partner_account.account_id: पार्टनर खाते काaccount_id.
उदाहरण के लिए, यहां एक filter दिया गया है. यह उन सभी पार्टनर लिंक को दिखाता है जिनमें मालिक खाते का आईडी OWNING_ACCOUNT_ID है:
owning_account.account_id = OWNING_ACCOUNT_ID
यहां filter का एक और उदाहरण दिया गया है. इससे उन सभी पार्टनर लिंक की जानकारी मिलती है जिनमें मालिक खाते का आईडी OWNING_ACCOUNT_ID है या पार्टनर खाते का आईडी PARTNER_ACCOUNT_ID है:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
OR के बजाय AND का इस्तेमाल करने के लिए, उस filter में बदलाव करने से, पार्टनर लिंक किए गए सिर्फ़ वे संसाधन दिखते हैं जिनमें मालिक के खाते का आईडी OWNING_ACCOUNT_ID और पार्टनर खाते का आईडी PARTNER_ACCOUNT_ID दोनों मौजूद हैं:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
नतीजों को पेजों में बांटना
page_size फ़ील्ड का इस्तेमाल करके, यह कंट्रोल किया जा सकता है कि एक जवाब में कितने नतीजे दिखाए जाएं. उदाहरण के लिए, अगर आपने page_size को 10 पर सेट किया है, तो एपीआई हर जवाब में ज़्यादा से ज़्यादा 10 नतीजे दिखाएगा. ऐसा हो सकता है कि आपके अनुरोध से मेल खाने वाले नतीजों की संख्या 10 से कम हो. ऐसे में, एपीआई 10 से कम नतीजे दिखाएगा.
डिफ़ॉल्ट page_size वैल्यू 50 होती है और ज़्यादा से ज़्यादा वैल्यू 1,000 होती है.
अगर एक जवाब में ज़्यादा नतीजे नहीं दिखाए जा सकते, तो जवाब में next_page_token शामिल होगा. अगला पेज या नतीजों का सेट पाने के लिए, page_token फ़ील्ड को इस वैल्यू पर सेट करके, उसी अनुरोध को फिर से भेजें. अन्य सभी पैरामीटर, पिछले अनुरोध के जैसे ही होने चाहिए.
अगर जवाब में next_page_token फ़ील्ड शामिल नहीं है, तो इसका मतलब है कि अब कोई और नतीजा नहीं है.