CrUX API

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

এটা চেষ্টা করুন!

সাধারণ ব্যবহারের ক্ষেত্রে

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

CrUX API কী

CrUX API ব্যবহার করার জন্য Chrome UX Report API ব্যবহারের জন্য একটি Google ক্লাউড API কী ব্যবস্থা করা প্রয়োজন৷

একটি API কী অর্জন এবং ব্যবহার করা

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

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

API কী ইউআরএল-এ এম্বেড করার জন্য নিরাপদ; এটা কোন এনকোডিং প্রয়োজন নেই.

উদাহরণ প্রশ্ন দেখুন.

ডেটা মডেল

এই বিভাগে অনুরোধ এবং প্রতিক্রিয়া তথ্যের গঠন বিবরণ.

রেকর্ড

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

শনাক্তকারী

শনাক্তকারীরা উল্লেখ করে যে কোন রেকর্ডগুলো দেখতে হবে। CrUX-এ এই শনাক্তকারীগুলি হল ওয়েবপেজ এবং ওয়েবসাইট৷

উৎপত্তি

যখন শনাক্তকারী একটি উত্স হয় তখন সেই উত্সের সমস্ত পৃষ্ঠাগুলির জন্য উপস্থিত সমস্ত ডেটা একসাথে একত্রিত হয়৷ উদাহরণ স্বরূপ, বলুন যে http://www.example.com মূলে এই সাইটম্যাপ দ্বারা নির্ধারিত পৃষ্ঠাগুলি ছিল:

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

এর মানে হল যে যখন Chrome UX রিপোর্টের জন্য অনুসন্ধান করা হয় তখন http://www.example.com , 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 বিভক্ত।

মেট্রিক

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

ফ্লোটিং পয়েন্টের মানগুলি 4 দশমিক স্থানে বৃত্তাকার করা হয় (মনে রাখবেন যে cumulative_layout_shift মেট্রিকগুলি একটি স্ট্রিং হিসাবে দ্বিগুণ এনকোড করা হয়, তাই ফ্লোটগুলি বিবেচনা করা হয় না এবং স্ট্রিংয়ের মধ্যে 2 দশমিক স্থানে রিপোর্ট করা হয়)।

হিস্টোগ্রাম

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

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

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

এই ডেটা ইঙ্গিত করে যে 38.18% পৃষ্ঠা লোডের জন্য, উদাহরণ মেট্রিকটি 0ms এবং 1,000ms এর মধ্যে পরিমাপ করা হয়েছিল৷ মেট্রিকের একক এই হিস্টোগ্রামে নেই, এই ক্ষেত্রে আমরা মিলিসেকেন্ড ধরে নেব।

অতিরিক্তভাবে, পৃষ্ঠা লোডের 49.91% 1,000ms এবং 3,000ms এর মধ্যে একটি মেট্রিক মান দেখেছে, এবং 11.92% 3,000ms এর চেয়ে বেশি একটি মান দেখেছে৷

শতকরা

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

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

এই উদাহরণে, পৃষ্ঠা লোডের কমপক্ষে 75% একটি মেট্রিক মান <= 2063 দিয়ে পরিমাপ করা হয়েছিল।

ভগ্নাংশ

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

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

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

এই ক্ষেত্রে, পৃষ্ঠা লোডের 3.77% একটি ডেস্কটপে, 2.88% একটি ট্যাবলেটে এবং 93.35% একটি ফোনে, মোট 100% দেয়৷

মেট্রিক মান প্রকার

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

সংগ্রহের সময়কাল

অক্টোবর 2022 পর্যন্ত, CrUX API-এ firstDate এবং endDate ফিল্ড সহ একটি collectionPeriod অবজেক্ট রয়েছে যা অ্যাগ্রিগেশন উইন্ডোর শুরু এবং শেষ তারিখগুলিকে উপস্থাপন করে। যেমন:

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

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

মনে রাখবেন যে CrUX API আজকের তারিখ থেকে প্রায় দুই দিন পিছিয়ে আছে কারণ এটি দিনের জন্য সম্পূর্ণ ডেটার জন্য অপেক্ষা করে, এবং API-এ উপলব্ধ হওয়ার আগে কিছু প্রক্রিয়াকরণের সময় জড়িত। ব্যবহৃত টাইমজোন হল প্যাসিফিক স্ট্যান্ডার্ড টাইম (PST) দিনের আলো সঞ্চয়ের জন্য কোন পরিবর্তন ছাড়াই।

উদাহরণ প্রশ্ন

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

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

উদাহরণস্বরূপ, এটিকে নিম্নলিখিত কমান্ড লাইনের সাহায্যে curl থেকে কল করা যেতে পারে (আপনার কী দিয়ে API_KEY প্রতিস্থাপন করা):

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_time_to_first_byte
• navigation_types
• form_factors (অনুরোধে কোনো formFactor উল্লেখ না থাকলে শুধুমাত্র রিপোর্ট করা হয়)

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

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

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

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

রোলিং গড়

ক্রোম ইউএক্স রিপোর্টের ডেটা হল একত্রিত মেট্রিক্সের 28-দিনের রোলিং গড়৷ এর মানে হল যে কোনও নির্দিষ্ট সময়ে Chrome UX রিপোর্টে উপস্থাপিত ডেটা আসলে গত 28 দিনের একত্রিত ডেটা।

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

প্রতিদিনের আপডেট

ডেটা প্রতিদিন প্রায় 04:00 UTC আপডেট করা হয়। আপডেট সময়ের জন্য কোন পরিষেবা স্তর চুক্তি নেই; এটি প্রতিদিন সর্বোত্তম প্রচেষ্টার ভিত্তিতে পরিচালিত হয়।

স্কিমা

CrUX API-এর জন্য একটি একক এন্ডপয়েন্ট রয়েছে যা POST HTTP অনুরোধ গ্রহণ করে। এপিআই এমন একটি 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.
}

উদাহরণস্বরূপ, ক্রোম বিকাশকারী ডকুমেন্টেশন হোমপেজের জন্য ডেস্কটপের বৃহত্তম সামগ্রীপূর্ণ পেইন্ট মানগুলির জন্য অনুরোধ করতে:

{
  "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 একটি সিরিজ হিসাবে বাস্তব বিশ্বের ক্রোমের ব্যবহারের একটি সারাংশ হিস্টোগ্রাম থাকতে পারে, নির্দিষ্ট শতাংশ ডেটা (যেমন p75), অথবা এতে লেবেলযুক্ত ভগ্নাংশ থাকতে পারে।

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

বা

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

বিন

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

একটি বিনের শুরু এবং শেষের মানগুলি মেট্রিকের মান প্রকারে দেওয়া হয় যা এটি প্রতিনিধিত্ব করে। উদাহরণস্বরূপ, প্রথম কনটেন্টফুল পেইন্টটি মিলিসেকেন্ডে পরিমাপ করা হয় এবং ints হিসাবে প্রকাশ করা হয়, তাই এর মেট্রিক বিনগুলি এর শুরু এবং শেষ প্রকারের জন্য int32s ব্যবহার করবে। তবে ক্রমবর্ধমান বিন্যাস স্থানান্তর ইউনিটহীন দশমিকে পরিমাপ করা হয় এবং একটি স্ট্রিং হিসাবে এনকোড করা দশমিক হিসাবে উন্মুক্ত করা হয়, তাই এর মেট্রিক বিনগুলি এর মান প্রকারের জন্য স্ট্রিং ব্যবহার করবে।

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

শতকরা

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

{
  "P75": value
}

ভগ্নাংশ

Fractions লেবেলযুক্ত ভগ্নাংশ থাকে যা ~1 পর্যন্ত যোগ করে। প্রতিটি লেবেল কোনো না কোনোভাবে একটি পৃষ্ঠা লোডকে বর্ণনা করে, তাই এইভাবে উপস্থাপিত মেট্রিকগুলিকে সংখ্যাসূচক মানের পরিবর্তে স্বতন্ত্র মান তৈরি করার কথা ভাবা যেতে পারে এবং ভগ্নাংশগুলি প্রকাশ করে যে একটি নির্দিষ্ট স্বতন্ত্র মান কত ঘন ঘন পরিমাপ করা হয়েছিল।

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

অনেকটা হিস্টোগ্রাম বিনের ঘনত্বের মানের মতো, প্রতিটি fraction একটি সংখ্যা 0.0 <= value <= 1.0 , এবং তারা ~1.0 পর্যন্ত যোগ করে।

ইউআরএল স্বাভাবিককরণ

সফল লুকআপের একটি উচ্চতর সম্ভাবনা অর্জনের জন্য একটি URL স্বাভাবিক করার জন্য নেওয়া স্বাভাবিককরণের ক্রিয়াগুলিকে প্রতিনিধিত্ব করে। এইগুলি হল সহজ স্বয়ংক্রিয় পরিবর্তন যা প্রদত্ত url_pattern সন্ধান করার সময় নেওয়া হয় ব্যর্থ বলে জানা যাবে৷ নিম্নোক্ত পুনঃনির্দেশের মতো জটিল ক্রিয়াগুলি পরিচালনা করা হয় না।

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

হারের সীমা

CrUX API Google ক্লাউড প্রকল্প প্রতি মিনিটে 150টি প্রশ্নের মধ্যে সীমাবদ্ধ, যা কোনো চার্জ ছাড়াই দেওয়া হয়। এই সীমা, এবং আপনার বর্তমান ব্যবহার, Google ক্লাউড কনসোলে দেখা যাবে। এই উদার কোটা বেশিরভাগ ব্যবহারের ক্ষেত্রে যথেষ্ট হওয়া উচিত এবং বর্ধিত কোটার জন্য অর্থ প্রদান করা সম্ভব নয়।