CrUX API

CrUX API, পৃষ্ঠা ও অরিজিন গ্র্যানুলারিটিতে, প্রকৃত ব্যবহারকারীর অভিজ্ঞতা সম্পর্কিত মোট ডেটায় কম-লেটেন্সি অ্যাক্সেস প্রদান করে।

এটি ব্যবহার করে দেখুন!

সাধারণ ব্যবহারিক প্রয়োগ

CrUX API, "https://example.com অরিজিনের জন্য মেট্রিক পান"-এর মতো নির্দিষ্ট URI-এর জন্য ব্যবহারকারীর অভিজ্ঞতা সংক্রান্ত মেট্রিক কোয়েরি করার অনুমতি দেয়।

CrUX API Key

CrUX API ব্যবহার করার জন্য Chrome UX Report API ব্যবহারের জন্য Google Cloud API কী প্রয়োজন।

API key পাওয়া ও ব্যবহার করা

অথবা ক্রেডেনশিয়াল পৃষ্ঠা থেকে একটি তৈরি করুন।

API কী পাওয়ার পরে, আপনার অ্যাপ্লিকেশন সব অনুরোধের URL-এ কোয়েরি প্যারামিটার key=yourAPIKey যোগ করতে পারবে।

URL-এ এম্বেড করার জন্য API কী নিরাপদ; এর জন্য কোনও এনকোডিংয়ের প্রয়োজন নেই।

কোয়েরির উদাহরণ দেখুন।

ডেটা মডেল

এই বিভাগে অনুরোধ ও উত্তরে ডেটার স্ট্রাকচার সম্পর্কে বিস্তারিত তথ্য দেওয়া হয়েছে।

রেকর্ড করুন

কোনও পৃষ্ঠা বা সাইট সম্পর্কে তথ্যের একটি পৃথক অংশ। একটি রেকর্ডে এমন ডেটা থাকতে পারে যা কোনও শনাক্তকারী এবং ডাইমেনশনের নির্দিষ্ট কম্বিনেশনের জন্য নির্দিষ্ট। একটি রেকর্ডে এক বা একাধিক মেট্রিকের ডেটা থাকতে পারে।

আইডেন্টিফায়ার

কোন রেকর্ড দেখতে হবে তা শনাক্তকারী নির্দিষ্ট করে। CrUX-এ এইসব আইডেন্টিফায়ার হল ওয়েবপেজ ও ওয়েবসাইট।

অরিজিন

শনাক্তকারীটি কোনও উৎস হলে, সেই উৎসের সব পৃষ্ঠার জন্য উপস্থিত সমস্ত ডেটা একসাথে একত্রিত করা হয়। যেমন, ধরুন http://www.example.com অরিজিনে এই সাইটম্যাপের লেআউট অনুযায়ী পৃষ্ঠা ছিল:

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

এর অর্থ হল, http://www.example.com-এ সেট করা উৎসের সাথে Chrome UX Report কোয়েরি করার সময়, http://www.example.com/, http://www.example.com/foo.html ও http://www.example.com/bar.html-এর ডেটা একসাথে এগ্রিগেট করে ফেরত পাঠানো হবে, কারণ এগুলি সবই সেই উৎসের অধীনে থাকা পৃষ্ঠা।

ইউআরএল

শনাক্তকারীটি URL হলে, শুধুমাত্র সেই নির্দিষ্ট URL-এর ডেটা দেখানো হবে। http://www.example.com মূল সাইটম্যাপ আবার দেখা হচ্ছে:

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

শনাক্তকারী যদি http://www.example.com/foo.html ভ্যালু সহ URL-এ সেট করা থাকে, তাহলে শুধু সেই পৃষ্ঠার ডেটা দেখানো হবে।

আকার

ডাইমেনশন ডেটার একটি নির্দিষ্ট গ্রুপকে শনাক্ত করে যার বিপরীতে একটি রেকর্ড এগ্রিগেট করা হচ্ছে, উদাহরণস্বরূপ PHONE-এর ফর্ম ফ্যাক্টর নির্দেশ করে যে রেকর্ডে মোবাইল ডিভাইসে হওয়া লোড সম্পর্কে তথ্য রয়েছে। প্রতিটি ডাইমেনশনের নির্দিষ্ট সংখ্যক ভ্যালু থাকবে এবং সেই ডাইমেনশন উল্লেখ না করার অর্থ হল, ডাইমেনশনটি সমস্ত ভ্যালু জুড়ে অ্যাগ্রিগেট করা হয়েছে। যেমন, কোনও ফর্ম ফ্যাক্টর উল্লেখ না করার অর্থ হল, রেকর্ডে যেকোনও ফর্ম ফ্যাক্টরে হওয়া লোড সম্পর্কে তথ্য রয়েছে।

ফর্ম ফ্যাক্টর

ব্যবহারকারী যে ডিভাইস ক্লাস ব্যবহার করে পৃষ্ঠায় নেভিগেট করেছেন। এটি ডিভাইসের একটি সাধারণ ক্লাস যা PHONE, TABLET এবং DESKTOP-এ বিভক্ত।

মেট্রিক

আমরা হিস্টোগ্রাম, পার্সেন্টাইল ও ভগ্নাংশে পরিসংখ্যানগত অ্যাগ্রিগেশন হিসেবে মেট্রিক রিপোর্ট করি।

ফ্লোটিং পয়েন্ট ভ্যালু দশমিকের পরে ৪টি সংখ্যা পর্যন্ত রাউন্ড অফ করা হয় (মনে রাখবেন যে cumulative_layout_shift মেট্রিক হল স্ট্রিং হিসেবে এনকোড করা ডবল, তাই ফ্লোট হিসেবে বিবেচনা করা হয় না এবং স্ট্রিংয়ের মধ্যে দশমিকের পরে ২টি সংখ্যা পর্যন্ত রিপোর্ট করা হয়)।

হিস্টোগ্রাম

হিস্টোগ্রামে মেট্রিক দেখানো হলে, সেই মেট্রিকের জন্য নির্দিষ্ট রেঞ্জের মধ্যে থাকা পৃষ্ঠা লোডের শতাংশ আমরা দেখাই।

উদাহরণ হিসেবে একটি মেট্রিকের জন্য তিন বিন হিস্টোগ্রাম এইরকম দেখতে হয়:

{
  "histogram": [
    {
      "start": 0,
      "end": 1000,
      "density": 0.3818
    },
    {
      "start": 1000,
      "end": 3000,
      "density": 0.4991
    },
    {
      "start": 3000,
      "density": 0.1192
    }
  ]
}

এই ডেটা থেকে বোঝা যায় যে ৩৮.১৮% পৃষ্ঠা লোডের ক্ষেত্রে, উদাহরণ মেট্রিকটি ০ms থেকে ১,০০০ms-এর মধ্যে পরিমাপ করা হয়েছে। এই হিস্টোগ্রামে মেট্রিকের ইউনিট নেই, এই ক্ষেত্রে আমরা মিলিসেকেন্ড ধরে নেব।

এছাড়াও, ৪৯.৯১% পৃষ্ঠা লোড হওয়ার ক্ষেত্রে মেট্রিক ভ্যালু ১,০০০ms থেকে ৩,০০০ms-এর মধ্যে এবং ১১.৯২% পৃষ্ঠা লোড হওয়ার ক্ষেত্রে ৩,০০০ms-এর বেশি দেখা গেছে।

পার্সেন্টাইল

মেট্রিকে পার্সেন্টাইলও থাকতে পারে যা অতিরিক্ত বিশ্লেষণের জন্য উপযোগী হতে পারে। আমরা সেই মেট্রিকের জন্য প্রদত্ত পার্সেন্টাইলে নির্দিষ্ট মেট্রিক ভ্যালু রিপোর্ট করি। এগুলি উপলভ্য ডেটার সম্পূর্ণ সেটের উপর ভিত্তি করে তৈরি করা হয়, চূড়ান্ত বিন করা ডেটার উপর নয়, তাই চূড়ান্ত বিন করা হিস্টোগ্রামের উপর ভিত্তি করে ইন্টারপোলেট করা পার্সেন্টাইলের সাথে এগুলি নাও মিলতে পারে।

{
  "percentiles": {
    "p75": 2063
  }
}

এই উদাহরণে, অন্তত ৭৫% পৃষ্ঠা লোড হওয়ার সময় মেট্রিক ভ্যালু <= 2063 পরিমাপ করা হয়েছে।

ভগ্নাংশ

ভগ্নাংশ থেকে বোঝা যায় যে কত শতাংশ পৃষ্ঠা লোডকে নির্দিষ্ট উপায়ে লেবেল করা যেতে পারে। এই ক্ষেত্রে, মেট্রিক ভ্যালু হল এইসব লেবেল।

যেমন, form_factors মেট্রিক fractions অবজেক্ট নিয়ে গঠিত যা প্রদত্ত কোয়েরি কভার করে এমন ফর্ম ফ্যাক্টর (বা ডিভাইস)-এর ব্রেকডাউন তালিকাভুক্ত করে:

"form_factors": {
  "fractions": {
    "desktop": 0.0377,
    "tablet": 0.0288,
    "phone": 0.9335
  }
}

এই ক্ষেত্রে, ৩.৭৭% পৃষ্ঠা লোড ডেস্কটপে, ২.৮৮% ট্যাবলেটে এবং ৯৩.৩৫% ফোনে পরিমাপ করা হয়েছে, যা মোট ১০০%।

মেট্রিক ভ্যালুর ধরন

BigQuery মেট্রিক নামের ম্যাপিং

সংগ্রহের মেয়াদ

অক্টোবর ২০২২ থেকে, CrUX API-তে collectionPeriod অবজেক্ট রয়েছে যার মধ্যে firstDate ও endDate ফিল্ড আছে এবং এগুলি অ্যাগ্রিগেশন উইন্ডোর শুরু ও শেষের তারিখ দেখায়। যেমন:

    "collectionPeriod": {
      "firstDate": {
        "year": 2022,
        "month": 9,
        "day": 12
      },
      "lastDate": {
        "year": 2022,
        "month": 10,
        "day": 9
      }
    }

এর ফলে ডেটা আরও ভালোভাবে বোঝা যায় এবং সেই দিনের জন্য এটি আপডেট করা হয়েছে কিনা বা গতকালের মতো একই ডেটা দেখাচ্ছে কিনা তা জানা যায়।

সংগ্রহের মেয়াদ PageSpeed Insights-এও উপলভ্য:

এছাড়াও, collectionPeriod সবসময় ২৮ দিনের ডেটা দেখাবে, এমনকি ডেটা যদি সম্পূর্ণ ২৮ দিনের জন্য না হয় (যেমন, কোনও পৃষ্ঠা ২৮ দিনের কম সময় আগে লঞ্চ করা হলে)। collectionPeriod হল সেই সময়সীমা যার মধ্যে CrUX ডেটা একত্রিত করা হয়েছে, তবে এটি ডেটা যে সময়সীমাকে তুলে ধরে তার সাথে এক নাও হতে পারে।

কোয়েরির উদাহরণ

কোয়েরি ডেটা সহ https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=[YOUR_API_KEY]"-এ POST অনুরোধ ব্যবহার করে JSON অবজেক্ট হিসেবে কোয়েরি জমা দেওয়া হয়, POST বডিতে JSON অবজেক্ট হিসেবে:

{
  "origin": "https://example.com",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

যেমন, নিম্নলিখিত কমান্ড লাইন (API_KEY-এর জায়গায় আপনার 'কী' ব্যবহার করে) সহ curl থেকে এটি কল করা যেতে পারে:

curl -s --request POST 'https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=API_KEY' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --data '{"formFactor":"PHONE","origin":"https://www.example.com","metrics":["largest_contentful_paint", "experimental_time_to_first_byte"]}'

কোয়েরিতে origin-এর পরিবর্তে url প্রপার্টি পাস করার মাধ্যমে API-এর মাধ্যমে পৃষ্ঠা-লেভেল ডেটা উপলভ্য হয়:

{
  "url": "https://example.com/page",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

metrics প্রপার্টি সেট করা না থাকলে, উপলভ্য সব মেট্রিক ফিরিয়ে দেওয়া হবে:

• cumulative_layout_shift
• first_contentful_paint
• interaction_to_next_paint
• largest_contentful_paint
• experimental_cumulative_layout_shift_with_softnavs
• experimental_first_contentful_paint_with_softnavs
• experimental_interaction_to_next_paint_with_softnavs
• experimental_largest_contentful_paint_with_softnavs
• experimental_navigation_types_with_softnavs
• experimental_time_to_first_byte
• largest_contentful_paint_resource_type
• largest_contentful_paint_image_time_to_first_byte
• largest_contentful_paint_image_resource_load_delay
• largest_contentful_paint_image_resource_load_duration
• largest_contentful_paint_image_element_render_delay
• navigation_types
• round_trip_time
• form_factors (অনুরোধে কোনও formFactor উল্লেখ না করা থাকলে তবেই রিপোর্ট করা হয়)
• experimental_ad_count (শুধুমাত্র বিজ্ঞাপন মেট্রিক্সে অন্তর্ভুক্ত পৃষ্ঠার জন্য রিপোর্ট করা হয়েছে)
• experimental_ad_density (শুধুমাত্র বিজ্ঞাপন মেট্রিক্সে অন্তর্ভুক্ত পৃষ্ঠার জন্য রিপোর্ট করা হয়েছে)
• experimental_ad_cpu (শুধুমাত্র বিজ্ঞাপন মেট্রিক্সে অন্তর্ভুক্ত পৃষ্ঠার জন্য রিপোর্ট করা হয়েছে)
• experimental_ad_kilobytes (শুধুমাত্র বিজ্ঞাপন মেট্রিক্সে অন্তর্ভুক্ত পৃষ্ঠার জন্য রিপোর্ট করা হয়েছে)

formFactor-এর কোনও ভ্যালু প্রদান করা না হলে, সব ফর্ম ফ্যাক্টর জুড়ে ভ্যালু অ্যাগ্রিগেট করা হবে।

আরও উদাহরণ কোয়েরির জন্য Chrome UX Report API ব্যবহার করা দেখুন।

ডেটা পাইপলাইন

API ব্যবহার করে উপলভ্য হওয়ার আগে, ডেটা একত্রিত, অ্যাগ্রিগেট ও ফিল্টার করার জন্য CrUX ডেটাসেট একটি পাইপলাইনের মাধ্যমে প্রসেস করা হয়।

রোলিং অ্যাভারেজ

Chrome UX Report-এর ডেটা হল ২৮ দিনের রোলিং অ্যাভারেজ এগ্রিগেটেড মেট্রিক। এর অর্থ হল, যেকোনও সময়ে Chrome UX Report-এ দেখানো ডেটা আসলে গত ২৮ দিনের মোট ডেটা।

BigQuery-তে CrUX ডেটাসেট যেভাবে মাসিক রিপোর্ট এগ্রিগেট করে, এটিও ঠিক সেইভাবেই কাজ করে।

দৈনিক আপডেট

প্রতিদিন প্রায় ০৪:০০ UTC-তে ডেটা আপডেট করা হয়। আপডেট করার সময়ের জন্য কোনও পরিষেবা লেভেল এগ্রিমেন্ট নেই; এটি প্রতিদিন যথাসাধ্য চেষ্টা করার ভিত্তিতে চালানো হয়।

স্কিমা

CrUX API-এর জন্য একটিই এন্ডপয়েন্ট আছে যা POST HTTP অনুরোধ গ্রহণ করে। API একটি record রিটার্ন করে যার মধ্যে এক বা একাধিক metrics থাকে যা অনুরোধ করা অরিজিন বা পৃষ্ঠার পারফর্ম্যান্স ডেটার সাথে সম্পর্কিত।

HTTP অনুরোধ

POST https://chromeuxreport.googleapis.com/v1/records:queryRecord

URL-এ gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়।

অনুরোধের বডি

অনুরোধের বডিতে নিম্নলিখিত স্ট্রাকচার সহ ডেটা থাকতে হবে:

{
  "formFactor": enum (FormFactor),
  "metrics": [
    string
  ],

  // Union field url_pattern can be only one of the following:
  "origin": string,
  "url": string
  // End of list of possible types for union field url_pattern.
}

যেমন, Chrome ডেভেলপার ডকুমেন্টেশন হোমপেজের জন্য ডেস্কটপ Largest Contentful Paint ভ্যালুর অনুরোধ করতে:

{
  "url": "https://developer.chrome.com/docs/",
  "formFactor": "DESKTOP",
  "metrics": [
    "largest_contentful_paint"
  ]
}

প্রতিক্রিয়ার বডি

সফল অনুরোধের ক্ষেত্রে record অবজেক্ট ও urlNormalizationDetails সহ নিম্নলিখিত স্ট্রাকচারে উত্তর পাওয়া যায়:

{
  "record": {
    "key": {
      object (Key)
    },
    "metrics": [
      string: {
        object (Metric)
      }
    ]
  },
  "urlNormalizationDetails": {
    object (UrlNormalization)
  }
}

যেমন, আগের অনুরোধে অনুরোধের বডির উত্তর হতে পারে:

{
  "record": {
    "key": {
      "formFactor": "DESKTOP",
      "url": "https://developer.chrome.com/docs/"
    },
    "metrics": {
      "largest_contentful_paint": {
        "histogram": [
          {
            "start": 0,
            "end": 2500,
            "density": 0.9815
          },
          {
            "start": 2500,
            "end": 4000,
            "density": 0.0108
          },
          {
            "start": 4000,
            "density": 0.0077
          }
        ],
        "percentiles": {
          "p75": 651
        }
      }
    },
    "collectionPeriod": {
      "firstDate": {
        "year": 2022,
        "month": 9,
        "day": 12
      },
      "lastDate": {
        "year": 2022,
        "month": 10,
        "day": 9
      }
    }
  }
}

কী

Key সেইসব ডাইমেনশনকে সংজ্ঞায়িত করে যেগুলি এই রেকর্ডকে অনন্য হিসেবে শনাক্ত করে।

{
  "formFactor": enum (FormFactor),

  // Union field url_pattern can be only one of the following:
  "origin": string,
  "url": string
  // End of list of possible types for union field url_pattern.
}

মেট্রিক্স

metric হল একটি ওয়েব পারফর্ম্যান্স মেট্রিকের জন্য ব্যবহারকারীর অভিজ্ঞতার মোট ডেটার সেট, যেমন ফার্স্ট কন্টেন্টফুল পেইন্ট। এতে bins-এর সিরিজ হিসেবে বাস্তব জগতে Chrome ব্যবহারের সারাংশ হিস্টোগ্রাম, নির্দিষ্ট শতাংশ ডেটা (যেমন p75) বা লেবেলযুক্ত ভগ্নাংশ থাকতে পারে।

{
  "histogram": [
    {
      object (Bin)
    }
  ],
  "percentiles": {
    object (Percentiles)
  }
}

অথবা

{
  "fractions": {
    object (Fractions)
  }
}

বিন

bin হল ডেটার একটি বিচ্ছিন্ন অংশ যা শুরু থেকে শেষ পর্যন্ত বিস্তৃত, অথবা যদি কোনও শেষ না দেওয়া হয় তবে শুরু থেকে পজিটিভ ইনফিনিটি পর্যন্ত।

বিনের শুরু ও শেষের ভ্যালু, এটি যে মেট্রিককে দেখায় তার ভ্যালুর ধরন অনুযায়ী দেওয়া হয়। যেমন, ফার্স্ট কন্টেন্টফুল পেইন্ট মিলিসেকেন্ডে পরিমাপ করা হয় এবং int হিসেবে দেখানো হয়, তাই এর মেট্রিক বিন শুরু ও শেষের ধরন হিসেবে int32s ব্যবহার করবে। তবে, কিউমুলেটিভ লেআউট শিফ্ট ইউনিটলেস দশমিক হিসেবে পরিমাপ করা হয় এবং স্ট্রিং হিসেবে এনকোড করা দশমিক হিসেবে দেখানো হয়, তাই এর মেট্রিক বিন ভ্যালুর ধরন হিসেবে স্ট্রিং ব্যবহার করবে।

{
  "start": value,
  "end": value,
  "density": number
}

পার্সেন্টাইল

Percentiles-এ প্রদত্ত পরিসংখ্যানগত পার্সেন্টাইলে কোনও মেট্রিকের সিন্থেটিক ভ্যালু থাকে। মোট ব্যবহারকারীর সংখ্যার মধ্যে থেকে শতাংশ হিসেবে ব্যবহারকারীদের অভিজ্ঞতা অনুযায়ী মেট্রিকের ভ্যালু অনুমান করার জন্য এগুলি ব্যবহার করা হয়।

{
  "P75": value
}

ভগ্নাংশ

Fractions-এ লেবেল করা ভগ্নাংশ আছে যা যোগ করলে ~১ হয়। প্রতিটি লেবেল কোনও না কোনওভাবে পৃষ্ঠা লোড হওয়ার বিষয়টি বর্ণনা করে, তাই এইভাবে দেখানো মেট্রিককে সংখ্যাগত মানের পরিবর্তে স্বতন্ত্র মান হিসেবে বিবেচনা করা যেতে পারে এবং ভগ্নাংশটি দেখায় যে কত ঘন ঘন একটি নির্দিষ্ট স্বতন্ত্র মান পরিমাপ করা হয়েছে।

{
  "label_1": fraction,
  "label_2": fraction,
  ...
  "label_n": fraction
}

হিস্টোগ্রাম বিনের ডেনসিটি ভ্যালুর মতো, প্রতিটি fraction হল একটি সংখ্যা 0.0 <= value <= 1.0 এবং সেগুলি যোগ করলে ~১.০ হয়।

UrlNormalization

অবজেক্ট যা একটি URL স্বাভাবিক করার জন্য গৃহীত স্বাভাবিককরণ ক্রিয়াগুলিকে উপস্থাপন করে যাতে সফল লুকআপের উচ্চ সম্ভাবনা অর্জন করা যায়। এগুলি হল প্রাথমিক, অটোমেটিক পরিবর্তন যা প্রদান করা url_pattern খোঁজার সময় ব্যর্থ হবে বলে জানা থাকলে করা হয়। রিডাইরেক্ট ফলো করার মতো জটিল অ্যাকশন ম্যানেজ করা হয় না।

{
  "originalUrl": string,
  "normalizedUrl": string
}

রেটের সীমা

CrUX API-এর মাধ্যমে Google Cloud প্রোজেক্ট প্রতি মিনিটে ১৫০টি কোয়েরি করতে পারে, যার জন্য কোনও চার্জ নেওয়া হয় না। এই সীমা এবং আপনার বর্তমান ব্যবহার Google Cloud Console-এ দেখা যাবে। এই কোটা বেশিরভাগ ব্যবহারের ক্ষেত্রে যথেষ্ট এবং কোটা বাড়ানোর জন্য পেমেন্ট করা সম্ভব নয়।