Method: accounts.searchChangeHistoryEvents

חיפוש בכל השינויים בחשבון או בצאצאים שלו, בהתאם לקבוצת המסננים שצוינה.

הפונקציה מחזירה רק את קבוצת המשנה של השינויים שנתמכים ב-API. יכול להיות שבממשק המשתמש יוצגו שינויים נוספים.

בקשת HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{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 וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
pageSize

integer

אופציונלי. המספר המקסימלי של הפריטים מסוג ChangeHistoryEvent שיוחזר. אם לא מציינים ערך, יוחזרו עד 50 פריטים. הערך המקסימלי הוא 200 (ערכים גבוהים יותר יומרו לערך המקסימלי).

חשוב לזכור שהשירות עשוי להחזיר דף עם פחות פריטים מהערך שצוין (יכול להיות אפילו אפס), ויכול להיות שעדיין יהיו דפים נוספים. אם רוצים לקבל מספר מסוים של פריטים, צריך להמשיך לבקש דפים נוספים באמצעות 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

ChangeHistoryResourceType

סוגי המשאבים שיכול להיות שהשינויים שלהם יוחזרו מהיסטוריית השינויים.

טיפוסים בני מנייה (enum)
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED סוג המשאב לא ידוע או לא צוין.
ACCOUNT משאב בחשבון
PROPERTY משאב נכס
GOOGLE_SIGNALS_SETTINGS המשאב GoogleSignalsSettings
CONVERSION_EVENT המשאב ConversionEvent
MEASUREMENT_PROTOCOL_SECRET משאב MeasurementProtocolSecret
CUSTOM_DIMENSION משאב CustomDimension
CUSTOM_METRIC משאב CustomMetric
DATA_RETENTION_SETTINGS המשאב DataRetentionSettings
DATA_STREAM משאב DataStream
ATTRIBUTION_SETTINGS המשאב AttributionSettings

ActionType

סוגי הפעולות שעשויות לשנות משאב.

טיפוסים בני מנייה (enum)
ACTION_TYPE_UNSPECIFIED סוג הפעולה לא ידוע או לא צוין.
CREATED המשאב נוצר בשינוי הזה.
UPDATED המשאב עודכן בשינוי הזה.
DELETED המשאב נמחק בשינוי הזה.

ChangeHistoryEvent

קבוצה של שינויים בחשבון Google Analytics או בנכסי הצאצא שלו שנובעים מאותה סיבה. גורמים נפוצים לכך הם עדכונים שבוצעו בממשק המשתמש של Google Analytics, שינויים משירות הלקוחות או שינויים אוטומטיים במערכת של Google Analytics.

ייצוג ב-JSON 
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
שדות
id

string

המזהה של האירוע הזה בהיסטוריית השינויים. המזהה הזה הוא ייחודי ב-Google Analytics.
changeTime

string (Timestamp format)

השעה שבה בוצע השינוי.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
actorType

enum (ActorType)

סוג הגורם שביצע את השינוי.
userActorEmail

string

כתובת האימייל של חשבון Google שבו בוצע השינוי. כתובת האימייל הזו תהיה חוקית אם שדה הגורם מוגדר כ-USER, ותמוזג אחרת. חשבונות Google שנמחקו יגרמו לשגיאה.
changesFiltered

boolean

אם הערך הוא true, רשימת השינויים שהתקבלה סוננה והיא לא מייצגת את כל השינויים שהתרחשו באירוע הזה.
changes[]

object (ChangeHistoryChange)

רשימה של השינויים שבוצעו באירוע הזה בהיסטוריית השינויים שתואמים למסננים שצוינו ב-SearchChangeHistoryEventsRequest.

ActorType

סוגים שונים של גורמים שיכולים לבצע שינויים במשאבים של Google Analytics.

טיפוסים בני מנייה (enum)
ACTOR_TYPE_UNSPECIFIED סוג גורם לא ידוע או לא מוגדר.
USER שינויים שבוצעו על ידי המשתמש שצוין ב-actorEmail.
SYSTEM שינויים שבוצעו על ידי מערכת Google Analytics.
SUPPORT שינויים שבוצעו על ידי צוות התמיכה של Google Analytics.

ChangeHistoryChange

תיאור של שינוי במשאב יחיד ב-Google Analytics.

ייצוג ב-JSON 
{
  "resource": string,
  "action": enum (ActionType),
  "resourceBeforeChange": {
    object (ChangeHistoryResource)
  },
  "resourceAfterChange": {
    object (ChangeHistoryResource)
  }
}
שדות
resource

string

שם המשאב של המשאב שהשינויים שלו מתוארים ברשומה הזו.
action

enum (ActionType)

סוג הפעולה ששינתה את המשאב הזה.
resourceBeforeChange

object (ChangeHistoryResource)

תוכן המשאב לפני ביצוע השינוי. אם המשאב הזה נוצר בשינוי הזה, השדה הזה יהיה חסר.
resourceAfterChange

object (ChangeHistoryResource)

תוכן המשאבים אחרי ביצוע השינוי. אם המשאב הזה נמחק במסגרת השינוי, השדה הזה יהיה חסר.

ChangeHistoryResource

קובץ snapshot של משאב לפני או אחרי שינוי בהיסטוריית השינויים.

ייצוג ב-JSON 
{

  // Union field resource can be only one of the following:
  "account": {
    object (Account)
  },
  "property": {
    object (Property)
  },
  "firebaseLink": {
    object (FirebaseLink)
  },
  "googleAdsLink": {
    object (GoogleAdsLink)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "dataStream": {
    object (DataStream)
  }
  // End of list of possible types for union field resource.
}
שדות

שדה האיחוד resource.

הערך של resource יכול להיות רק אחת מהאפשרויות הבאות:
account

object (Account)

קובץ snapshot של משאב בחשבון בהיסטוריית השינויים.
property

object (Property)

קובץ snapshot של משאב נכס בהיסטוריית השינויים.
conversionEvent

object (ConversionEvent)

תמונת מצב של משאב ConversionEvent בהיסטוריית השינויים.
measurementProtocolSecret

object (MeasurementProtocolSecret)

קובץ snapshot של משאב MeasurementProtocolSecret בהיסטוריית השינויים.
dataRetentionSettings

object (DataRetentionSettings)

תמונת מצב של משאב של הגדרות שמירת נתונים בהיסטוריית השינויים.
dataStream

object (DataStream)

קובץ snapshot של משאב DataStream בהיסטוריית השינויים.