Package google.analytics.admin.v1beta

فهرست مطالب

AnalyticsAdminService

رابط سرویس برای API مدیریت Analytics (GA4).

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection( AcknowledgeUserDataCollectionRequest ) returns ( AcknowledgeUserDataCollectionResponse )

شرایط جمع آوری داده های کاربر را برای دارایی مشخص شده تأیید می کند.

قبل از ایجاد منابع MeasurementProtocolSecret، این تأیید باید تکمیل شود (چه در رابط کاربری Google Analytics یا از طریق این API).

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension( ArchiveCustomDimensionRequest ) returns ( Empty )

یک CustomDimension را در یک ویژگی بایگانی می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric( ArchiveCustomMetricRequest ) returns ( Empty )

CustomMetric را در یک ملک بایگانی می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent( CreateConversionEventRequest ) returns ( ConversionEvent )

یک رویداد تبدیل با ویژگی های مشخص شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension( CreateCustomDimensionRequest ) returns ( CustomDimension )

یک CustomDimension ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric( CreateCustomMetricRequest ) returns ( CustomMetric )

CustomMetric ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateDataStream

rpc CreateDataStream( CreateDataStreamRequest ) returns ( DataStream )

یک DataStream ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateKeyEvent

rpc CreateKeyEvent( CreateKeyEventRequest ) returns ( KeyEvent )

یک رویداد کلیدی ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret( CreateMeasurementProtocolSecretRequest ) returns ( MeasurementProtocolSecret )

یک راز پروتکل اندازه گیری ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty( CreatePropertyRequest ) returns ( Property )

یک ویژگی "GA4" با مکان و ویژگی های مشخص شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
حذف حساب کاربری

rpc DeleteAccount( DeleteAccountRequest ) returns ( Empty )

حساب هدف را به‌عنوان پاک‌شده (یعنی «حذف‌شده») علامت‌گذاری می‌کند و آن را برمی‌گرداند.

این API روشی برای بازیابی حساب های حذف شده نرم افزاری ندارد. با این حال، آنها را می توان با استفاده از سطل زباله UI بازیابی کرد.

اگر حساب‌ها قبل از زمان انقضا بازیابی نشوند، حساب و همه منابع فرزند (به عنوان مثال: Properties، GoogleAdsLinks، Streams، AccessBindings) برای همیشه پاک می‌شوند. https://support.google.com/analytics/answer/6154772

اگر هدف پیدا نشد، خطا را برمی‌گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent( DeleteConversionEventRequest ) returns ( Empty )

یک رویداد تبدیل را در یک ویژگی حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDataStream

rpc DeleteDataStream( DeleteDataStreamRequest ) returns ( Empty )

یک DataStream را در یک ویژگی حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
DeleteKeyEvent

rpc DeleteKeyEvent( DeleteKeyEventRequest ) returns ( Empty )

یک رویداد کلیدی را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret( DeleteMeasurementProtocolSecretRequest ) returns ( Empty )

هدف MeasurementProtocolSecret را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty( DeletePropertyRequest ) returns ( Property )

ویژگی هدف را به‌عنوان پاک‌شده (یعنی «حذف‌شده») علامت‌گذاری می‌کند و آن را برمی‌گرداند.

این API روشی برای بازیابی ویژگی های حذف شده نرم ندارد. با این حال، آنها را می توان با استفاده از سطل زباله UI بازیابی کرد.

اگر ویژگی‌ها قبل از زمان انقضا بازیابی نشوند، ویژگی و همه منابع فرزند (به عنوان مثال: GoogleAdsLinks، Streams، AccessBindings) برای همیشه پاک می‌شوند. https://support.google.com/analytics/answer/6154772

اگر هدف پیدا نشود یا یک ویژگی GA4 نباشد، خطا را برمی‌گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
GetAccount

rpc GetAccount( GetAccountRequest ) returns ( Account )

جستجو برای یک حساب واحد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetConversionEvent( GetConversionEventRequest ) returns ( ConversionEvent )

یک رویداد تبدیل واحد را بازیابی کنید.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetCustomDimension( GetCustomDimensionRequest ) returns ( CustomDimension )

جستجو برای یک CustomDimension واحد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetCustomMetric( GetCustomMetricRequest ) returns ( CustomMetric )

جستجو برای یک CustomMetric واحد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetDataRetentionSettings( GetDataRetentionSettingsRequest ) returns ( DataRetentionSettings )

تنظیمات حفظ داده های singleton را برای این ویژگی برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetDataSharingSettings( GetDataSharingSettingsRequest ) returns ( DataSharingSettings )

تنظیمات اشتراک گذاری داده را در یک حساب دریافت کنید. تنظیمات اشتراک‌گذاری داده‌ها تک‌تنه هستند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetDataStream( GetDataStreamRequest ) returns ( DataStream )

جستجو برای یک DataStream واحد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetKeyEvent( GetKeyEventRequest ) returns ( KeyEvent )

یک رویداد کلیدی را بازیابی کنید.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetMeasurementProtocolSecret( GetMeasurementProtocolSecretRequest ) returns ( MeasurementProtocolSecret )

جستجو برای یک "GA4" MeasurementProtocolSecret.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc GetProperty( GetPropertyRequest ) returns ( Property )

جستجو برای یک ملک "GA4".

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListAccountSummaries( ListAccountSummariesRequest ) returns ( ListAccountSummariesResponse )

خلاصه‌ای از تمام حساب‌های قابل دسترسی تماس‌گیرنده را برمی‌گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListAccounts( ListAccountsRequest ) returns ( ListAccountsResponse )

همه حساب‌های قابل دسترسی تماس‌گیرنده را برمی‌گرداند.

توجه داشته باشید که این حساب‌ها ممکن است در حال حاضر دارای ویژگی‌های GA4 نباشند. حساب‌های حذف‌شده نرم (یعنی «حذف‌شده») به‌طور پیش‌فرض مستثنی هستند. اگر هیچ حساب مرتبطی پیدا نشد، یک لیست خالی برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListConversionEvents( ListConversionEventsRequest ) returns ( ListConversionEventsResponse )

فهرستی از رویدادهای تبدیل را در ویژگی والد مشخص شده برمی گرداند.

اگر هیچ رویداد تبدیلی پیدا نشد، یک لیست خالی برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustom Dimensions

rpc ListCustomDimensions( ListCustomDimensionsRequest ) returns ( ListCustomDimensionsResponse )

CustomDimensions را در یک ویژگی فهرست می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListCustomMetrics( ListCustomMetricsRequest ) returns ( ListCustomMetricsResponse )

CustomMetrics را در یک ویژگی فهرست می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListDataStreams( ListDataStreamsRequest ) returns ( ListDataStreamsResponse )

DataStream ها را در یک ویژگی فهرست می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListKeyEvents( ListKeyEventsRequest ) returns ( ListKeyEventsResponse )

فهرستی از رویدادهای کلیدی را در ویژگی والد مشخص شده برمی گرداند. در صورتی که هیچ رویداد کلیدی یافت نشد، یک لیست خالی برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListMeasurementProtocolSecrets( ListMeasurementProtocolSecretsRequest ) returns ( ListMeasurementProtocolSecretsResponse )

فرزند MeasurementProtocolSecrets را تحت ویژگی والد مشخص شده برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc ListProperties( ListPropertiesRequest ) returns ( ListPropertiesResponse )

ویژگی های فرزند را در حساب اصلی مشخص شده برمی گرداند.

فقط ویژگی های "GA4" برگردانده می شود. اگر تماس گیرنده دسترسی نداشته باشد، ویژگی ها حذف می شوند. ویژگی های حذف شده نرم (یعنی "حذف شده") به طور پیش فرض مستثنی هستند. اگر هیچ ویژگی مرتبطی پیدا نشد، یک لیست خالی برمی گرداند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccount Ticket

rpc ProvisionAccountTicket( ProvisionAccountTicketRequest ) returns ( ProvisionAccountTicketResponse )

درخواست یک بلیط برای ایجاد یک حساب کاربری.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
RunAccessReport

rpc RunAccessReport( RunAccessReportRequest ) returns ( RunAccessReportResponse )

یک گزارش سفارشی از سوابق دسترسی به داده ها را برمی گرداند. این گزارش سوابقی از هر بار خواندن داده های گزارش Google Analytics توسط کاربر ارائه می دهد. سوابق دسترسی تا 2 سال حفظ می شود.

گزارش های دسترسی به داده ها را می توان برای یک ملک درخواست کرد. گزارش‌ها ممکن است برای هر دارایی درخواست شوند، اما ابعادی که به سهمیه مربوط نمی‌شوند را فقط می‌توان در دارایی‌های Google Analytics 360 درخواست کرد. این روش فقط برای مدیران در دسترس است.

این سوابق دسترسی به داده ها شامل گزارش GA4 UI، GA4 UI Explorations، GA4 Data API و سایر محصولاتی مانند Firebase و Admob است که می توانند داده ها را از Google Analytics از طریق پیوند بازیابی کنند. این سوابق شامل تغییرات پیکربندی دارایی مانند افزودن جریان یا تغییر منطقه زمانی ملک نمی‌شود. برای تاریخچه تغییر پیکربندی، به searchChangeHistoryEvents مراجعه کنید.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

rpc SearchChangeHistoryEvents( SearchChangeHistoryEventsRequest ) returns ( SearchChangeHistoryEventsResponse )

با توجه به مجموعه فیلترهای مشخص شده، تمام تغییرات یک حساب یا فرزندان آن را جستجو می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
به روز رسانی حساب کاربری

rpc UpdateAccount( UpdateAccountRequest ) returns ( Account )

یک حساب کاربری را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateConversionEvent

rpc UpdateConversionEvent( UpdateConversionEventRequest ) returns ( ConversionEvent )

یک رویداد تبدیل را با ویژگی های مشخص شده به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension( UpdateCustomDimensionRequest ) returns ( CustomDimension )

یک CustomDimension را در یک ویژگی به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric( UpdateCustomMetricRequest ) returns ( CustomMetric )

CustomMetric را در یک ویژگی به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings( UpdateDataRetentionSettingsRequest ) returns ( DataRetentionSettings )

تنظیمات حفظ داده های singleton را برای این ویژگی به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataStream

rpc UpdateDataStream( UpdateDataStreamRequest ) returns ( DataStream )

یک DataStream را در یک ویژگی به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateKeyEvent

rpc UpdateKeyEvent( UpdateKeyEventRequest ) returns ( KeyEvent )

یک رویداد کلیدی را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret( UpdateMeasurementProtocolSecretRequest ) returns ( MeasurementProtocolSecret )

راز پروتکل اندازه گیری را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty( UpdatePropertyRequest ) returns ( Property )

یک ملک را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

AccessBetweenFilter

برای بیان اینکه نتیجه باید بین دو عدد (شامل) باشد.

زمینه های
from_value

NumericValue

با این عدد شروع می شود.

to_value

NumericValue

با این عدد به پایان می رسد.

AccessDateRange

محدوده روز به هم پیوسته: startDate، startDate + 1، ...، endDate.

زمینه های
start_date

string

تاریخ شروع شامل درخواست در قالب YYYY-MM-DD . نمی تواند بعد از endDate باشد. فرمت NdaysAgo ، yesterday یا today نیز پذیرفته می شود و در این صورت، تاریخ بر اساس زمان فعلی در منطقه زمانی درخواست استنباط می شود.

end_date

string

تاریخ پایان شامل درخواست در قالب YYYY-MM-DD . نمی تواند قبل از startDate باشد. فرمت NdaysAgo ، yesterday یا today نیز پذیرفته می شود و در این صورت، تاریخ بر اساس زمان فعلی در منطقه زمانی درخواست استنباط می شود.

AccessDimension

ابعاد ویژگی های داده های شما هستند. به عنوان مثال، بعد userEmail ایمیل کاربری را نشان می دهد که به داده های گزارش دسترسی داشته است. مقادیر ابعاد در پاسخ های گزارش رشته ای هستند.

زمینه های
dimension_name

string

نام API بعد. برای فهرست ابعادی که در این API پشتیبانی می‌شوند ، طرح دسترسی به داده را ببینید.

ابعاد با نام در dimensionFilter و orderBys ارجاع داده می شوند.

AccessDimensionHeader

یک ستون بعد را در گزارش توضیح می دهد. ابعاد درخواست شده در یک گزارش، ورودی های ستونی را در ردیف ها و DimensionHeader ایجاد می کند. با این حال، ابعادی که منحصراً در فیلترها یا عبارات استفاده می‌شوند، ستون‌هایی در گزارش تولید نمی‌کنند. به همین ترتیب، آن ابعاد هدر تولید نمی کنند.

زمینه های
dimension_name

string

نام ابعاد؛ به عنوان مثال 'userEmail'.

AccessDimensionValue

ارزش یک بعد

زمینه های
value

string

مقدار ابعاد به عنوان مثال، این مقدار ممکن است برای بعد "کشور" "فرانسه" باشد.

AccessFilter

عبارتی برای فیلتر ابعاد یا مقادیر متریک.

زمینه های
field_name

string

نام ابعاد یا نام متریک.

فیلد اتحادیه one_filter . یک نوع فیلتر را برای Filter مشخص کنید. one_filter تنها می تواند یکی از موارد زیر باشد:
string_filter

AccessStringFilter

فیلتر مربوط به رشته ها

in_list_filter

AccessInListFilter

فیلتری برای مقادیر در لیست.

numeric_filter

AccessNumericFilter

فیلتری برای مقادیر عددی یا تاریخ.

between_filter

AccessBetweenFilter

یک فیلتر برای دو مقدار

AccessFilterExpression

فیلترهای ابعاد یا متریک را بیان می کند. فیلدهای یک عبارت باید یا همه ابعاد یا همه معیارها باشند.

زمینه های
فیلد اتحادیه one_expression . یک نوع بیان فیلتر را برای FilterExpression مشخص کنید. one_expression می تواند تنها یکی از موارد زیر باشد:
and_group

AccessFilterExpressionList

هر یک از FilterExpressions در and_group یک رابطه AND دارند.

or_group

AccessFilterExpressionList

هر یک از FilterExpressions در or_group یک رابطه OR دارند.

not_expression

AccessFilterExpression

FilterExpression از not_expression نیست.

access_filter

AccessFilter

یک فیلتر اولیه در همان FilterExpression، همه نام‌های فیلد فیلتر باید همه ابعاد یا همه معیارها باشند.

AccessFilterExpressionList

لیستی از عبارات فیلتر.

زمینه های
expressions[]

AccessFilterExpression

لیستی از عبارات فیلتر.

AccessInListFilter

نتیجه باید در لیستی از مقادیر رشته باشد.

زمینه های
values[]

string

لیست مقادیر رشته باید خالی نباشد

case_sensitive

bool

اگر درست باشد، مقدار رشته به حروف بزرگ و کوچک حساس است.

AccessMetric

اندازه گیری های کمی یک گزارش به عنوان مثال، متریک accessCount تعداد کل رکوردهای دسترسی به داده است.

زمینه های
metric_name

string

نام API متریک. برای فهرست معیارهای پشتیبانی شده در این API ، به طرح دسترسی به داده مراجعه کنید.

معیارها با نام در metricFilter & orderBys ارجاع می‌شوند.

AccessMetricHeader

یک ستون متریک را در گزارش توضیح می دهد. معیارهای قابل مشاهده درخواست شده در یک گزارش، ورودی های ستونی را در ردیف ها و MetricHeader ایجاد می کند. با این حال، معیارهایی که منحصراً در فیلترها یا عبارات استفاده می‌شوند، ستون‌هایی را در گزارش تولید نمی‌کنند. به همین ترتیب، آن معیارها هدر تولید نمی کنند.

زمینه های
metric_name

string

نام متریک؛ برای مثال 'accessCount'.

AccessMetricValue

مقدار یک متریک

زمینه های
value

string

مقدار اندازه گیری برای مثال، این مقدار ممکن است '13' باشد.

AccessNumericFilter

فیلترهایی برای مقادیر عددی یا تاریخ.

زمینه های
operation

Operation

نوع عملکرد این فیلتر

value

NumericValue

یک مقدار عددی یا یک مقدار تاریخ.

عمل

عملیات بر روی یک فیلتر عددی اعمال می شود.

Enums
OPERATION_UNSPECIFIED نامشخص
EQUAL برابر
LESS_THAN کمتر از
LESS_THAN_OR_EQUAL کمتر یا مساوی
GREATER_THAN بزرگتر از
GREATER_THAN_OR_EQUAL بزرگتر یا مساوی

AccessOrderBy

ترتیب بر اساس تعیین می کند که ردیف ها چگونه در پاسخ مرتب می شوند. برای مثال، ترتیب ردیف‌ها با نزولی تعداد دسترسی، یک مرتبه است، و ترتیب ردیف‌ها بر اساس رشته کشور، ترتیب متفاوتی است.

زمینه های
desc

bool

اگر درست است، به ترتیب نزولی مرتب می شود. اگر نادرست یا نامشخص باشد، به ترتیب صعودی مرتب می شود.

فیلد اتحادیه one_order_by . یک نوع سفارش توسط برای OrderBy مشخص کنید. one_order_by می تواند تنها یکی از موارد زیر باشد:
metric

MetricOrderBy

نتایج را بر اساس مقادیر یک متریک مرتب می کند.

dimension

DimensionOrderBy

نتایج را بر اساس مقادیر یک بعد مرتب می کند.

DimensionOrderBy

بر اساس مقادیر ابعاد مرتب می شود.

زمینه های
dimension_name

string

نام ابعاد در درخواست سفارش توسط.

order_type

OrderType

قانون ترتیب ارزش ابعاد را کنترل می کند.

نوع سفارش

قانون ترتیب دادن مقادیر ابعاد رشته بر اساس.

Enums
ORDER_TYPE_UNSPECIFIED نامشخص
ALPHANUMERIC مرتب سازی الفبایی بر اساس نقطه کد یونیکد. به عنوان مثال، "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC مرتب سازی حروف عددی بدون حروف بزرگ و کوچک بر اساس نقطه کد یونیکد. به عنوان مثال، "2" < "A" < "b" < "X" < "z".
NUMERIC مقادیر ابعاد قبل از مرتب سازی به اعداد تبدیل می شوند. به عنوان مثال در مرتب سازی NUMERIC، "25" < "100"، و در مرتب سازی ALPHANUMERIC ، "100" < "25". مقادیر ابعاد غیر عددی همگی دارای ارزش ترتیب برابری زیر همه مقادیر عددی هستند.

MetricOrderBy

بر اساس مقادیر متریک مرتب می شود.

زمینه های
metric_name

string

یک نام متریک در درخواست سفارش توسط.

AccessQuota

وضعیت فعلی همه سهمیه‌ها برای این ویژگی Analytics. اگر هر سهمیه ای برای یک دارایی تمام شود، همه درخواست ها به آن ویژگی خطاهای Resource Exhausted را برمی گرداند.

زمینه های
tokens_per_day

AccessQuotaStatus

Properties می توانند از 250000 توکن در روز استفاده کنند. اکثر درخواست ها کمتر از 10 توکن مصرف می کنند.

tokens_per_hour

AccessQuotaStatus

Properties می توانند از 50000 توکن در ساعت استفاده کنند. یک درخواست API یک تعداد توکن مصرف می کند و این تعداد از تمام سهمیه های ساعتی، روزانه و هر پروژه کسر می شود.

concurrent_requests

AccessQuotaStatus

Properties می توانند از 50 درخواست همزمان استفاده کنند.

server_errors_per_project_per_hour

AccessQuotaStatus

ویژگی ها و جفت پروژه های ابری می توانند تا 50 خطای سرور در ساعت داشته باشند.

tokens_per_project_per_hour

AccessQuotaStatus

Properties می توانند تا 25% از توکن های خود را در هر پروژه در ساعت استفاده کنند. این یعنی Analytics 360 Properties می تواند از 12500 توکن در هر پروژه در ساعت استفاده کند. یک درخواست API یک تعداد توکن مصرف می کند و این تعداد از تمام سهمیه های ساعتی، روزانه و هر پروژه کسر می شود.

AccessQuotaStatus

وضعیت فعلی برای یک گروه سهمیه خاص.

زمینه های
consumed

int32

سهمیه مصرف شده توسط این درخواست.

remaining

int32

سهمیه پس از این درخواست باقی مانده است.

AccessRow

دسترسی به داده های گزارش برای هر ردیف.

زمینه های
dimension_values[]

AccessDimensionValue

فهرست مقادیر ابعاد این مقادیر به همان ترتیبی هستند که در درخواست مشخص شده است.

metric_values[]

AccessMetricValue

فهرست مقادیر متریک این مقادیر به همان ترتیبی هستند که در درخواست مشخص شده است.

AccessStringFilter

فیلتر رشته ها

زمینه های
match_type

MatchType

نوع مطابقت برای این فیلتر.

value

string

مقدار رشته ای که برای تطبیق استفاده می شود.

case_sensitive

bool

اگر درست باشد، مقدار رشته به حروف بزرگ و کوچک حساس است.

MatchType

نوع تطبیق فیلتر رشته ای.

Enums
MATCH_TYPE_UNSPECIFIED نامشخص
EXACT مطابقت دقیق مقدار رشته
BEGINS_WITH با مقدار رشته شروع می شود.
ENDS_WITH با مقدار رشته به پایان می رسد.
CONTAINS حاوی مقدار رشته است.
FULL_REGEXP مطابقت کامل برای عبارت منظم با مقدار رشته.
PARTIAL_REGEXP مطابقت جزئی برای عبارت منظم با مقدار رشته.

حساب

یک پیام منبع که نشان دهنده یک حساب Google Analytics است.

زمینه های
name

string

فقط خروجی نام منبع این حساب. قالب: accounts/{account} مثال: "accounts/100"

create_time

Timestamp

فقط خروجی زمانی که این حساب در ابتدا ایجاد شد.

update_time

Timestamp

فقط خروجی زمان آخرین به‌روزرسانی فیلدهای بار حساب.

display_name

string

ضروری. نام نمایشی قابل خواندن توسط انسان برای این حساب.

region_code

string

کشور تجارت. باید کد منطقه Unicode CLDR باشد.

deleted

bool

فقط خروجی نشان می دهد که آیا این حساب به صورت نرم حذف شده است یا خیر. حساب‌های حذف‌شده از نتایج فهرست حذف می‌شوند مگر اینکه به‌طور خاص درخواست شود.

gmp_organization

string

فقط خروجی URI برای یک منبع سازمانی پلتفرم بازاریابی Google. فقط زمانی تنظیم شود که این حساب به یک سازمان GMP متصل باشد. قالب: marketingplatformadmin.googleapis.com/organizations/{org_id}

خلاصه حساب

یک منبع مجازی که نمایانگر یک نمای کلی از یک حساب و تمام ویژگی‌های فرزند GA4 آن است.

زمینه های
name

string

نام منبع برای خلاصه این حساب. قالب: accountSummaries/{account_id} مثال: "accountSummaries/1000"

account

string

نام منبع حساب که توسط این خلاصه حساب به آن اشاره شده است قالب: حساب‌ها/{account_id} مثال: "accounts/1000"

display_name

string

نام نمایشی برای حساب مورد اشاره در این خلاصه حساب.

property_summaries[]

PropertySummary

فهرست خلاصه‌های حساب‌های فرزند این حساب.

AcknowledgeUserDataCollectionRequest

درخواست پیام برای AcknowledgeUserDataCollection RPC.

زمینه های
property

string

ضروری. خاصیتی که جمع آوری داده های کاربر برای آن تایید می شود.

acknowledgement

string

ضروری. تصدیق این که تماس گیرنده این روش شرایط جمع آوری داده های کاربر را درک می کند.

این فیلد باید حاوی مقدار دقیق باشد: "من تصدیق می‌کنم که افشای حریم خصوصی و حقوق لازم را از کاربران نهایی خود برای جمع‌آوری و پردازش داده‌هایشان دارم، از جمله ارتباط این داده‌ها با اطلاعات بازدید که Google Analytics از سایت من جمع‌آوری می‌کند و /یا ویژگی برنامه."

AcknowledgeUserDataCollectionResponse

این نوع هیچ فیلدی ندارد.

پیام پاسخ برای AcknowledgeUserDataCollection RPC.

ActionType

انواع اقداماتی که ممکن است یک منبع را تغییر دهد.

Enums
ACTION_TYPE_UNSPECIFIED نوع اقدام ناشناخته یا مشخص نشده است.
CREATED منبع در این تغییر ایجاد شد.
UPDATED منبع در این تغییر به روز شد.
DELETED منبع در این تغییر حذف شد.

ActorType

انواع مختلفی از بازیگران که می توانند در منابع Google Analytics تغییراتی ایجاد کنند.

Enums
ACTOR_TYPE_UNSPECIFIED نوع بازیگر نامشخص یا نامشخص.
USER تغییرات ایجاد شده توسط کاربر مشخص شده در actor_email.
SYSTEM تغییرات ایجاد شده توسط سیستم Google Analytics.
SUPPORT تغییرات ایجاد شده توسط کارکنان تیم پشتیبانی Google Analytics.

ArchiveCustomDimensionRequest

درخواست پیام برای ArchiveCustomDimension RPC.

زمینه های
name

string

ضروری. نام CustomDimension برای بایگانی. فرمت مثال: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

درخواست پیام برای ArchiveCustomMetric RPC.

زمینه های
name

string

ضروری. نام CustomMetric برای بایگانی. قالب مثال: properties/1234/customMetrics/5678

Change HistoryChange

شرح تغییر در یک منبع Google Analytics.

زمینه های
resource

string

نام منبع منبعی که تغییرات آن توسط این مدخل توضیح داده شده است.

action

ActionType

نوع اقدامی که این منبع را تغییر داد.

resource_before_change

ChangeHistoryResource

محتوای منابع مربوط به قبل از ایجاد تغییر است. اگر این منبع در این تغییر ایجاد شده باشد، این فیلد وجود ندارد.

resource_after_change

ChangeHistoryResource

محتوای منابع از پس از ایجاد تغییر. اگر این منبع در این تغییر حذف شده باشد، این فیلد وجود ندارد.

ChangeHistoryResource

یک عکس فوری از یک منبع مانند قبل یا بعد از نتیجه تغییر در تاریخچه تغییرات.

زمینه های

resource میدانی اتحادیه

resource می تواند تنها یکی از موارد زیر باشد:

account

Account

یک عکس فوری از یک منبع حساب در تاریخچه تغییرات.

property

Property

یک عکس فوری از یک منبع Property در تاریخچه تغییرات.

conversion_event

ConversionEvent

یک عکس فوری از یک منبع ConversionEvent در تاریخچه تغییرات.

measurement_protocol_secret

MeasurementProtocolSecret

یک عکس فوری از یک منبع MeasurementProtocolSecret در تاریخچه تغییرات.

data_retention_settings

DataRetentionSettings

یک عکس فوری از یک منبع تنظیمات حفظ داده در تاریخچه تغییرات.

data_stream

DataStream

یک عکس فوری از یک منبع DataStream در تاریخچه تغییرات.

ChangeHistoryEvent

مجموعه‌ای از تغییرات در حساب Google Analytics یا ویژگی‌های فرزند آن که ناشی از همین علت است. دلایل رایج به‌روزرسانی‌های ایجاد شده در رابط کاربری Google Analytics، تغییرات ناشی از پشتیبانی مشتری یا تغییرات خودکار سیستم Google Analytics است.

زمینه های
id

string

شناسه این رویداد تاریخچه تغییر. این شناسه در Google Analytics منحصر به فرد است.

change_time

Timestamp

زمانی که تغییر ایجاد شد.

actor_type

ActorType

نوع بازیگری که این تغییر را ایجاد کرد.

user_actor_email

string

آدرس ایمیل حساب Google که این تغییر را ایجاد کرده است. اگر قسمت بازیگر روی USER تنظیم شده باشد، این یک آدرس ایمیل معتبر خواهد بود و در غیر این صورت خالی خواهد بود. اکانت های گوگل که حذف شده اند باعث بروز خطا می شوند.

changes_filtered

bool

اگر درست باشد، لیست تغییرات برگشتی فیلتر شده است و همه تغییراتی را که در این رویداد رخ داده است را نشان نمی دهد.

changes[]

ChangeHistoryChange

فهرستی از تغییرات ایجاد شده در این رویداد تاریخچه تغییر که متناسب با فیلترهای مشخص شده در SearchChangeHistoryEventsRequest است.

ChangeHistoryResourceType

انواع منابعی که تغییرات آنها ممکن است از تاریخچه تغییرات بازگردانده شود.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED نوع منبع ناشناخته یا مشخص نشده است.
ACCOUNT منبع حساب
PROPERTY منبع اموال
GOOGLE_SIGNALS_SETTINGS منبع GoogleSignalsSettings
CONVERSION_EVENT منبع ConversionEvent
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret منبع
DATA_RETENTION_SETTINGS منبع DataRetentionSettings
DATA_STREAM منبع DataStream
ATTRIBUTION_SETTINGS منبع AttributionSettings

ConversionEvent

یک رویداد تبدیل در یک ویژگی Google Analytics.

زمینه های
name

string

فقط خروجی نام منبع این رویداد تبدیل. قالب: خواص/{property}/conversionEvents/{conversion_event}

event_name

string

تغییرناپذیر. نام رویداد برای این رویداد تبدیل. مثال‌ها: «کلیک»، «خرید»

create_time

Timestamp

فقط خروجی زمانی که این رویداد تبدیل در ویژگی ایجاد شد.

deletable

bool

فقط خروجی در صورت تنظیم، این رویداد در حال حاضر با DeleteConversionEvent قابل حذف است.

custom

bool

فقط خروجی اگر روی true تنظیم شود، این رویداد تبدیل به یک رویداد سفارشی اشاره دارد. اگر روی false تنظیم شود، این رویداد تبدیل به یک رویداد پیش‌فرض در GA اشاره می‌کند. رویدادهای پیش‌فرض معمولاً در GA معنای خاصی دارند. رویدادهای پیش‌فرض معمولاً توسط سیستم GA برای شما ایجاد می‌شوند، اما در برخی موارد می‌توانند توسط مدیران دارایی ایجاد شوند. رویدادهای سفارشی برای حداکثر تعداد رویدادهای تبدیل سفارشی که ممکن است در هر ویژگی ایجاد شود، حساب می‌شوند.

counting_method

ConversionCountingMethod

اختیاری. روشی که با آن تبدیل ها در چندین رویداد در یک جلسه شمارش می شوند. اگر این مقدار ارائه نشود، روی ONCE_PER_EVENT تنظیم می‌شود.

default_conversion_value

DefaultConversionValue

اختیاری. یک مقدار/ارز پیش‌فرض را برای یک رویداد تبدیل تعریف می‌کند.

ConversionCounting Method

روشی که با آن تبدیل ها در چندین رویداد در یک جلسه شمارش می شوند.

Enums
CONVERSION_COUNTING_METHOD_UNSPECIFIED روش شمارش مشخص نشده است.
ONCE_PER_EVENT هر نمونه رویداد به عنوان تبدیل در نظر گرفته می شود.
ONCE_PER_SESSION یک نمونه رویداد حداکثر یک بار در هر جلسه برای هر کاربر تبدیل در نظر گرفته می شود.

DefaultConversionValue

یک مقدار/ارز پیش‌فرض را برای یک رویداد تبدیل تعریف می‌کند. هم ارزش و هم ارز باید ارائه شود.

زمینه های
value

double

از این مقدار برای پر کردن مقدار برای همه تبدیل‌های رویداد_name مشخص شده استفاده می‌شود که در آن پارامتر رویداد "مقدار" تنظیم نشده است.

currency_code

string

وقتی یک رویداد تبدیل برای این event_name ارز تنظیمی نداشته باشد، این ارز به عنوان پیش‌فرض اعمال می‌شود. باید در قالب کد ارز ISO 4217 باشد. برای اطلاعات بیشتر به https://en.wikipedia.org/wiki/ISO_4217 مراجعه کنید.

CreateConversionEventRequest

درخواست پیام برای CreateConversionEvent RPC

زمینه های
conversion_event

ConversionEvent

ضروری. رویداد تبدیل برای ایجاد.

parent

string

ضروری. نام منبع ویژگی والد که در آن این رویداد تبدیل ایجاد خواهد شد. فرمت: خواص/123

CreateCustomDimensionRequest

درخواست پیام برای CreateCustomDimension RPC.

زمینه های
parent

string

ضروری. فرمت مثال: properties/1234

custom_dimension

CustomDimension

ضروری. CustomDimension برای ایجاد.

CreateCustomMetricRequest

درخواست پیام برای CreateCustomMetric RPC.

زمینه های
parent

string

ضروری. فرمت مثال: properties/1234

custom_metric

CustomMetric

ضروری. CustomMetric برای ایجاد.

CreateDataStreamRequest

درخواست پیام برای CreateDataStream RPC.

زمینه های
parent

string

ضروری. فرمت مثال: properties/1234

data_stream

DataStream

ضروری. DataStream برای ایجاد.

ایجاد FirebaseLinkRequest

درخواست پیام برای CreateFirebaseLink RPC

زمینه های
parent

string

ضروری. قالب: خواص/{property_id} مثال: properties/1234

ایجاد GoogleAdsLinkRequest

درخواست پیام برای CreateGoogleAdsLink RPC

زمینه های
parent

string

ضروری. فرمت مثال: properties/1234

CreateKeyEventRequest

درخواست پیام برای CreateKeyEvent RPC

زمینه های
key_event

KeyEvent

ضروری. رویداد کلیدی برای ایجاد.

parent

string

ضروری. نام منبع ویژگی والد که این رویداد کلیدی در آن ایجاد خواهد شد. فرمت: خواص/123

CreateMeasurementProtocolSecretRequest

درخواست پیام برای CreateMeasurementProtocolSecret RPC

زمینه های
parent

string

ضروری. منبع والد که در آن این راز ایجاد خواهد شد. قالب: خواص/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

ضروری. راز پروتکل اندازه گیری برای ایجاد.

CreatePropertyRequest

درخواست پیام برای CreateProperty RPC.

زمینه های
property

Property

ضروری. دارایی برای ایجاد. نکته: ملک عرضه شده باید والد خود را مشخص کند.

ابعاد سفارشی

تعریفی برای CustomDimension.

زمینه های
name

string

فقط خروجی نام منبع برای این منبع CustomDimension. قالب: خواص/{property}/customDimensions/{customDimension}

parameter_name

string

ضروری. تغییرناپذیر. برچسب گذاری نام پارامتر برای این بعد سفارشی.

اگر این یک بعد با محدوده کاربر است، این نام ویژگی کاربر است. اگر این یک بعد با دامنه رویداد است، این نام پارامتر رویداد است.

اگر این یک بعد با دامنه مورد است، این نام پارامتر موجود در آرایه اقلام تجارت الکترونیک است.

ممکن است فقط شامل نویسه‌های حروف عددی و زیرخط باشد که با یک حرف شروع می‌شوند. حداکثر طول 24 نویسه برای ابعاد با محدوده کاربر، 40 نویسه برای ابعاد با محدوده رویداد.

display_name

string

ضروری. نام نمایشی برای این بعد سفارشی همانطور که در رابط کاربری Analytics نشان داده شده است. حداکثر طول 82 کاراکتر، حروف عددی به اضافه فاصله و خط زیر که با یک حرف شروع می شود. نام‌های نمایشی تولید شده توسط سیستم قدیمی ممکن است دارای کروشه باشد، اما به‌روزرسانی‌های این فیلد هرگز اجازه ایجاد براکت را نمی‌دهد.

description

string

اختیاری. توضیحات برای این بعد سفارشی. حداکثر طول 150 کاراکتر

scope

DimensionScope

ضروری. تغییرناپذیر. دامنه این بعد.

disallow_ads_personalization

bool

اختیاری. اگر روی درست تنظیم شود، این بعد را به عنوان NPA تنظیم می کند و آن را از شخصی سازی تبلیغات مستثنی می کند.

این در حال حاضر فقط توسط ابعاد سفارشی با محدوده کاربر پشتیبانی می شود.

DimensionScope

مقادیر معتبر برای دامنه این بعد.

Enums
DIMENSION_SCOPE_UNSPECIFIED محدوده نامعلوم یا مشخص نشده است.
EVENT ابعاد به یک رویداد.
USER ابعاد برای یک کاربر.
ITEM ابعاد محدوده به موارد تجارت الکترونیک

سفارشی متریک

تعریفی برای یک متریک سفارشی.

زمینه های
name

string

فقط خروجی نام منبع برای این منبع CustomMetric. قالب: خواص/{property}/customMetrics/{customMetric}

parameter_name

string

ضروری. تغییرناپذیر. نام برچسب گذاری برای این معیار سفارشی.

اگر این یک متریک با محدوده رویداد است، این نام پارامتر رویداد است.

ممکن است فقط شامل نویسه‌های حروف عددی و زیرخط باشد که با یک حرف شروع می‌شوند. حداکثر طول 40 نویسه برای معیارهای محدوده رویداد.

display_name

string

ضروری. نام نمایشی برای این معیار سفارشی همانطور که در رابط کاربری Analytics نشان داده شده است. حداکثر طول 82 کاراکتر، حروف عددی به اضافه فاصله و خط زیر که با یک حرف شروع می شود. نام‌های نمایشی تولید شده توسط سیستم قدیمی ممکن است دارای کروشه باشد، اما به‌روزرسانی‌های این فیلد هرگز اجازه ایجاد براکت را نمی‌دهد.

description

string

اختیاری. توضیحات برای این بعد سفارشی. حداکثر طول 150 کاراکتر

measurement_unit

MeasurementUnit

ضروری. نوع مقدار متریک سفارشی.

scope

MetricScope

ضروری. تغییرناپذیر. دامنه این معیار سفارشی.

restricted_metric_type[]

RestrictedMetricType

اختیاری. انواع داده‌های محدود شده که این معیار ممکن است شامل شود. برای معیارهای با واحد اندازه گیری CURRENCY مورد نیاز است. برای معیارهای دارای واحد اندازه گیری غیر ارزی باید خالی باشد.

واحد اندازه گیری

انواع احتمالی نمایش مقدار معیار سفارشی.

نمایش ارز ممکن است در آینده تغییر کند، که نیاز به تغییر API قطعی دارد.

Enums
MEASUREMENT_UNIT_UNSPECIFIED واحد اندازه گیری مشخص نشده یا وجود ندارد.
STANDARD این معیار از واحدهای پیش فرض استفاده می کند.
CURRENCY این معیار یک واحد پولی را اندازه گیری می کند.
FEET این متریک پاها را اندازه گیری می کند.
METERS این متریک متر را اندازه گیری می کند.
KILOMETERS این متریک کیلومتر را اندازه گیری می کند.
MILES این متریک مایل ها را اندازه گیری می کند.
MILLISECONDS این متریک میلی ثانیه را اندازه گیری می کند.
SECONDS این متریک ثانیه ها را اندازه گیری می کند.
MINUTES این متریک دقیقه ها را اندازه گیری می کند.
HOURS این متریک ساعت ها را اندازه گیری می کند.

MetricScope

دامنه این متریک.

Enums
METRIC_SCOPE_UNSPECIFIED محدوده نامعلوم یا مشخص نشده است.
EVENT مقیاس اندازه گیری به یک رویداد.

RestrictedMetricType

برچسب‌هایی که داده‌ها را در این معیار سفارشی به‌عنوان داده‌هایی که باید به کاربران خاصی محدود شود، علامت‌گذاری می‌کنند.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED ناشناخته یا نامشخص را تایپ کنید.
COST_DATA گزارش های متریک داده های هزینه.
REVENUE_DATA داده های درآمد را گزارش می کند.

dataretentionsettings

مقادیر تنظیمات برای حفظ داده ها. این یک منبع مجرد است.

زمینه های
name

string

فقط خروجی نام منبع برای این منبع اطلاعاتی. قالب: Properties/{Properties}/DateAretEntionSettings

event_data_retention

RetentionDuration

مدت زمانی که داده های سطح رویداد حفظ می شود.

reset_user_data_on_new_activity

bool

اگر درست است ، دوره نگهداری را برای شناسه کاربر با هر رویداد از آن کاربر تنظیم کنید.

تجویز

مقادیر معتبر برای مدت حفظ داده ها.

Enums
RETENTION_DURATION_UNSPECIFIED مدت زمان نگهداری داده ها مشخص نشده است.
TWO_MONTHS مدت زمان حفظ داده ها 2 ماه است.
FOURTEEN_MONTHS مدت زمان حفظ داده ها 14 ماه است.
TWENTY_SIX_MONTHS مدت زمان حفظ داده ها 26 ماه است. فقط در دسترس 360 خاصیت است.
THIRTY_EIGHT_MONTHS مدت زمان نگهداری داده ها 38 ماه است. فقط در دسترس 360 خاصیت است.
FIFTY_MONTHS مدت زمان حفظ داده ها 50 ماه است. فقط در دسترس 360 خاصیت است.

Datasharingsettings

یک پیام منبع که تنظیمات به اشتراک گذاری داده ها از یک حساب Google Analytics را نشان می دهد.

زمینه های
name

string

فقط خروجی نام منبع. قالب: حساب ها/{حساب}/Datasharingsettings مثال: "حساب ها/1000/Datasharingsettings"

sharing_with_google_support_enabled

bool

به پشتیبانی Google اجازه می دهد تا به داده ها دسترسی پیدا کند تا بتواند مشکلات عیب یابی را انجام دهد.

sharing_with_google_assigned_sales_enabled

bool

به تیم های فروش Google که به مشتری اختصاص داده شده اند اجازه می دهد تا به داده ها دسترسی پیدا کنند تا تغییرات پیکربندی را برای بهبود نتایج پیشنهاد دهند. محدودیت های تیم فروش هنوز در صورت فعال بودن اعمال می شود.

sharing_with_google_any_sales_enabled

bool

به هر یک از فروش های Google اجازه می دهد تا به داده ها دسترسی پیدا کند تا تغییرات پیکربندی را برای بهبود نتایج پیشنهاد کند.

sharing_with_google_products_enabled

bool

به Google اجازه می دهد تا از داده ها برای بهبود سایر محصولات یا خدمات Google استفاده کند.

sharing_with_others_enabled

bool

به Google اجازه می دهد تا داده ها را به صورت ناشناس به صورت کل با دیگران به اشتراک بگذارد.

جریان داده ها

یک پیام منبع که یک جریان داده را نشان می دهد.

زمینه های
name

string

فقط خروجی نام منابع این جریان داده. قالب: Properties/{Propert_id}/DataStreams/{stream_id} مثال: "Properties/1000/DataStreams/2000"

type

DataStreamType

ضروری. تغییرناپذیر. نوع این منبع DataStream.

display_name

string

نام صفحه نمایش قابل خواندن انسانی برای جریان داده.

برای جریان داده های وب مورد نیاز است.

طول نام مجاز نمایش حداکثر 255 واحد کد UTF-16 است.

create_time

Timestamp

فقط خروجی زمانی که این جریان در ابتدا ایجاد شده بود.

update_time

Timestamp

فقط خروجی زمان آخرین به روزرسانی قسمت های بارگذاری جریان.

Union Field stream_data . داده ها برای انواع جریان داده های خاص. پیامی که تنظیم می شود با نوع این جریان مطابقت دارد. stream_data فقط می تواند یکی از موارد زیر باشد:
web_stream_data

WebStreamData

داده های خاص برای جریان های وب. اگر Type Web_data_stream باشد ، باید جمع شود.

android_app_stream_data

AndroidAppStreamData

داده های خاص برای جریان برنامه Android. اگر نوع Android_App_Data_Stream باشد ، باید جمع شود.

ios_app_stream_data

IosAppStreamData

داده های خاص برای جریان برنامه iOS. اگر نوع IOS_APP_DATA_STREAM باشد ، باید جمع شود.

AndroidAppstreamData

داده های خاص برای جریان برنامه Android.

زمینه های
firebase_app_id

string

فقط خروجی در صورت وجود شناسه برنامه Android مربوطه در Firebase. در صورت حذف و بازآفرینی برنامه Android ، این شناسه می تواند تغییر کند.

package_name

string

تغییرناپذیر. نام بسته برای برنامه اندازه گیری شده است. مثال: "com.example.myandroidapp"

دیتارایم

نوع جریان داده.

Enums
DATA_STREAM_TYPE_UNSPECIFIED ناشناخته یا مشخص نشده است.
WEB_DATA_STREAM جریان داده های وب.
ANDROID_APP_DATA_STREAM جریان داده برنامه Android.
IOS_APP_DATA_STREAM جریان داده برنامه iOS.

iOSappstreamData

داده های خاص برای جریان برنامه iOS.

زمینه های
firebase_app_id

string

فقط خروجی در صورت وجود شناسه برنامه iOS مربوطه در Firebase. اگر برنامه iOS حذف و بازآفرینی شود ، این شناسه می تواند تغییر کند.

bundle_id

string

ضروری. تغییرناپذیر. شناسه بسته فروشگاه App App برای مثال برنامه: "com.example.myiosapp"

WebStreamData

داده های خاص برای جریان های وب.

زمینه های
measurement_id

string

فقط خروجی شناسه اندازه گیری تجزیه و تحلیل.

مثال: "G-1A2BCD345E"

firebase_app_id

string

فقط خروجی شناسه برنامه وب مربوطه در Firebase ، در صورت وجود. در صورت حذف و بازآفرینی برنامه وب ، این شناسه می تواند تغییر کند.

default_uri

string

نام دامنه برنامه وب اندازه گیری شده یا خالی است. مثال: "http://www.google.com" ، "https://www.google.com"

حذف

درخواست پیام برای حذف RPC.

زمینه های
name

string

ضروری. نام حساب به Delete Soft. قالب: حساب ها/{حساب} مثال: "حساب/100"

DeleteConversionEventRequest

درخواست پیام برای حذف RPC

زمینه های
name

string

ضروری. نام منبع رویداد تبدیل برای حذف. قالب: Properties/{Properties}/ConversionEvents/{Conversion_Event} مثال: "Properties/123/ConversionEvents/456"

DeletEdataStreamRequest

درخواست پیام برای حذف RPC.

زمینه های
name

string

ضروری. نام DataStream برای حذف. قالب مثال: Properties/1234/DataStreams/5678

DeletefireBaselinkRequest

درخواست پیام برای DeletefireBaselink RPC

زمینه های
name

string

ضروری. قالب: Properties/{Propert_id}/FireBaselinks/{Firebase_Link_Id} مثال: Properties/1234/Firebaselinks/5678

DeleteGoOgLeadSlinkRequest

پیام درخواست DeleteGoOgLeadSlink RPC.

زمینه های
name

string

ضروری. قالب مثال: Properties/1234/googleadslinks/5678

DeletKeyeVentRequest

پیام درخواست DeleteKeyevent RPC

زمینه های
name

string

ضروری. نام منبع رویداد اصلی برای حذف. قالب: Properties/{Properties}/keyevents/{key_event} مثال: "ویژگی ها/123/keyevents/456"

releeMeSeasurementProtoColSecretRequest

پیام درخواست حذف RPC برای حذف

زمینه های
name

string

ضروری. نام اندازه گیری protocolsecret برای حذف. قالب: Properties/{Properties}/DataStreams/{DataStream}/اندازه گیری protocolsecrets/{اندازه گیری protocolsecret}

DeletePropertyRequest

پیام درخواست DeleteProperty RPC.

زمینه های
name

string

ضروری. نام این ملک به Delete Soft. قالب: Properties/{Propert_id} مثال: "ویژگی ها/1000"

getAccountrequest

پیام درخواست GetAccount RPC.

زمینه های
name

string

ضروری. نام حساب برای جستجوی. قالب: حساب ها/{حساب} مثال: "حساب/100"

getConversionEventRequest

پیام درخواست برای getConversionEvent rpc

زمینه های
name

string

ضروری. نام منبع رویداد تبدیل برای بازیابی. قالب: Properties/{Properties}/ConversionEvents/{Conversion_Event} مثال: "Properties/123/ConversionEvents/456"

getCustomDimensionRequest

درخواست پیام برای GetCustomDimension RPC.

زمینه های
name

string

ضروری. نام سفارشی برای دریافت. قالب مثال: Properties/1234/CustomDimensions/5678

getCustMetricRequest

درخواست پیام برای GetCustMometric RPC.

زمینه های
name

string

ضروری. نام Custommetric برای بدست آوردن. قالب مثال: Properties/1234/Custommetrics/5678

getDataretEntionSettingsRequest

درخواست پیام برای getDataretEntionSettings RPC.

زمینه های
name

string

ضروری. نام تنظیمات برای جستجوی. قالب: Properties/{Properties}/DataRetentionSettings مثال: "ویژگی ها/1000/DataRetentionSettings"

getDatasharingsettingsRequest

درخواست پیام برای getDatasharingSettings RPC.

زمینه های
name

string

ضروری. نام تنظیمات برای جستجوی. قالب: حساب ها/{حساب}/Datasharingsettings مثال: "حساب ها/1000/Datasharingsettings"

GetDataStreamRequest

پیام درخواست GetDataStream RPC.

زمینه های
name

string

ضروری. نام DataStream برای بدست آوردن. قالب مثال: Properties/1234/DataStreams/5678

GetKeyeventRequest

پیام درخواست GetKeyevent RPC

زمینه های
name

string

ضروری. نام منبع رویداد اصلی برای بازیابی. قالب: Properties/{Properties}/keyevents/{key_event} مثال: "ویژگی ها/123/keyevents/456"

اندازه گیری getMeasurementProtocolSecretRequest

پیام درخواست GetMeasurementProtoColsecret RPC.

زمینه های
name

string

ضروری. نام پروتکل اندازه گیری راز برای جستجوی. قالب: Properties/{Properties}/DataStreams/{DataStream}/اندازه گیری protocolsecrets/{اندازه گیری protocolsecret}

GetPropertyRequest

پیام درخواست GetProperty RPC.

زمینه های
name

string

ضروری. نام ملک برای جستجوی. قالب: Properties/{Propert_id} مثال: "ویژگی ها/1000"

گروه

دسته انتخاب شده برای این ملک ، که برای معیار صنعت استفاده می شود.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED دسته صنعت نامشخص است
AUTOMOTIVE خودرو
BUSINESS_AND_INDUSTRIAL_MARKETS بازارهای تجاری و صنعتی
FINANCE دارایی، مالیه، سرمایه گذاری
HEALTHCARE مراقبت های بهداشتی
TECHNOLOGY فن آوری
TRAVEL مسافرت رفتن
OTHER دیگر
ARTS_AND_ENTERTAINMENT هنر و سرگرمی
BEAUTY_AND_FITNESS زیبایی و تناسب اندام
BOOKS_AND_LITERATURE کتاب و ادبیات
FOOD_AND_DRINK غذا و نوشیدنی
GAMES بازی ها
HOBBIES_AND_LEISURE سرگرمی ها و اوقات فراغت
HOME_AND_GARDEN خانه و باغ
INTERNET_AND_TELECOM اینترنت و مخابرات
LAW_AND_GOVERNMENT قانون و حکومت
NEWS اخبار
ONLINE_COMMUNITIES جوامع آنلاین
PEOPLE_AND_SOCIETY مردم و جامعه
PETS_AND_ANIMALS حیوانات خانگی و حیوانات
REAL_ESTATE مشاور املاک
REFERENCE ارجاع
SCIENCE علوم پایه
SPORTS ورزش ها
JOBS_AND_EDUCATION مشاغل و تحصیلات
SHOPPING خريد كردن

رویداد کلیدی

یک رویداد کلیدی در یک ویژگی Google Analytics.

زمینه های
name

string

فقط خروجی نام منابع این رویداد کلیدی. قالب: Properties/{Properties}/keyevents/{key_event}

event_name

string

تغییرناپذیر. نام رویداد برای این رویداد کلیدی. مثال: "کلیک کنید" ، "خرید"

create_time

Timestamp

فقط خروجی زمانی که این رویداد کلیدی در این ملک ایجاد شد.

deletable

bool

فقط خروجی اگر درست تنظیم شود ، این رویداد قابل حذف است.

custom

bool

فقط خروجی اگر درست تنظیم شود ، این رویداد کلیدی به یک رویداد سفارشی اشاره دارد. اگر روی False تنظیم شود ، این رویداد کلیدی به یک رویداد پیش فرض در GA اشاره دارد. رویدادهای پیش فرض به طور معمول در GA معنای خاصی دارند. رویدادهای پیش فرض معمولاً توسط سیستم GA برای شما ایجاد می شود ، اما در برخی موارد می تواند توسط سرپرستان املاک ایجاد شود. رویدادهای سفارشی به حداکثر تعداد رویدادهای کلیدی سفارشی که ممکن است در هر ملک ایجاد شود ، حساب می شود.

counting_method

CountingMethod

ضروری. روشی که در طی یک جلسه وقایع کلیدی در چندین رویداد شمارش می شود.

default_value

DefaultValue

اختیاری. مقدار/ارز پیش فرض را برای یک رویداد کلیدی تعریف می کند.

شمارش

روشی که در طی یک جلسه وقایع کلیدی در چندین رویداد شمارش می شود.

Enums
COUNTING_METHOD_UNSPECIFIED روش شمارش مشخص نشده است.
ONCE_PER_EVENT هر نمونه رویداد یک رویداد کلیدی محسوب می شود.
ONCE_PER_SESSION یک نمونه رویداد حداکثر یک رویداد کلیدی در هر جلسه در هر کاربر در نظر گرفته می شود.

مقدار پیش فرض

مقدار/ارز پیش فرض را برای یک رویداد کلیدی تعریف می کند.

زمینه های
numeric_value

double

ضروری. این برای جمع آوری پارامتر "مقدار" برای همه وقایع این رویداد کلیدی (مشخص شده توسط event_name) استفاده می شود که در آن پارامتر غیرقانونی است.

currency_code

string

ضروری. هنگامی که وقوع این رویداد کلیدی (مشخص شده توسط Event_Name) هیچ ارز مشخصی ندارد این ارز به عنوان پیش فرض اعمال می شود. باید در قالب کد ارز ISO 4217 باشد.

برای اطلاعات بیشتر به https://en.wikipedia.org/wiki/iso_4217 مراجعه کنید.

ListAccountSummariesRequest

درخواست پیام برای ListAccountSummaries RPC.

زمینه های
page_size

int32

حداکثر تعداد منابع حساب کاربری برای بازگشت. حتی اگر صفحات اضافی وجود داشته باشد ، ممکن است این سرویس کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک صفحه صفحه ، که از یک تماس قبلی ListAccountSummaries دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. در هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListAccountSummaries باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

پاسخ listAccountSummariesResponse

پیام پاسخ برای ListAccountSummaries RPC.

زمینه های
account_summaries[]

AccountSummary

خلاصه حساب کلیه حسابهایی که تماس گیرنده به آن دسترسی دارد.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

listAccountSrequest

پیام درخواست ListAccounts RPC.

زمینه های
page_size

int32

حداکثر تعداد منابع برای بازگشت. حتی اگر صفحات اضافی وجود داشته باشد ، ممکن است این سرویس کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک نشان صفحه ، از یک تماس قبلی ListAccounts دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. در هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListAccounts باید با تماس ارائه شده با صفحه صفحه مطابقت داشته باشند.

show_deleted

bool

در این که شامل حساب های حذف شده نرم (یعنی: "Trashed") در نتایج است. برای تعیین اینکه آیا آنها حذف شده اند یا نه ، می توان حساب ها را مورد بازرسی قرار داد.

لیست

پیام درخواست ListAccounts RPC.

زمینه های
accounts[]

Account

نتایج قابل دسترسی برای تماس گیرنده.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListConversionEventSrequest

درخواست پیام برای لیست conversionevents rpc

زمینه های
parent

string

ضروری. نام منابع دارایی والدین. مثال: "خواص/123"

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک صفحه صفحه ، که از یک تماس قبلی ListConversionEvents دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده برای ListConversionEvents باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

لیست لیست

پیام پاسخ برای ListConversionEvents RPC.

زمینه های
conversion_events[]

ConversionEvent

رویدادهای تبدیل درخواست شده

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListCustomDimensionSrequest

درخواست پیام برای ListCustomDimensions RPC.

زمینه های
parent

string

ضروری. قالب مثال: Properties/1234

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اجبار می شود).

page_token

string

یک صفحه صفحه ، که از یک تماس قبلی ListCustomDimensions دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListCustomDimensions باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

listCustomDimensResponse

پیام پاسخ برای ListCustomDimensions RPC.

زمینه های
custom_dimensions[]

CustomDimension

لیست موارد سفارشی.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListCustommetricsRequest

درخواست پیام برای ListCustommetrics RPC.

زمینه های
parent

string

ضروری. قالب مثال: Properties/1234

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اجبار می شود).

page_token

string

یک صفحه صفحه ، که از یک تماس قبلی ListCustomMetrics دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListCustomMetrics باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

لیست

پیام پاسخ برای ListCustommetrics RPC.

زمینه های
custom_metrics[]

CustomMetric

لیست Custommetrics.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListDataStreamsRequest

درخواست پیام برای ListDataStreams RPC.

زمینه های
parent

string

ضروری. قالب مثال: Properties/1234

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اجبار می شود).

page_token

string

یک نشان صفحه ، از تماس قبلی ListDataStreams دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListDataStreams باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

پاسخ لیست

پیام پاسخ برای ListDataStreams RPC.

زمینه های
data_streams[]

DataStream

لیست داده ها.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

listfirebaselinksrequest

درخواست پیام برای لیست firebaselinks rpc

زمینه های
parent

string

ضروری. قالب: Properties/{Propert_id} مثال: Properties/1234

page_size

int32

حداکثر تعداد منابع برای بازگشت. حتی اگر صفحات اضافی وجود داشته باشد ، ممکن است این سرویس کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک نشان صفحه ، از تماس قبلی ListFirebaseLinks دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListFirebaseLinks باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

listfirebaselinksresponse

پیام پاسخ برای ListfireBaselinks RPC

زمینه های
next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد. در حال حاضر ، Google Analytics فقط از یک Firebaselink در هر ملک پشتیبانی می کند ، بنابراین این هرگز جمع نمی شود.

listgoogleadslinksrequest

درخواست پیام برای ListGoOgLeadSlinks RPC.

زمینه های
parent

string

ضروری. قالب مثال: Properties/1234

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اجبار می شود).

page_token

string

یک صفحه صفحه ، که از یک تماس قبلی ListGoogleAdsLinks دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListGoogleAdsLinks باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

لیست

پیام پاسخ برای ListGoOgLeadSlinks RPC.

زمینه های
next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListKeyeventSrequest

درخواست پیام برای ListKeyevents RPC

زمینه های
parent

string

ضروری. نام منابع دارایی والدین. مثال: "خواص/123"

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک صفحه صفحه ، از تماس قبلی ListKeyEvents دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListKeyEvents باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

لیست لیست

پیام پاسخ برای ListKeyevents RPC.

زمینه های
key_events[]

KeyEvent

رویدادهای کلیدی درخواست شده

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

steaseMeasurementProtocolsecretSrequest

درخواست پیام برای ListMeasurementProtoColsecret RPC

زمینه های
parent

string

ضروری. نام منابع جریان والدین. قالب: Properties/{Properties}/DataStreams/{DataStream}/اندازه گیری protocolsecrets

page_size

int32

حداکثر تعداد منابع برای بازگشت. در صورت نامشخص ، حداکثر 10 منبع بازگردانده می شود. حداکثر مقدار 10 است. مقادیر بالاتر به حداکثر اجبار می شوند.

page_token

string

یک صفحه صفحه ، که از تماس قبلی ListMeasurementProtocolSecrets دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListMeasurementProtocolSecrets باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

لیست اندازه گیری

پیام پاسخ برای ListMeasurementProtoColsecret RPC

زمینه های
measurement_protocol_secrets[]

MeasurementProtocolSecret

لیستی از اسرار برای جریان والدین مشخص شده در درخواست.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListPropertiesRequest

درخواست پیام برای ListProperties RPC.

زمینه های
filter

string

ضروری. عبارتی برای فیلتر کردن نتایج درخواست. زمینه های واجد شرایط برای فیلتر عبارتند از: parent: (نام منبع حساب والدین/دارایی) یا ancestor: (نام منبع حساب والدین) یا firebase_project: (شناسه یا تعداد پروژه Firebase مرتبط). برخی از نمونه های فیلترها:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

حداکثر تعداد منابع برای بازگشت. حتی اگر صفحات اضافی وجود داشته باشد ، ممکن است این سرویس کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 50 منبع بازگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر به حداکثر اجبار می شود)

page_token

string

یک نشان صفحه ، از یک تماس قبلی ListProperties دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. در هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده به ListProperties باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

show_deleted

bool

آیا شامل خواص حذف شده نرم (به عنوان مثال: "زباله") در نتایج است. برای تعیین اینکه آیا آنها حذف شده اند یا خیر ، می توان از خواص بازرسی کرد.

ListPropertiesResponse

پیام پاسخ برای ListProperties RPC.

زمینه های
properties[]

Property

نتایج حاصل از معیارهای فیلتر و در دسترس تماس گیرنده.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

اندازه گیری

مقدار مخفی که برای ارسال بازدیدها به پروتکل اندازه گیری استفاده می شود.

زمینه های
name

string

فقط خروجی نام منابع این راز. این راز ممکن است فرزند هر نوع جریان باشد. قالب: Properties/{Properties}/DataStreams/{DataStream}/اندازه گیری protocolsecrets/{اندازه گیری protocolsecret}

display_name

string

ضروری. نام نمایشگر قابل خواندن انسانی برای این راز.

secret_value

string

فقط خروجی پروتکل اندازه گیری مقدار مخفی. این مقدار را به قسمت API_SECRET پروتکل اندازه گیری API هنگام ارسال بازدیدها به دارایی والدین این راز منتقل کنید.

مقدار عددی

برای نمایندگی یک عدد.

زمینه های
Union Field one_value . یکی از مقدار عددی one_value فقط می تواند یکی از موارد زیر باشد:
int64_value

int64

مقدار عدد صحیح

double_value

double

دو برابر

ویژگی

یک پیام منبع که یک ویژگی Google Analytics GA4 را نشان می دهد.

زمینه های
name

string

فقط خروجی نام منابع این ملک. قالب: Properties/{Propert_id} مثال: "ویژگی ها/1000"

property_type

PropertyType

تغییرناپذیر. نوع ملک برای این منبع املاک. هنگام ایجاد یک ویژگی ، اگر نوع "Propert_type_unspecified" باشد ، "Irminary_Property" دلالت خواهد کرد.

create_time

Timestamp

فقط خروجی زمانی که در ابتدا موجودیت ایجاد شده بود.

update_time

Timestamp

فقط خروجی زمان آخرین به روزرسانی قسمت های بارگذاری موجودیت.

parent

string

تغییرناپذیر. نام منابع والدین منطقی این ویژگی.

توجه: از UI با حرکت ملک می توان برای تغییر والدین استفاده کرد. قالب: حساب ها/{حساب} ، ویژگی ها/{ویژگی} مثال: "حساب/100" ، "ویژگی ها/101"

display_name

string

ضروری. نام صفحه نمایش قابل خواندن انسانی برای این ویژگی.

حداکثر طول نام نام صفحه نمایش 100 واحد کد UTF-16 است.

industry_category

IndustryCategory

صنعت مرتبط با این ملک مثال: خودرو ، Food_and_drink

time_zone

string

ضروری. گزارش منطقه زمانی ، بدون توجه به اینکه داده ها از کجا سرچشمه می گیرند ، به عنوان مرز روز برای گزارش ها استفاده می شود. اگر منطقه زمانی از DST افتخار کند ، تجزیه و تحلیل به طور خودکار برای تغییرات تنظیم می شود.

توجه: تغییر منطقه زمانی فقط داده ها را به جلو می برد و به صورت برگشتی اعمال نمی شود.

فرمت: https://www.iana.org/time-overse مثال: "آمریکا/LOS_ANGELES"

currency_code

string

نوع ارز مورد استفاده در گزارش های مربوط به مقادیر پولی.

قالب: https://en.wikipedia.org/wiki/iso_4217 مثال: "USD" ، "EUR" ، "JPY"

service_level

ServiceLevel

فقط خروجی سطح خدمات Google Analytics که در مورد این ویژگی اعمال می شود.

delete_time

Timestamp

فقط خروجی در صورت تنظیم ، زمانی که این ملک خراب شد. اگر تنظیم نشده باشد ، این ملک در حال حاضر در سطل زباله نیست.

expire_time

Timestamp

فقط خروجی در صورت تنظیم ، زمانی که این خاصیت زباله به طور دائم حذف می شود. اگر تنظیم نشده باشد ، این خاصیت در حال حاضر در سطل زباله نیست و قرار نیست حذف شود.

account

string

تغییرناپذیر. نام منبع فرمت حساب والدین: حساب ها/{حساب_id} مثال: "حساب ها/123"

خواص

یک منبع مجازی به نمایندگی از ابرداده برای یک ویژگی GA4.

زمینه های
property

string

نام منبع املاک که توسط این قالب خلاصه املاک مورد اشاره قرار گرفته است: Properties/{Propert_id} مثال: "Properties/1000"

display_name

string

نمایش نام برای ملک ذکر شده در این خلاصه ملک.

property_type

PropertyType

نوع ملک.

parent

string

نام منابع والدین منطقی این ویژگی.

توجه: از UI با حرکت ملک می توان برای تغییر والدین استفاده کرد. قالب: حساب ها/{حساب} ، ویژگی ها/{ویژگی} مثال: "حساب/100" ، "ویژگی ها/200"

PropertyType

انواع منابع املاک.

Enums
PROPERTY_TYPE_UNSPECIFIED نوع خاصیت ناشناخته یا نامشخص
PROPERTY_TYPE_ORDINARY املاک معمولی GA4
PROPERTY_TYPE_SUBPROPERTY زیرمجموعه GA4
PROPERTY_TYPE_ROLLUP خاصیت Rollup GA4

رفیق

درخواست پیام برای ارائه RPC.

زمینه های
account

Account

حساب برای ایجاد.

redirect_uri

string

تغییر مسیر URI که در آن کاربر پس از پذیرش شرایط خدمات ارسال می شود. باید در کنسول ابری به عنوان URI تغییر مسیر پیکربندی شود.

پیش بینی

پیام پاسخ برای RPC PresentAccountTicket.

زمینه های
account_ticket_id

string

پارامتر باید در لینک TOS منتقل شود.

RunaccessReportrequest

درخواست گزارش ضبط دسترسی به داده ها.

زمینه های
entity

string

گزارش دسترسی به داده ها از درخواست در سطح ملک یا سطح حساب پشتیبانی می کند. در صورت درخواست در سطح حساب ، گزارش های دسترسی به داده ها شامل دسترسی به کلیه خصوصیات تحت آن حساب می شوند.

برای درخواست در سطح ملک ، اگر "123" شناسه خاصیت GA4 شما باشد ، باید به عنوان مثال "Properties/123" باشد. برای درخواست در سطح حساب ، اگر "1234" شناسه حساب GA4 شما باشد ، باید به عنوان مثال "حساب ها/1234" باشد.

dimensions[]

AccessDimension

ابعاد درخواست شده و در پاسخ نمایش داده می شود. درخواست ها تا 9 بعد مجاز است.

metrics[]

AccessMetric

معیارهای درخواست شده و در پاسخ نمایش داده می شوند. درخواست ها تا 10 معیار مجاز است.

date_ranges[]

AccessDateRange

محدوده تاریخ سوابق دسترسی برای خواندن. در صورت درخواست دامنه های چند تاریخ ، هر سطر پاسخ شامل شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشد ، سوابق دسترسی برای روزهای همپوشانی در ردیف های پاسخ برای هر دو محدوده تاریخ گنجانده شده است. درخواست ها تا 2 محدوده تاریخ مجاز است.

dimension_filter

AccessFilterExpression

فیلترهای ابعاد به شما امکان می دهد پاسخ گزارش به مقادیر ابعاد خاص را که با فیلتر مطابقت دارند محدود کنید. به عنوان مثال ، فیلتر کردن سوابق دسترسی یک کاربر واحد. برای کسب اطلاعات بیشتر ، برای مثال به اصول فیلترهای ابعاد مراجعه کنید. از معیارها در این فیلتر قابل استفاده نیست.

metric_filter

AccessFilterExpression

فیلترهای متریک به شما امکان می دهند پاسخ گزارش را به مقادیر متریک خاص که با فیلتر مطابقت دارند محدود کنید. فیلترهای متریک پس از جمع کردن ردیف های گزارش ، مشابه SQL دارای بند اعمال می شوند. ابعاد در این فیلتر قابل استفاده نیست.

offset

int64

تعداد ردیف ردیف شروع. ردیف اول به عنوان ردیف 0 محاسبه می شود. اگر افست مشخص نشده باشد ، به صورت 0. تحت درمان قرار می گیرد. اگر جبران صفر باشد ، این روش صفحه اول نتایج را با ورودی های limit باز می گرداند.

برای کسب اطلاعات بیشتر در مورد این پارامتر صفحه بندی ، به صفحه بندی مراجعه کنید.

limit

int64

تعداد ردیف ها برای بازگشت. در صورت نامشخص ، 10،000 ردیف بازگردانده می شود. API حداکثر 100000 ردیف در هر درخواست را برمی گرداند ، مهم نیست که چند نفر از آنها بخواهید. limit باید مثبت باشد.

در صورت وجود ردیف های باقی مانده به عنوان limit ، API ممکن است کمتر از limit درخواست شده بازگردد. به عنوان مثال ، کمتر از 300 مقدار ممکن برای country ابعاد وجود دارد ، بنابراین هنگام گزارش فقط در country ، شما نمی توانید بیش از 300 ردیف دریافت کنید ، حتی اگر limit با ارزش بالاتر را تعیین کنید.

برای کسب اطلاعات بیشتر در مورد این پارامتر صفحه بندی ، به صفحه بندی مراجعه کنید.

time_zone

string

در صورت مشخص شدن منطقه زمانی این درخواست. در صورت نامشخص ، از منطقه زمانی خاصیت استفاده می شود. منطقه زمانی درخواست برای تفسیر تاریخ شروع و پایان گزارش استفاده می شود.

به عنوان رشته ها از پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) فرمت شده است. به عنوان مثال "America/New_york" یا "آسیا/توکیو".

order_bys[]

AccessOrderBy

نحوه سفارش ردیف ها در پاسخ را مشخص می کند.

return_entity_quota

bool

آیا می تواند وضعیت فعلی سهمیه این ملک تحلیلی را برگرداند. سهمیه در AccessQuota بازگردانده می شود. برای درخواست های سطح حساب ، این قسمت باید نادرست باشد.

include_all_users

bool

اختیاری. تعیین می کند که آیا کاربرانی را که هرگز در این پاسخ تماس API برقرار نکرده اند ، شامل شود. اگر درست باشد ، همه کاربران با دسترسی به خاصیت یا حساب مشخص شده ، صرف نظر از اینکه آنها یک تماس API برقرار کرده اند یا خیر ، در پاسخ گنجانده شده اند. اگر نادرست باشد ، فقط کاربرانی که یک تماس API برقرار کرده اند گنجانده می شوند.

expand_groups

bool

اختیاری. تصمیم می گیرد که آیا کاربران را در گروه های کاربر بازگرداند. این قسمت فقط زمانی کار می کند که شامل_هل_سرها بر روی درست تنظیم شود. در صورت صحت ، همه کاربران را با دسترسی به ویژگی یا حساب مشخص شده باز می گرداند. اگر نادرست باشد ، فقط کاربران با دسترسی مستقیم بازگردانده می شوند.

RunaccessReportresponse

پاسخ گزارش گزارش دسترسی به داده های سفارشی.

زمینه های
dimension_headers[]

AccessDimensionHeader

عنوان ستون در گزارش که مربوط به یک بعد خاص است. تعداد DimensionHeaders و سفارش DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metric_headers[]

AccessMetricHeader

عنوان یک ستون در گزارش که مربوط به یک معیار خاص است. تعداد Metricheaders و سفارش Metricheaders با معیارهای موجود در ردیف مطابقت دارد.

rows[]

AccessRow

ردیف های ترکیب ارزش ابعاد و مقادیر متریک در گزارش.

row_count

int32

تعداد کل ردیف ها در نتیجه پرس و جو. rowCount مستقل از تعداد ردیف های برگشتی در پاسخ ، پارامتر درخواست limit و پارامتر درخواست offset است. به عنوان مثال اگر یک پرس و جو 175 ردیف را بازگرداند و شامل limit 50 در درخواست API باشد ، پاسخ حاوی rowCount 175 اما فقط 50 ردیف خواهد بود.

برای کسب اطلاعات بیشتر در مورد این پارامتر صفحه بندی ، به صفحه بندی مراجعه کنید.

quota

AccessQuota

وضعیت سهمیه برای این ملک تحلیلی از جمله این درخواست. این قسمت با درخواست های سطح حساب کار نمی کند.

SearchChangeHistoryEventSrequest

درخواست پیام برای SearchangeHistoryEvents RPC.

زمینه های
account

string

ضروری. منبع حساب برای بازگشت منابع تاریخ تغییر. قالب: حساب ها/{حساب} مثال: "حساب/100"

property

string

اختیاری. نام منابع برای یک خاصیت کودک. در صورت تنظیم ، فقط تغییرات ایجاد شده در این ملک یا منابع کودک آن را بازگردانید. قالب: Properties/{PropertId} مثال: "ویژگی ها/100"

resource_type[]

ChangeHistoryResourceType

اختیاری. در صورت تنظیم ، فقط در صورتی که برای منبعی باشد که حداقل با یکی از این نوع ها مطابقت داشته باشد ، تغییر می کند.

action[]

ActionType

اختیاری. در صورت تنظیم ، فقط تغییراتی را برگردانید که با یک یا چند مورد از این نوع اقدامات مطابقت داشته باشد.

actor_email[]

string

اختیاری. در صورت تنظیم ، فقط در صورت ایجاد توسط کاربر در این لیست ، تغییر می کند.

earliest_change_time

Timestamp

اختیاری. در صورت تنظیم ، فقط تغییرات ایجاد شده پس از این زمان (فراگیر).

latest_change_time

Timestamp

اختیاری. در صورت تنظیم ، فقط تغییرات ایجاد شده قبل از این زمان (فراگیر) را برگردانید.

page_size

int32

اختیاری. حداکثر تعداد موارد ChangeHistoryEvent برای بازگشت. حتی اگر صفحات اضافی وجود داشته باشد ، ممکن است این سرویس کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 50 مورد بازگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اجبار می شود).

page_token

string

اختیاری. یک صفحه صفحه ، که از تماس قبلی SearchChangeHistoryEvents دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده برای SearchChangeHistoryEvents باید با تماس ارائه شده با صفحه مطابقت داشته باشند.

جستجو

پیام پاسخ برای SearchAccounts RPC.

زمینه های
change_history_events[]

ChangeHistoryEvent

نتایج قابل دسترسی برای تماس گیرنده.

next_page_token

string

یک نشانه ، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

سطح سرویس

سطوح مختلف خدمات برای Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED سطح خدمات مشخص نشده یا نامعتبر نیست.
GOOGLE_ANALYTICS_STANDARD نسخه استاندارد Google Analytics.
GOOGLE_ANALYTICS_360 نسخه پرداخت شده و حق بیمه Google Analytics.

UpdateAccountRequest

درخواست پیام برای updateaccount rpc.

زمینه های
account

Account

ضروری. حساب برای به روزرسانی قسمت name حساب برای شناسایی حساب استفاده می شود.

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. نام فیلد باید در مورد مار باشد (برای مثال ، "field_to_update"). زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

UpdateConversionEventRequest

درخواست پیام برای updateconversionevent rpc

زمینه های
conversion_event

ConversionEvent

ضروری. رویداد تبدیل برای به روزرسانی. قسمت name برای شناسایی تنظیمات به روز شده استفاده می شود.

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. نام فیلد باید در مورد مار باشد (به عنوان مثال ، "field_to_update"). زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

UpdateCustomDimensionRequest

درخواست پیام برای UpdateCustomDimension RPC.

زمینه های
custom_dimension

CustomDimension

ابعاد سفارشی برای به روزرسانی

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

updateCustMetricTerquest

درخواست پیام برای updateCustommentry RPC.

زمینه های
custom_metric

CustomMetric

Custommetric برای به روزرسانی

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

به روز شده

درخواست پیام برای به روز شده برای RPC به روز شده.

زمینه های
data_retention_settings

DataRetentionSettings

ضروری. تنظیمات برای به روزرسانی. قسمت name برای شناسایی تنظیمات به روز شده استفاده می شود.

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. نام فیلد باید در مورد مار باشد (به عنوان مثال ، "field_to_update"). زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

به روز شده

پیام درخواست برای RPC به روز شده.

زمینه های
data_stream

DataStream

Datastream برای به روزرسانی

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

UpdateGoOgLeadSlinkRequest

درخواست پیام برای UpdateGoOgLeadSlink RPC

زمینه های
update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. نام فیلد باید در مورد مار باشد (به عنوان مثال ، "field_to_update"). زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

UpdateKeyeVentRequest

درخواست پیام برای UpdateKeyevent RPC

زمینه های
key_event

KeyEvent

ضروری. رویداد اصلی برای به روزرسانی. قسمت name برای شناسایی تنظیمات به روز شده استفاده می شود.

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. نام فیلد باید در مورد مار باشد (به عنوان مثال ، "field_to_update"). زمینه های حذف شده به روز نمی شوند. برای جایگزینی کل موجودیت ، از یک مسیر با رشته "*" برای مطابقت با همه زمینه ها استفاده کنید.

به روزرسانی

درخواست پیام برای UpdateMeasurementProtoColsecret RPC

زمینه های
measurement_protocol_secret

MeasurementProtocolSecret

ضروری. پروتکل اندازه گیری راز برای به روزرسانی.

update_mask

FieldMask

ضروری. لیست زمینه هایی که باید به روز شوند. زمینه های حذف شده به روز نمی شوند.

UpdatePropertyRequest

درخواست پیام برای UpdateProperty RPC.

زمینه های
property

Property

ضروری. ویژگی به روزرسانی. The property's name field is used to identify the property to be updated.

update_mask

FieldMask

ضروری. The list of fields to be updated. Field names must be in snake case (eg, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.