Package google.analytics.admin.v1beta

ดัชนี

AnalyticsAdminService

อินเทอร์เฟซบริการสำหรับ Analytics Admin API (GA4)

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

ยอมรับข้อกำหนดในการรวบรวมข้อมูลผู้ใช้สำหรับพร็อพเพอร์ตี้ที่ระบุ

คุณต้องรับทราบนี้ (ใน UI ของ 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)

เก็บ CustomMetric ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

สร้างเหตุการณ์ Conversion ที่มีแอตทริบิวต์ที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

สร้าง CustomDimension

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

สร้าง CustomMetrics

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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)

สร้างพร็อพเพอร์ตี้ "GA4" ที่มีตําแหน่งและแอตทริบิวต์ที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

ทำเครื่องหมายบัญชีเป้าหมายว่าถูกลบชั่วคราว (เช่น "ถังขยะ") และส่งคืน

API นี้ไม่มีวิธีกู้คืนบัญชีที่ทำเครื่องหมายว่าลบ แต่สามารถกู้คืนได้โดยใช้ UI ถังขยะ

หากไม่ได้กู้คืนบัญชีก่อนเวลาหมดอายุ ระบบจะลบบัญชีและทรัพยากรย่อยทั้งหมด (เช่น พร็อพเพอร์ตี้, GoogleAdsLinks, สตรีม, AccessBindings) ออกอย่างถาวร https://support.google.com/analytics/answer/6154772

แสดงผลข้อผิดพลาดหากไม่พบเป้าหมาย

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

ลบกิจกรรม Conversion ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

ลบ DataStream ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

ลบกิจกรรมสำคัญ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

ลบ MeasurementProtocolSecret เป้าหมาย

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

ทำเครื่องหมายพร็อพเพอร์ตี้เป้าหมายเป็น "ลบชั่วคราว" (เช่น "ถังขยะ") และส่งคืน

API นี้ไม่มีวิธีกู้คืนพร็อพเพอร์ตี้ที่ลบชั่วคราว แต่สามารถกู้คืนได้โดยใช้ UI ถังขยะ

หากไม่มีการกู้คืนพร็อพเพอร์ตี้ก่อนเวลาหมดอายุ ระบบจะลบพร็อพเพอร์ตี้และทรัพยากรย่อยทั้งหมด (เช่น GoogleAdsLinks, สตรีม, AccessBindings) ออกอย่างถาวร https://support.google.com/analytics/answer/6154772

แสดงผลข้อผิดพลาดหากไม่พบเป้าหมาย หรือไม่ใช่พร็อพเพอร์ตี้ GA4

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc GetAccount(GetAccountRequest) returns (Account)

ค้นหาบัญชีเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

ดึงข้อมูลเหตุการณ์ Conversion รายการเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

ค้นหา CustomDimension เดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

ค้นหา CustomMetrics เดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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)

ค้นหา 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 ของ "GA4" รายการเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc GetProperty(GetPropertyRequest) returns (Property)

ค้นหาพร็อพเพอร์ตี้ "GA4" รายการเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

แสดงข้อมูลสรุปของบัญชีทั้งหมดที่ผู้โทรสามารถเข้าถึงได้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

แสดงผลบัญชีทั้งหมดที่ผู้โทรสามารถเข้าถึงได้

โปรดทราบว่าบัญชีเหล่านี้อาจยังไม่มีพร็อพเพอร์ตี้ GA4 ในตอนนี้ บัญชีที่ลบชั่วคราว (เช่น "ถังขยะ") จะไม่รวมอยู่โดยค่าเริ่มต้น แสดงรายการที่ว่างเปล่าหากไม่พบบัญชีที่เกี่ยวข้อง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

แสดงรายการเหตุการณ์ Conversion ในพร็อพเพอร์ตี้ระดับบนสุดที่ระบุ

แสดงรายการที่ว่างเปล่าหากไม่พบเหตุการณ์ Conversion

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

แสดงรายการมิติข้อมูลที่กำหนดเองในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

แสดงรายการ CustomMetrics ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

แสดงรายการ DataStreams ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

แสดงรายการเหตุการณ์สำคัญในพร็อพเพอร์ตี้ระดับบนสุดที่ระบุ แสดงรายการที่ว่างเปล่าหากไม่พบเหตุการณ์สำคัญ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

แสดงผล MeasurementProtocolSecrets ระดับล่างภายใต้พร็อพเพอร์ตี้ระดับบนสุดที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

แสดงผลพร็อพเพอร์ตี้ย่อยภายใต้บัญชีหลักที่ระบุ

ระบบจะแสดงเฉพาะพร็อพเพอร์ตี้ "GA4" เท่านั้น ระบบจะยกเว้นพร็อพเพอร์ตี้หากผู้โทรไม่มีสิทธิ์เข้าถึง โดยค่าเริ่มต้น ระบบจะยกเว้นพร็อพเพอร์ตี้ที่ลบชั่วคราว (เช่น "ถังขยะ") แสดงรายการที่ว่างเปล่าหากไม่พบพร็อพเพอร์ตี้ที่เกี่ยวข้อง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

ขอคำขอแจ้งปัญหาสำหรับการสร้างบัญชี

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

แสดงรายงานที่กำหนดเองของบันทึกการเข้าถึงข้อมูล รายงานจะแสดงบันทึกในแต่ละครั้งที่ผู้ใช้อ่านข้อมูลการรายงานของ Google Analytics ระบบจะเก็บรักษาบันทึกการเข้าถึงไว้ไม่เกิน 2 ปี

สามารถขอรายงานการเข้าถึงข้อมูลสำหรับพร็อพเพอร์ตี้ได้ คุณจะขอรายงานสำหรับพร็อพเพอร์ตี้ใดก็ได้ แต่จะขอมิติข้อมูลที่ไม่เกี่ยวข้องกับโควต้าได้เฉพาะในพร็อพเพอร์ตี้ Google Analytics 360 เท่านั้น วิธีนี้ใช้ได้เฉพาะกับผู้ดูแลระบบเท่านั้น

บันทึกการเข้าถึงข้อมูลเหล่านี้ประกอบด้วยการรายงาน UI ของ GA4, การสํารวจ UI ของ GA4, API ข้อมูลของ GA4 และผลิตภัณฑ์อื่นๆ เช่น Firebase และ AdMob ที่สามารถดึงข้อมูลจาก Google Analytics ผ่านการลิงก์ ระเบียนเหล่านี้จะไม่รวมการเปลี่ยนแปลงการกำหนดค่าพร็อพเพอร์ตี้ เช่น การเพิ่มสตรีมหรือการเปลี่ยนเขตเวลาของพร็อพเพอร์ตี้ โปรดดูประวัติการเปลี่ยนแปลงการกำหนดค่าที่ searchChangeHistoryEvents

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

ค้นหาการเปลี่ยนแปลงทั้งหมดที่เกิดขึ้นกับบัญชีหรือระดับย่อยในบัญชีตามชุดตัวกรองที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

อัปเดตบัญชี

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

อัปเดตเหตุการณ์ Conversion ด้วยแอตทริบิวต์ที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

อัปเดต CustomDimension ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

อัปเดต CustomMetric ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

อัปเดตการตั้งค่าการเก็บรักษาข้อมูล Singleton สำหรับพร็อพเพอร์ตี้นี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

อัปเดต DataStream ในพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

อัปเดตเหตุการณ์สําคัญ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

อัปเดตข้อมูลลับของ 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

เพื่อแสดงให้เห็นว่าผลลัพธ์ต้องอยู่ระหว่าง 2 จำนวน (นับรวมด้วย)

ช่อง
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 ระบุตัวกรอง 1 ประเภทสำหรับFilter one_filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
string_filter

AccessStringFilter

ตัวกรองที่เกี่ยวข้องกับสตริง

in_list_filter

AccessInListFilter

ตัวกรองสำหรับค่าในรายการ

numeric_filter

AccessNumericFilter

ตัวกรองสำหรับค่าตัวเลขหรือวันที่

between_filter

AccessBetweenFilter

ตัวกรองสำหรับ 2 ค่า

AccessFilterExpression

แสดงตัวกรองมิติข้อมูลหรือเมตริก ช่องในนิพจน์เดียวกันต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด

ช่อง
ฟิลด์สหภาพ one_expression ระบุนิพจน์ตัวกรอง 1 ประเภทสำหรับ FilterExpression one_expression ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
and_group

AccessFilterExpressionList

นิพจน์ตัวกรองแต่ละรายการใน and_group จะมีความสัมพันธ์แบบ "และ"

or_group

AccessFilterExpressionList

นิพจน์ตัวกรองแต่ละรายการใน or_group มีความสัมพันธ์ OR

not_expression

AccessFilterExpression

filterExpression ไม่ใช่ของ not_expression

access_filter

AccessFilter

ตัวกรองพื้นฐาน ในFilterExpression เดียวกัน ชื่อช่องทั้งหมดของตัวกรองจะต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด

AccessFilterExpressionList

รายการนิพจน์ตัวกรอง

ช่อง
expressions[]

AccessFilterExpression

รายการนิพจน์ตัวกรอง

AccessInListFilter

ผลลัพธ์ต้องอยู่ในรายการค่าสตริง

ช่อง
values[]

string

รายการค่าสตริง ต้องระบุ

case_sensitive

bool

หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

AccessMetric

การวัดเชิงปริมาณของรายงาน ตัวอย่างเช่น เมตริก accessCount คือจำนวนบันทึกการเข้าถึงข้อมูลทั้งหมด

ช่อง
metric_name

string

ชื่อ API ของเมตริก โปรดดูสคีมาการเข้าถึงข้อมูลสำหรับรายการเมตริกที่ API นี้รองรับ

ชื่อเมตริกจะอ้างอิงใน metricFilter และ orderBys

AccessMetricHeader

อธิบายคอลัมน์เมตริกในรายงาน คำขอเมตริกที่มองเห็นได้ในรายงานจะสร้างรายการคอลัมน์ภายในแถวและ 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

ลำดับตามจะกำหนดวิธีจัดเรียงแถวในคำตอบ เช่น การจัดลำดับแถวตามจํานวนการเข้าถึงจากมากไปน้อยเป็นการเรียงลำดับ 1 แถว และการเรียงลำดับแถวตามสตริงประเทศจะเป็นลำดับที่ต่างกัน

ช่อง
desc

bool

หากจริง ให้จัดเรียงตามลำดับจากมากไปน้อย หากเป็นเท็จหรือไม่ได้ระบุ ให้จัดเรียงตามลำดับจากน้อยไปหามาก

ฟิลด์สหภาพ one_order_by ระบุคำสั่งซื้อ 1 ประเภทตามสำหรับ OrderBy one_order_by ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
metric

MetricOrderBy

จัดเรียงผลลัพธ์ตามค่าของเมตริก

dimension

DimensionOrderBy

จัดเรียงผลลัพธ์ตามค่าของมิติข้อมูล

DimensionOrderBy

จัดเรียงตามค่ามิติข้อมูล

ช่อง
dimension_name

string

ชื่อมิติข้อมูลในคำขอเรียงลำดับตาม

order_type

OrderType

ควบคุมกฎในการจัดลำดับค่าของมิติข้อมูล

OrderType

กฎสำหรับเรียงลำดับค่ามิติข้อมูลสตริง

Enum
ORDER_TYPE_UNSPECIFIED ไม่ระบุ
ALPHANUMERIC จัดเรียงตัวอักษรและตัวเลขตามจุดรหัส Unicode เช่น "2" < "A" < "X" < "b" < "z"
CASE_INSENSITIVE_ALPHANUMERIC ตัวอักษรและตัวเลขคละกันที่ไม่คำนึงถึงตัวพิมพ์เล็กหรือใหญ่จะจัดเรียงตามโค้ด 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 รายการต่อชั่วโมง

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

หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

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

ประเทศของธุรกิจ ต้องเป็นรหัสภูมิภาค CLDR แบบ Unicode

deleted

bool

เอาต์พุตเท่านั้น ระบุว่าบัญชีนี้ถูกลบชั่วคราวหรือไม่ บัญชีที่ลบจะไม่รวมอยู่ในผลลัพธ์รายการ ยกเว้นกรณีที่ได้รับคำขออย่างเจาะจง

gmp_organization

string

เอาต์พุตเท่านั้น URI สำหรับทรัพยากรขององค์กรที่ใช้ Google Marketing Platform ตั้งค่าเฉพาะเมื่อบัญชีนี้เชื่อมต่อกับองค์กรที่ใช้ GMP เท่านั้น รูปแบบ: Marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

ทรัพยากรเสมือนที่แสดงภาพรวมของบัญชีและพร็อพเพอร์ตี้ GA4 ย่อยทั้งหมด

ช่อง
name

string

ชื่อแหล่งข้อมูลสำหรับสรุปบัญชีนี้ รูปแบบ: accountSummaries/{account_id} ตัวอย่างเช่น "accountSummaries/1000"

account

string

ชื่อทรัพยากรของบัญชีที่สรุปบัญชีนี้อ้างอิง รูปแบบ: accounts/{account_id} ตัวอย่างเช่น "accounts/1000"

display_name

string

ชื่อที่แสดงสำหรับบัญชีที่อ้างอิงในข้อมูลสรุปของบัญชีนี้

property_summaries[]

PropertySummary

รายการข้อมูลสรุปของบัญชีย่อยของบัญชีนี้

AcknowledgeUserDataCollectionRequest

ข้อความคำขอสำหรับ AcknowledgeUserDataCollection RPC

ช่อง
property

string

ต้องระบุ พร็อพเพอร์ตี้สำหรับรับทราบการเก็บรวบรวมข้อมูลผู้ใช้

acknowledgement

string

ต้องระบุ การรับทราบว่าผู้เรียกใช้เมธอดนี้เข้าใจข้อกําหนดในการรวบรวมข้อมูลผู้ใช้

ช่องนี้ต้องมีค่าที่ถูกต้องดังนี้ "ฉันรับทราบว่าฉันได้รับการเปิดเผยข้อมูลความเป็นส่วนตัวที่จำเป็นและสิทธิ์จากผู้ใช้ปลายทางเพื่อเก็บรวบรวมและประมวลผลข้อมูลผู้ใช้ ซึ่งรวมถึงการเชื่อมโยงข้อมูลดังกล่าวกับข้อมูลการเข้าชมที่ Google Analytics เก็บรวบรวมจากพร็อพเพอร์ตี้เว็บไซต์และ/หรือแอปของฉันด้วย"

AcknowledgeUserDataCollectionResponse

ประเภทนี้ไม่มีช่อง

ข้อความตอบกลับสำหรับ AcknowledgeUserDataCollection RPC

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

ข้อความคำขอสำหรับ ArchiveCustomDimension RPC

ช่อง
name

string

ต้องระบุ ชื่อของ CustomDimension ที่จะเก็บถาวร รูปแบบตัวอย่าง: property/1234/customdimension/5678

ArchiveCustomMetricRequest

ข้อความคำขอสำหรับ ArchiveCustomMetric RPC

ช่อง
name

string

ต้องระบุ ชื่อของ CustomMetric ที่จะเก็บถาวร รูปแบบตัวอย่าง: property/1234/customMetrics/5678

ChangeHistoryChange

คำอธิบายการเปลี่ยนแปลงของทรัพยากร Google Analytics รายการเดียว

ช่อง
resource

string

ชื่อทรัพยากรของทรัพยากรที่มีรายการนี้อธิบายการเปลี่ยนแปลง

action

ActionType

ประเภทของการดำเนินการที่เปลี่ยนทรัพยากรนี้

resource_before_change

ChangeHistoryResource

เนื้อหาแหล่งข้อมูลก่อนทำการเปลี่ยนแปลง หากสร้างทรัพยากรนี้ขึ้นในการเปลี่ยนแปลงนี้ ช่องนี้จะหายไป

resource_after_change

ChangeHistoryResource

เนื้อหาแหล่งข้อมูลหลังจากทำการเปลี่ยนแปลง หากแหล่งข้อมูลนี้ถูกลบเนื่องจากการเปลี่ยนแปลงนี้ ช่องนี้จะหายไป

ChangeHistoryResource

ภาพรวมของทรัพยากรเหมือนก่อนหรือหลังผลลัพธ์ของการเปลี่ยนแปลงในประวัติการเปลี่ยนแปลง

ช่อง

ฟิลด์สหภาพ resource

resource ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

account

Account

ภาพรวมของทรัพยากรบัญชีในประวัติการเปลี่ยนแปลง

property

Property

ภาพรวมของทรัพยากรพร็อพเพอร์ตี้ในประวัติการเปลี่ยนแปลง

conversion_event

ConversionEvent

ภาพรวมของทรัพยากร ConversionEvent ในประวัติการเปลี่ยนแปลง

measurement_protocol_secret

MeasurementProtocolSecret

ภาพรวมของทรัพยากร MeasurementProtocolSecret ในประวัติการเปลี่ยนแปลง

data_retention_settings

DataRetentionSettings

ภาพรวมของทรัพยากรการตั้งค่าการเก็บรักษาข้อมูลในประวัติการเปลี่ยนแปลง

data_stream

DataStream

ภาพรวมของทรัพยากร DataStream ในประวัติการเปลี่ยนแปลง

ChangeHistoryEvent

ชุดการเปลี่ยนแปลงภายในบัญชี Google Analytics หรือพร็อพเพอร์ตี้ย่อยในบัญชีที่เกิดจากสาเหตุเดียวกัน สาเหตุที่พบบ่อยคือการอัปเดตใน UI ของ Google Analytics, การเปลี่ยนแปลงจากฝ่ายสนับสนุนลูกค้า หรือการเปลี่ยนแปลงระบบ Google Analytics อัตโนมัติ

ช่อง
id

string

รหัสของเหตุการณ์ประวัติการเปลี่ยนแปลงนี้ รหัสนี้ไม่ซ้ำกันใน Google Analytics

change_time

Timestamp

เวลาที่ทำการเปลี่ยนแปลง

actor_type

ActorType

ประเภทนักแสดงที่ทำการเปลี่ยนแปลงนี้

user_actor_email

string

อีเมลของบัญชี Google ที่ทำการเปลี่ยนแปลง ที่อยู่อีเมลนี้จะเป็นอีเมลที่ถูกต้องหากมีการตั้งค่าช่องนักแสดงเป็น USER หรือเว้นว่างไว้ บัญชี Google ที่ลบไปแล้วจะทำให้เกิดข้อผิดพลาด

changes_filtered

bool

หากเป็นจริง รายการของการเปลี่ยนแปลงที่แสดงผลจะถูกกรองออกและไม่ได้แสดงการเปลี่ยนแปลงทั้งหมดที่เกิดขึ้นในเหตุการณ์นี้

changes[]

ChangeHistoryChange

รายการการเปลี่ยนแปลงที่เกิดขึ้นในเหตุการณ์ประวัติการเปลี่ยนแปลงนี้ซึ่งตรงตามตัวกรองที่ระบุใน SearchChangeHistoryEventsRequest

ChangeHistoryResourceType

ประเภทของทรัพยากรที่สามารถแสดงการเปลี่ยนแปลงจากประวัติการเปลี่ยนแปลง

Enum
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED ไม่ทราบหรือไม่ได้ระบุประเภททรัพยากร
ACCOUNT ทรัพยากรของบัญชี
PROPERTY ทรัพยากรพร็อพเพอร์ตี้
GOOGLE_SIGNALS_SETTINGS แหล่งข้อมูล GoogleSignalsSettings
CONVERSION_EVENT แหล่งข้อมูลเหตุการณ์ Conversion
MEASUREMENT_PROTOCOL_SECRET ทรัพยากร MeasurementProtocolSecret
DATA_RETENTION_SETTINGS แหล่งข้อมูลการตั้งค่าการเก็บรักษาข้อมูล
DATA_STREAM ทรัพยากร DataStream
ATTRIBUTION_SETTINGS แหล่งข้อมูล AttributionSettings

ConversionEvent

เหตุการณ์ Conversion ในพร็อพเพอร์ตี้ Google Analytics

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของเหตุการณ์ Conversion นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/conversionEvents/{conversion_event}

event_name

string

เปลี่ยนแปลงไม่ได้ ชื่อเหตุการณ์สําหรับเหตุการณ์ Conversion นี้ ตัวอย่างเช่น "คลิก" "การซื้อ"

create_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างเหตุการณ์ Conversion นี้ในพร็อพเพอร์ตี้

deletable

bool

เอาต์พุตเท่านั้น หากตั้งค่าไว้ ในตอนนี้คุณจะลบเหตุการณ์นี้ได้ด้วย DeleteConversionEvent

custom

bool

เอาต์พุตเท่านั้น หากตั้งค่าเป็น "จริง" เหตุการณ์ Conversion นี้จะหมายถึงเหตุการณ์ที่กําหนดเอง หากตั้งค่าเป็น "เท็จ" เหตุการณ์ Conversion นี้หมายถึงเหตุการณ์เริ่มต้นใน GA โดยทั่วไปเหตุการณ์เริ่มต้นจะมีความหมายพิเศษใน GA โดยปกติแล้วระบบ GA จะสร้างเหตุการณ์เริ่มต้นให้คุณ แต่ในบางกรณีอาจสร้างได้โดยผู้ดูแลระบบพร็อพเพอร์ตี้ ระบบจะนับเหตุการณ์ที่กําหนดเองรวมในจํานวนเหตุการณ์ Conversion ที่กําหนดเองสูงสุดซึ่งอาจสร้างได้ต่อพร็อพเพอร์ตี้

counting_method

ConversionCountingMethod

ไม่บังคับ วิธีการนับ Conversion ในหลายๆ เหตุการณ์ภายในหนึ่งเซสชัน หากไม่ได้ระบุค่านี้ไว้ ระบบจะตั้งค่าเป็น ONCE_PER_EVENT

default_conversion_value

DefaultConversionValue

ไม่บังคับ กำหนดมูลค่า/สกุลเงินเริ่มต้นสำหรับเหตุการณ์ Conversion

ConversionCountingMethod

วิธีการนับ Conversion ในหลายๆ เหตุการณ์ภายในหนึ่งเซสชัน

Enum
CONVERSION_COUNTING_METHOD_UNSPECIFIED ไม่ได้ระบุวิธีการนับ
ONCE_PER_EVENT แต่ละเหตุการณ์ของเหตุการณ์ถือเป็น Conversion
ONCE_PER_SESSION อินสแตนซ์เหตุการณ์จะถือว่าเป็น Conversion มากที่สุด 1 ครั้งต่อเซสชันต่อผู้ใช้

DefaultConversionValue

กำหนดมูลค่า/สกุลเงินเริ่มต้นสำหรับเหตุการณ์ Conversion ต้องระบุทั้งมูลค่าและสกุลเงิน

ช่อง
value

double

ระบบจะใช้ค่านี้เพื่อเติมค่าให้กับ Conversion ทั้งหมดของ event_name ที่ระบุซึ่งไม่มีการตั้งค่าพารามิเตอร์ "value" ของเหตุการณ์

currency_code

string

เมื่อเหตุการณ์ Conversion สำหรับ event_name นี้ไม่ได้กำหนดสกุลเงินไว้ ระบบจะใช้สกุลเงินนี้เป็นค่าเริ่มต้น ต้องอยู่ในรูปแบบรหัสสกุลเงิน ISO 4217 ดูข้อมูลเพิ่มเติมได้ที่ https://en.wikipedia.org/wiki/ISO_4217

CreateConversionEventRequest

ข้อความคำขอสำหรับ CreateConversionEvent RPC

ช่อง
conversion_event

ConversionEvent

ต้องระบุ เหตุการณ์ Conversion ที่จะสร้าง

parent

string

ต้องระบุ ชื่อทรัพยากรของพร็อพเพอร์ตี้หลักที่จะสร้างเหตุการณ์ Conversion นี้ รูปแบบ: พร็อพเพอร์ตี้/123

CreateCustomDimensionRequest

ข้อความคำขอสำหรับ CreateCustomDimension RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

custom_dimension

CustomDimension

ต้องระบุ CustomDimension ที่จะสร้าง

CreateCustomMetricRequest

ข้อความคำขอสำหรับ CreateCustomMetric RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

custom_metric

CustomMetric

ต้องระบุ CustomMetric ที่จะสร้าง

CreateDataStreamRequest

ข้อความคำขอสำหรับ CreateDataStream RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

data_stream

DataStream

ต้องระบุ DataStream ที่จะสร้าง

CreateFirebaseLinkRequest

ข้อความคำขอสำหรับ CreateFirebaseLink RPC

ช่อง
parent

string

ต้องระบุ รูปแบบ: พร็อพเพอร์ตี้/{property_id} ตัวอย่าง: พร็อพเพอร์ตี้/1234

CreateGoogleAdsLinkRequest

ข้อความคำขอสำหรับ CreateGoogleAdsLink RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

CreateKeyEventRequest

ข้อความคำขอสำหรับ CreateKeyEvent RPC

ช่อง
key_event

KeyEvent

ต้องระบุ เหตุการณ์สําคัญที่จะสร้าง

parent

string

ต้องระบุ ชื่อทรัพยากรของพร็อพเพอร์ตี้หลักที่จะสร้างเหตุการณ์สำคัญนี้ รูปแบบ: พร็อพเพอร์ตี้/123

CreateMeasurementProtocolSecretRequest

ข้อความคำขอสำหรับ CreateMeasurementProtocolSecret RPC

ช่อง
parent

string

ต้องระบุ ทรัพยากรระดับบนสุดที่จะสร้างข้อมูลลับนี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

ต้องระบุ ข้อมูลลับของ Measurement Protocol ที่จะสร้าง

CreatePropertyRequest

ข้อความคำขอสำหรับ CreateProperty RPC

ช่อง
property

Property

ต้องระบุ พร็อพเพอร์ตี้ที่จะสร้าง หมายเหตุ: พร็อพเพอร์ตี้ที่ระบุต้องระบุในระดับบนสุด

CustomDimension

คำจำกัดความของ CustomDimension

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของทรัพยากร CustomDimension นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/customได้อีกต่อไป/{customDimension}

parameter_name

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อพารามิเตอร์การติดแท็กสําหรับมิติข้อมูลที่กําหนดเองนี้

หากเป็นมิติข้อมูลที่กําหนดขอบเขตระดับผู้ใช้ ชื่อนี้คือชื่อพร็อพเพอร์ตี้ผู้ใช้ หากเป็นมิติข้อมูลที่กําหนดขอบเขตระดับเหตุการณ์ ชื่อนี้คือชื่อพารามิเตอร์เหตุการณ์

หากเป็นมิติข้อมูลระดับสินค้า ชื่อนี้คือชื่อพารามิเตอร์ที่พบในอาร์เรย์รายการอีคอมเมิร์ซ

มีได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกันและขีดล่างเท่านั้น โดยขึ้นต้นด้วยตัวอักษร ความยาวสูงสุด 24 อักขระสำหรับมิติข้อมูลที่กำหนดขอบเขตระดับผู้ใช้ และ 40 อักขระสำหรับมิติข้อมูลที่กำหนดขอบเขตระดับเหตุการณ์

display_name

string

ต้องระบุ ชื่อที่แสดงสําหรับมิติข้อมูลที่กําหนดเองนี้ตามที่แสดงใน UI ของ Analytics มีความยาวได้สูงสุด 82 อักขระ โดยประกอบด้วยตัวอักษรและตัวเลขคละกัน รวมถึงเว้นวรรคและขีดล่างที่ขึ้นต้นด้วยตัวอักษร ชื่อที่แสดงซึ่งระบบสร้างขึ้นแบบเดิมอาจมีวงเล็บเหลี่ยม แต่การอัปเดตช่องนี้จะไม่อนุญาตให้ใช้วงเล็บเหลี่ยม

description

string

ไม่บังคับ คําอธิบายสําหรับมิติข้อมูลที่กําหนดเองนี้ ความยาวสูงสุด 150 อักขระ

scope

DimensionScope

ต้องระบุ เปลี่ยนแปลงไม่ได้ ขอบเขตของมิติข้อมูลนี้

disallow_ads_personalization

bool

ไม่บังคับ หากตั้งค่าเป็น "จริง" ให้กำหนดมิติข้อมูลนี้เป็น NPA และยกเว้นจากการปรับโฆษณาตามโปรไฟล์ของผู้ใช้

ปัจจุบันมิติข้อมูลที่กำหนดเองที่กำหนดขอบเขตระดับผู้ใช้รองรับเฉพาะมิติข้อมูลนี้เท่านั้น

DimensionScope

ค่าที่ถูกต้องสำหรับขอบเขตของมิติข้อมูลนี้

Enum
DIMENSION_SCOPE_UNSPECIFIED ไม่ทราบขอบเขตหรือไม่ได้ระบุ
EVENT มิติข้อมูลที่กำหนดขอบเขตเป็นเหตุการณ์
USER มิติข้อมูลที่กำหนดขอบเขตเป็นผู้ใช้
ITEM มิติข้อมูลที่กำหนดขอบเขตไปยังรายการอีคอมเมิร์ซ

CustomMetric

คำจำกัดความของเมตริกที่กำหนดเอง

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของทรัพยากร CustomMetric นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/customMetrics/{customMetric}

parameter_name

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อการติดแท็กสําหรับเมตริกที่กําหนดเองนี้

หากเป็นเมตริกที่กําหนดขอบเขตระดับเหตุการณ์ ชื่อนี้คือชื่อพารามิเตอร์เหตุการณ์

มีได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกันและขีดล่างเท่านั้น โดยขึ้นต้นด้วยตัวอักษร ความยาวสูงสุด 40 อักขระสำหรับเมตริกที่กำหนดขอบเขตระดับเหตุการณ์

display_name

string

ต้องระบุ ชื่อที่แสดงของเมตริกที่กำหนดเองนี้ตามที่แสดงใน UI ของ 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

ค่าของการตั้งค่าสำหรับการเก็บรักษาข้อมูล นี่คือทรัพยากร Singleton

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรสำหรับทรัพยากร DataPrivacySetting นี้ รูปแบบ: property/{property}/datareservationSettings

event_data_retention

RetentionDuration

ระยะเวลาที่มีการเก็บรักษาข้อมูลระดับเหตุการณ์

reset_user_data_on_new_activity

bool

หากเป็นจริง ให้รีเซ็ตระยะเวลาเก็บรักษาของตัวระบุผู้ใช้ที่มีเหตุการณ์ทั้งหมดจากผู้ใช้รายนั้น

RetentionDuration

ค่าที่ถูกต้องสำหรับระยะเวลาเก็บรักษาข้อมูล

Enum
RETENTION_DURATION_UNSPECIFIED ไม่ได้ระบุระยะเวลาเก็บรักษาข้อมูล
TWO_MONTHS ระยะเวลาเก็บรักษาข้อมูลคือ 2 เดือน
FOURTEEN_MONTHS ระยะเวลาเก็บรักษาข้อมูลคือ 14 เดือน
TWENTY_SIX_MONTHS ระยะเวลาเก็บรักษาข้อมูลคือ 26 เดือน ใช้ได้กับพร็อพเพอร์ตี้ 360 เท่านั้น
THIRTY_EIGHT_MONTHS ระยะเวลาเก็บรักษาข้อมูลคือ 38 เดือน ใช้ได้กับพร็อพเพอร์ตี้ 360 เท่านั้น
FIFTY_MONTHS ระยะเวลาเก็บรักษาข้อมูลคือ 50 เดือน ใช้ได้กับพร็อพเพอร์ตี้ 360 เท่านั้น

DataSharingSettings

ข้อความแหล่งข้อมูลที่แสดงถึงการตั้งค่าการแชร์ข้อมูลของบัญชี Google Analytics

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากร รูปแบบ: accounts/{account}/dataSharingSettings ตัวอย่างเช่น "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

อนุญาตให้ทีมสนับสนุนของ Google เข้าถึงข้อมูลเพื่อช่วยแก้ปัญหา

sharing_with_google_assigned_sales_enabled

bool

อนุญาตให้ทีมขายของ Google ที่กำหนดให้กับลูกค้าเข้าถึงข้อมูลเพื่อแนะนำการเปลี่ยนแปลงการกำหนดค่าเพื่อปรับปรุงผลลัพธ์ ข้อจำกัดของทีมขายจะยังคงมีผลเมื่อเปิดใช้งาน

sharing_with_google_any_sales_enabled

bool

อนุญาตให้ฝ่ายขายของ Google เข้าถึงข้อมูลเพื่อแนะนำการเปลี่ยนแปลงการกำหนดค่าเพื่อปรับปรุงผลลัพธ์

sharing_with_google_products_enabled

bool

อนุญาตให้ Google ใช้ข้อมูลนี้เพื่อปรับปรุงผลิตภัณฑ์หรือบริการอื่นๆ ของ Google

sharing_with_others_enabled

bool

อนุญาตให้ Google แชร์ข้อมูลโดยไม่ระบุตัวตนในรูปแบบรวมกับผู้อื่น

DataStream

ข้อความทรัพยากรที่แสดงถึงสตรีมข้อมูล

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของสตรีมข้อมูลนี้ รูปแบบ: พร็อพเพอร์ตี้/{property_id}/dataStreams/{stream_id} เช่น: "properties/1000/dataStreams/2000"

type

DataStreamType

ต้องระบุ เปลี่ยนแปลงไม่ได้ ประเภทของทรัพยากร DataStream นี้

display_name

string

ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับสตรีมข้อมูล

ต้องใช้สำหรับสตรีมข้อมูลเว็บ

ความยาวชื่อที่แสดงสูงสุดที่อนุญาตคือหน่วยโค้ด UTF-16 จำนวน 255 หน่วย

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 ลบบัญชี

ช่อง
name

string

ต้องระบุ ชื่อบัญชีที่จะทำเครื่องหมายว่าลบ รูปแบบ: accounts/{account} ตัวอย่างเช่น "accounts/100"

DeleteConversionEventRequest

ข้อความคำขอสำหรับ DeleteConversionEvent RPC

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเหตุการณ์ Conversion ที่จะลบ รูปแบบ: พร็อพเพอร์ตี้/{property}/conversionEvents/{conversion_event} เช่น: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

ข้อความคำขอสำหรับ DeleteDataStream RPC

ช่อง
name

string

ต้องระบุ ชื่อของ DataStream ที่จะลบ รูปแบบตัวอย่าง: property/1234/dataStreams/5678

DeleteFirebaseLinkRequest

ข้อความคำขอสำหรับ DeleteFirebaseLink RPC

ช่อง
name

string

ต้องระบุ รูปแบบ: property/{property_id}/firebaseLinks/{firebase_link_id} ตัวอย่าง: property/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

ข้อความคำขอสำหรับ DeleteGoogleAdsLink RPC

ช่อง
name

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234/googleAdsLinks/5678

DeleteKeyEventRequest

ข้อความคำขอสำหรับ DeleteKeyEvent RPC

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเหตุการณ์สำคัญที่จะลบ รูปแบบ: พร็อพเพอร์ตี้/{property}/keyEvents/{key_event} เช่น: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

ข้อความคำขอสำหรับ DeleteMeasurementProtocolSecret RPC

ช่อง
name

string

ต้องระบุ ชื่อของ MeasurementProtocolSecret ที่จะลบ รูปแบบ: property/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

ข้อความคำขอสำหรับ DeleteProperty RPC

ช่อง
name

string

ต้องระบุ ชื่อพร็อพเพอร์ตี้ที่จะลบชั่วคราว รูปแบบ: พร็อพเพอร์ตี้/{property_id} เช่น "พร็อพเพอร์ตี้/1000"

GetAccountRequest

ข้อความคำขอสำหรับ GetAccount RPC

ช่อง
name

string

ต้องระบุ ชื่อบัญชีที่จะค้นหา รูปแบบ: accounts/{account} ตัวอย่างเช่น "accounts/100"

GetConversionEventRequest

ข้อความคำขอสำหรับ GetConversionEvent RPC

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเหตุการณ์ Conversion ที่จะดึงข้อมูล รูปแบบ: พร็อพเพอร์ตี้/{property}/conversionEvents/{conversion_event} เช่น: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

ข้อความคำขอสำหรับ GetCustomDimension RPC

ช่อง
name

string

ต้องระบุ ชื่อของ CustomDimension ที่จะรับ รูปแบบตัวอย่าง: property/1234/customdimension/5678

GetCustomMetricRequest

ข้อความคำขอสำหรับ GetCustomMetric RPC

ช่อง
name

string

ต้องระบุ ชื่อของ CustomMetric ที่จะรับ รูปแบบตัวอย่าง: property/1234/customMetrics/5678

GetDataRetentionSettingsRequest

ข้อความคำขอสำหรับ RPC ของ GetDatareservationSettings

ช่อง
name

string

ต้องระบุ ชื่อของการตั้งค่าที่จะค้นหา รูปแบบ: พร็อพเพอร์ตี้/{property}/dataStorageSettings เช่น "พร็อพเพอร์ตี้/1000/datareservationSettings"

GetDataSharingSettingsRequest

ข้อความคำขอสำหรับ GetDataSharingSettings RPC

ช่อง
name

string

ต้องระบุ ชื่อของการตั้งค่าที่จะค้นหา รูปแบบ: accounts/{account}/dataSharingSettings ตัวอย่างเช่น "accounts/1000/dataSharingSettings"

GetDataStreamRequest

ข้อความคำขอสำหรับ GetDataStream RPC

ช่อง
name

string

ต้องระบุ ชื่อของ DataStream ที่จะรับ รูปแบบตัวอย่าง: property/1234/dataStreams/5678

GetKeyEventRequest

ข้อความคำขอสำหรับ GetKeyEvent RPC

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเหตุการณ์สำคัญที่จะเรียกข้อมูล รูปแบบ: พร็อพเพอร์ตี้/{property}/keyEvents/{key_event} เช่น: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

ข้อความคำขอสำหรับ GetMeasurementProtocolSecret RPC

ช่อง
name

string

ต้องระบุ ชื่อของข้อมูลลับของ Measurement Protocol ที่จะค้นหา รูปแบบ: property/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

ข้อความคำขอสำหรับ RPC ของ GetProperty

ช่อง
name

string

ต้องระบุ ชื่อของที่พักที่จะค้นหา รูปแบบ: พร็อพเพอร์ตี้/{property_id} เช่น "พร็อพเพอร์ตี้/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 Shopping

KeyEvent

เหตุการณ์สําคัญในพร็อพเพอร์ตี้ Google Analytics

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของเหตุการณ์สำคัญนี้ รูปแบบ: property/{property}/keyEvents/{key_event}

event_name

string

เปลี่ยนแปลงไม่ได้ ชื่อเหตุการณ์สําหรับเหตุการณ์สําคัญนี้ ตัวอย่างเช่น "คลิก" "การซื้อ"

create_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างเหตุการณ์สําคัญนี้ในพร็อพเพอร์ตี้

deletable

bool

เอาต์พุตเท่านั้น หากตั้งค่าเป็น "จริง" คุณจะลบกิจกรรมนี้ได้

custom

bool

เอาต์พุตเท่านั้น หากตั้งค่าเป็น "จริง" เหตุการณ์สําคัญนี้จะหมายถึงเหตุการณ์ที่กําหนดเอง หากตั้งค่าเป็น "เท็จ" เหตุการณ์สำคัญนี้หมายถึงเหตุการณ์เริ่มต้นใน GA โดยทั่วไปเหตุการณ์เริ่มต้นจะมีความหมายพิเศษใน GA โดยปกติแล้วระบบ GA จะสร้างเหตุการณ์เริ่มต้นให้คุณ แต่ในบางกรณีอาจสร้างได้โดยผู้ดูแลระบบพร็อพเพอร์ตี้ เหตุการณ์ที่กําหนดเองจะนับรวมในจํานวนเหตุการณ์สําคัญที่กําหนดเองสูงสุดซึ่งอาจสร้างได้ต่อพร็อพเพอร์ตี้

counting_method

CountingMethod

ต้องระบุ วิธีการนับเหตุการณ์สำคัญในหลายเหตุการณ์ภายในเซสชัน

default_value

DefaultValue

ไม่บังคับ กําหนดค่า/สกุลเงินเริ่มต้นสำหรับเหตุการณ์สําคัญ

CountingMethod

วิธีการนับเหตุการณ์สำคัญในหลายเหตุการณ์ภายในเซสชัน

Enum
COUNTING_METHOD_UNSPECIFIED ไม่ได้ระบุวิธีการนับ
ONCE_PER_EVENT แต่ละอินสแตนซ์ของกิจกรรมจะถือว่าเป็นเหตุการณ์สำคัญ
ONCE_PER_SESSION ระบบถือว่าอินสแตนซ์เหตุการณ์เป็นเหตุการณ์สําคัญมากที่สุด 1 ครั้งต่อเซสชันต่อผู้ใช้

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

ข้อความตอบกลับสำหรับ ListAccountSummaries RPC

ช่อง
account_summaries[]

AccountSummary

สรุปบัญชีของบัญชีทั้งหมดที่ผู้โทรมีสิทธิ์เข้าถึง

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

ข้อความตอบกลับสำหรับ ListConversionEvents RPC

ช่อง
conversion_events[]

ConversionEvent

เหตุการณ์ Conversion ที่ขอ

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListCustomDimensionsRequest

ข้อความคำขอสำหรับ ListCustomDimension RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListCustomDimensions ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListCustomDimensions ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListCustomDimensionsResponse

ข้อความตอบกลับสำหรับ ListCustomDimension RPC

ช่อง
custom_dimensions[]

CustomDimension

รายการมิติข้อมูลที่กำหนดเอง

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListCustomMetricsRequest

ข้อความคำขอสำหรับ RPC ของ ListCustomMetrics

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/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

ต้องระบุ รูปแบบตัวอย่าง: property/1234

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListDataStreams ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListDataStreams ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListDataStreamsResponse

ข้อความตอบกลับสำหรับ ListDataStreams RPC

ช่อง
data_streams[]

DataStream

รายการ DataStream

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListFirebaseLinksRequest

ข้อความคำขอสำหรับ RPC ของ ListFirebaseLinks

ช่อง
parent

string

ต้องระบุ รูปแบบ: พร็อพเพอร์ตี้/{property_id} ตัวอย่าง: พร็อพเพอร์ตี้/1234

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้แม้ว่าจะมีหน้าเพิ่มเติมก็ตาม หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListFirebaseLinks ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListFirebaseLinks ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListFirebaseLinksResponse

ข้อความตอบกลับสำหรับ ListFirebaseLinks RPC

ช่อง
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป ปัจจุบัน Google Analytics รองรับ FirebaseLink เพียง 1 รายการต่อพร็อพเพอร์ตี้เท่านั้น ดังนั้นจะไม่มีการป้อนข้อมูล

ListGoogleAdsLinksRequest

ข้อความคำขอสำหรับ ListGoogleAdsLinks RPC

ช่อง
parent

string

ต้องระบุ รูปแบบตัวอย่าง: property/1234

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListGoogleAdsLinks ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListGoogleAdsLinks ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListGoogleAdsLinksResponse

ข้อความตอบกลับสำหรับ ListGoogleAdsLinks RPC

ช่อง
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListKeyEventsRequest

ข้อความคำขอสำหรับ ListKeyEvents RPC

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพร็อพเพอร์ตี้หลัก ตัวอย่าง: "properties/123"

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListKeyEvents ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListKeyEvents ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListKeyEventsResponse

ข้อความตอบกลับสำหรับ ListKeyEvents RPC

ช่อง
key_events[]

KeyEvent

เหตุการณ์สําคัญที่ขอ

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListMeasurementProtocolSecretsRequest

ข้อความคำขอสำหรับ ListMeasurementProtocolSecret RPC

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของสตรีมหลัก รูปแบบ: property/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 10 รายการ ค่าสูงสุดคือ 10 ระบบจะเปลี่ยนค่าที่สูงกว่าให้เป็นค่าสูงสุด

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListMeasurementProtocolSecrets ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListMeasurementProtocolSecrets ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

ListMeasurementProtocolSecretsResponse

ข้อความตอบกลับสำหรับ ListMeasurementProtocolSecret RPC

ช่อง
measurement_protocol_secrets[]

MeasurementProtocolSecret

รายการข้อมูลลับสำหรับสตรีมหลักที่ระบุไว้ในคำขอ

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

ListPropertiesRequest

ข้อความคำขอสำหรับ ListProperties RPC

ช่อง
filter

string

ต้องระบุ นิพจน์สำหรับกรองผลลัพธ์ของคำขอ ช่องที่มีสิทธิ์กรอง ได้แก่ parent:(ชื่อทรัพยากรของบัญชี/พร็อพเพอร์ตี้หลัก) หรือ ancestor:(ชื่อทรัพยากรของบัญชีหลัก) หรือ firebase_project:(รหัสหรือหมายเลขของโปรเจ็กต์ Firebase ที่ลิงก์) ตัวอย่างตัวกรอง

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

int32

จำนวนทรัพยากรสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้แม้ว่าจะมีหน้าเพิ่มเติมก็ตาม หากไม่ระบุ ระบบจะแสดงผลทรัพยากรสูงสุด 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

page_token

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListProperties ครั้งก่อน ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้ ListProperties ต้องตรงกับการเรียกที่ระบุโทเค็นของหน้า

show_deleted

bool

จะรวมพร็อพเพอร์ตี้ที่ลบชั่วคราว (เช่น "ถังขยะ") ในผลลัพธ์หรือไม่ คุณตรวจสอบพร็อพเพอร์ตี้ได้เพื่อดูว่าจะลบพร็อพเพอร์ตี้นั้นหรือไม่

ListPropertiesResponse

ข้อความตอบกลับสำหรับ ListProperties RPC

ช่อง
properties[]

Property

ผลลัพธ์ที่ตรงกับเกณฑ์ตัวกรองและผู้โทรเข้าถึงได้

next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกดูหน้าถัดไปได้ หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป

MeasurementProtocolSecret

ค่าข้อมูลลับที่ใช้สำหรับส่ง Hit ไปยัง Measurement Protocol

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของข้อมูลลับนี้ ข้อมูลลับนี้อาจเป็นลูกของสตรีมทุกประเภท รูปแบบ: property/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

ต้องระบุ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับข้อมูลลับนี้

secret_value

string

เอาต์พุตเท่านั้น ค่าข้อมูลลับของ Measurement Protocol ส่งต่อค่านี้ลงในช่อง api_secret ของ Measurement Protocol API เมื่อส่ง Hit ไปยังพร็อพเพอร์ตี้หลักของข้อมูลลับนี้

NumericValue

เพื่อแสดงตัวเลข

ช่อง
ฟิลด์สหภาพ one_value ค่าตัวเลข one_value ค่าใดค่าหนึ่งต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
int64_value

int64

ค่าจำนวนเต็ม

double_value

double

ค่า Double

พร็อพเพอร์ตี้

ข้อความแหล่งข้อมูลที่แสดงถึงพร็อพเพอร์ตี้ GA4 ของ Google Analytics

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของพร็อพเพอร์ตี้นี้ รูปแบบ: พร็อพเพอร์ตี้/{property_id} เช่น "พร็อพเพอร์ตี้/1000"

property_type

PropertyType

เปลี่ยนแปลงไม่ได้ ประเภทพร็อพเพอร์ตี้สำหรับทรัพยากรพร็อพเพอร์ตี้นี้ เมื่อสร้างพร็อพเพอร์ตี้ หากประเภทเป็น "PROPERTY_TYPE_UNSPECIFIED" ระบบจะบอกเป็นนัยถึง "ORDINARY_PROPERTY"

create_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างเอนทิตีครั้งแรก

update_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่อัปเดตช่องเพย์โหลดเอนทิตีครั้งล่าสุด

parent

string

เปลี่ยนแปลงไม่ได้ ชื่อทรัพยากรของระดับบนเชิงตรรกะของพร็อพเพอร์ตี้นี้

หมายเหตุ: คุณสามารถใช้ UI การย้ายพร็อพเพอร์ตี้เพื่อเปลี่ยนระดับบนได้ รูปแบบ: accounts/{account}, พร็อพเพอร์ตี้/{property} เช่น "accounts/100", "properties/101"

display_name

string

ต้องระบุ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับพร็อพเพอร์ตี้นี้

ความยาวชื่อที่แสดงสูงสุดที่อนุญาตคือหน่วยโค้ด UTF-16 จำนวน 100 หน่วย

industry_category

IndustryCategory

อุตสาหกรรมที่เกี่ยวข้องกับพร็อพเพอร์ตี้นี้ เช่น AUTOMOTIVE, FOOD_AND_DRINK

time_zone

string

ต้องระบุ เขตเวลาในการรายงาน ซึ่งใช้กำหนดขอบเขตวันสำหรับรายงานโดยไม่คำนึงถึงแหล่งที่มาของข้อมูล หากเขตเวลาเป็นไปตาม DST ระบบของ 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

ทรัพยากรเสมือนที่แสดงข้อมูลเมตาสำหรับพร็อพเพอร์ตี้ GA4

ช่อง
property

string

ชื่อทรัพยากรของพร็อพเพอร์ตี้ที่สรุปพร็อพเพอร์ตี้นี้ รูปแบบ: พร็อพเพอร์ตี้/{property_id} เช่น "พร็อพเพอร์ตี้/1000"

display_name

string

ชื่อที่แสดงของพร็อพเพอร์ตี้ที่อ้างถึงในข้อมูลสรุปของพร็อพเพอร์ตี้นี้

property_type

PropertyType

ประเภทพร็อพเพอร์ตี้ของพร็อพเพอร์ตี้

parent

string

ชื่อทรัพยากรของระดับบนเชิงตรรกะของพร็อพเพอร์ตี้นี้

หมายเหตุ: คุณสามารถใช้ UI การย้ายพร็อพเพอร์ตี้เพื่อเปลี่ยนระดับบนได้ รูปแบบ: accounts/{account}, property/{property} เช่น "accounts/100", "properties/200"

PropertyType

ประเภททรัพยากรพร็อพเพอร์ตี้

Enum
PROPERTY_TYPE_UNSPECIFIED ประเภทพร็อพเพอร์ตี้ที่ไม่รู้จักหรือไม่ได้ระบุ
PROPERTY_TYPE_ORDINARY พร็อพเพอร์ตี้ GA4 ทั่วไป
PROPERTY_TYPE_SUBPROPERTY พร็อพเพอร์ตี้ย่อย GA4
PROPERTY_TYPE_ROLLUP พร็อพเพอร์ตี้ภาพรวม GA4

ProvisionAccountTicketRequest

ข้อความคำขอสำหรับ ProvisionAccountTicket RPC

ช่อง
account

Account

บัญชีที่จะสร้าง

redirect_uri

string

เปลี่ยนเส้นทาง URI ที่จะส่งผู้ใช้ไปหลังจากยอมรับข้อกำหนดในการให้บริการ ต้องกำหนดค่าใน Cloud Console เป็น URI การเปลี่ยนเส้นทาง

ProvisionAccountTicketResponse

ข้อความตอบกลับสำหรับ ProvisionAccountTicket RPC

ช่อง
account_ticket_id

string

พารามิเตอร์ที่จะส่งในลิงก์ข้อกำหนดในการให้บริการ

RunAccessReportRequest

คำขอรายงานบันทึกการเข้าถึงข้อมูล

ช่อง
entity

string

รายงานการเข้าถึงข้อมูลจะรองรับการขอที่ระดับพร็อพเพอร์ตี้หรือระดับบัญชี รายงานการเข้าถึงข้อมูลจะรวมการเข้าถึงทั้งหมดสำหรับพร็อพเพอร์ตี้ทั้งหมดในบัญชีนั้นหากมีการขอที่ระดับบัญชี

หากต้องการขอที่ระดับพร็อพเพอร์ตี้ เอนทิตีควรเป็น "พร็อพเพอร์ตี้/123" หาก "123" คือรหัสพร็อพเพอร์ตี้ GA4 หากต้องการส่งคำขอที่ระดับบัญชี เอนทิตีควรเป็น "accounts/1234" หาก "1234" เป็นรหัสบัญชี GA4 ของคุณ

dimensions[]

AccessDimension

มิติข้อมูลที่ขอและแสดงในคำตอบ อนุญาตให้มีมิติข้อมูลได้สูงสุด 9 รายการ

metrics[]

AccessMetric

เมตริกที่ขอและแสดงในคำตอบ อนุญาตให้มีเมตริกไม่เกิน 10 รายการ

date_ranges[]

AccessDateRange

ช่วงวันที่ของระเบียนการเข้าถึงที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่อิงกับ 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน บันทึกการเข้าถึงของวันที่ทับซ้อนกันจะรวมอยู่ในแถวคำตอบของทั้ง 2 ช่วงวันที่ อนุญาตให้มีช่วงวันที่ได้ไม่เกิน 2 ช่วง

dimension_filter

AccessFilterExpression

ตัวกรองมิติข้อมูลช่วยให้คุณจำกัดการตอบกลับของรายงานให้แสดงเฉพาะค่ามิติข้อมูลที่เฉพาะเจาะจงซึ่งตรงกับตัวกรองได้ เช่น การกรองบันทึกการเข้าถึงของผู้ใช้รายเดียว หากต้องการเรียนรู้เพิ่มเติม โปรดดูพื้นฐานของตัวกรองมิติข้อมูลเพื่อดูตัวอย่าง เมตริกใช้ในตัวกรองนี้ไม่ได้

metric_filter

AccessFilterExpression

ตัวกรองเมตริกช่วยให้คุณจำกัดการตอบกลับของรายงานให้แสดงเฉพาะค่าเมตริกที่ตรงกับตัวกรองเท่านั้นได้ จะมีการใช้ตัวกรองเมตริกหลังจากรวมแถวของรายงานแล้ว ซึ่งคล้ายกับวลีที่มีเงื่อนไขของ SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้

offset

int64

จำนวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0 หากไม่ได้ระบุออฟเซ็ต ระบบจะถือว่าเป็น 0 หากออฟเซ็ตเป็น 0 เมธอดนี้จะแสดงหน้าแรกของผลลัพธ์ที่มี limit รายการ

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า

limit

int64

จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม limit ต้องเป็นค่าบวก

API อาจแสดงผลแถวน้อยกว่า limit ที่ขอ หากไม่มีแถวเหลืออยู่มากเท่ากับ limit ตัวอย่างเช่น มิติข้อมูล country มีค่าที่เป็นไปได้น้อยกว่า 300 ค่า ดังนั้นเมื่อรายงานเฉพาะ 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 ช่องนี้ต้องเป็นเท็จสำหรับคำขอระดับบัญชี

include_all_users

bool

ไม่บังคับ กำหนดว่าจะรวมผู้ใช้ที่ไม่เคยเรียก API ไว้ในการตอบกลับหรือไม่ หากเป็น "จริง" ผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุจะรวมอยู่ในการตอบกลับ ไม่ว่าผู้ใช้จะเรียกใช้ API หรือไม่ก็ตาม หากเป็นเท็จ ระบบจะรวมเฉพาะผู้ใช้ที่ทำการเรียก API เท่านั้น

expand_groups

bool

ไม่บังคับ เลือกว่าจะส่งคืนผู้ใช้ภายในกลุ่มผู้ใช้หรือไม่ ช่องนี้จะใช้ได้เฉพาะเมื่อตั้งค่า include_all_users เป็น "จริง" เท่านั้น หากเป็น "จริง" ระบบจะแสดงผลผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุ หากเป็นเท็จ ระบบจะแสดงผลเฉพาะผู้ใช้ที่มีสิทธิ์เข้าถึงโดยตรงเท่านั้น

RunAccessReportResponse

การตอบสนองของรายงานที่กำหนดเองสำหรับรายงานการเข้าถึงข้อมูล

ช่อง
dimension_headers[]

AccessDimensionHeader

ส่วนหัวของคอลัมน์ในรายงานที่สอดคล้องกับมิติข้อมูลที่เฉพาะเจาะจง จำนวน DimensionHeaders และการจัดลำดับของ DimensionHeaders ตรงกับมิติข้อมูลที่แสดงในแถว

metric_headers[]

AccessMetricHeader

ส่วนหัวของคอลัมน์ในรายงานที่สอดคล้องกับเมตริกที่เฉพาะเจาะจง จำนวน MetricHeaders และการจัดลำดับของ MetricHeaders ตรงกับเมตริกที่แสดงในแถว

rows[]

AccessRow

แถวของชุดค่าผสมมิติข้อมูลและค่าเมตริกในรายงาน

row_count

int32

จำนวนแถวทั้งหมดในผลลัพธ์การค้นหา rowCount ไม่ขึ้นอยู่กับจำนวนแถวที่แสดงผลในคำตอบ พารามิเตอร์คำขอ limit และพารามิเตอร์คำขอ offset ตัวอย่างเช่น หากการค้นหาแสดงผล 175 แถวและมี limit เป็น 50 แถวในคำขอ API คำตอบจะมี rowCount จาก 175 แถว แต่มีเพียง 50 แถว

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า

quota

AccessQuota

สถานะโควต้าสําหรับพร็อพเพอร์ตี้ Analytics นี้รวมถึงคําขอนี้ ช่องนี้ใช้ไม่ได้กับคำขอระดับบัญชี

SearchChangeHistoryEventsRequest

ข้อความคำขอสำหรับ SearchChangeHistoryEvents RPC

ช่อง
account

string

ต้องระบุ ทรัพยากรของบัญชีที่จะแสดงทรัพยากรประวัติการเปลี่ยนแปลง รูปแบบ: accounts/{account} ตัวอย่างเช่น "accounts/100"

property

string

ไม่บังคับ ชื่อทรัพยากรของพร็อพเพอร์ตี้ย่อย หากตั้งค่าไว้ จะแสดงการเปลี่ยนแปลงที่เกิดขึ้นกับพร็อพเพอร์ตี้นี้หรือทรัพยากรย่อยเท่านั้น รูปแบบ: พร็อพเพอร์ตี้/{propertyId} เช่น "พร็อพเพอร์ตี้/100"

resource_type[]

ChangeHistoryResourceType

ไม่บังคับ หากตั้งค่าไว้ ระบบจะส่งคืนค่าการเปลี่ยนแปลงก็ต่อเมื่อมีการเปลี่ยนแปลงสำหรับทรัพยากรที่ตรงกับประเภทเหล่านี้อย่างน้อย 1 ประเภท

action[]

ActionType

ไม่บังคับ หากตั้งค่าไว้ ระบบจะแสดงเฉพาะการเปลี่ยนแปลงที่ตรงกับประเภทการดำเนินการเหล่านี้อย่างน้อย 1 รายการ

actor_email[]

string

ไม่บังคับ หากตั้งค่าไว้ ระบบจะแสดงการเปลี่ยนแปลงเฉพาะในกรณีที่ดำเนินการโดยผู้ใช้ในรายการนี้

earliest_change_time

Timestamp

ไม่บังคับ หากตั้งค่าไว้ ระบบจะแสดงเฉพาะการเปลี่ยนแปลงที่เกิดขึ้นหลังจากเวลานี้เท่านั้น (รวม)

latest_change_time

Timestamp

ไม่บังคับ หากตั้งค่าไว้ ระบบจะแสดงผลเฉพาะการเปลี่ยนแปลงที่เกิดขึ้นก่อนเวลานี้เท่านั้น (รวม)

page_size

int32

ไม่บังคับ จำนวนสูงสุดของรายการ ChangeHistoryEvent ที่จะแสดงผล บริการอาจแสดงผลน้อยกว่าค่านี้แม้ว่าจะมีหน้าเพิ่มเติมก็ตาม หากไม่ระบุ ระบบจะส่งคืนสินค้าไม่เกิน 50 รายการ ค่าสูงสุดคือ 200 (ค่าที่สูงกว่าจะถูกเปลี่ยนเป็นค่าสูงสุด)

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

ข้อความคำขอสำหรับ UpdateAccount RPC

ช่อง
account

Account

ต้องระบุ บัญชีที่จะอัปเดต ฟิลด์ name ของบัญชีใช้เพื่อระบุบัญชี

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องอยู่ในตัวพิมพ์ใหญ่แบบ Snake (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateConversionEventRequest

ข้อความคำขอสำหรับ UpdateConversionEvent RPC

ช่อง
conversion_event

ConversionEvent

ต้องระบุ เหตุการณ์ Conversion ที่จะอัปเดต ฟิลด์ name ใช้เพื่อระบุการตั้งค่าที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องใส่ตัวพิมพ์เล็กหรือใหญ่ (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateCustomDimensionRequest

ข้อความคำขอสำหรับ UpdateCustomDimension RPC

ช่อง
custom_dimension

CustomDimension

CustomDimension ที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateCustomMetricRequest

ข้อความคำขอสำหรับ UpdateCustomMetric RPC

ช่อง
custom_metric

CustomMetric

CustomMetrics ที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateDataRetentionSettingsRequest

ข้อความคำขอสำหรับ UpdateDataPrivacySettings RPC

ช่อง
data_retention_settings

DataRetentionSettings

ต้องระบุ การตั้งค่าที่จะอัปเดต ฟิลด์ name ใช้เพื่อระบุการตั้งค่าที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องใส่ตัวพิมพ์เล็กหรือใหญ่ (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateDataStreamRequest

ข้อความคำขอสำหรับ UpdateDataStream RPC

ช่อง
data_stream

DataStream

DataStream ที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateGoogleAdsLinkRequest

ข้อความคำขอสำหรับ UpdateGoogleAdsLink RPC

ช่อง
update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องใส่ตัวพิมพ์เล็กหรือใหญ่ (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateKeyEventRequest

ข้อความคำขอสำหรับ UpdateKeyEvent RPC

ช่อง
key_event

KeyEvent

ต้องระบุ เหตุการณ์สําคัญที่ต้องอัปเดต ฟิลด์ name ใช้เพื่อระบุการตั้งค่าที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องใส่ตัวพิมพ์เล็กหรือใหญ่ (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง

UpdateMeasurementProtocolSecretRequest

ข้อความคำขอสำหรับ UpdateMeasurementProtocolSecret RPC

ช่อง
measurement_protocol_secret

MeasurementProtocolSecret

ต้องระบุ ข้อมูลลับของ Measurement Protocol ที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ระบบจะไม่อัปเดตช่องที่ละเว้น

UpdatePropertyRequest

ข้อความคำขอสำหรับ RPC ของ UpdateProperty

ช่อง
property

Property

ต้องระบุ พร็อพเพอร์ตี้ที่จะอัปเดต ช่อง name ของพร็อพเพอร์ตี้ใช้เพื่อระบุพร็อพเพอร์ตี้ที่จะอัปเดต

update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ชื่อช่องต้องใส่ตัวพิมพ์เล็กหรือใหญ่ (เช่น "field_to_update") ระบบจะไม่อัปเดตช่องที่ละเว้น หากต้องการแทนที่เอนทิตีทั้งหมด ให้ใช้เส้นทาง 1 เส้นทางที่มีสตริง "*" เพื่อจับคู่กับทุกช่อง