Package google.analytics.admin.v1beta

אינדקס

AnalyticsAdminService

ממשק שירות ל-Google Analytics Admin API.

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

אישור לתנאים של איסוף נתוני המשתמשים בנכס שצוין.

צריך להשלים את האישור הזה (בממשק המשתמש של Google Analytics או דרך ה-API הזה) לפני שאפשר ליצור משאבים מסוג MeasurementProtocolSecret.

היקפי הרשאה

נדרשת הרשאת 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)

העברת מדד מותאם אישית לארכיון בנכס.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-CreateKeyEvent. יצירת אירוע המרה עם המאפיינים שצוינו.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (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)

יצירת סוד של Measurement Protocol.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

יצירת נכס Google Analytics עם המיקום והמאפיינים שצוינו.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

הסימון של חשבון היעד כחשבון שנמחק באופן זמני (כלומר, 'הועבר לאשפה') והחזרתו.

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

אם החשבונות לא ישוחזר לפני מועד התפוגה, החשבון וכל המשאבים הצאצאים (למשל: נכסים, קישורים ל-Google Ads, מקורות נתונים, קישורי גישה) יימחקו לתמיד. https://support.google.com/analytics/answer/6154772

אם היעד לא נמצא, הפונקציה מחזירה שגיאה.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

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

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

מחיקה של מקור נתונים בנכס.

היקפי הרשאה

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

אם הנכסים לא ישוחזרו לפני מועד התפוגה, הנכס וכל המשאבים הצאצאים שלו (למשל: GoogleAdsLinks, ‏ Streams, ‏ AccessBindings) יימחקו לתמיד. https://support.google.com/analytics/answer/6154772

אם היעד לא נמצא, הפונקציה מחזירה שגיאה.

היקפי הרשאה

נדרשת הרשאת 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)

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-GetKeyEvent. אחזור של אירוע המרה יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

חיפוש של מאפיין מותאם אישית יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

חיפוש של מדד מותאם אישית יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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)

חיפוש של מקור נתונים יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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)

חיפוש של MeasurementProtocolSecret יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc GetProperty(GetPropertyRequest) returns (Property)

חיפוש של נכס GA יחיד.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

הפונקציה מחזירה סיכומים של כל החשבונות שמבצע הקריאה החוזרת (caller) יכול לגשת אליהם.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

הפונקציה מחזירה את כל החשבונות שמבצע הקריאה החוזרת (caller) יכול לגשת אליהם.

שימו לב: יכול להיות שלחשבונות האלה אין כרגע נכסי GA. חשבונות שנמחקו באופן זמני (כלומר, הועברו לאשפה) לא נכללים כברירת מחדל. אם לא נמצאו חשבונות רלוונטיים, הפונקציה מחזירה רשימה ריקה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

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

הפונקציה מחזירה רשימה ריקה אם לא נמצאו אירועי המרה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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)

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

הצגת רשימה של מקורות הנתונים בנכס.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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)

הפונקציה מחזירה נכסי צאצא בחשבון ההורה שצוין.

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

בקשה לקבלת כרטיס ליצירת חשבון.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

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

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

רשומות הגישה לנתונים האלה כוללות את הדוחות בממשק המשתמש של GA, את הניתוחים בממשק המשתמש של GA, את GA Data API ומוצרים אחרים כמו Firebase ו-AdMob שיכולים לאחזר נתונים מ-Google Analytics דרך קישור. הרשומות האלה לא כוללות שינויים בהגדרות של הנכס, כמו הוספת מקור נתונים או שינוי של אזור הזמן של הנכס. להיסטוריית השינויים בהגדרות, ראו searchChangeHistoryEvents.

כדי לשלוח משוב על ה-API הזה, יש למלא את הטופס משוב על דוחות הגישה של Google Analytics.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

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

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

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

עדכון חשבון.

היקפי הרשאה

נדרשת הרשאת OAuth ברמה הבאה:

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

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-UpdateKeyEvent. הקוד מעדכן אירוע המרה עם המאפיינים שצוינו.

היקפי הרשאה

נדרשת הרשאת 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)

עדכון של מדד מותאם אישית בנכס.

היקפי הרשאה

נדרשת הרשאת 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)

עדכון של מקור נתונים בנכס.

היקפי הרשאה

נדרשת הרשאת 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)

עדכון סוד של Measurement Protocol.

היקפי הרשאה

נדרשת הרשאת 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

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

שדות
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 של not_expression.
access_filter

AccessFilter

מסנן פרימיטיבי. באותו FilterExpression, כל שמות השדות של המסנן צריכים להיות כולם מאפיינים או כולם מדדים.

AccessFilterExpressionList

רשימה של ביטויי סינון.

שדות
expressions[]

AccessFilterExpression

רשימה של ביטויי סינון.

AccessInListFilter

התוצאה צריכה להיות ברשימת ערכים של מחרוזות.

שדות
values[]

string

רשימת ערכי המחרוזות. השדה לא יכול להיות ריק.
case_sensitive

bool

אם הערך הוא True, ערך המחרוזת תלוי אותיות רישיות.

AccessMetric

המדידות הכמותיות של דוח. לדוגמה, המדד accessCount הוא המספר הכולל של רשומות הגישה לנתונים.

שדות
metric_name

string

שם ה-API של המדד. ברשימת המדדים שנתמכים ב-API הזה מפורטת סכימת הגישה לנתונים.

המדדים מופיעים לפי שם ב-metricFilter וב-orderBys.

AccessMetricHeader

תיאור של עמודה של מדד בדוח. מדדים גלויים שנשלחת עבורם בקשה בדוח יוצרים רשומות של עמודות בתוך שורות ו-MetricHeaders. עם זאת, מדדים שמשמשים אך ורק במסננים או בביטויים לא יוצרים עמודות בדוח. בהתאם, המדדים האלה לא יוצרים כותרות.

שדות
metric_name

string

שם המדד. לדוגמה, 'accessCount'.

AccessMetricValue

הערך של מדד.

שדות
value

string

ערך המדידה. לדוגמה, הערך הזה יכול להיות '13'.

AccessNumericFilter

מסננים לערכים מספריים או לתאריכים.

שדות
operation

Operation

סוג הפעולה של המסנן הזה.
value

NumericValue

ערך מספרי או ערך תאריך.

פעולה

הפעולה שחלה על מסנן מספרי.

טיפוסים בני מנייה (enum)
OPERATION_UNSPECIFIED לא צוין.
EQUAL שווה
LESS_THAN פחות מ-
LESS_THAN_OR_EQUAL קטן מ- או שווה ל-
GREATER_THAN גדול מ-
GREATER_THAN_OR_EQUAL גדול מ- או שווה ל-

AccessOrderBy

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

שדות
desc

bool

אם הערך הוא True, מתבצע מיון בסדר יורד. אם הערך הוא false או לא צוין, המיון יתבצע בסדר עולה.
שדה האיחוד one_order_by. מציינים סוג אחד של סדר לפי עבור OrderBy. הערך של one_order_by יכול להיות רק אחת מהאפשרויות הבאות:
metric

MetricOrderBy

מיון התוצאות לפי הערכים של מדד.
dimension

DimensionOrderBy

מיון התוצאות לפי ערכי המאפיין.

DimensionOrderBy

מיון לפי ערכי המאפיינים.

שדות
dimension_name

string

שם המאפיין בבקשה לפיו רוצים למיין.
order_type

OrderType

קובע את הכלל לסדר של ערכי המאפיינים.

OrderType

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

טיפוסים בני מנייה (enum)
ORDER_TYPE_UNSPECIFIED לא צוין.
ALPHANUMERIC מיון אלפאנומרי לפי מיקום תו (code point) ב-Unicode. לדוגמה, '2' < 'A' < 'X' < 'b' < 'z'.
CASE_INSENSITIVE_ALPHANUMERIC מיון אלפאנומרי ללא תלות ברישיות לפי מיקום תו (code point) של Unicode באותיות קטנות. לדוגמה, '2' < 'A' < 'b' < 'X' < 'z'.
NUMERIC ערכי המאפיינים מומרים למספרים לפני המיון. לדוגמה, במיון NUMERIC, הערך '25' קטן מהערך '100', ובמיון ALPHANUMERIC, הערך '100' קטן מהערך '25'. לכל הערכים של מאפיינים לא מספריים יש ערך סדר שווה מתחת לכל הערכים המספריים.

MetricOrderBy

מיון לפי ערכי המדדים.

שדות
metric_name

string

שם המדד בבקשה לפיו רוצים למיין.

AccessQuota

המצב הנוכחי של כל המכסות בנכס Analytics הזה. אם מכסה כלשהי של נכס מסוים תיגמר, כל הבקשות לנכס הזה יחזירו שגיאות מסוג 'המשאב נגמר'.

שדות
tokens_per_day

AccessQuotaStatus

אפשר להשתמש ב-250,000 טוקנים ביום בכל נכס. בשביל רוב הבקשות צריך פחות מ-10 טוקנים.
tokens_per_hour

AccessQuotaStatus

אפשר להשתמש ב-50,000 אסימונים בכל שעה בנכסים. בקשת API צורכת מספר טוקנים אחד, והמספר הזה ינוכה מכל המכסות השעתיות, היומיות והשעתיות לכל פרויקט.
concurrent_requests

AccessQuotaStatus

אפשר להשתמש בנכסים ב-50 בקשות בו-זמנית לכל היותר.
server_errors_per_project_per_hour

AccessQuotaStatus

אפשר לקבל עד 50 שגיאות שרת לשעה בזוגות של נכסים ופרויקטים ב-Cloud.
tokens_per_project_per_hour

AccessQuotaStatus

נכסים יכולים להשתמש ב-25% מהאסימונים שלהם לכל פרויקט לשעה. כלומר, בנכסי Analytics 360 אפשר להשתמש ב-12,500 אסימונים לכל פרויקט לשעה. בקשת API צורכת מספר טוקנים אחד, והמספר הזה ינוכה מכל המכסות השעתיות, היומיות והשעתיות לכל פרויקט.

AccessQuotaStatus

המצב הנוכחי של קבוצת מכסות מסוימת.

שדות
consumed

int32

המכסה שנעשה בה שימוש בבקשה הזו.
remaining

int32

המכסה שנותר אחרי הבקשה הזו.

AccessRow

גישה לנתוני הדוח בכל שורה.

שדות
dimension_values[]

AccessDimensionValue

רשימה של ערכי המאפיינים. הערכים האלה מופיעים באותו סדר שבו הם צוינו בבקשה.
metric_values[]

AccessMetricValue

רשימה של ערכי המדדים. הערכים האלה מופיעים באותו סדר שבו הם צוינו בבקשה.

AccessStringFilter

המסנן למחרוזות.

שדות
match_type

MatchType

סוג ההתאמה של המסנן הזה.
value

string

ערך המחרוזת שמשמש להתאמה.
case_sensitive

bool

אם הערך הוא True, ערך המחרוזת תלוי אותיות רישיות.

MatchType

סוג ההתאמה של מסנן מחרוזת.

טיפוסים בני מנייה (enum)
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 Marketing Platform. ההגדרה הזו מוגדרת רק כשהחשבון הזה מחובר לארגון ב-GMP. פורמט: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

משאב וירטואלי שמייצג סקירה כללית של חשבון ושל כל נכסי הצאצא שלו ב-Google Analytics.

שדות
name

string

שם המשאב של סיכום החשבון הזה. פורמט: accountSummaries/{account_id}. דוגמה: accountSummaries/1000
account

string

שם המשאב של החשבון שאליו מתייחס סיכום החשבון הזה. הפורמט: accounts/{account_id}. דוגמה: "accounts/1000"
display_name

string

השם המוצג של החשבון שמצוין בסיכום החשבון הזה.
property_summaries[]

PropertySummary

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

AcknowledgeUserDataCollectionRequest

הודעת בקשה ל-RPC של AcknowledgeUserDataCollection.

שדות
property

string

חובה. הנכס שעבורו רוצים לאשר את איסוף נתוני המשתמשים.
acknowledgement

string

חובה. אישור לכך שהמבצע של השיטה הזו מבין את התנאים של איסוף נתוני המשתמשים.

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

AcknowledgeUserDataCollectionResponse

אין שדות לסוג הזה.

הודעת תגובה ל-RPC של AcknowledgeUserDataCollection.

ActionType

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

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

ActorType

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

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

ArchiveCustomDimensionRequest

הודעת בקשה ל-RPC של ArchiveCustomDimension.

שדות
name

string

חובה. השם של המאפיין המותאם אישית שרוצים להעביר לארכיון. פורמט לדוגמה: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

הודעת בקשה ל-RPC של ArchiveCustomMetric.

שדות
name

string

חובה. השם של CustomMetric שרוצים להעביר לארכיון. פורמט לדוגמה: properties/1234/customMetrics/5678

ChangeHistoryChange

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

שדות
resource

string

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

ActionType

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

ChangeHistoryResource

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

ChangeHistoryResource

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

ChangeHistoryResource

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

שדות

שדה האיחוד resource.

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

Account

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

Property

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

ConversionEvent

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

MeasurementProtocolSecret

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

DataRetentionSettings

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

DataStream

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

ChangeHistoryEvent

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

שדות
id

string

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

Timestamp

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

ActorType

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

string

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

bool

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

ChangeHistoryChange

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

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

ConversionEvent

אירוע המרה בנכס Google Analytics.

שדות
name

string

פלט בלבד. שם המשאב של אירוע ההמרה הזה. פורמט: properties/{property}/conversionEvents/{conversion_event}
event_name

string

לא ניתן לשינוי. שם האירוע של אירוע ההמרה הזה. דוגמאות: 'click',‏ 'purchase'
create_time

Timestamp

פלט בלבד. המועד שבו אירוע ההמרה הזה נוצר בנכס.
deletable

bool

פלט בלבד. אם האפשרות הזו מוגדרת, אפשר למחוק את האירוע הזה באמצעות DeleteConversionEvent.
custom

bool

פלט בלבד. אם הערך מוגדר כ-true, אירוע ההמרה הזה מתייחס לאירוע מותאם אישית. אם הערך מוגדר כ-false, אירוע ההמרה הזה מתייחס לאירוע ברירת מחדל ב-GA. בדרך כלל, לאירועי ברירת מחדל יש משמעות מיוחדת ב-GA. בדרך כלל מערכת GA יוצרת בשבילכם אירועי ברירת מחדל, אבל במקרים מסוימים אדמינים של נכסים יכולים ליצור אותם. אירועים מותאמים אישית נספרים במסגרת המספר המקסימלי של אירועי המרה מותאמים אישית שניתן ליצור בכל נכס.
counting_method

ConversionCountingMethod

אופציונלי. השיטה שבה ההמרות ייספרו במספר אירועים במהלך סשן. אם לא מציינים את הערך הזה, הוא מוגדר כ-ONCE_PER_EVENT.
default_conversion_value

DefaultConversionValue

אופציונלי. הגדרת ערך ברירת מחדל או מטבע ברירת מחדל לאירוע המרה.

ConversionCountingMethod

השיטה שבה ההמרות ייספרו במספר אירועים במהלך סשן.

טיפוסים בני מנייה (enum)
CONVERSION_COUNTING_METHOD_UNSPECIFIED לא צוינה שיטת הספירה.
ONCE_PER_EVENT כל מופע של אירוע נחשב כהמרה.
ONCE_PER_SESSION מופע של אירוע נחשב להמרה לכל היותר פעם אחת לכל סשן לכל משתמש.

DefaultConversionValue

הגדרת ערך ברירת מחדל או מטבע ברירת מחדל לאירוע המרה. חובה לציין את הערך ואת המטבע.

שדות
value

double

הערך הזה ישמש למילוי הערך של כל ההמרות של event_name שצוין, שבהן הפרמטר 'value' של האירוע לא מוגדר.
currency_code

string

אם לאירוע המרה עם השם event_name לא מוגדר מטבע, המטבע הזה יחול כברירת המחדל. חייב להיות בפורמט של קוד מטבע לפי תקן ISO 4217. מידע נוסף זמין בכתובת https://en.wikipedia.org/wiki/ISO_4217.

CreateConversionEventRequest

הודעת הבקשה ל-RPC של CreateConversionEvent

שדות
conversion_event

ConversionEvent

חובה. אירוע ההמרה שיצרתם.
parent

string

חובה. שם המשאב של נכס ההורה שבו אירוע ההמרה הזה ייווצר. פורמט: properties/123

CreateCustomDimensionRequest

הודעת הבקשה של קריאה חוזרת לשירות RPC מסוג CreateCustomDimension.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
custom_dimension

CustomDimension

חובה. המאפיין המותאם אישית שיצרתם.

CreateCustomMetricRequest

הודעת הבקשה ל-RPC של CreateCustomMetric.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
custom_metric

CustomMetric

חובה. המדד המותאם אישית שיצרתם.

CreateDataStreamRequest

הודעת הבקשה ל-RPC של CreateDataStream.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
data_stream

DataStream

חובה. מקור הנתונים שייווצר.

CreateFirebaseLinkRequest

הודעת הבקשה ל-RPC של CreateFirebaseLink

שדות
parent

string

חובה. פורמט: properties/{property_id}

לדוגמה: properties/1234

CreateGoogleAdsLinkRequest

הודעת הבקשה ל-RPC של CreateGoogleAdsLink

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234

CreateKeyEventRequest

הודעת בקשה ל-RPC של CreateKeyEvent

שדות
key_event

KeyEvent

חובה. האירוע המרכזי שיצרתם.
parent

string

חובה. שם המשאב של נכס ההורה שבו האירוע המרכזי הזה ייווצר. פורמט: properties/123

CreateMeasurementProtocolSecretRequest

הודעת בקשה ל-RPC של CreateMeasurementProtocolSecret

שדות
parent

string

חובה. משאב ההורה שבו הסוד הזה ייווצר. פורמט: properties/{property}/dataStreams/{dataStream}
measurement_protocol_secret

MeasurementProtocolSecret

חובה. הסוד של Measurement Protocol שיצרתם.

CreatePropertyRequest

הודעת הבקשה ל-RPC של CreateProperty.

שדות
property

Property

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

CustomDimension

הגדרה של CustomDimension.

שדות
name

string

פלט בלבד. שם המשאב של משאב CustomDimension הזה. פורמט: properties/{property}/customDimensions/{customDimension}
parameter_name

string

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

אם מדובר במאפיין ברמת המשתמש, זהו השם של מאפיין המשתמש. אם מדובר במאפיין ברמת האירוע, זהו שם פרמטר האירוע.

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

יכולים להכיל רק תווים אלפאנומריים וקווים תחתונים, ולהתחיל באות. האורך המקסימלי הוא 24 תווים למאפיינים ברמת המשתמש ו-40 תווים למאפיינים ברמת האירוע.
display_name

string

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

string

אופציונלי. תיאור למאפיין המותאם אישית הזה. האורך המקסימלי הוא 150 תווים.
scope

DimensionScope

חובה. לא ניתן לשינוי. ההיקף של המאפיין הזה.
disallow_ads_personalization

bool

אופציונלי. אם הערך מוגדר כ-true, המאפיין הזה מוגדר כ-NPA ומוחרג מההתאמה האישית של המודעות.

בשלב זה, האפשרות הזו נתמכת רק במאפיינים מותאמים אישית ברמת המשתמש.

DimensionScope

הערכים החוקיים להיקף של המאפיין הזה.

טיפוסים בני מנייה (enum)
DIMENSION_SCOPE_UNSPECIFIED ההיקף לא ידוע או לא צוין.
EVENT מאפיין ברמת האירוע.
USER מאפיין ברמת המשתמש.
ITEM מאפיין ברמת הפריטים של המסחר האלקטרוני

CustomMetric

הגדרה של מדד מותאם אישית.

שדות
name

string

פלט בלבד. שם המשאב של משאב CustomMetric הזה. פורמט: properties/{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. צריך להשאיר את השדה ריק עבור מדדים עם יחידת מידה שאינה CURRENCY.

MeasurementUnit

סוגי הייצוג האפשריים של הערך של המדד המותאם אישית.

ייתכן שהאופן שבו מטבעות מיוצגים ישתנה בעתיד, ויהיה צורך לבצע שינוי משמעותי ב-API.

טיפוסים בני מנייה (enum)
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit לא צוין או חסר.
STANDARD המדד הזה משתמש ביחידות ברירת המחדל.
CURRENCY המדד הזה מודד מטבע.
FEET המדד הזה מודד פיט.
METERS המדד הזה מודד מטרים.
KILOMETERS המדד הזה מודד קילומטרים.
MILES המדד הזה מודד קילומטרים.
MILLISECONDS המדד הזה מודד אלפיות שנייה.
SECONDS המדד הזה מודד שניות.
MINUTES המדד הזה מודד דקות.
HOURS המדד הזה מודד שעות.

MetricScope

ההיקף של המדד הזה.

טיפוסים בני מנייה (enum)
METRIC_SCOPE_UNSPECIFIED ההיקף לא ידוע או לא צוין.
EVENT מדד ברמת האירוע.

RestrictedMetricType

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

טיפוסים בני מנייה (enum)
RESTRICTED_METRIC_TYPE_UNSPECIFIED סוג לא ידוע או לא צוין.
COST_DATA מדד שמדווח על נתוני עלות.
REVENUE_DATA המדד מדווח על נתוני ההכנסות.

DataRetentionSettings

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

שדות
name

string

פלט בלבד. שם המשאב של משאב DataRetentionSetting הזה. פורמט: properties/{property}/dataRetentionSettings
event_data_retention

RetentionDuration

חובה. משך הזמן שבו נשמרים נתונים ברמת האירוע.
user_data_retention

RetentionDuration

חובה. משך הזמן שבו נשמרים נתונים ברמת המשתמש.
reset_user_data_on_new_activity

bool

אם הערך הוא true, מערכת Analytics מאפסת את תקופת השמירה של מזהה המשתמש בכל אירוע מהמשתמש הזה.

RetentionDuration

ערכים חוקיים למשך שמירת הנתונים.

טיפוסים בני מנייה (enum)
RETENTION_DURATION_UNSPECIFIED לא צוין משך הזמן של שמירת הנתונים.
TWO_MONTHS משך שמירת הנתונים הוא חודשיים.
FOURTEEN_MONTHS משך שמירת הנתונים הוא 14 חודשים.
TWENTY_SIX_MONTHS משך שמירת הנתונים הוא 26 חודשים. התכונה זמינה לנכסי 360 בלבד. האפשרות הזו זמינה רק לנתוני אירועים.
THIRTY_EIGHT_MONTHS משך שמירת הנתונים הוא 38 חודשים. התכונה זמינה לנכסי 360 בלבד. האפשרות הזו זמינה רק לנתוני אירועים.
FIFTY_MONTHS משך שמירת הנתונים הוא 50 חודשים. התכונה זמינה לנכסי 360 בלבד. האפשרות הזו זמינה רק לנתוני אירועים.

DataSharingSettings

הודעת משאב שמייצגת את הגדרות שיתוף הנתונים של חשבון Google Analytics.

שדות
name

string

פלט בלבד. שם המשאב. פורמט: accounts/{account}/dataSharingSettings. דוגמה: "accounts/1000/dataSharingSettings"
sharing_with_google_support_enabled

bool

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

השדה הזה ממופה לשדה 'תמיכה טכנית' בממשק המשתמש לניהול ב-Google Analytics.
sharing_with_google_assigned_sales_enabled

bool

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

השדה הזה ממופה לשדה 'המלצות לעסק' בממשק המשתמש לניהול ב-Google Analytics.
sharing_with_google_any_sales_enabled
(deprecated)

bool

הוצא משימוש. השדה הזה לא בשימוש יותר ותמיד מחזיר את הערך false.
sharing_with_google_products_enabled

bool

מתן הרשאה ל-Google להשתמש בנתונים כדי לשפר מוצרים או שירותים אחרים של Google.

השדות האלה ממפים לשדה 'מוצרים ושירותים של Google' בממשק המשתמש לניהול ב-Google Analytics.
sharing_with_others_enabled

bool

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

השדה הזה ממופה לשדה 'שיתוף נתונים ליצירת מודלים ותובנות עסקיות' בממשק המשתמש לניהול ב-Google Analytics.

DataStream

הודעת משאב שמייצגת מקור נתונים.

שדות
name

string

פלט בלבד. שם המשאב של מקור הנתונים הזה. פורמט: properties/{property_id}/dataStreams/{stream_id} דוגמה: "properties/1000/dataStreams/2000"
type

DataStreamType

חובה. לא ניתן לשינוי. הסוג של משאב DataStream הזה.
display_name

string

שם תצוגה קריא של מקור הנתונים.

חובה למקורות לנתוני אתר.

האורך המקסימלי המותר של השם המוצג הוא 255 יחידות קוד UTF-16.
create_time

Timestamp

פלט בלבד. השעה שבה הסטרימינג נוצר במקור.
update_time

Timestamp

פלט בלבד. המועד האחרון שבו שדות עומס העבודה של הסטרימינג עודכנו.
שדה האיחוד stream_data. נתונים עבור סוגי מקורות נתונים ספציפיים. ההודעה שתוגדר תהיה תואמת לסוג של הזרם הזה. הערך של stream_data יכול להיות רק אחת מהאפשרויות הבאות:
web_stream_data

WebStreamData

נתונים ספציפיים למקורות של נתוני אתר. צריך לאכלס את השדה אם הסוג הוא 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"‎

DataStreamType

סוג מקור הנתונים.

טיפוסים בני מנייה (enum)
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

חובה. לא ניתן לשינוי. מזהה החבילה של האפליקציה ב-Apple App Store. דוגמה: 'com.example.myiosapp'

WebStreamData

נתונים ספציפיים למקורות של נתוני אתר.

שדות
measurement_id

string

פלט בלבד. מזהה המדידה ב-Analytics.

דוגמה: 'G-1A2BCD345E'
firebase_app_id

string

פלט בלבד. המזהה של אפליקציית האינטרנט התואמת ב-Firebase, אם יש כזו. המזהה הזה עשוי להשתנות אם אפליקציית האינטרנט נמחקת ונוצרת מחדש.
default_uri

string

שם הדומיין של אפליקציית האינטרנט שנמדדת, או ריק. דוגמה: "http://www.google.com",‏ "https://www.google.com"

DeleteAccountRequest

הודעת הבקשה ל-RPC של DeleteAccount.

שדות
name

string

חובה. השם של החשבון שרוצים למחוק באופן סופי. פורמט: accounts/{account} דוגמה: "accounts/100"

DeleteConversionEventRequest

הודעת בקשה ל-RPC של DeleteConversionEvent

שדות
name

string

חובה. שם המשאב של אירוע ההמרה שרוצים למחוק. פורמט: properties/{property}/conversionEvents/{conversion_event} דוגמה: ‎"properties/123/conversionEvents/456"‎

DeleteDataStreamRequest

הודעת הבקשה ל-RPC של DeleteDataStream.

שדות
name

string

חובה. השם של מקור הנתונים שרוצים למחוק. פורמט לדוגמה: properties/1234/dataStreams/5678

DeleteFirebaseLinkRequest

הודעת הבקשה ל-RPC של DeleteFirebaseLink

שדות
name

string

חובה. פורמט: properties/{property_id}/firebaseLinks/{firebase_link_id}

לדוגמה: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

הודעת הבקשה ל-RPC של DeleteGoogleAdsLink.

שדות
name

string

חובה. פורמט לדוגמה: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

הודעת בקשה ל-RPC של DeleteKeyEvent

שדות
name

string

חובה. שם המשאב של האירוע המרכזי שרוצים למחוק. פורמט: properties/{property}/keyEvents/{key_event} דוגמה: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

הודעת בקשה ל-RPC של DeleteMeasurementProtocolSecret

שדות
name

string

חובה. השם של הסוד MeasurementProtocolSecret שרוצים למחוק. פורמט: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

הודעת הבקשה ל-RPC של DeleteProperty.

שדות
name

string

חובה. השם של הנכס שרוצים למחוק באופן סופי. פורמט: properties/{property_id}. דוגמה: ‎"properties/1000"‎

GetAccountRequest

הודעת הבקשה ל-RPC של GetAccount.

שדות
name

string

חובה. השם של החשבון שרוצים לחפש. פורמט: accounts/{account} דוגמה: "accounts/100"

GetConversionEventRequest

הודעת הבקשה ל-RPC של GetConversionEvent

שדות
name

string

חובה. שם המשאב של אירוע ההמרה שרוצים לאחזר. פורמט: properties/{property}/conversionEvents/{conversion_event} דוגמה: ‎"properties/123/conversionEvents/456"‎

GetCustomDimensionRequest

הודעת הבקשה ל-RPC של GetCustomDimension.

שדות
name

string

חובה. השם של המאפיין המותאם אישית שרוצים לקבל. פורמט לדוגמה: properties/1234/customDimensions/5678

GetCustomMetricRequest

הודעת הבקשה ל-RPC של GetCustomMetric.

שדות
name

string

חובה. השם של CustomMetric שרוצים לקבל. פורמט לדוגמה: properties/1234/customMetrics/5678

GetDataRetentionSettingsRequest

הודעת בקשה ל-RPC של GetDataRetentionSettings.

שדות
name

string

חובה. השם של ההגדרות לחיפוש. פורמט: properties/{property}/dataRetentionSettings. דוגמה: ‎"properties/1000/dataRetentionSettings"‎

GetDataSharingSettingsRequest

הודעת הבקשה ל-RPC של GetDataSharingSettings.

שדות
name

string

חובה. השם של ההגדרות לחיפוש. פורמט: accounts/{account}/dataSharingSettings

לדוגמה: accounts/1000/dataSharingSettings

GetDataStreamRequest

הודעת בקשה ל-RPC של GetDataStream.

שדות
name

string

חובה. השם של מקור הנתונים שרוצים לקבל. פורמט לדוגמה: properties/1234/dataStreams/5678

GetKeyEventRequest

הודעת בקשה ל-RPC של GetKeyEvent

שדות
name

string

חובה. שם המשאב של האירוע המרכזי שרוצים לאחזר. פורמט: properties/{property}/keyEvents/{key_event} דוגמה: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

הודעת בקשה ל-RPC של GetMeasurementProtocolSecret.

שדות
name

string

חובה. השם של הסוד של פרוטוקול המדידה שרוצים לחפש. פורמט: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

הודעת הבקשה ל-RPC של GetProperty.

שדות
name

string

חובה. השם של הנכס שרוצים לחפש. פורמט: properties/{property_id}. דוגמה: ‎"properties/1000"‎

IndustryCategory

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

טיפוסים בני מנייה (enum)
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 שופינג

KeyEvent

אירוע מרכזי בנכס Google Analytics.

שדות
name

string

פלט בלבד. שם המשאב של האירוע המרכזי הזה. פורמט: properties/{property}/keyEvents/{key_event}
event_name

string

לא ניתן לשינוי. שם האירוע של האירוע המרכזי הזה. דוגמאות: 'click',‏ 'purchase'
create_time

Timestamp

פלט בלבד. המועד שבו האירוע המרכזי הזה נוצר בנכס.
deletable

bool

פלט בלבד. אם הערך מוגדר כ-True, אפשר למחוק את האירוע הזה.
custom

bool

פלט בלבד. אם הערך מוגדר כ-true, האירוע המרכזי הזה מתייחס לאירוע מותאם אישית. אם הערך מוגדר כ-false, האירוע המרכזי הזה מתייחס לאירוע ברירת מחדל ב-GA. בדרך כלל, לאירועי ברירת מחדל יש משמעות מיוחדת ב-GA. בדרך כלל מערכת GA יוצרת בשבילכם אירועי ברירת מחדל, אבל במקרים מסוימים אדמינים של נכסים יכולים ליצור אותם. אירועים מותאמים אישית נספרים במסגרת המספר המקסימלי של אירועים מרכזיים בהתאמה אישית שניתן ליצור בכל נכס.
counting_method

CountingMethod

חובה. השיטה שבה אירועים מרכזיים ייספרו במספר אירועים במהלך סשן.
default_value

DefaultValue

אופציונלי. הגדרת ערך ברירת מחדל או מטבע ברירת מחדל לאירוע מרכזי.

CountingMethod

השיטה שבה אירועים מרכזיים ייספרו במספר אירועים במהלך סשן.

טיפוסים בני מנייה (enum)
COUNTING_METHOD_UNSPECIFIED לא צוינה שיטת הספירה.
ONCE_PER_EVENT כל מופע של אירוע נחשב לאירוע מרכזי.
ONCE_PER_SESSION מופע של אירוע נחשב לאירוע מרכזי לכל היותר פעם אחת לכל סשן לכל משתמש.

DefaultValue

הגדרת ערך ברירת מחדל או מטבע ברירת מחדל לאירוע מרכזי.

שדות
numeric_value

double

חובה. הערך הזה ישמש למילוי הפרמטר 'value' לכל המופעים של אירוע המפתח הזה (שצוין על ידי event_name) שבהם הפרמטר הזה לא מוגדר.
currency_code

string

חובה. אם לאירוע מרכזי מסוים (שמצוין על ידי event_name) אין מטבע מוגדר, המערכת תחיל את המטבע הזה כברירת מחדל. חייב להיות בפורמט של קוד מטבע לפי תקן ISO 4217.

מידע נוסף זמין בכתובת https://en.wikipedia.org/wiki/ISO_4217.

ListAccountSummariesRequest

הודעת בקשה ל-RPC של ListAccountSummaries.

שדות
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListAccountSummaries. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListAccountSummaries חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListAccountSummariesResponse

הודעת התגובה של קריאת ה-RPC ListAccountSummaries.

שדות
account_summaries[]

AccountSummary

סיכומי חשבונות של כל החשבונות שמבצע הקריאה החוזרת (caller) רשאי לגשת אליהם.
next_page_token

string

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

ListAccountsRequest

הודעת בקשה ל-RPC של ListAccounts.

שדות
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListAccounts. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListAccounts חייבים להתאים לקריאה שסיפקה את אסימון הדף.
show_deleted

bool

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

ListAccountsResponse

הודעת בקשה ל-RPC של ListAccounts.

שדות
accounts[]

Account

תוצאות שהיו נגישות למתקשר.
next_page_token

string

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

ListConversionEventsRequest

הודעת בקשה ל-RPC של ListConversionEvents

שדות
parent

string

חובה. שם המשאב של נכס ההורה. דוגמה: 'properties/123'
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListConversionEvents. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListConversionEvents חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListConversionEventsResponse

הודעת תגובה ל-RPC של ListConversionEvents.

שדות
conversion_events[]

ConversionEvent

אירועי ההמרה המבוקשים
next_page_token

string

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

ListCustomDimensionsRequest

הודעת בקשה ל-RPC של ListCustomDimensions.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListCustomDimensions. צריך לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListCustomDimensions חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListCustomDimensionsResponse

הודעת תגובה ל-RPC של ListCustomDimensions.

שדות
custom_dimensions[]

CustomDimension

רשימה של מאפיינים מותאמים אישית.
next_page_token

string

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

ListCustomMetricsRequest

הודעת בקשה ל-RPC של ListCustomMetrics.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListCustomMetrics. צריך לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListCustomMetrics חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListCustomMetricsResponse

הודעת תגובה ל-RPC של ListCustomMetrics.

שדות
custom_metrics[]

CustomMetric

רשימה של CustomMetrics.
next_page_token

string

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

ListDataStreamsRequest

הודעת בקשה ל-RPC של ListDataStreams.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListDataStreams. צריך לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListDataStreams חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListDataStreamsResponse

הודעת תגובה ל-RPC של ListDataStreams.

שדות
data_streams[]

DataStream

רשימה של מקורות נתונים.
next_page_token

string

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

ListFirebaseLinksRequest

הודעת הבקשה ל-RPC של ListFirebaseLinks

שדות
parent

string

חובה. פורמט: properties/{property_id}

לדוגמה: properties/1234
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListFirebaseLinks. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListFirebaseLinks חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListFirebaseLinksResponse

הודעת תגובה ל-RPC של ListFirebaseLinks

שדות
next_page_token

string

אסימון שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים. נכון לעכשיו, מערכת Google Analytics תומכת רק ב-FirebaseLink אחד לכל נכס, ולכן השדה הזה לא מאוכלס אף פעם.

ListGoogleAdsLinksRequest

הודעת הבקשה ל-RPC של ListGoogleAdsLinks.

שדות
parent

string

חובה. פורמט לדוגמה: properties/1234
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListGoogleAdsLinks. צריך לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListGoogleAdsLinks חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListGoogleAdsLinksResponse

הודעת תגובה ל-RPC של ListGoogleAdsLinks.

שדות
next_page_token

string

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

ListKeyEventsRequest

הודעת בקשה ל-RPC של ListKeyEvents

שדות
parent

string

חובה. שם המשאב של נכס ההורה. דוגמה: 'properties/123'
page_size

int32

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

string

אסימון דף, שהתקבל משיחה קודמת של ListKeyEvents. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListKeyEvents חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListKeyEventsResponse

הודעת תגובה ל-RPC של ListKeyEvents.

שדות
key_events[]

KeyEvent

האירועים המרכזיים המבוקשים
next_page_token

string

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

ListMeasurementProtocolSecretsRequest

הודעת בקשה ל-RPC של ListMeasurementProtocolSecret

שדות
parent

string

חובה. שם המשאב של מקור הנתונים הראשי. פורמט: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
page_size

int32

המספר המקסימלי של המשאבים להחזרה. אם לא צוין, יוחזרו עד 10 משאבים. הערך המקסימלי הוא 10. ערכים גבוהים יותר יומרו לערך המקסימלי.
page_token

string

אסימון דף, שהתקבל משיחה קודמת של ListMeasurementProtocolSecrets. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListMeasurementProtocolSecrets חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListMeasurementProtocolSecretsResponse

הודעת תגובה ל-RPC של ListMeasurementProtocolSecret

שדות
measurement_protocol_secrets[]

MeasurementProtocolSecret

רשימה של סודות של מקור הנתונים שצוין בבקשה.
next_page_token

string

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

ListPropertiesRequest

הודעת בקשה ל-RPC של ListProperties.

שדות
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

הודעת תגובה ל-RPC של ListProperties.

שדות
properties[]

Property

תוצאות שתואמות לקריטריונים של המסנן והיו נגישות למבצע הקריאה החוזרת.
next_page_token

string

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

MeasurementProtocolSecret

ערך סודי שמשמש לשליחת היטים ל-Measurement Protocol.

שדות
name

string

פלט בלבד. שם המשאב של הסוד הזה. הסוד הזה יכול להיות צאצא של כל סוג של מקור נתונים. פורמט: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
display_name

string

חובה. השם המוצג של הסוד, שקריא לאנשים.
secret_value

string

פלט בלבד. הערך הסודי של Measurement Protocol. מעבירים את הערך הזה לשדה api_secret של Measurement Protocol API כששולחים היטים לנכס ההורה של הסוד הזה.

NumericValue

כדי לייצג מספר.

שדות
שדה האיחוד one_value. אחד מהערכים המספריים של one_value יכול להיות רק אחד מהערכים הבאים:
int64_value

int64

ערך שלם
double_value

double

ערך כפול

נכס

הודעת משאב שמייצגת נכס Google Analytics.

שדות
name

string

פלט בלבד. שם המשאב של הנכס הזה. פורמט: properties/{property_id}. דוגמה: ‎"properties/1000"‎
property_type

PropertyType

לא ניתן לשינוי. סוג הנכס של משאב הנכס הזה. כשיוצרים נכס, אם הסוג הוא PROPERTY_TYPE_UNSPECIFIED, המערכת תשתמש ב-ORDINARY_PROPERTY.
create_time

Timestamp

פלט בלבד. המועד שבו הישות נוצרה במקור.
update_time

Timestamp

פלט בלבד. המועד האחרון שבו עודכנו שדות המטען הייעודי של הישות.
parent

string

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

הערה: אפשר להשתמש בממשק המשתמש להעברת נכסים כדי לשנות את הנכס ההורה. פורמט: accounts/{account}, ‏ properties/{property}. דוגמה: "accounts/100",‏ "properties/101"
display_name

string

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

האורך המקסימלי המותר של השם המוצג הוא 100 יחידות קוד UTF-16.
industry_category

IndustryCategory

התחום שמשויך לנכס הזה. דוגמה: AUTOMOTIVE, ‏ FOOD_AND_DRINK
time_zone

string

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

הערה: שינוי אזור הזמן משפיע רק על נתונים עתידיים, ולא מיושם רטרואקטיבית.

פורמט: https://www.iana.org/time-zones דוגמה: 'America/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

לא ניתן לשינוי. שם המשאב של החשבון הראשי. הפורמט: accounts/{account_id}. דוגמה: accounts/123

PropertySummary

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

שדות
property

string

שם המשאב של הנכס שאליו מתייחס סיכום הנכס הזה. הפורמט: properties/{property_id}. דוגמה: "properties/1000"
display_name

string

שם התצוגה של הנכס שאליו מתייחס סיכום הנכס הזה.
property_type

PropertyType

סוג הנכס.
parent

string

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

הערה: אפשר להשתמש בממשק המשתמש להעברת נכסים כדי לשנות את הנכס ההורה. פורמט: accounts/{account}, ‏ properties/{property}. דוגמה: "accounts/100",‏ "properties/200"

PropertyType

סוגי המשאבים של Property.

טיפוסים בני מנייה (enum)
PROPERTY_TYPE_UNSPECIFIED סוג נכס לא ידוע או לא מוגדר
PROPERTY_TYPE_ORDINARY נכס רגיל ב-Google Analytics
PROPERTY_TYPE_SUBPROPERTY נכס משנה ב-Google Analytics
PROPERTY_TYPE_ROLLUP נכס-על ב-Google Analytics

ProvisionAccountTicketRequest

הודעת הבקשה ל-RPC של ProvisionAccountTicket.

שדות
account

Account

החשבון שיצרתם.
redirect_uri

string

URI להפניה אוטומטית שאליו המשתמש יועבר אחרי אישור התנאים וההגבלות. צריך להגדיר אותו במסוף Cloud כ-URI להפניה אוטומטית.

ProvisionAccountTicketResponse

הודעת תגובה ל-RPC של ProvisionAccountTicket.

שדות
account_ticket_id

string

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

RunAccessReportRequest

הבקשה לדוח של רשומות גישה לנתונים.

שדות
entity

string

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

כדי לשלוח בקשה ברמת הנכס, הישות צריכה להיות, לדוגמה, 'נכסים/123' אם '123' הוא מזהה הנכס ב-Google Analytics. כדי לשלוח בקשה ברמת החשבון, הישות צריכה להיות, לדוגמה, 'accounts/1234' אם '1234' הוא מזהה חשבון Google Analytics שלכם.
dimensions[]

AccessDimension

המאפיינים המבוקשים שמוצגים בתגובה. בקשות יכולות לכלול עד 9 מאפיינים.
metrics[]

AccessMetric

המדדים המבוקשים שמוצגים בתגובה. אפשר לשלוח בקשות עם עד 10 מדדים.
date_ranges[]

AccessDateRange

טווחי התאריכים של רשומות הגישה לקריאה. אם מבקשים כמה טווחי תאריכים, כל שורת תגובה תכיל אינדקס של טווח תאריכים שמתחיל באפס. אם שני טווחי תאריכים חופפים, רשומות הגישה של הימים החופפים נכללות בשורות התשובה של שני טווחי התאריכים. אפשר לשלוח בקשות עם עד 2 טווחי תאריכים.
dimension_filter

AccessFilterExpression

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

AccessFilterExpression

מסנני מדדים מאפשרים להגביל את התגובה של הדוח לערכי מדדים ספציפיים שתואמים למסנן. מסנני המדדים מוחלים אחרי צבירה של שורות הדוח, בדומה לתנאי having ב-SQL. אי אפשר להשתמש במאפיינים במסנן הזה.
offset

int64

מספר השורות של שורת ההתחלה. השורה הראשונה נספרת כשורה 0. אם לא צוין ערך לפרמטר offset, הוא ייחשב כ-0. אם הערך של offset הוא אפס, השיטה הזו תחזיר את דף התוצאות הראשון עם limit רשומות.

מידע נוסף על הפרמטר הזה של חלוקה לדפים זמין במאמר חלוקה לדפים.
limit

int64

מספר השורות שיש להחזיר. אם לא צוין ערך, המערכת תחזיר 10,000 שורות. ה-API מחזיר עד 100,000 שורות לכל בקשה, לא משנה כמה שורות מבקשים. הערך של limit חייב להיות חיובי.

יכול להיות שה-API יחזיר פחות שורות מ-limit המבוקש, אם אין מספיק שורות נותרות כדי למלא את ה-limit. לדוגמה, יש פחות מ-300 ערכים אפשריים למאפיין country, כך שבדיווח על country בלבד לא ניתן לקבל יותר מ-300 שורות, גם אם מגדירים ל-limit ערך גבוה יותר.

מידע נוסף על הפרמטר הזה של חלוקה לדפים זמין במאמר חלוקה לדפים.
time_zone

string

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

בפורמט של מחרוזות ממסד הנתונים של אזורי הזמן של IANA‏ (https://www.iana.org/time-zones). לדוגמה, 'America/New_York' או 'Asia/Tokyo'.
order_bys[]

AccessOrderBy

מציין את סדר השורות בתגובה.
return_entity_quota

bool

מצב שמציין אם להחזיר את המצב הנוכחי של המכסה של נכס Analytics הזה. המכסה מוחזר ב-AccessQuota. בבקשות ברמת החשבון, השדה הזה חייב להיות FALSE.
include_all_users

bool

אופציונלי. קובע אם לכלול בתגובה משתמשים שמעולם לא ביצעו קריאה ל-API. אם הערך הוא true, כל המשתמשים שיש להם גישה לנכס או לחשבון שצוינו נכללים בתגובה, גם אם הם לא ביצעו קריאה ל-API. אם הערך הוא false, רק המשתמשים שביצעו קריאה ל-API ייכללו.
expand_groups

bool

אופציונלי. קובע אם להחזיר את המשתמשים בקבוצות משתמשים. השדה הזה פועל רק כשהאפשרות include_all_users מוגדרת כ-true. אם הערך הוא true, המערכת תחזיר את כל המשתמשים שיש להם גישה לנכס או לחשבון שצוינו. אם הערך הוא false, רק המשתמשים עם גישה ישירה יחזרו.

RunAccessReportResponse

התשובה בהתאמה אישית לדוח 'רשומת גישה לנתונים'.

שדות
dimension_headers[]

AccessDimensionHeader

הכותרת של עמודה בדוח שתואמת למאפיין ספציפי. מספר ה-DimensionHeaders והסדר שלהם תואמים למאפיינים שקיימים בשורות.
metric_headers[]

AccessMetricHeader

הכותרת של עמודה בדוח שתואמת למדד ספציפי. מספר הכותרות של המדדים והסדר שלהן תואמים למדדים שמופיעים בשורות.
rows[]

AccessRow

שורות של שילובים של ערכי מאפיינים וערכי מדדים בדוח.
row_count

int32

המספר הכולל של השורות בתוצאת השאילתה. הערך של rowCount לא תלוי במספר השורות שמוחזרות בתגובה, בפרמטר הבקשה limit ובפרמטר הבקשה offset. לדוגמה, אם שאילתה מחזירה 175 שורות וכוללת limit של 50 בבקשת ה-API, התגובה תכלול rowCount של 175 אבל רק 50 שורות.

מידע נוסף על הפרמטר הזה של חלוקה לדפים זמין במאמר חלוקה לדפים.
quota

AccessQuota

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

SearchChangeHistoryEventsRequest

הודעת הבקשה ל-RPC של SearchChangeHistoryEvents.

שדות
account

string

חובה. משאב החשבון שעבורו רוצים להציג משאבים של היסטוריית שינויים. פורמט: accounts/{account}

לדוגמה: accounts/100
property

string

אופציונלי. שם המשאב של נכס צאצא. אם ההגדרה הזו מוגדרת, המערכת תחזיר רק שינויים שבוצעו בנכס הזה או במשאבי הצאצאים שלו. פורמט: properties/{propertyId}

לדוגמה: properties/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 עד שמקבלים את המספר הרצוי.
page_token

string

אופציונלי. אסימון דף, שהתקבל משיחה קודמת של SearchChangeHistoryEvents. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-SearchChangeHistoryEvents חייבים להתאים לקריאה שסיפקה את אסימון הדף.

SearchChangeHistoryEventsResponse

הודעת תגובה ל-RPC של SearchAccounts.

שדות
change_history_events[]

ChangeHistoryEvent

תוצאות שהיו נגישות למתקשר.
next_page_token

string

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

ServiceLevel

רמות שירות שונות ב-Google Analytics.

טיפוסים בני מנייה (enum)
SERVICE_LEVEL_UNSPECIFIED רמת השירות לא צוינה או לא תקינה.
GOOGLE_ANALYTICS_STANDARD הגרסה הרגילה של Google Analytics.
GOOGLE_ANALYTICS_360 הגרסה בתשלום של Google Analytics.

UpdateAccountRequest

הודעת בקשה ל-RPC של UpdateAccount.

שדות
account

Account

חובה. החשבון שרוצים לעדכן. השדה name של החשבון משמש לזיהוי החשבון.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות קטנות (למשל, 'field_to_update'). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateConversionEventRequest

הודעת בקשה ל-RPC של UpdateConversionEvent

שדות
conversion_event

ConversionEvent

חובה. אירוע ההמרה שרוצים לעדכן. השדה name משמש לזיהוי ההגדרות שרוצים לעדכן.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות (למשל, "field_to_update"). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateCustomDimensionRequest

הודעת בקשה ל-RPC של UpdateCustomDimension.

שדות
custom_dimension

CustomDimension

המאפיין המותאם אישית שרוצים לעדכן
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateCustomMetricRequest

הודעת בקשה ל-RPC של UpdateCustomMetric.

שדות
custom_metric

CustomMetric

המדד המותאם אישית שרוצים לעדכן
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateDataRetentionSettingsRequest

הודעת בקשה ל-RPC של UpdateDataRetentionSettings.

שדות
data_retention_settings

DataRetentionSettings

חובה. ההגדרות שרוצים לעדכן. השדה name משמש לזיהוי ההגדרות שרוצים לעדכן.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות (למשל, "field_to_update"). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateDataStreamRequest

הודעת בקשה ל-RPC של UpdateDataStream.

שדות
data_stream

DataStream

מקור הנתונים שרוצים לעדכן
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateGoogleAdsLinkRequest

הודעת בקשה ל-RPC של UpdateGoogleAdsLink

שדות
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות (למשל, "field_to_update"). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateKeyEventRequest

הודעת בקשה ל-RPC של UpdateKeyEvent

שדות
key_event

KeyEvent

חובה. האירוע המרכזי שרוצים לעדכן. השדה name משמש לזיהוי ההגדרות שרוצים לעדכן.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות (למשל, "field_to_update"). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.

UpdateMeasurementProtocolSecretRequest

הודעת בקשה ל-RPC של UpdateMeasurementProtocolSecret

שדות
measurement_protocol_secret

MeasurementProtocolSecret

חובה. הסוד של Measurement Protocol שרוצים לעדכן.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שדות שלא צוינו לא יתעדכנו.

UpdatePropertyRequest

הודעת הבקשה ל-RPC של UpdateProperty.

שדות
property

Property

חובה. הנכס שרוצים לעדכן. השדה name של המלון משמש לזיהוי המלון שרוצים לעדכן.
update_mask

FieldMask

חובה. רשימת השדות שרוצים לעדכן. שמות השדות חייבים להיות באותיות רישיות (למשל, "field_to_update"). שדות שלא צוינו לא יתעדכנו. כדי להחליף את הישות כולה, משתמשים בנתיבים אחד עם המחרוזת '*' כדי להתאים לכל השדות.