बोली मैनेजर एपीआई v1.1 से v2 में माइग्रेट करें

हमने मार्च 2022 में, बिड मैनेजर एपीआई का दूसरा वर्शन रिलीज़ किया था. इस नए वर्शन को रिलीज़ करने के बाद, हम v1.1 के लिए जल्द ही बंद होने की तारीख का एलान करेंगे. हमारा सुझाव है कि आप v1.1 से v2 पर, जल्द से जल्द अपना माइग्रेशन शुरू करें.

अपना ऐप्लिकेशन माइग्रेट करना

वर्शन 1.1 से v2 पर माइग्रेट करने के लिए, आपके एंडपॉइंट यूआरएल को वर्शन 2 पर कॉल करने और बदलाव करने के लिए आपके ऐप्लिकेशन को अपडेट करने की ज़रूरत होगी.

अपने एपीआई कॉल को v1.1 से v2 में अपडेट करें

v1.1 के बजाय v2 का इस्तेमाल करने के लिए, आपको नए v2 एंडपॉइंट का इस्तेमाल करने के लिए अपने अनुरोध अपडेट करने होंगे.

मिलते-जुलते तरीके पहचानें

अपने एपीआई कॉल को v1.1 से v2 में अपडेट करने के लिए, आपको पहले इसके v2 वर्शन में इससे मिलते-जुलते v1.1 तरीकों की पहचान करनी होगी.

वर्शन 1.1 और v2 के बीच सभी सेवाओं और तरीकों के ये नाम थोड़े बदल गए हैं:

नए एंडपॉइंट पर अपडेट करें

मिलते-जुलते तरीकों की पहचान करने के बाद, आपको अपने अनुरोध अपडेट करने होंगे. उदाहरण के लिए, v1.1 वाले queries.getquery तरीके को कॉल करने के लिए, आप इस यूआरएल का इस्तेमाल करेंगे:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

वर्शन 2 में, queries.get नाम के मिलते-जुलते तरीके को कॉल करने के लिए, यूआरएल को नीचे दिए गए तरीके से अपडेट करें:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

अगर आप एपीआई के लिए अनुरोध करने के लिए क्लाइंट लाइब्रेरी का इस्तेमाल कर रहे हैं, तो क्लाइंट लाइब्रेरी का सबसे नया वर्शन इस्तेमाल करें और वर्शन 2 को इस्तेमाल करने के लिए कॉन्फ़िगरेशन को अपडेट करें.

ज़रूरी बदलाव करें

वर्शन 2 में, हम कई नुकसान पहुंचा सकने वाले बदलाव पेश कर रहे हैं. नीचे दिए गए निर्देशों की समीक्षा करें और बिडिंग मैनेजर एपीआई के मौजूदा इस्तेमाल से जुड़े ज़रूरी बदलाव करें.

queries सेवा के लिए कॉल अपडेट करें

  • आम तौर पर नेस्ट किए गए ऑब्जेक्ट से जुड़े, Query संसाधन में ये फ़ील्ड बदल गए हैं. ये ऑब्जेक्ट, नीचे दिए गए ऑब्जेक्ट टाइप का इस्तेमाल करते हैं:
    वर्शन 1.1 फ़ील्डइसके बराबर का v2 ऑब्जेक्ट टाइप
    metadata QueryMetadata
    params Parameters
    params.options Options
    params.options.pathQueryOptions PathQueryOptions
    params.options.pathQueryOptions.channelGrouping ChannelGrouping
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter PathQueryOptionsFilter
    params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter PathQueryOptionsFilter
    schedule QuerySchedule
  • Query संसाधन में मौजूद नीचे दिए गए फ़ील्ड, जिन्हें आम तौर पर सामान्य सूची ऑब्जेक्ट से दिखाया जाता है, उन्हें नीचे दिए गए नए ऑब्जेक्ट की सूची में बदल दिया गया है:
    v1.1 सूची फ़ील्डवर्शन 2 ऑब्जेक्ट प्रकार
    params.filters[] FilterPair
    params.options.pathQueryOptions.channelGrouping.rules[] Rule
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] DisjunctiveMatchStatement
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] EventFilter
    params.options.pathQueryOptions.pathFilters[] PathFilter
    params.options.pathQueryOptions.pathFilters[].eventFilters[] EventFilter
  • Query रिसॉर्स के इन फ़ील्ड को मूल रूप से स्ट्रिंग से दिखाया जाता है. इन्हें v2 में enum टाइप के ज़रिए दिखाया जाता है. इनमें ये बदलाव शामिल होते हैं:
    • metadata.dataRange के वर्शन 2 के बराबर, अब Range ईनम का इस्तेमाल किया गया है. इस ईनम में बदलने के लिए, PREVIOUS_HALF_MONTH की वैल्यू हटा दी गई है और TYPE_NOT_SUPPORTED की वैल्यू को बदलकर RANGE_UNSPECIFIED कर दिया गया है.
    • metadata.format अब Format ईनम का इस्तेमाल करता है. इस ईनम में, EXCEL_CSV वैल्यू को हटा दिया गया है और FORMAT_UNSPECIFIED वैल्यू को जोड़ा गया है.
    • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match और params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match अब Match ईनम का इस्तेमाल करें.
    • अब params.options.pathQueryOptions.pathFilters[].pathMatchPositionPathMatchPosition ईनम का इस्तेमाल करता है. इस ईनम में बदलकर, PATH_MATCH_POSITION_UNSPECIFIED वैल्यू जोड़ दी गई है.
    • schedule.frequency अब Frequency ईनम का इस्तेमाल करता है. इस ईनम में बदलकर, FREQUENCY_UNSPECIFIED वैल्यू जोड़ दी गई है.
    • params.type अब ReportType ईनम का इस्तेमाल करता है. इस ईनम में बदलाव करते हुए, ये बदलाव किए गए हैं:
    • इन वैल्यू को बंद कर दिया गया है:
      • TYPE_ACTIVE_GRP
      • TYPE_AUDIENCE_PERFORMANCE
      • TYPE_CLIENT_SAFE
      • TYPE_COMSCORE_VCE
      • TYPE_CROSS_FEE
      • TYPE_CROSS_PARTNER
      • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
      • TYPE_ESTIMATED_CONVERSION
      • TYPE_FEE
      • TYPE_KEYWORD
      • TYPE_LINEAR_TV_SEARCH_LIFT
      • TYPE_NIELSEN_AUDIENCE_PROFILE
      • TYPE_NIELSEN_DAILY_REACH_BUILD
      • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
      • TYPE_PAGE_CATEGORY
      • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
      • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
      • TYPE_PIXEL_LOAD
      • TYPE_THIRD_PARTY_DATA_PROVIDER
      • TYPE_TRUEVIEW_IAR
      • TYPE_VERIFICATION
      • TYPE_YOUTUBE_VERTICAL
    • बची हुई वैल्यू को अपडेट किया गया है, ताकि वे यूज़र इंटरफ़ेस (यूआई) में उनके बराबर वैल्यू को बेहतर तरीके से दिखा सकें:
      v1.1 मानReportType के बराबर वैल्यू
      TYPE_NOT_SUPPORTED REPORT_TYPE_UNSPECIFIED
      TYPE_GENERAL STANDARD
      TYPE_INVENTORY_AVAILABILITY INVENTORY_AVAILABILITY
      TYPE_AUDIENCE_COMPOSITION AUDIENCE_COMPOSITION
      TYPE_ORDER_ID FLOODLIGHT
      TYPE_TRUEVIEW YOUTUBE
      TYPE_NIELSEN_SITE GRP
      TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE YOUTUBE_PROGRAMMATIC_GUARANTEED
      TYPE_REACH_AND_FREQUENCY REACH
      TYPE_REACH_AUDIENCE UNIQUE_REACH_AUDIENCE
      TYPE_PATH FULL_PATH
      TYPE_PATH_ATTRIBUTION PATH_ATTRIBUTION
  • फ़ील्ड metadata.dataRange, reportDataStartTimeMs, और reportDataEndTimeMs को फ़ील्ड range, customStartDate, और customEndDate से बदल दिया गया है. तारीख के नए फ़ील्ड, Unix Epoch के बाद से मिलीसेकंड के बजाय Date ऑब्जेक्ट का इस्तेमाल करते हैं. इन बदले गए फ़ील्ड को QueryMetadata ऑब्जेक्ट में dataRange फ़ील्ड को असाइन किए गए DataRange ऑब्जेक्ट में ले जाया गया है.
  • फ़ील्ड schedule.startTimeMs और schedule.endTimeMs को QuerySchedule ऑब्जेक्ट के फ़ील्ड startDate और endDateसे बदल दिया गया है. तारीख के नए फ़ील्ड, Unix Epoch के बाद से मिलीसेकंड के बजाय Date ऑब्जेक्ट का इस्तेमाल करते हैं.
  • फ़ील्ड metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport, और metadata.latestReportRunTimeMs हटा दिए गए हैं. किसी क्वेरी के लिए हाल ही में जनरेट की गई रिपोर्ट से जुड़ी जानकारी को "key.reportId ब्यौरा" के orderBy क्वेरी पैरामीटर के साथ queries.reports.list तरीके का इस्तेमाल करके वापस लाया जाना चाहिए. इससे यह गारंटी मिलेगी कि अनुरोध में सबसे हाल ही की रिपोर्ट शामिल हैं.
  • फ़ील्ड kind, timezoneCode, metadata.locale, params.includeInviteData, और schedule.nextRunMinuteOfDay हटा दिए गए हैं.
  • queries.create बनाने के बाद, क्वेरी अपने-आप नहीं चलती और asynchronous क्वेरी पैरामीटर हटा दिया गया. नई क्वेरी की रिपोर्ट जनरेट करने के लिए, queries.create के बाद queries.run को कॉल करें.
  • queries.run का तरीका इन तरीकों से अपडेट किया गया है:
    • asynchronous क्वेरी पैरामीटर को synchronous क्वेरी पैरामीटर से बदल दिया गया है. नया क्वेरी पैरामीटर, ववर्स लॉजिक के साथ काम करता है और अगर बताया नहीं गया है, तो इसे 'गलत' माना जाता है. इसे देखकर, queries.run सिंक करने के बजाय v2 में डिफ़ॉल्ट रूप से एसिंक्रोनस तरीके से रिपोर्ट जनरेट होती हैं, जो v1.1 में डिफ़ॉल्ट है.
    • अनुरोध के मुख्य हिस्से को अपडेट करके, timezoneCode फ़ील्ड को हटाया गया और dataRange, reportDataStartTimeMs, reportDataEndTimeMs फ़ील्ड की जगह DataRange वाले फ़ील्ड का इस्तेमाल किया गया. ऐसा dataRange फ़ील्ड के लिए किया गया.
    • इस तरीके से, जवाब के मुख्य हिस्से के बजाय, Report ऑब्जेक्ट दिखता है.
  • queries.list जवाब के मुख्य भाग का kind फ़ील्ड हटा दिया गया है.

reports सेवा के लिए कॉल अपडेट करें

गड़बड़ी हैंडलिंग लॉजिक को अपडेट करें

वर्शन 2 में, पूरे एपीआई में गड़बड़ी के मैसेज अपडेट कर दिए गए हैं. गड़बड़ी के ये नए मैसेज ज़्यादा सटीक होते हैं. कुछ मामलों में, एपीआई अनुरोध की वैल्यू के बारे में जानकारी दी जाती है. इस वजह से गड़बड़ी मिलती है. अगर आपकी गड़बड़ी को मैनेज करने का मौजूदा तरीका, गड़बड़ी के मैसेज के लिए किसी खास टेक्स्ट पर निर्भर करता है, तो वर्शन 2 पर माइग्रेट करने से पहले, गड़बड़ी को मैनेज करना न भूलें.