Method: accounts.searchChangeHistoryEvents

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

فقط زیرمجموعه‌ای از تغییرات پشتیبانی‌شده توسط API را برمی‌گرداند. رابط کاربری ممکن است تغییرات بیشتری را نیز برگرداند.

درخواست HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{account=accounts/*}:searchChangeHistoryEvents

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
account

string

الزامی. منبع حساب کاربری که قرار است منابع تاریخچه تغییرات برای آن برگردانده شود. قالب: accounts/{account}

مثال: accounts/100

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "property": string,
  "resourceType": [
    enum (ChangeHistoryResourceType)
  ],
  "action": [
    enum (ActionType)
  ],
  "actorEmail": [
    string
  ],
  "earliestChangeTime": string,
  "latestChangeTime": string,
  "pageSize": integer,
  "pageToken": string
}
فیلدها
property

string

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

مثال: properties/100

resourceType[]

enum ( ChangeHistoryResourceType )

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

action[]

enum ( ActionType )

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

actorEmail[]

string

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

earliestChangeTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

latestChangeTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

pageSize

integer

اختیاری. حداکثر تعداد آیتم‌های ChangeHistoryEvent که باید برگردانده شوند. اگر مشخص نشود، حداکثر ۵۰ آیتم برگردانده خواهد شد. حداکثر مقدار ۲۰۰ است (مقادیر بالاتر به حداکثر مقدار خود محدود می‌شوند).

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

pageToken

string

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

بدنه پاسخ

پیام پاسخ برای RPC مربوط به SearchAccounts.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "changeHistoryEvents": [
    {
      object (ChangeHistoryEvent)
    }
  ],
  "nextPageToken": string
}
فیلدها
changeHistoryEvents[]

object ( ChangeHistoryEvent )

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

nextPageToken

string

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

دامنه‌های مجوز

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

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

تاریخچه تغییرنوع منبع

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

انوم‌ها
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED نوع منبع ناشناخته یا مشخص نشده است.
ACCOUNT منبع حساب
PROPERTY منبع ملک
GOOGLE_SIGNALS_SETTINGS منبع تنظیمات GoogleSignals
CONVERSION_EVENT منبع رویداد تبدیل
MEASUREMENT_PROTOCOL_SECRET منبع مخفی پروتکل اندازه‌گیری
CUSTOM_DIMENSION منبع CustomDimension
CUSTOM_METRIC منبع CustomMetric
DATA_RETENTION_SETTINGS منبع تنظیمات حفظ داده
DATA_STREAM منبع دیتا استریم
ATTRIBUTION_SETTINGS منبع تنظیمات انتساب
EXPANDED_DATA_SET منبع ExpandedDataSet
CHANNEL_GROUP منبع گروه کانال
ENHANCED_MEASUREMENT_SETTINGS منبع تنظیمات اندازه‌گیری پیشرفته
DATA_REDACTION_SETTINGS منبع تنظیمات اصلاح داده
SKADNETWORK_CONVERSION_VALUE_SCHEMA منبع SKAdNetworkConversionValueSchema
AUDIENCE منبع مخاطب
EVENT_CREATE_RULE منبع EventCreateRule
KEY_EVENT منبع KeyEvent
CALCULATED_METRIC منبع CalculatedMetric
REPORTING_DATA_ANNOTATION منبع حاشیه‌نویسی گزارش‌دهی داده‌ها
SUBPROPERTY_SYNC_CONFIG منبع SubpropertySyncConfig
REPORTING_IDENTITY_SETTINGS منبع ReportingIdentitySettings
USER_PROVIDED_DATA_SETTINGS منبع UserProvidedDataSettings

نوع اقدام

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

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

رویداد تغییر تاریخچه

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

نمایش JSON 
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
فیلدها
id

string

شناسه این رویداد تاریخچه تغییرات. این شناسه در سراسر گوگل آنالیتیکس منحصر به فرد است.

changeTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

actorType

enum ( ActorType )

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

userActorEmail

string

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

changesFiltered

boolean

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

changes[]

object ( ChangeHistoryChange )

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

نوع بازیگر

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

انوم‌ها
ACTOR_TYPE_UNSPECIFIED نوع بازیگر ناشناخته یا نامشخص.
USER تغییرات ایجاد شده توسط کاربر مشخص شده در actorEmail.
SYSTEM تغییراتی که توسط سیستم گوگل آنالیتیکس ایجاد شده است.
SUPPORT تغییراتی که توسط کارکنان تیم پشتیبانی گوگل آنالیتیکس ایجاد شده است.

تاریخچه تغییرتغییر

توضیحی از تغییر در یک منبع گوگل آنالیتیکس.

نمایش JSON 
{
  "resource": string,
  "action": enum (ActionType),
  "resourceBeforeChange": {
    object (ChangeHistoryResource)
  },
  "resourceAfterChange": {
    object (ChangeHistoryResource)
  }
}
فیلدها
resource

string

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

action

enum ( ActionType )

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

resourceBeforeChange

object ( ChangeHistoryResource )

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

resourceAfterChange

object ( ChangeHistoryResource )

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

تغییرتاریخچهمنبع

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

نمایش JSON 
{

  // Union field resource can be only one of the following:
  "account": {
    object (Account)
  },
  "property": {
    object (Property)
  },
  "firebaseLink": {
    object (FirebaseLink)
  },
  "googleAdsLink": {
    object (GoogleAdsLink)
  },
  "googleSignalsSettings": {
    object (GoogleSignalsSettings)
  },
  "displayVideo360AdvertiserLink": {
    object (DisplayVideo360AdvertiserLink)
  },
  "displayVideo360AdvertiserLinkProposal": {
    object (DisplayVideo360AdvertiserLinkProposal)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "customDimension": {
    object (CustomDimension)
  },
  "customMetric": {
    object (CustomMetric)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "searchAds360Link": {
    object (SearchAds360Link)
  },
  "dataStream": {
    object (DataStream)
  },
  "attributionSettings": {
    object (AttributionSettings)
  },
  "expandedDataSet": {
    object (ExpandedDataSet)
  },
  "channelGroup": {
    object (ChannelGroup)
  },
  "bigqueryLink": {
    object (BigQueryLink)
  },
  "enhancedMeasurementSettings": {
    object (EnhancedMeasurementSettings)
  },
  "dataRedactionSettings": {
    object (DataRedactionSettings)
  },
  "skadnetworkConversionValueSchema": {
    object (SKAdNetworkConversionValueSchema)
  },
  "adsenseLink": {
    object (AdSenseLink)
  },
  "audience": {
    object (Audience)
  },
  "eventCreateRule": {
    object (EventCreateRule)
  },
  "keyEvent": {
    object (KeyEvent)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  },
  "reportingDataAnnotation": {
    object (ReportingDataAnnotation)
  },
  "subpropertySyncConfig": {
    object (SubpropertySyncConfig)
  },
  "reportingIdentitySettings": {
    object (ReportingIdentitySettings)
  },
  "userProvidedDataSettings": {
    object (UserProvidedDataSettings)
  }
  // End of list of possible types for union field resource.
}
فیلدها

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

resource می‌تواند فقط یکی از موارد زیر باشد:

account

object ( Account )

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

property

object ( Property )

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

googleSignalsSettings

object ( GoogleSignalsSettings )

تصویری از منبع GoogleSignalsSettings در تاریخچه تغییرات.

conversionEvent

object ( ConversionEvent )

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

measurementProtocolSecret

object ( MeasurementProtocolSecret )

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

customDimension

object ( CustomDimension )

تصویری از یک منبع CustomDimension در تاریخچه تغییرات.

customMetric

object ( CustomMetric )

تصویری از یک منبع CustomMetric در تاریخچه تغییرات.

dataRetentionSettings

object ( DataRetentionSettings )

تصویری از منبع تنظیمات نگهداری داده‌ها در تاریخچه تغییرات.

dataStream

object ( DataStream )

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

attributionSettings

object ( AttributionSettings )

تصویری از منبع AttributionSettings در تاریخچه تغییرات.

expandedDataSet

object ( ExpandedDataSet )

تصویری از یک منبع ExpandedDataSet در تاریخچه تغییرات.

channelGroup

object ( ChannelGroup )

تصویری از یک منبع ChannelGroup در تاریخچه تغییرات.

enhancedMeasurementSettings

object ( EnhancedMeasurementSettings )

تصویری از منبع EnhancedMeasurementSettings در تاریخچه تغییرات.

dataRedactionSettings

object ( DataRedactionSettings )

تصویری از منبع DataRedactionSettings در تاریخچه تغییرات.

skadnetworkConversionValueSchema

object ( SKAdNetworkConversionValueSchema )

تصویری از منبع SKAdNetworkConversionValueSchema در تاریخچه تغییرات.

audience

object ( Audience )

تصویری از یک منبع مخاطب در تاریخچه تغییر.

eventCreateRule

object ( EventCreateRule )

تصویری از یک منبع EventCreateRule در تاریخچه تغییرات.

keyEvent

object ( KeyEvent )

تصویری از یک منبع KeyEvent در تاریخچه تغییرات.

calculatedMetric

object ( CalculatedMetric )

تصویری از یک منبع CalculatedMetric در تاریخچه تغییرات.

reportingDataAnnotation

object ( ReportingDataAnnotation )

تصویری از یک منبع ReportingDataAnnotation در تاریخچه تغییرات.

subpropertySyncConfig

object ( SubpropertySyncConfig )

تصویری از یک منبع SubpropertySyncConfig در تاریخچه تغییرات.

reportingIdentitySettings

object ( ReportingIdentitySettings )

تصویری از منبع ReportingIdentitySettings در تاریخچه تغییرات.

userProvidedDataSettings

object ( UserProvidedDataSettings )

تصویری از منبع UserProvidedDataSettings در تاریخچه تغییرات.