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 हेडर के साथ काम करता है. इससे अनुरोध में, parent खाते के लिए आपके क्रेडेंशियल के ऐक्सेस पाथ को तय किया जा सकता है. linked-account हेडर का इस्तेमाल, PartnerLinkService तरीकों के लिए नहीं किया जा सकता.
ऐक्सेस करने के अलग-अलग मामलों के लिए हेडर सेट करने के तरीके के बारे में ज़्यादा जानकारी और निर्देश पाने के लिए, डेस्टिनेशन और हेडर देखें.
फ़िल्टर के नतीजे
किसी खास पार्टनर लिंक को वापस पाने के लिए, अनुरोध के filter फ़ील्ड का इस्तेमाल करें. filter फ़ील्ड एक स्ट्रिंग है. इससे उन शर्तों के सेट के बारे में पता चलता है जिन्हें आपको लागू करना है. साथ ही, यह भी पता चलता है कि एपीआई को AND या OR का इस्तेमाल करके शर्तों को जोड़ना चाहिए या नहीं.
AIP-160: फ़िल्टर करना में, फ़िल्टर करने के विकल्पों और सिंटैक्स के बारे में ज़्यादा जानें.
filter को मालिक के खाते या पार्टनर खाते के account_id का इस्तेमाल करके तय किया जा सकता है:
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 फ़ील्ड शामिल नहीं है, तो इसका मतलब है कि कोई और नतीजा नहीं है.