Method: properties.getMetadata

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

উদাহরণস্বরূপ, যদি কোনো প্রপার্টিতে levels_unlocked প্যারামিটার নামের একটি কাস্টম মেট্রিক রেজিস্টার করা হয়, তাহলে মেটাডেটা রেসপন্সে customEvent:levels_unlocked থাকবে। ইউনিভার্সাল মেটাডেটা হলো ডাইমেনশন এবং মেট্রিক যা যেকোনো প্রপার্টির জন্য প্রযোজ্য, যেমন country এবং totalUsers ।

HTTP অনুরোধ

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

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

পথের পরামিতি

প্যারামিটার
name

string

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

উদাহরণ: প্রোপার্টিজ/১২৩৪/মেটাডেটা

সকল প্রপার্টির জন্য সাধারণ ডাইমেনশন ও মেট্রিক্সের ক্ষেত্রে প্রপার্টি আইডি ০-তে সেট করুন। এই বিশেষ মোডে, এই মেথডটি কাস্টম ডাইমেনশন ও মেট্রিক্স রিটার্ন করবে না।

অনুরোধকারী শরীর

অনুরোধের মূল অংশ অবশ্যই খালি হতে হবে।

প্রতিক্রিয়া সংস্থা

প্রতিবেদন পদ্ধতিতে বর্তমানে গৃহীত মাত্রা, পরিমাপক এবং তুলনাসমূহ।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
ক্ষেত্র
name

string

এই মেটাডেটার রিসোর্স নাম।

dimensions[]

object ( DimensionMetadata )

মাত্রার বিবরণ।

metrics[]

object ( MetricMetadata )

মেট্রিক বিবরণগুলো।

comparisons[]

object ( ComparisonMetadata )

তুলনামূলক বিবরণগুলো।

conversions[]

object ( ConversionMetadata )

রূপান্তরের বিবরণ।

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ডাইমেনশনমেটাডেটা

একটি মাত্রা ব্যাখ্যা করে।

JSON উপস্থাপনা 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
ক্ষেত্র
apiName

string

এই ডাইমেনশনের নাম। এটি ডাইমেনশনের name ব্যবহারযোগ্য। উদাহরণস্বরূপ, eventName ।

uiName

string

গুগল অ্যানালিটিক্স ইউজার ইন্টারফেসের মধ্যে এই ডাইমেনশনটির নাম। উদাহরণস্বরূপ, Event name ।

description

string

এই ডাইমেনশনটি কীভাবে ব্যবহৃত ও গণনা করা হয় তার বিবরণ।

deprecatedApiNames[]

string

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

customDefinition

boolean

ডাইমেনশনটি যদি এই প্রপার্টির জন্য কাস্টম হয়, তবে এর মান হবে True। এর মধ্যে ইউজার, ইভেন্ট, ও আইটেম-স্কোপড কাস্টম ডাইমেনশন অন্তর্ভুক্ত; কাস্টম ডাইমেনশন সম্পর্কে আরও জানতে, দেখুন https://support.google.com/analytics/answer/14240153 । এর মধ্যে কাস্টম চ্যানেল গ্রুপও অন্তর্ভুক্ত; কাস্টম চ্যানেল গ্রুপ সম্পর্কে আরও জানতে, দেখুন https://support.google.com/analytics/answer/13051316 ।

category

string

এই ডাইমেনশনটি যে ক্যাটাগরির অন্তর্গত, তার প্রদর্শিত নাম। একই ধরনের ডাইমেনশন ও মেট্রিকগুলোকে একত্রে শ্রেণীবদ্ধ করা হয়।

sections[]

enum ( Section )

গুগল অ্যানালিটিক্সের যে বিভাগগুলিতে এই ডাইমেনশনটি প্রযোজ্য, তা নির্দিষ্ট করে।

মেট্রিকমেটাডেটা

একটি মেট্রিক ব্যাখ্যা করে।

JSON উপস্থাপনা 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
ক্ষেত্র
apiName

string

মেট্রিকের নাম। মেট্রিকের name ব্যবহারযোগ্য। উদাহরণস্বরূপ, eventCount ।

uiName

string

গুগল অ্যানালিটিক্স ইউজার ইন্টারফেসে এই মেট্রিকটির নাম। উদাহরণস্বরূপ, Event count ।

description

string

এই মেট্রিকটি কীভাবে ব্যবহৃত ও গণনা করা হয় তার বিবরণ।

deprecatedApiNames[]

string

এই মেট্রিকের জন্য নামগুলো এখনও ব্যবহারযোগ্য কিন্তু অপ্রচলিত। যদি এতে ডেটা যোগ করা থাকে, তবে এই মেট্রিকটি একটি নির্দিষ্ট সময়ের জন্য apiName অথবা deprecatedApiNames যেকোনো একটি দ্বারা উপলব্ধ হবে। অপ্রচলিত থাকার সময়কাল শেষ হওয়ার পর, মেট্রিকটি শুধুমাত্র apiName দ্বারাই উপলব্ধ হবে।

type

enum ( MetricType )

এই মেট্রিকের ধরণ।

expression

string

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

customDefinition

boolean

এই প্রপার্টির জন্য মেট্রিকটি একটি কাস্টম মেট্রিক হলে সত্য হবে।

blockedReasons[]

enum ( BlockedReason )

যদি কারণ উল্লেখ করা থাকে, তাহলে এই প্রপার্টির জন্য এই মেট্রিকটিতে আপনার অ্যাক্সেস ব্লক করা থাকবে। এই মেট্রিকের জন্য এই প্রপার্টিতে আপনার পাঠানো এপিআই অনুরোধ সফল হবে; তবে, রিপোর্টে এই মেট্রিকটির জন্য শুধুমাত্র শূন্য থাকবে। ব্লক করা মেট্রিকগুলিতে মেট্রিক ফিল্টার ব্যবহার করে করা এপিআই অনুরোধ ব্যর্থ হবে। যদি কারণগুলি খালি থাকে, তাহলে আপনি এই মেট্রিকটিতে অ্যাক্সেস পাবেন।

আরও জানতে, অ্যাক্সেস এবং ডেটা-সীমাবদ্ধতা ব্যবস্থাপনা দেখুন।

category

string

এই মেট্রিকটি যে ক্যাটাগরির অন্তর্গত, তার প্রদর্শিত নাম। একই ধরনের ডাইমেনশন ও মেট্রিকগুলোকে একত্রে শ্রেণীবদ্ধ করা হয়।

sections[]

enum ( Section )

গুগল অ্যানালিটিক্সের যে বিভাগগুলিতে এই মেট্রিকটি প্রযোজ্য, তা নির্দিষ্ট করে।

অবরুদ্ধ কারণ

এই মেট্রিকটি কেন ব্লক করা হয়েছে তার কারণসমূহ।

এনাম
BLOCKED_REASON_UNSPECIFIED এপিআই রেসপন্সে এটি কখনোই নির্দিষ্ট করা হবে না।
NO_REVENUE_METRICS যদি এটি উপস্থিত থাকে, তাহলে এই প্রপার্টির রাজস্ব-সম্পর্কিত মেট্রিক্সে আপনার অ্যাক্সেস ব্লক করা হয়েছে, এবং এই মেট্রিকটি রাজস্ব-সম্পর্কিত।
NO_COST_METRICS যদি এটি উপস্থিত থাকে, তাহলে এই প্রপার্টির জন্য খরচ-সম্পর্কিত মেট্রিকগুলিতে আপনার অ্যাক্সেস ব্লক করা হয়েছে, এবং এই মেট্রিকটি খরচ-সম্পর্কিত।

তুলনা মেটাডেটা

একটিমাত্র তুলনার মেটাডেটা।

JSON উপস্থাপনা 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
ক্ষেত্র
apiName

string

এই তুলনার রিসোর্স নাম। এটি Comparison- এর comparison ফিল্ডে ব্যবহারযোগ্য। উদাহরণস্বরূপ, 'comparisons/1234'।

uiName

string

গুগল অ্যানালিটিক্স ইউজার ইন্টারফেসের মধ্যে এই তুলনাটির নাম।

description

string

এই তুলনার বিবরণ।

রূপান্তর মেটাডেটা

একটি একক রূপান্তরের মেটাডেটা।

JSON উপস্থাপনা 
{
  "conversionAction": string,
  "displayName": string
}
ক্ষেত্র
conversionAction

string

রূপান্তর ক্রিয়ার অনন্য শনাক্তকারী। একটি রিপোর্ট অনুরোধের ConversionsSpec এর conversionActions ফিল্ডটি পূরণ করার মাধ্যমে, কোন রূপান্তরগুলিকে একটি রিপোর্টে অন্তর্ভুক্ত করতে হবে তা নির্দিষ্ট করার জন্য এই আইডিটি ব্যবহৃত হয়। উদাহরণস্বরূপ, 'conversionActions/1234'।

displayName

string

গুগল অ্যানালিটিক্স ইউজার ইন্টারফেসের মধ্যে এই কনভার্সনটির নাম।