বিড ম্যানেজার API v1.1 থেকে v2 তে স্থানান্তর করুন

২০২২ সালের মার্চ মাসে আমরা বিড ম্যানেজার এপিআই-এর ভার্সন ২ প্রকাশ করেছি। এই নতুন সংস্করণটি প্রকাশের পরিপ্রেক্ষিতে, আমরা শীঘ্রই v1.1-এর কার্যক্রম বন্ধের তারিখ ঘোষণা করার পরিকল্পনা করছি। আমরা আপনাকে যত দ্রুত সম্ভব v1.1 থেকে v2-তে মাইগ্রেশন শুরু করার পরামর্শ দিচ্ছি।

আপনার অ্যাপ্লিকেশনটি স্থানান্তর করুন

v1.1 থেকে v2-তে স্থানান্তরিত হতে হলে, আপনার এন্ডপয়েন্ট URL-গুলিকে v2 কল করার জন্য আপডেট করতে হবে এবং ব্রেকিং চেঞ্জগুলির সাথে সামঞ্জস্য রেখে আপনার অ্যাপ্লিকেশনটিও আপডেট করতে হবে।

আপনার API কলগুলো v1.1 থেকে v2 তে আপডেট করুন।

v1.1-এর পরিবর্তে v2 ব্যবহার করতে হলে, আপনাকে নতুন v2 এন্ডপয়েন্টগুলো ব্যবহারের জন্য আপনার রিকোয়েস্টগুলো আপডেট করতে হবে।

সমতুল্য পদ্ধতি শনাক্ত করুন

আপনার এপিআই কলগুলোকে v1.1 থেকে v2-তে আপডেট করতে হলে, আপনাকে প্রথমে v2-তে v1.1-এর সমতুল্য মেথডগুলো শনাক্ত করতে হবে।

v1.1 এবং v2 এর মধ্যে নিম্নলিখিত সমস্ত পরিষেবা এবং পদ্ধতির নামগুলিতে সামান্য পরিবর্তন হয়েছে:

নতুন এন্ডপয়েন্টগুলিতে আপডেট করুন

একবার আপনি সমতুল্য পদ্ধতিগুলো শনাক্ত করে ফেললে, আপনাকে আপনার অনুরোধগুলো আপডেট করতে হবে। উদাহরণস্বরূপ, v1.1 দিয়ে queries.getquery পদ্ধতিটি কল করতে, আপনাকে নিম্নলিখিত URL-টি ব্যবহার করতে হবে:

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

v2-তে queries.get নামে পরিচিত সমতুল্য মেথডটি কল করতে, URL-টি নিম্নলিখিতভাবে আপডেট করুন:

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

আপনি যদি এপিআই-তে অনুরোধ পাঠানোর জন্য কোনো ক্লায়েন্ট লাইব্রেরি ব্যবহার করে থাকেন, তাহলে ক্লায়েন্ট লাইব্রেরির সর্বশেষ সংস্করণটি ব্যবহার করুন এবং আপনার কনফিগারেশনটি v2 ব্যবহারের জন্য আপডেট করুন।

প্রয়োজনীয় পরিবর্তন করুন

আমরা v2-তে বেশ কিছু বড় ধরনের পরিবর্তন আনছি। নিচের নির্দেশাবলী পর্যালোচনা করুন এবং আপনার বিড ম্যানেজার এপিআই-এর বর্তমান ব্যবহারের ক্ষেত্রে প্রয়োজনীয় পরিবর্তনগুলো করুন।

queries পরিষেবাতে কল আপডেট করুন

  • Query রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত সাধারণ নেস্টেড অবজেক্ট দ্বারা উপস্থাপিত হত, এখন নিম্নলিখিত অবজেক্ট টাইপগুলি ব্যবহার করার জন্য পরিবর্তিত হয়েছে:
    v1.1 ক্ষেত্র সমতুল্য v2 অবজেক্ট টাইপ
    metadata QueryMetadata
    params Parameters
    params.options Options
    params.options.pathQueryOptions অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter অপসারণ করা হয়েছে
    schedule QuerySchedule
  • Query রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত সাধারণ তালিকা অবজেক্ট দ্বারা উপস্থাপিত ছিল, সেগুলিকে নিম্নলিখিত নতুন অবজেক্ট প্রকারের তালিকায় পরিবর্তন করা হয়েছে:
    v1.1 তালিকা ক্ষেত্র v2 অবজেক্ট টাইপ
    params.filters[] FilterPair
    params.options.pathQueryOptions.channelGrouping.rules[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[].eventFilters[] অপসারণ করা হয়েছে
  • Query রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত স্ট্রিং দ্বারা উপস্থাপিত হত, v2-তে এনাম টাইপ দ্বারা উপস্থাপিত হয়েছে এবং এতে নিম্নলিখিত পরিবর্তনগুলি অন্তর্ভুক্ত রয়েছে:
    • metadata.dataRange এর v2 সংস্করণটি এখন Range enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময়, PREVIOUS_HALF_MONTH মানটি সরিয়ে দেওয়া হয়েছে এবং TYPE_NOT_SUPPORTED মানটিকে RANGE_UNSPECIFIED এ পরিবর্তন করা হয়েছে।
    • metadata.format এখন Format enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময়, EXCEL_CSV ভ্যালুটি সরিয়ে দেওয়া হয়েছে এবং FORMAT_UNSPECIFIED ভ্যালুটি যোগ করা হয়েছে।
    • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match এবং params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match এখন Match enum ব্যবহার করে।
    • params.options.pathQueryOptions.pathFilters[].pathMatchPosition এখন PathMatchPosition enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময়, PATH_MATCH_POSITION_UNSPECIFIED মানটি যোগ করা হয়েছে।
    • schedule.frequency এখন Frequency enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময় FREQUENCY_UNSPECIFIED মানটি যোগ করা হয়েছে।
    • params.type এখন ReportType enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময় নিম্নলিখিত পরিবর্তনগুলি করা হয়েছে:
    • নিম্নলিখিত মানগুলি বাতিল করা হয়েছে:
      • 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
    • অবশিষ্ট মানগুলো UI-তে তাদের সমতুল্য মানগুলোকে আরও ভালোভাবে প্রতিফলিত করার জন্য আপডেট করা হয়েছে:
      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 ফিল্ড দ্বারা প্রতিস্থাপন করা হয়েছে। নতুন ডেট ফিল্ডগুলো ইউনিক্স ইপোক থেকে মিলিসেকেন্ডের পরিবর্তে Date অবজেক্ট ব্যবহার করে। এই প্রতিস্থাপিত ফিল্ডগুলোকে QueryMetadata অবজেক্টের dataRange ফিল্ডে অ্যাসাইন করা DataRange অবজেক্টের মধ্যে স্থানান্তর করা হয়েছে।
  • QuerySchedule অবজেক্টে schedule.startTimeMs এবং schedule.endTimeMs ফিল্ড দুটিকে startDate এবং endDate ফিল্ড দ্বারা প্রতিস্থাপন করা হয়েছে। নতুন এই ডেট ফিল্ডগুলো ইউনিক্স ইপোক থেকে মিলিসেকেন্ডের পরিবর্তে Date অবজেক্ট ব্যবহার করে।
  • metadata.running , metadata.reportCount , metadata.googleCloudStoragePathForLatestReport , metadata.googleDrivePathForLatestReport , এবং metadata.latestReportRunTimeMs ফিল্ডগুলো সরিয়ে ফেলা হয়েছে। এর পরিবর্তে, একটি কোয়েরির সবচেয়ে সাম্প্রতিক তৈরি হওয়া রিপোর্ট সম্পর্কিত তথ্য queries.reports.list মেথড ব্যবহার করে “key.reportId desc” orderBy কোয়েরি প্যারামিটারের মাধ্যমে সংগ্রহ করা উচিত, যাতে অনুরোধটি সবচেয়ে সাম্প্রতিক রিপোর্টগুলোকে প্রথমে তালিকাভুক্ত করে তা নিশ্চিত করা যায়।
  • kind , timezoneCode , metadata.locale , params.includeInviteData এবং schedule.nextRunMinuteOfDay ফিল্ডগুলো সরিয়ে ফেলা হয়েছে।
  • queries.create এখন আর কোয়েরি তৈরির পর স্বয়ংক্রিয়ভাবে রান করে না এবং asynchronous কোয়েরি প্যারামিটারটি সরিয়ে ফেলা হয়েছে। নতুন কোয়েরিগুলোর জন্য রিপোর্ট তৈরি করতে queries.run এর পর queries.create কল করুন।
  • queries.run মেথডটি নিম্নলিখিত উপায়ে আপডেট করা হয়েছে:
    • asynchronous কোয়েরি প্যারামিটারটি synchronous কোয়েরি প্যারামিটার দ্বারা প্রতিস্থাপিত হয়েছে। নতুন কোয়েরি প্যারামিটারটি বিপরীত যুক্তিতে কাজ করে এবং নির্দিষ্ট না করা হলে এটিকে ফলস (false) হিসেবে গণ্য করা হয়। এই কারণে, v2-তে queries.run ডিফল্টরূপে অ্যাসিঙ্ক্রোনাসভাবে রিপোর্ট তৈরি করে, যেখানে v1.1-এ এটি সিঙ্ক্রোনাসভাবে রিপোর্ট তৈরি করত।
    • অনুরোধের বডি থেকে timezoneCode ফিল্ডটি সরিয়ে দেওয়া হয়েছে এবং dataRange , reportDataStartTimeMs , reportDataEndTimeMs ফিল্ডগুলোকে dataRange ফিল্ডে অ্যাসাইন করা একটি DataRange অবজেক্ট দিয়ে প্রতিস্থাপন করা হয়েছে।
    • এই মেথডটি একটি খালি রেসপন্স বডির পরিবর্তে ফলাফলস্বরূপ প্রাপ্ত Report অবজেক্টটি রিটার্ন করে।
  • queries.list রেসপন্স বডি থেকে kind ফিল্ডটি সরিয়ে দেওয়া হয়েছে।

reports পরিষেবাতে কল আপডেট করুন

  • Report রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত সাধারণ নেস্টেড অবজেক্ট দ্বারা উপস্থাপিত হত, এখন নিম্নলিখিত অবজেক্ট টাইপগুলি ব্যবহার করার জন্য পরিবর্তিত হয়েছে:
    v1.1 ক্ষেত্র সমতুল্য v2 অবজেক্ট টাইপ
    key ReportKey
    metadata ReportMetadata
    metadata.status ReportStatus
    params Parameters
    params.options Options
    params.options.pathQueryOptions অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter অপসারণ করা হয়েছে
  • Report রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত সাধারণ তালিকা অবজেক্ট দ্বারা উপস্থাপিত ছিল, এখন নিম্নলিখিত নতুন অবজেক্ট প্রকারগুলির তালিকায় পরিবর্তিত হয়েছে:
    v1.1 তালিকা ক্ষেত্র v2 অবজেক্ট টাইপ
    params.filters[] FilterPair
    params.options.pathQueryOptions.channelGrouping.rules[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[] অপসারণ করা হয়েছে
    params.options.pathQueryOptions.pathFilters[].eventFilters[] অপসারণ করা হয়েছে
  • Report রিসোর্সের নিম্নলিখিত ফিল্ডগুলি, যা মূলত স্ট্রিং দ্বারা উপস্থাপিত ছিল, সেগুলিতে পরিবর্তন আনা হয়েছে। তাই v2-তে তাদের সমতুল্য ফিল্ডগুলি নতুন enum টাইপ দ্বারা উপস্থাপিত হয় এবং গ্রহণযোগ্য মানগুলিতেও পরিবর্তন আনা হয়েছে:
    • metadata.status.format এখন Format enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময়, EXCEL_CSV ভ্যালুটি সরিয়ে দেওয়া হয়েছে এবং FORMAT_UNSPECIFIED যোগ করা হয়েছে।
    • metadata.status.state এখন State enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময় QUEUED এবং STATE_UNSPECIFIED ভ্যালুগুলো যোগ করা হয়েছে।
    • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match এবং params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match এখন Match enum ব্যবহার করে।
    • params.options.pathQueryOptions.pathFilters[].pathMatchPosition এখন PathMatchPosition enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময়, PATH_MATCH_POSITION_UNSPECIFIED মানটি যোগ করা হয়েছে।
    • params.type এখন ReportType enum ব্যবহার করে। এই enum-এ রূপান্তর করার সময় অসংখ্য পরিবর্তন করা হয়েছে এবং কোয়েরি সার্ভিস কল আপডেট করার বিষয়ে পূর্ববর্তী বিভাগে সেগুলি বিস্তারিতভাবে তালিকাভুক্ত করা হয়েছে।
  • ReportMetadata অবজেক্টে metadata.reportDataStartTimeMs এবং metadata.reportDataEndTimeMs ফিল্ড দুটিকে reportDataStartDate এবং reportDataEndDate ফিল্ড দ্বারা প্রতিস্থাপন করা হয়েছে। নতুন ফিল্ডগুলো ইউনিক্স ইপোক থেকে মিলিসেকেন্ডের পরিবর্তে Date অবজেক্ট ব্যবহার করে।
  • ReportStatus অবজেক্টে metadata.status.finishTimeMs finishTime ফিল্ড দ্বারা প্রতিস্থাপন করা হয়েছে। এই নতুন টাইম ফিল্ডটি ইউনিক্স ইপোক থেকে মিলিসেকেন্ডের পরিবর্তে RFC3339 UTC "জুলু" ফরম্যাটে একটি টাইমস্ট্যাম্প হিসাবে ডেটটাইম উপস্থাপন করে।
  • metadata.status.failure এবং params.includeInviteData ফিল্ডগুলো সরিয়ে দেওয়া হয়েছে।
  • reports.list এর রেসপন্স বডি থেকে kind ফিল্ডটি সরিয়ে দেওয়া হয়েছে।

ত্রুটি পরিচালনা লজিক আপডেট করুন

v2-তে API জুড়ে ত্রুটির বার্তাগুলো আপডেট করা হয়েছে। এই নতুন ত্রুটির বার্তাগুলো আরও সুনির্দিষ্ট এবং কিছু ক্ষেত্রে, API অনুরোধের সেই মানগুলো সম্পর্কে তথ্য প্রদান করে যা ত্রুটির কারণ হচ্ছে। যদি আপনার বিদ্যমান ত্রুটি পরিচালনা করার লজিক নির্দিষ্ট ত্রুটির বার্তার পাঠ্যের উপর নির্ভর করে, তবে v2-তে স্থানান্তরিত হওয়ার আগে আপনার ত্রুটি পরিচালনাকে সাধারণীকরণ করুন।