Method: accounts.searchChangeHistoryEvents

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

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-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 resource
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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-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 שביצע את השינוי. אם השדה actor מוגדר כ-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

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

ייצוג 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)

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

object (Property)

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

object (ConversionEvent)

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

object (MeasurementProtocolSecret)

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

object (DataRetentionSettings)

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

object (DataStream)

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