Package google.analytics.admin.v1beta

색인

AnalyticsAdminService

Google 애널리틱스 Admin API의 서비스 인터페이스입니다.

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

지정된 속성에 대한 사용자 데이터 수집 약관을 확인합니다.

MeasurementProtocolSecret 리소스를 만들려면 먼저 Google 애널리틱스 UI 또는 이 API를 통해 확인을 완료해야 합니다.

승인 범위

다음 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)

지원 중단됨: 대신 CreateKeyEvent를 사용하세요. 지정된 속성으로 전환 이벤트를 만듭니다.

승인 범위

다음 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)

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)

측정 프로토콜 보안 비밀을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

rpc CreateProperty(CreatePropertyRequest) returns (Property)

지정된 위치 및 속성으로 Google 애널리틱스 속성을 만듭니다.

승인 범위

다음 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)

지원 중단됨: 대신 DeleteKeyEvent를 사용하세요. 속성에서 전환 이벤트를 삭제합니다.

승인 범위

다음 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, 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)

단일 CustomDimension을 조회합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

단일 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)

단일 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)

호출자가 액세스할 수 있는 모든 계정의 요약을 반환합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

호출자가 액세스할 수 있는 모든 계정을 반환합니다.

이러한 계정에는 현재 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)

속성의 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)

지정된 상위 계정의 하위 속성을 반환합니다.

호출자가 액세스할 수 없는 경우 속성이 제외됩니다. 소프트 삭제된 (예: '휴지통에 넣은') 속성은 기본적으로 제외됩니다. 관련 속성이 없으면 빈 목록을 반환합니다.

승인 범위

다음 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 애널리틱스 보고 데이터를 읽을 때마다 기록을 제공합니다. 액세스 기록은 최대 2년 동안 보관됩니다.

속성에 대해 데이터 액세스 보고서를 요청할 수 있습니다. 보고서는 모든 속성에 대해 요청할 수 있지만 할당량과 관련 없는 측정기준은 Google 애널리틱스 360 속성에서만 요청할 수 있습니다. 이 방법은 관리자만 사용할 수 있습니다.

이러한 데이터 액세스 기록에는 GA UI 보고, GA UI 탐색 분석, GA 데이터 API, 연결을 통해 Google 애널리틱스에서 데이터를 가져올 수 있는 Firebase 및 Admob과 같은 기타 제품이 포함됩니다. 이러한 레코드에는 스트림 추가 또는 속성의 시간대 변경과 같은 속성 구성 변경사항은 포함되지 않습니다. 구성 변경 기록은 searchChangeHistoryEvents를 참고하세요.

이 API에 관한 의견을 보내려면 Google 애널리틱스 액세스 보고서 의견 양식을 작성하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

지정된 필터 집합을 기준으로 계정 또는 하위 계정의 모든 변경사항을 검색합니다.

API에서 지원하는 변경사항의 하위 집합만 반환합니다. UI에 추가 변경사항이 반환될 수 있습니다.

승인 범위

다음 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)

속성의 CustomMetric을 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

이 속성의 싱글톤 데이터 보관 설정을 업데이트합니다.

승인 범위

다음 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)

측정 프로토콜 비밀을 업데이트합니다.

승인 범위

다음 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에서 지원되는 측정기준 목록은 데이터 액세스 스키마를 참고하세요.

측정기준은 dimensionFilterorderBys에서 이름으로 참조됩니다.

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

and_group의 각 FilterExpression에는 AND 관계가 있습니다.

or_group

AccessFilterExpressionList

or_group의 각 FilterExpression은 OR 관계를 갖습니다.

not_expression

AccessFilterExpression

FilterExpression이 not_expression이 아닙니다.

access_filter

AccessFilter

원시 필터 동일한 FilterExpression에서 필터의 모든 필드 이름은 모든 측정기준이거나 모든 측정항목이어야 합니다.

AccessFilterExpressionList

필터 표현식 목록입니다.

필드
expressions[]

AccessFilterExpression

필터 표현식 목록입니다.

AccessInListFilter

결과는 문자열 값 목록에 있어야 합니다.

필드
values[]

string

문자열 값 목록입니다. 비어 있지 않아야 합니다.

case_sensitive

bool

true이면 문자열 값이 대소문자를 구분합니다.

AccessMetric

보고서의 정량적 측정값입니다. 예를 들어 accessCount 측정항목은 총 데이터 액세스 레코드 수입니다.

필드
metric_name

string

측정항목의 API 이름입니다. 이 API에서 지원되는 측정항목 목록은 데이터 액세스 스키마를 참고하세요.

측정항목은 metricFilterorderBys에서 이름으로 참조됩니다.

AccessMetricHeader

보고서의 측정항목 열을 설명합니다. 보고서에서 요청된 표시 측정항목은 행 및 MetricHeaders 내에 열 항목을 생성합니다. 그러나 필터 또는 표현식 내에서만 사용되는 측정항목은 보고서에 열을 생성하지 않으며, 이에 따라 이러한 측정항목은 헤더를 생성하지 않습니다.

필드
metric_name

string

측정항목의 이름입니다(예: 'accessCount').

AccessMetricValue

측정항목의 값입니다.

필드
value

string

측정 값입니다. 예를 들어 이 값은 '13'일 수 있습니다.

AccessNumericFilter

숫자 또는 날짜 값을 필터링합니다.

필드
operation

Operation

이 필터의 작업 유형입니다.

value

NumericValue

숫자 값 또는 날짜 값입니다.

작업

숫자 필터에 적용된 연산입니다.

열거형
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

문자열 측정기준 값을 정렬하는 규칙입니다.

열거형
ORDER_TYPE_UNSPECIFIED 지정되지 않음.
ALPHANUMERIC 유니코드 코드 포인트별 영숫자 정렬 예를 들어 '2' < 'A' < 'X' < 'b' < 'z'입니다.
CASE_INSENSITIVE_ALPHANUMERIC 소문자 유니코드 코드 포인트 기준으로 대소문자를 구분하지 않는 영숫자 정렬 예를 들어 '2' < 'A' < 'b' < 'X' < 'z'입니다.
NUMERIC 측정기준 값은 정렬하기 전에 숫자로 변환됩니다. 예를 들어 숫자 정렬에서는 '25' < '100'이고 ALPHANUMERIC 정렬에서는 '100' < '25'입니다. 숫자가 아닌 측정기준 값은 모두 숫자 값 아래에서 동일한 순서 값을 갖습니다.

MetricOrderBy

측정항목 값을 기준으로 정렬합니다.

필드
metric_name

string

정렬할 요청의 측정항목 이름입니다.

AccessQuota

이 애널리틱스 속성에 대한 모든 할당량의 현재 상태입니다. 속성의 할당량이 소진되면 해당 속성에 대한 모든 요청에서 리소스 소진 오류가 반환됩니다.

필드
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

속성 및 Cloud 프로젝트 쌍에는 시간당 최대 50개의 서버 오류가 발생할 수 있습니다.

tokens_per_project_per_hour

AccessQuotaStatus

속성은 시간당 프로젝트당 토큰의 최대 25% 를 사용할 수 있습니다. 즉, 애널리틱스 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

문자열 필터의 일치 유형입니다.

열거형
MATCH_TYPE_UNSPECIFIED 미지정
EXACT 문자열 값이 정확하게 일치합니다.
BEGINS_WITH 문자열 값으로 시작합니다.
ENDS_WITH 문자열 값으로 끝납니다.
CONTAINS 문자열 값을 포함합니다.
FULL_REGEXP 정규 표현식과 문자열 값의 전체 일치입니다.
PARTIAL_REGEXP 정규 표현식과 문자열 값의 부분 일치입니다.

계정

Google 애널리틱스 계정을 나타내는 리소스 메시지입니다.

필드
name

string

출력 전용입니다. 계정의 리소스 이름입니다. 형식: accounts/{account} 예: 'accounts/100'

create_time

Timestamp

출력 전용입니다. 이 계정이 처음 생성된 시간입니다.

update_time

Timestamp

출력 전용입니다. 계정 페이로드 필드가 마지막으로 업데이트된 시간입니다.

display_name

string

필수 항목입니다. 이 계정의 사람이 읽을 수 있는 표시 이름입니다.

region_code

string

비즈니스 소재 국가입니다. 유니코드 CLDR 지역 코드여야 합니다.

deleted

bool

출력 전용입니다. 이 계정이 조용히 삭제되었는지 여부를 나타냅니다. 삭제된 계정은 특별히 요청하지 않는 한 목록 결과에서 제외됩니다.

gmp_organization

string

출력 전용입니다. Google Marketing Platform 조직 리소스의 URI입니다. 이 계정이 GMP 조직에 연결된 경우에만 설정됩니다. 형식: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

계정 및 모든 하위 Google 애널리틱스 속성의 개요를 나타내는 가상 리소스입니다.

필드
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 애널리틱스에서 내 사이트 및 앱 속성으로부터 수집하는 방문 정보를 최종 사용자의 데이터와 연결하는 것을 포함하여 이러한 데이터의 수집과 처리를 위한 권한을 최종 사용자로부터 확보했음을 확인합니다.'라는 정확한 값이 포함되어야 합니다.

AcknowledgeUserDataCollectionResponse

이 유형에는 필드가 없습니다.

AcknowledgeUserDataCollection RPC의 응답 메시지입니다.

ActionType

리소스를 변경할 수 있는 작업 유형입니다.

열거형
ACTION_TYPE_UNSPECIFIED 작업 유형을 알 수 없거나 지정되지 않았습니다.
CREATED 이 변경사항에서 리소스가 생성되었습니다.
UPDATED 이번 변경사항에서 리소스가 업데이트되었습니다.
DELETED 이 변경사항에서 리소스가 삭제되었습니다.

ActorType

Google 애널리틱스 리소스를 변경할 수 있는 다양한 행위자

열거형
ACTOR_TYPE_UNSPECIFIED 알 수 없거나 지정되지 않은 행위자 유형입니다.
USER actor_email에 지정된 사용자가 변경한 사항입니다.
SYSTEM Google 애널리틱스 시스템에서 변경한 사항입니다.
SUPPORT Google 애널리틱스 지원팀 직원이 변경한 사항입니다.

ArchiveCustomDimensionRequest

ArchiveCustomDimension RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 보관처리할 CustomDimension의 이름입니다. 예시 형식: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

ArchiveCustomMetric RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 보관할 CustomMetric의 이름입니다. 예시 형식: properties/1234/customMetrics/5678

ChangeHistoryChange

단일 Google 애널리틱스 리소스의 변경사항에 대한 설명입니다.

필드
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 애널리틱스 계정 또는 하위 속성 내에서 발생한 일련의 변경사항입니다. 일반적인 원인은 Google 애널리틱스 UI에서 이루어진 업데이트, 고객 지원팀에서 이루어진 변경사항, 자동 Google 애널리틱스 시스템 변경사항 등입니다.

필드
id

string

이 변경 기록 이벤트의 ID입니다. 이 ID는 Google 애널리틱스에서 고유합니다.

change_time

Timestamp

변경된 시간입니다.

actor_type

ActorType

이 변경사항을 적용한 행위자의 유형입니다.

user_actor_email

string

변경을 적용한 Google 계정의 이메일 주소입니다. 이메일 주소는 작업 수행자 필드가 USER로 설정된 경우 유효한 이메일 주소이고, 그렇지 않은 경우에는 비어 있습니다. 삭제된 Google 계정은 오류를 일으킵니다.

changes_filtered

bool

true인 경우 반환된 변경사항 목록이 필터링되었으며 이 이벤트에서 발생한 모든 변경사항을 나타내지 않습니다.

changes[]

ChangeHistoryChange

SearchChangeHistoryEventsRequest에 지정된 필터와 일치하는 이 변경 내역 이벤트에서 이루어진 변경사항 목록입니다.

ChangeHistoryResourceType

변경 내역에서 변경사항이 반환될 수 있는 리소스 유형입니다.

열거형
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 애널리틱스 속성의 전환 이벤트입니다.

필드
name

string

출력 전용입니다. 이 전환 이벤트의 리소스 이름입니다. 형식: properties/{property}/conversionEvents/{conversion_event}

event_name

string

변경할 수 없습니다. 이 전환 이벤트의 이벤트 이름입니다. 예: '클릭', '구매'

create_time

Timestamp

출력 전용입니다. 속성에서 이 전환 이벤트가 생성된 시간입니다.

deletable

bool

출력 전용입니다. 이 옵션을 설정하면 현재 DeleteConversionEvent를 사용하여 이 이벤트를 삭제할 수 있습니다.

custom

bool

출력 전용입니다. true로 설정하면 이 전환 이벤트가 맞춤 이벤트를 참조합니다. false로 설정하면 이 전환 이벤트는 GA의 기본 이벤트를 참조합니다. 기본 이벤트는 일반적으로 GA에서 특별한 의미를 갖습니다. 기본 이벤트는 일반적으로 GA 시스템에서 자동으로 생성되지만 경우에 따라 속성 관리자가 만들 수도 있습니다. 맞춤 이벤트는 속성당 만들 수 있는 최대 맞춤 전환 이벤트 수에 포함됩니다.

counting_method

ConversionCountingMethod

선택사항입니다. 세션 내 여러 이벤트에서 전환을 집계하는 방법입니다. 이 값을 제공하지 않으면 ONCE_PER_EVENT로 설정됩니다.

default_conversion_value

DefaultConversionValue

선택사항입니다. 전환 이벤트의 기본값/통화를 정의합니다.

ConversionCountingMethod

세션 내 여러 이벤트에서 전환을 집계하는 방법입니다.

열거형
CONVERSION_COUNTING_METHOD_UNSPECIFIED 집계 방법이 지정되지 않았습니다.
ONCE_PER_EVENT 각 이벤트 인스턴스는 전환으로 간주됩니다.
ONCE_PER_SESSION 이벤트 인스턴스는 사용자당 세션당 최대 한 번 전환으로 간주됩니다.

DefaultConversionValue

전환 이벤트의 기본값/통화를 정의합니다. 값과 통화를 모두 제공해야 합니다.

필드
value

double

이 값은 이벤트 'value' 매개변수가 설정되지 않은 지정된 event_name의 모든 전환에 대한 값을 채우는 데 사용됩니다.

currency_code

string

이 event_name의 전환 이벤트에 설정된 통화가 없는 경우 이 통화가 기본값으로 적용됩니다. ISO 4217 통화 코드 형식이어야 합니다. 자세한 내용은 https://en.wikipedia.org/wiki/ISO_4217을 참고하세요.

CreateConversionEventRequest

CreateConversionEvent RPC의 요청 메시지

필드
conversion_event

ConversionEvent

필수 항목입니다. 만들려는 전환 이벤트입니다.

parent

string

필수 항목입니다. 이 전환 이벤트가 생성될 상위 속성의 리소스 이름입니다. 형식: properties/123

CreateCustomDimensionRequest

CreateCustomDimension RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

custom_dimension

CustomDimension

필수 항목입니다. 생성할 CustomDimension입니다.

CreateCustomMetricRequest

CreateCustomMetric RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

custom_metric

CustomMetric

필수 항목입니다. 만들려는 CustomMetric입니다.

CreateDataStreamRequest

CreateDataStream RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

data_stream

DataStream

필수 항목입니다. 만들 DataStream입니다.

CreateFirebaseLinkRequest

CreateFirebaseLink RPC의 요청 메시지

필드
parent

string

필수 항목입니다. 형식: properties/{property_id}

예: properties/1234

CreateGoogleAdsLinkRequest

CreateGoogleAdsLink RPC의 요청 메시지

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

CreateKeyEventRequest

CreateKeyEvent RPC의 요청 메시지

필드
key_event

KeyEvent

필수 항목입니다. 만들려는 주요 이벤트입니다.

parent

string

필수 항목입니다. 이 키 이벤트가 생성될 상위 속성의 리소스 이름입니다. 형식: properties/123

CreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecret RPC의 요청 메시지

필드
parent

string

필수 항목입니다. 이 비밀이 생성될 상위 리소스입니다. 형식: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

필수 항목입니다. 만들 측정 프로토콜 비밀입니다.

CreatePropertyRequest

CreateProperty RPC의 요청 메시지입니다.

필드
property

Property

필수 항목입니다. 만들 속성입니다. 참고: 제공된 속성은 상위를 지정해야 합니다.

CustomDimension

CustomDimension의 정의입니다.

필드
name

string

출력 전용입니다. 이 CustomDimension 리소스의 리소스 이름입니다. 형식: properties/{property}/customDimensions/{customDimension}

parameter_name

string

필수 항목입니다. 변경할 수 없습니다. 이 맞춤 측정기준의 태그 지정 매개변수 이름입니다.

사용자 범위 측정기준인 경우 사용자 속성 이름입니다. 이벤트 범위 측정기준인 경우 이벤트 매개변수 이름입니다.

상품 범위 측정기준인 경우 전자상거래 상품 배열에 있는 매개변수 이름입니다.

영숫자와 밑줄 문자만 포함할 수 있으며 문자로 시작해야 합니다. 사용자 범위 측정기준의 최대 길이는 24자(영문 기준), 이벤트 범위 측정기준의 최대 길이는 40자(영문 기준)입니다.

display_name

string

필수 항목입니다. 애널리틱스 UI에 표시되는 이 맞춤 측정기준의 표시 이름입니다. 최대 82자(영문 기준)이며 영숫자와 공백, 밑줄을 사용할 수 있으며 문자로 시작해야 합니다. 기존 시스템에서 생성된 표시 이름에는 대괄호가 포함될 수 있지만 이 필드를 업데이트해도 대괄호는 허용되지 않습니다.

description

string

선택사항입니다. 이 맞춤 측정기준에 대한 설명입니다. 최대 150자(영문 기준)

scope

DimensionScope

필수 항목입니다. 변경할 수 없습니다. 이 측정기준의 범위입니다.

disallow_ads_personalization

bool

선택사항입니다. 이 값을 true로 설정하면 이 측정기준이 NPA로 설정되고 광고 개인 최적화에서 제외됩니다.

현재는 사용자 범위 맞춤 측정기준에서만 지원됩니다.

DimensionScope

이 측정기준의 범위에 유효한 값입니다.

열거형
DIMENSION_SCOPE_UNSPECIFIED 범위를 알 수 없거나 지정하지 않았습니다.
EVENT 이벤트 범위의 측정기준입니다.
USER 사용자 범위의 측정기준입니다.
ITEM 전자상거래 상품 범위 측정기준

CustomMetric

맞춤 측정항목의 정의입니다.

필드
name

string

출력 전용입니다. 이 CustomMetric 리소스의 리소스 이름입니다. 형식: properties/{property}/customMetrics/{customMetric}

parameter_name

string

필수 항목입니다. 변경할 수 없습니다. 이 맞춤 측정항목의 태그 이름입니다.

이벤트 범위 측정항목인 경우 이벤트 매개변수 이름입니다.

영숫자와 밑줄 문자만 포함할 수 있으며 문자로 시작해야 합니다. 이벤트 범위 측정항목의 최대 길이는 40자(영문 기준)입니다.

display_name

string

필수 항목입니다. 애널리틱스 UI에 표시되는 이 맞춤 측정항목의 표시 이름입니다. 최대 82자(영문 기준)이며 영숫자와 공백, 밑줄을 사용할 수 있으며 문자로 시작해야 합니다. 기존 시스템에서 생성된 표시 이름에는 대괄호가 포함될 수 있지만 이 필드를 업데이트해도 대괄호는 허용되지 않습니다.

description

string

선택사항입니다. 이 맞춤 측정기준에 대한 설명입니다. 최대 150자(영문 기준)

measurement_unit

MeasurementUnit

필수 항목입니다. 맞춤 측정항목 값의 유형입니다.

scope

MetricScope

필수 항목입니다. 변경할 수 없습니다. 이 맞춤 측정항목의 범위입니다.

restricted_metric_type[]

RestrictedMetricType

선택사항입니다. 이 측정항목에 포함될 수 있는 제한된 데이터 유형입니다. CURRENCY 측정 단위가 있는 측정항목에 필요합니다. 통화가 아닌 측정 단위가 있는 측정항목의 경우 비워 두어야 합니다.

MeasurementUnit

커스텀 측정항목 값을 나타낼 수 있는 유형입니다.

통화 표현은 향후 변경될 수 있으며, 이 경우 API 변경이 필요합니다.

열거형
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit이 지정되지 않았거나 누락되었습니다.
STANDARD 이 측정항목은 기본 단위를 사용합니다.
CURRENCY 이 측정항목은 통화를 측정합니다.
FEET 이 측정항목은 피트를 측정합니다.
METERS 이 측정항목은 미터를 측정합니다.
KILOMETERS 이 측정항목은 킬로미터를 측정합니다.
MILES 이 측정항목은 마일을 측정합니다.
MILLISECONDS 이 측정항목은 밀리초를 측정합니다.
SECONDS 이 측정항목은 초 단위로 측정됩니다.
MINUTES 이 측정항목은 분 단위로 측정됩니다.
HOURS 이 측정항목은 시간을 측정합니다.

MetricScope

이 측정항목의 범위입니다.

열거형
METRIC_SCOPE_UNSPECIFIED 범위를 알 수 없거나 지정하지 않았습니다.
EVENT 이벤트 범위 측정항목

RestrictedMetricType

이 맞춤 측정항목의 데이터를 특정 사용자로 제한해야 하는 데이터로 표시하는 라벨입니다.

열거형
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이면 해당 사용자의 모든 이벤트와 함께 사용자 식별자의 보관 기간을 재설정합니다.

RetentionDuration

데이터 보관 기간의 유효한 값입니다.

열거형
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 애널리틱스 계정의 데이터 공유 설정을 나타내는 리소스 메시지입니다.

필드
name

string

출력 전용입니다. 리소스 이름입니다. 형식: accounts/{account}/dataSharingSettings 예: 'accounts/1000/dataSharingSettings'

sharing_with_google_support_enabled

bool

Google 기술 지원 담당자가 서비스를 제공하고 기술적 문제에 대한 해결책을 찾기 위해 필요한 경우 내 Google 애널리틱스 데이터 및 계정에 액세스할 수 있습니다.

이 필드는 Google 애널리틱스 관리 UI의 '기술 지원' 필드에 매핑됩니다.

sharing_with_google_assigned_sales_enabled

bool

Google에서 계정 사용 정보 및 구성 데이터, 제품 지출, Google 애널리틱스 계정과 연결된 사용자 등 Google 애널리틱스 계정 데이터에 액세스하도록 허용하면 Google에서 Google 제품을 최대한 활용할 수 있도록 지원하고 Google 애널리틱스와 기타 비즈니스용 Google 제품 전반에서 통계, 혜택, 추천, 최적화 도움말을 제공할 수 있습니다.

이 필드는 Google 애널리틱스 관리 UI의 '비즈니스 추천' 입력란에 매핑됩니다.

sharing_with_google_any_sales_enabled
(deprecated)

bool

지원 중단되었습니다. 이 필드는 더 이상 사용되지 않으며 항상 false를 반환합니다.

sharing_with_google_products_enabled

bool

Google에서 데이터를 사용하여 다른 Google 제품 또는 서비스를 개선하도록 허용합니다.

이 필드는 Google 애널리틱스 관리 UI의 'Google 제품 및 서비스' 필드에 매핑됩니다.

sharing_with_others_enabled

bool

집계된 측정 데이터를 포함하면 풍부한 비즈니스 통계를 제공할 수 있는 예측, 모델링된 데이터, 벤치마킹 등의 기능을 사용할 수 있습니다. 내가 공유하는 데이터 (데이터가 공유되는 속성에 대한 정보 포함)는 비즈니스 통계를 생성하는 데 사용되기 전에 집계되고 익명화됩니다.

이 필드는 Google 애널리틱스 관리 UI의 '참여 모델링 및 비즈니스 통계' 필드에 매핑됩니다.

DataStream

데이터 스트림을 나타내는 리소스 메시지입니다.

필드
name

string

출력 전용입니다. 이 데이터 스트림의 리소스 이름입니다. 형식: properties/{property_id}/dataStreams/{stream_id} 예: 'properties/1000/dataStreams/2000'

type

DataStreamType

필수 항목입니다. 변경할 수 없습니다. 이 DataStream 리소스의 유형입니다.

display_name

string

사람이 읽을 수 있는 데이터 스트림의 표시 이름입니다.

웹 데이터 스트림에 필요합니다.

허용되는 최대 표시 이름 길이는 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

출력 전용입니다. Firebase의 해당 Android 앱 ID(있는 경우) Android 앱을 삭제하고 다시 만들면 이 ID가 변경될 수 있습니다.

package_name

string

변경할 수 없습니다. 측정 중인 앱의 패키지 이름입니다. 예: 'com.example.myandroidapp'

DataStreamType

데이터 스트림의 유형입니다.

열거형
DATA_STREAM_TYPE_UNSPECIFIED 알 수 없는 유형이거나 지정되지 않았습니다.
WEB_DATA_STREAM 웹 데이터 스트림
ANDROID_APP_DATA_STREAM Android 앱 데이터 스트림
IOS_APP_DATA_STREAM iOS 앱 데이터 스트림

IosAppStreamData

iOS 앱 스트림에 관한 데이터입니다.

필드
firebase_app_id

string

출력 전용입니다. Firebase의 해당 iOS 앱 ID(있는 경우) iOS 앱을 삭제하고 다시 만들면 이 ID가 변경될 수 있습니다.

bundle_id

string

필수 항목입니다. 변경할 수 없습니다. 앱의 Apple App Store 번들 ID입니다(예: 'com.example.myiosapp').

WebStreamData

웹 스트림에 관한 데이터입니다.

필드
measurement_id

string

출력 전용입니다. 애널리틱스 측정 ID

예: 'G-1A2BCD345E'

firebase_app_id

string

출력 전용입니다. Firebase의 해당 웹 앱 ID입니다(있는 경우). 웹 앱을 삭제하고 다시 만들면 이 ID가 변경될 수 있습니다.

default_uri

string

측정 중인 웹 앱의 도메인 이름 또는 빈 문자열입니다. 예: 'http://www.google.com', 'https://www.google.com'

DeleteAccountRequest

DeleteAccount RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조용히 삭제할 계정의 이름입니다. 형식: accounts/{account} 예: 'accounts/100'

DeleteConversionEventRequest

DeleteConversionEvent RPC의 요청 메시지

필드
name

string

필수 항목입니다. 삭제할 전환 이벤트의 리소스 이름입니다. 형식: properties/{property}/conversionEvents/{conversion_event} 예: 'properties/123/conversionEvents/456'

DeleteDataStreamRequest

DeleteDataStream RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 삭제할 DataStream의 이름입니다. 예시 형식: properties/1234/dataStreams/5678

DeleteFirebaseLinkRequest

DeleteFirebaseLink RPC의 요청 메시지

필드
name

string

필수 항목입니다. 형식: properties/{property_id}/firebaseLinks/{firebase_link_id}

예: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

DeleteGoogleAdsLink RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 형식 예: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

DeleteKeyEvent RPC 요청 메시지

필드
name

string

필수 항목입니다. 삭제할 키 이벤트의 리소스 이름입니다. 형식: properties/{property}/keyEvents/{key_event} 예: 'properties/123/keyEvents/456'

DeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecret RPC의 요청 메시지

필드
name

string

필수 항목입니다. 삭제할 MeasurementProtocolSecret의 이름입니다. 형식: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

DeleteProperty RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조용히 삭제할 속성의 이름입니다. 형식: properties/{property_id} 예: 'properties/1000'

GetAccountRequest

GetAccount RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조회할 계정의 이름입니다. 형식: accounts/{account} 예: 'accounts/100'

GetConversionEventRequest

GetConversionEvent RPC의 요청 메시지

필드
name

string

필수 항목입니다. 검색할 전환 이벤트의 리소스 이름입니다. 형식: properties/{property}/conversionEvents/{conversion_event} 예: 'properties/123/conversionEvents/456'

GetCustomDimensionRequest

GetCustomDimension RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 CustomDimension의 이름입니다. 예시 형식: properties/1234/customDimensions/5678

GetCustomMetricRequest

GetCustomMetric RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 CustomMetric의 이름입니다. 예시 형식: properties/1234/customMetrics/5678

GetDataRetentionSettingsRequest

GetDataRetentionSettings RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조회할 설정의 이름입니다. 형식: properties/{property}/dataRetentionSettings 예: 'properties/1000/dataRetentionSettings'

GetDataSharingSettingsRequest

GetDataSharingSettings RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조회할 설정의 이름입니다. 형식: accounts/{account}/dataSharingSettings

예: accounts/1000/dataSharingSettings

GetDataStreamRequest

GetDataStream RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 DataStream의 이름입니다. 예시 형식: properties/1234/dataStreams/5678

GetKeyEventRequest

GetKeyEvent RPC의 요청 메시지

필드
name

string

필수 항목입니다. 검색할 키 이벤트의 리소스 이름입니다. 형식: properties/{property}/keyEvents/{key_event} 예: 'properties/123/keyEvents/456'

GetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecret RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조회할 측정 프로토콜 보안 비밀의 이름입니다. 형식: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

GetProperty RPC의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 조회할 속성의 이름입니다. 형식: properties/{property_id} 예: 'properties/1000'

IndustryCategory

이 속성에 대해 선택된 카테고리로, 업계 벤치마킹에 사용됩니다.

열거형
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 쇼핑

키 이벤트

Google 애널리틱스 속성의 주요 이벤트입니다.

필드
name

string

출력 전용입니다. 이 주요 이벤트의 리소스 이름입니다. 형식: properties/{property}/keyEvents/{key_event}

event_name

string

변경할 수 없습니다. 이 주요 이벤트의 이벤트 이름입니다. 예: '클릭', '구매'

create_time

Timestamp

출력 전용입니다. 속성에서 이 주요 이벤트가 생성된 시간입니다.

deletable

bool

출력 전용입니다. true로 설정하면 이 이벤트를 삭제할 수 있습니다.

custom

bool

출력 전용입니다. true로 설정하면 이 주요 이벤트는 맞춤 이벤트를 참조합니다. false로 설정하면 이 주요 이벤트는 GA의 기본 이벤트를 참조합니다. 기본 이벤트는 일반적으로 GA에서 특별한 의미를 갖습니다. 기본 이벤트는 일반적으로 GA 시스템에서 자동으로 생성되지만 경우에 따라 속성 관리자가 만들 수도 있습니다. 맞춤 이벤트는 속성당 만들 수 있는 최대 맞춤 주요 이벤트 수에 포함됩니다.

counting_method

CountingMethod

필수 항목입니다. 세션 내 여러 이벤트에서 주요 이벤트를 집계하는 방법입니다.

default_value

DefaultValue

선택사항입니다. 주요 이벤트의 기본값/통화를 정의합니다.

CountingMethod

세션 내 여러 이벤트에서 주요 이벤트를 집계하는 방법입니다.

열거형
COUNTING_METHOD_UNSPECIFIED 집계 방법이 지정되지 않았습니다.
ONCE_PER_EVENT 각 이벤트 인스턴스는 주요 이벤트로 간주됩니다.
ONCE_PER_SESSION 이벤트 인스턴스는 사용자당 세션당 최대 한 번 주요 이벤트로 간주됩니다.

DefaultValue

주요 이벤트의 기본값/통화를 정의합니다.

필드
numeric_value

double

필수 항목입니다. 이 값은 이 주요 이벤트 (event_name으로 지정됨)가 발생할 때마다 매개변수가 설정되지 않은 경우 'value' 매개변수를 채우는 데 사용됩니다.

currency_code

string

필수 항목입니다. 이 주요 이벤트 (event_name으로 지정됨)가 발생했을 때 설정된 통화가 없는 경우 이 통화가 기본값으로 적용됩니다. ISO 4217 통화 코드 형식이어야 합니다.

자세한 내용은 https://en.wikipedia.org/wiki/ISO_4217을 참고하세요.

ListAccountSummariesRequest

ListAccountSummaries RPC의 요청 메시지입니다.

필드
page_size

int32

반환할 AccountSummary 리소스의 최대 개수입니다. 페이지가 더 있더라도 서비스에서 이 값보다 적은 값을 반환할 수 있습니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListAccountSummaries 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, ListAccountSummaries에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.

ListAccountSummariesResponse

ListAccountSummaries RPC의 응답 메시지입니다.

필드
account_summaries[]

AccountSummary

호출자가 액세스할 수 있는 모든 계정의 계정 요약입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListAccountsRequest

ListAccounts RPC의 요청 메시지입니다.

필드
page_size

int32

반환할 최대 리소스 수입니다. 페이지가 더 있더라도 서비스에서 이 값보다 적은 값을 반환할 수 있습니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListAccounts 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, ListAccounts에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.

show_deleted

bool

결과에 소프트 삭제된 (예: '휴지통') 계정을 포함할지 여부입니다. 계정을 검사하여 삭제되었는지 확인할 수 있습니다.

ListAccountsResponse

ListAccounts RPC의 요청 메시지입니다.

필드
accounts[]

Account

호출자가 액세스할 수 있었던 결과입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListConversionEventsRequest

ListConversionEvents RPC의 요청 메시지

필드
parent

string

필수 항목입니다. 상위 속성의 리소스 이름입니다. 예: 'properties/123'

page_size

int32

반환할 최대 리소스 수입니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListConversionEvents 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, ListConversionEvents에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.

ListConversionEventsResponse

ListConversionEvents RPC의 응답 메시지입니다.

필드
conversion_events[]

ConversionEvent

요청된 전환 이벤트

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListCustomDimensionsRequest

ListCustomDimensions RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

page_size

int32

반환할 최대 리소스 수입니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListCustomDimensions 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 ListCustomDimensions에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

ListCustomDimensionsResponse

ListCustomDimensions RPC의 응답 메시지입니다.

필드
custom_dimensions[]

CustomDimension

CustomDimensions 목록입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListCustomMetricsRequest

ListCustomMetrics RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/1234

page_size

int32

반환할 최대 리소스 수입니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListCustomMetrics 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 ListCustomMetrics에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

ListCustomMetricsResponse

ListCustomMetrics RPC의 응답 메시지입니다.

필드
custom_metrics[]

CustomMetric

CustomMetrics 목록입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListDataStreamsRequest

ListDataStreams RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/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

ListFirebaseLinks RPC의 요청 메시지

필드
parent

string

필수 항목입니다. 형식: properties/{property_id}

예: properties/1234

page_size

int32

반환할 최대 리소스 수입니다. 페이지가 더 있더라도 서비스에서 이 값보다 적은 값을 반환할 수 있습니다. 지정하지 않으면 최대 50개의 리소스가 반환됩니다. 최대값은 200이며, 이보다 큰 값은 최대값으로 변환됩니다.

page_token

string

이전 ListFirebaseLinks 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, ListFirebaseLinks에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.

ListFirebaseLinksResponse

ListFirebaseLinks RPC의 응답 메시지

필드
next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다. 현재 Google 애널리틱스는 속성당 하나의 FirebaseLink만 지원하므로 이 필드는 채워지지 않습니다.

ListGoogleAdsLinksRequest

ListGoogleAdsLinks RPC의 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 예시 형식: properties/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

필수 항목입니다. 상위 스트림의 리소스 이름입니다. 형식: properties/{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 프로젝트의 ID 또는 번호)입니다. 필터의 예는 다음과 같습니다.

| 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

측정 프로토콜에 조회를 전송하는 데 사용되는 비밀 값입니다.

필드
name

string

출력 전용입니다. 이 보안 비밀의 리소스 이름입니다. 이 보안 비밀은 모든 유형의 스트림의 하위 요소가 될 수 있습니다. 형식: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

필수 항목입니다. 이 보안 비밀의 사람이 읽을 수 있는 표시 이름입니다.

secret_value

string

출력 전용입니다. 측정 프로토콜 비밀번호 값입니다. 이 비밀번호의 상위 속성에 조회를 전송할 때 이 값을 측정 프로토콜 API의 api_secret 필드에 전달합니다.

NumericValue

숫자를 나타냅니다.

필드
통합 필드 one_value. 숫자 값 one_value 중 하나는 다음 중 하나여야 합니다.
int64_value

int64

정수 값

double_value

double

이중 값

속성

Google 애널리틱스 속성을 나타내는 리소스 메시지입니다.

필드
name

string

출력 전용입니다. 이 속성의 리소스 이름입니다. 형식: properties/{property_id} 예: 'properties/1000'

property_type

PropertyType

변경할 수 없습니다. 이 숙박 시설 리소스의 숙박 시설 유형입니다. 속성을 만들 때 유형이 'PROPERTY_TYPE_UNSPECIFIED'이면 'ORDINARY_PROPERTY'가 암시됩니다.

create_time

Timestamp

출력 전용입니다. 항목이 처음 생성된 시간입니다.

update_time

Timestamp

출력 전용입니다. 항목 페이로드 필드가 마지막으로 업데이트된 시간입니다.

parent

string

변경할 수 없습니다. 이 속성의 논리적 상위 요소의 리소스 이름입니다.

참고: 속성 이동 UI를 사용하여 상위를 변경할 수 있습니다. 형식: accounts/{account}, properties/{property} 예: 'accounts/100', 'properties/101'

display_name

string

필수 항목입니다. 이 속성에 대해 사람이 읽을 수 있는 표시 이름입니다.

허용되는 최대 표시 이름 길이는 100자(UTF-16 코드 단위)입니다.

industry_category

IndustryCategory

이 숙박 시설과 연결된 업계입니다(예: AUTOMOTIVE, FOOD_AND_DRINK).

time_zone

string

필수 항목입니다. 보고 시간대: 데이터의 출처와 관계없이 보고서에서 날짜 구분을 위해 사용할 시간대입니다. 시간대가 일광 절약 시간제를 준수하는 경우 애널리틱스에서 이에 맞춰 시간을 자동으로 조정합니다.

참고: 시간대를 변경하면 이후부터 수집되는 데이터에만 영향을 미치며 이전 데이터에는 적용되지 않습니다.

형식: 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 애널리틱스 서비스 수준입니다.

delete_time

Timestamp

출력 전용입니다. 이 속성이 휴지통에 추가된 시간입니다(설정된 경우). 설정되지 않은 경우 이 속성이 현재 휴지통에 없습니다.

expire_time

Timestamp

출력 전용입니다. 이 속성이 휴지통에 추가된 후 완전히 삭제되는 시간을 설정합니다. 설정하지 않으면 이 속성이 현재 휴지통에 없으며 삭제될 예정이 아닙니다.

account

string

변경할 수 없습니다. 상위 계정의 리소스 이름 형식: accounts/{account_id} 예: 'accounts/123'

PropertySummary

Google 애널리틱스 속성의 메타데이터를 나타내는 가상 리소스입니다.

필드
property

string

이 속성 요약에서 참조하는 속성의 리소스 이름입니다. 형식: properties/{property_id} 예: 'properties/1000'

display_name

string

이 속성 요약에서 참조된 속성의 표시 이름입니다.

property_type

PropertyType

속성의 속성 유형입니다.

parent

string

이 속성의 논리적 상위 요소의 리소스 이름입니다.

참고: 속성 이동 UI를 사용하여 상위를 변경할 수 있습니다. 형식: accounts/{account}, properties/{property} 예: 'accounts/100', 'properties/200'

PropertyType

Property 리소스의 유형입니다.

열거형
PROPERTY_TYPE_UNSPECIFIED 알 수 없거나 지정되지 않은 속성 유형
PROPERTY_TYPE_ORDINARY 일반 Google 애널리틱스 속성
PROPERTY_TYPE_SUBPROPERTY Google 애널리틱스 하위 속성
PROPERTY_TYPE_ROLLUP Google 애널리틱스 롤업 속성

ProvisionAccountTicketRequest

ProvisionAccountTicket RPC의 요청 메시지입니다.

필드
account

Account

만들 계정입니다.

redirect_uri

string

사용자가 서비스 약관에 동의한 후 리디렉션되는 URI입니다. Cloud 콘솔에서 리디렉션 URI로 구성해야 합니다.

ProvisionAccountTicketResponse

ProvisionAccountTicket RPC의 응답 메시지입니다.

필드
account_ticket_id

string

서비스 약관 링크에 전달할 매개변수입니다.

RunAccessReportRequest

데이터 액세스 기록 보고서 요청

필드
entity

string

데이터 액세스 보고서는 속성 수준 또는 계정 수준에서 요청을 지원합니다. 계정 수준에서 요청된 경우 데이터 액세스 보고서에는 해당 계정의 모든 속성에 대한 모든 액세스가 포함됩니다.

속성 수준에서 요청하려면 '123'이 Google 애널리틱스 속성 ID인 경우 'properties/123'과 같은 항목이어야 합니다. 계정 수준에서 요청하려면 '1234'가 Google 애널리틱스 계정 ID인 경우 'accounts/1234'와 같이 항목이 지정되어야 합니다.

dimensions[]

AccessDimension

요청되고 응답에 표시되는 측정기준입니다. 요청은 최대 9개의 측정기준을 허용합니다.

metrics[]

AccessMetric

요청되고 응답에 표시되는 측정항목입니다. 요청은 최대 10개의 측정항목을 허용합니다.

date_ranges[]

AccessDateRange

읽을 액세스 기록의 기간입니다. 여러 기간이 요청되면 각 응답 행에 0 기반 기간 색인이 포함됩니다. 두 기간이 겹치는 경우 겹치는 기간의 액세스 기록이 두 기간의 응답 행에 모두 포함됩니다. 요청은 최대 2개의 기간을 허용합니다.

dimension_filter

AccessFilterExpression

측정기준 필터를 사용하면 필터와 일치하는 특정 측정기준 값으로 보고서 응답을 제한할 수 있습니다. 예를 들어 단일 사용자의 액세스 기록을 필터링하는 경우 자세한 내용은 측정기준 필터의 기본사항에서 예시를 참고하세요. 이 필터에서는 측정항목을 사용할 수 없습니다.

metric_filter

AccessFilterExpression

측정항목 필터를 사용하면 필터와 일치하는 특정 측정항목 값으로 보고서 응답을 제한할 수 있습니다. 측정항목 필터는 SQL having 절과 마찬가지로 보고서의 행을 집계한 후에 적용됩니다. 이 필터에서는 측정기준을 사용할 수 없습니다.

offset

int64

시작 행의 행 수입니다. 첫 번째 행은 0번 행으로 집계됩니다. 오프셋을 지정하지 않으면 0으로 취급됩니다. 오프셋이 0이면 이 메서드는 limit 항목이 포함된 결과의 첫 번째 페이지를 반환합니다.

이 페이징 매개변수에 대한 자세한 내용은 페이징을 참고하세요.

limit

int64

반환할 행의 개수입니다. 지정하지 않으면 10,000개의 행이 반환됩니다. API는 요청한 개수와 관계없이 요청당 최대 100,000개의 행을 반환합니다. limit는 양수여야 합니다.

limit만큼 남은 행이 없으면 API에서 요청된 limit보다 적은 행을 반환할 수 있습니다. 예를 들어 측정기준 country의 가능한 값은 300개 미만이므로 country에 대해서만 보고하는 경우 limit를 더 높은 값으로 설정해도 300개가 넘는 행을 가져올 수 없습니다.

이 페이징 매개변수에 대한 자세한 내용은 페이징을 참고하세요.

time_zone

string

이 요청의 시간대입니다(지정된 경우). 지정하지 않으면 속성의 시간대가 사용됩니다. 요청의 시간대는 보고서의 시작일 및 종료일을 해석하는 데 사용됩니다.

IANA 시간대 데이터베이스(https://www.iana.org/time-zones)의 문자열 형식입니다(예: 'America/New_York' 또는 'Asia/Tokyo').

order_bys[]

AccessOrderBy

응답에서 행이 정렬되는 방식을 지정합니다.

return_entity_quota

bool

이 애널리틱스 속성의 할당량의 현재 상태를 반환할지 여부를 전환합니다. 할당량은 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의 수와 DimensionHeaders의 순서가 행에 있는 차원과 일치합니다.

metric_headers[]

AccessMetricHeader

보고서에서 특정 측정항목에 해당하는 열의 헤더입니다. MetricHeader의 수와 MetricHeader의 순서가 행에 있는 측정항목과 일치합니다.

rows[]

AccessRow

보고서의 측정기준 값 조합 및 측정항목 값 행입니다.

row_count

int32

쿼리 결과의 총 행 수입니다. rowCount는 응답에 반환된 행 수, limit 요청 매개변수, offset 요청 매개변수와는 무관합니다. 예를 들어 쿼리가 175개의 행을 반환하고 API 요청에 50개의 limit가 포함된 경우 응답에는 175개의 rowCount가 포함되지만 50개의 행만 포함됩니다.

이 페이징 매개변수에 대한 자세한 내용은 페이징을 참고하세요.

quota

AccessQuota

이 요청을 포함하여 이 애널리틱스 속성의 할당량 상태입니다. 이 필드는 계정 수준 요청에는 작동하지 않습니다.

SearchChangeHistoryEventsRequest

SearchChangeHistoryEvents RPC의 요청 메시지입니다.

필드
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이며, 이보다 큰 값은 최대값으로 변환됩니다.

서비스에서 이 값보다 적은 수의 항목 (0일 수도 있음)이 포함된 페이지를 반환할 수 있으며 추가 페이지가 있을 수도 있습니다. 특정 수의 항목을 원하는 경우 필요한 수의 항목을 가져올 때까지 page_token를 사용하여 페이지를 계속 요청해야 합니다.

page_token

string

선택사항입니다. 이전 SearchChangeHistoryEvents 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, SearchChangeHistoryEvents에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.

SearchChangeHistoryEventsResponse

SearchAccounts RPC의 응답 메시지입니다.

필드
change_history_events[]

ChangeHistoryEvent

호출자가 액세스할 수 있었던 결과입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ServiceLevel

Google 애널리틱스의 다양한 서비스 수준

열거형
SERVICE_LEVEL_UNSPECIFIED 서비스 수준이 지정되지 않았거나 잘못되었습니다.
GOOGLE_ANALYTICS_STANDARD Google 애널리틱스의 표준 버전입니다.
GOOGLE_ANALYTICS_360 Google 애널리틱스의 유료 프리미엄 버전입니다.

UpdateAccountRequest

UpdateAccount RPC의 요청 메시지입니다.

필드
account

Account

필수 항목입니다. 업데이트할 계정입니다. 계정의 name 필드는 계정을 식별하는 데 사용됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 표기법을 사용해야 합니다 (예: 'field_to_update'). 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateConversionEventRequest

UpdateConversionEvent RPC의 요청 메시지

필드
conversion_event

ConversionEvent

필수 항목입니다. 업데이트할 전환 이벤트입니다. name 필드는 업데이트할 설정을 식별하는 데 사용됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 케이스를 사용해야 합니다 (예: 'field_to_update')를 입력합니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateCustomDimensionRequest

UpdateCustomDimension RPC의 요청 메시지입니다.

필드
custom_dimension

CustomDimension

업데이트할 맞춤 측정기준

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateCustomMetricRequest

UpdateCustomMetric RPC의 요청 메시지입니다.

필드
custom_metric

CustomMetric

업데이트할 CustomMetric

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettings RPC의 요청 메시지입니다.

필드
data_retention_settings

DataRetentionSettings

필수 항목입니다. 업데이트할 설정입니다. name 필드는 업데이트할 설정을 식별하는 데 사용됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 케이스를 사용해야 합니다 (예: 'field_to_update')를 입력합니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateDataStreamRequest

UpdateDataStream RPC의 요청 메시지입니다.

필드
data_stream

DataStream

업데이트할 DataStream

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateGoogleAdsLinkRequest

UpdateGoogleAdsLink RPC의 요청 메시지

필드
update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 케이스를 사용해야 합니다 (예: 'field_to_update')를 입력합니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateKeyEventRequest

UpdateKeyEvent RPC의 요청 메시지

필드
key_event

KeyEvent

필수 항목입니다. 업데이트할 주요 이벤트입니다. name 필드는 업데이트할 설정을 식별하는 데 사용됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 케이스를 사용해야 합니다 (예: 'field_to_update')를 입력합니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.

UpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecret RPC의 요청 메시지

필드
measurement_protocol_secret

MeasurementProtocolSecret

필수 항목입니다. 업데이트할 측정 프로토콜 비밀번호입니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 생략된 필드는 업데이트되지 않습니다.

UpdatePropertyRequest

UpdateProperty RPC의 요청 메시지입니다.

필드
property

Property

필수 항목입니다. 업데이트할 속성입니다. 속성의 name 필드는 업데이트할 속성을 식별하는 데 사용됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 목록입니다. 필드 이름은 스네이크 케이스를 사용해야 합니다 (예: 'field_to_update')를 입력합니다. 생략된 필드는 업데이트되지 않습니다. 전체 항목을 바꾸려면 문자열 '*'가 포함된 경로 하나를 사용하여 모든 필드를 일치시킵니다.