- 리소스: ReportTask
- ReportDefinition
- 크기
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- 측정항목
- DateRange
- FilterExpression
- FilterExpressionList
- 필터
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- 작업
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- 사용자 집단
- CohortsRange
- 세부사항
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- 상태
- 메서드
리소스: ReportTask
특정 보고서 태스크 구성입니다.
JSON 표현 |
---|
{ "name": string, "reportDefinition": { object ( |
필드 | |
---|---|
name |
출력 전용입니다. 식별자. 생성 중에 할당된 보고서 작업 리소스 이름입니다. 형식: 'properties/{property}/reportTasks/{reportTask}' |
report |
선택사항입니다. 보고서 데이터를 가져오는 보고서 정의로, 보고서의 구조를 설명합니다. 일반적으로 보고서에 포함할 필드와 데이터를 필터링하는 데 사용할 기준이 포함됩니다. |
report |
출력 전용입니다. 보고서에 대한 정보를 제공하는 특정 보고서 작업의 보고서 메타데이터입니다. 일반적으로 보고서의 리소스 이름, 보고서 상태, 보고서 생성 타임스탬프 등의 정보가 포함됩니다. |
ReportDefinition
보고서를 실행하는 방법의 정의입니다.
JSON 표현 |
---|
{ "dimensions": [ { object ( |
필드 | |
---|---|
dimensions[] |
선택사항입니다. 요청되고 표시된 측정기준입니다. |
metrics[] |
선택사항입니다. 요청되고 표시된 측정항목입니다. |
date |
선택사항입니다. 읽을 데이터의 기간입니다. 여러 기간이 요청되면 각 응답 행에 0 기반 기간 색인이 포함됩니다. 두 기간이 겹치는 경우 겹치는 기간의 이벤트 데이터가 두 기간의 응답 행에 모두 포함됩니다. 동질 집단 요청에서 이 |
dimension |
선택사항입니다. 측정기준 필터를 사용하면 보고서에서 특정 측정기준 값만 요청할 수 있습니다. 자세한 내용은 치수 필터의 기본사항에서 예시를 참고하세요. 이 필터에서는 측정항목을 사용할 수 없습니다. |
metric |
선택사항입니다. 측정항목의 필터 절입니다. SQL having 절과 마찬가지로 보고서의 행을 집계한 후에 적용됩니다. 이 필터에서는 측정기준을 사용할 수 없습니다. |
offset |
선택사항입니다. Google 애널리틱스 저장소의 시작 행의 행 개수입니다. 첫 번째 행은 0번 행으로 집계됩니다. 보고서 작업을 만들 때 |
limit |
선택사항입니다. 보고서에 반환할 행의 수입니다. 지정하지 않으면 10,000개의 행이 반환됩니다. API는 요청한 행 수와 관계없이 요청당 최대 250,000개의 행을 반환합니다.
|
metric |
선택사항입니다. 측정항목 집계 집계된 측정항목 값은 dimensionValues가 'RESERVED_(MetricAggregation)'으로 설정된 행에 표시됩니다. |
order |
선택사항입니다. 응답에서 행이 정렬되는 방식을 지정합니다. |
currency |
선택사항입니다. ISO4217 형식의 통화 코드입니다(예: 'AED', 'USD', 'JPY'). 이 필드가 비어 있으면 보고서에 속성의 기본 통화가 사용됩니다. |
cohort |
선택사항입니다. 이 요청과 연결된 사용자 집단 그룹입니다. 요청에 사용자 집단 그룹이 있는 경우 '사용자 집단' 측정기준이 있어야 합니다. |
keep |
선택사항입니다. false이거나 지정되지 않은 경우 모든 측정항목이 0인 각 행이 반환되지 않습니다. 이 값이 true이면 필터에 의해 별도로 삭제되지 않은 행이 반환됩니다. 이 예를 들어 속성이 |
sampling |
선택사항입니다. 보고서의 샘플링 수준입니다. |
측정기준
측정기준은 데이터의 속성입니다. 예를 들어 도시 측정기준은 이벤트가 발생한 도시를 나타냅니다. 보고서 응답의 측정기준 값은 문자열입니다. 예를 들어 도시는 '파리' 또는 '뉴욕'일 수 있습니다.
JSON 표현 |
---|
{
"name": string,
"dimensionExpression": {
object ( |
필드 | |
---|---|
name |
측정기준의 이름입니다.
크기는 |
dimension |
하나의 측정기준은 여러 측정기준의 표현식의 결과일 수 있습니다. 예를 들어 측정기준 '국가, 도시': concatenate(국가, ", ", 도시) |
DimensionExpression
여러 측정기준의 수식의 결과인 측정기준을 표현하는 데 사용됩니다. 사용 예: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2)
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 one_expression . DimensionExpression 에 하나의 크기 표현식 유형을 지정합니다. one_expression 은 다음 중 하나일 수 있습니다. |
|
lower |
측정기준 값을 소문자로 변환하는 데 사용됩니다. |
upper |
측정기준 값을 대문자로 변환하는 데 사용됩니다. |
concatenate |
측정기준 값을 단일 측정기준으로 결합하는 데 사용됩니다. 예를 들어 측정기준 '국가, 도시': concatenate(국가, ", ", 도시) |
CaseExpression
측정기준 값을 단일 케이스로 변환하는 데 사용됩니다.
JSON 표현 |
---|
{ "dimensionName": string } |
필드 | |
---|---|
dimension |
측정기준의 이름입니다. 이름은 요청의 측정기준 필드에 있는 이름을 다시 참조해야 합니다. |
ConcatenateExpression
측정기준 값을 단일 측정기준으로 결합하는 데 사용됩니다.
JSON 표현 |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
필드 | |
---|---|
dimension |
측정기준의 이름입니다. 이름은 요청의 측정기준 필드에 있는 이름을 다시 참조해야 합니다. |
delimiter |
측정기준 이름 사이에 배치되는 구분 기호입니다. 구분자는 '|' 또는 ','와 같은 단일 문자인 경우가 많지만 더 긴 문자열일 수도 있습니다. 측정기준 값에 구분자가 포함된 경우 구분 없이 둘 다 응답에 표시됩니다. 예를 들어 측정기준 1 값이 'US,FR', 측정기준 2 값이 'JP', 구분자가 ','인 경우 응답에는 'US,FR,JP'가 포함됩니다. |
측정항목
보고서의 정량적 측정값입니다. 예를 들어 eventCount
측정항목은 총 이벤트 수입니다. 요청은 최대 10개의 측정항목을 허용합니다.
JSON 표현 |
---|
{ "name": string, "expression": string, "invisible": boolean } |
필드 | |
---|---|
name |
측정항목의 이름입니다.
측정항목은 |
expression |
파생 측정항목의 수식입니다. 예를 들어 사용자당 이벤트 수 측정항목은 |
invisible |
보고서 응답에서 측정항목이 표시되지 않는지 여부를 나타냅니다. 측정항목이 표시되지 않으면 측정항목이 응답에 열을 생성하지 않지만 |
DateRange
연속된 일 그룹: startDate
, startDate + 1
, ..., endDate
요청은 최대 4개의 기간을 허용합니다.
JSON 표현 |
---|
{ "startDate": string, "endDate": string, "name": string } |
필드 | |
---|---|
start |
|
end |
|
name |
이 기간에 이름을 할당합니다. 보고서 응답에서 측정기준 |
FilterExpression
측정기준 또는 측정항목 필터를 표현합니다. 동일한 FilterExpression의 필드는 모든 측정기준이거나 모든 측정항목이어야 합니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 expr . FilterExpression 에 필터 표현식 유형을 하나 지정합니다. expr 은 다음 중 하나일 수 있습니다. |
|
and |
andGroup의 FilterExpressions는 AND 관계를 갖습니다. |
or |
orGroup의 FilterExpressions는 OR 관계를 갖습니다. |
not |
FilterExpression이 notExpression이 아닙니다. |
filter |
원시 필터 동일한 FilterExpression에서 필터의 모든 필드 이름은 모든 측정기준이거나 모든 측정항목이어야 합니다. |
FilterExpressionList
필터 표현식 목록입니다.
JSON 표현 |
---|
{
"expressions": [
{
object ( |
필드 | |
---|---|
expressions[] |
필터 표현식 목록입니다. |
필터
측정기준 또는 측정항목 값을 필터링하는 표현식입니다.
JSON 표현 |
---|
{ "fieldName": string, // Union field |
필드 | |
---|---|
field |
측정기준 이름 또는 측정항목 이름입니다. 측정기준 또는 측정항목에 정의된 이름이어야 합니다. |
통합 필드 one_filter . Filter 에 하나의 필터 유형을 지정합니다. one_filter 은 다음 중 하나일 수 있습니다. |
|
string |
문자열 관련 필터입니다. |
in |
in 목록 값 필터입니다. |
numeric |
숫자 또는 날짜 값을 위한 필터입니다. |
between |
두 값 사이의 필터입니다. |
empty |
'(not set)(설정되지 않음)' 및 '' 값과 같은 빈 값을 위한 필터입니다. |
StringFilter
문자열 필터
JSON 표현 |
---|
{
"matchType": enum ( |
필드 | |
---|---|
match |
이 필터의 일치 유형입니다. |
value |
일치에 사용되는 문자열 값입니다. |
case |
true이면 문자열 값이 대소문자를 구분합니다. |
MatchType
문자열 필터의 일치 유형
열거형 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
미지정 |
EXACT |
문자열 값의 정확한 일치입니다. |
BEGINS_WITH |
문자열 값으로 시작합니다. |
ENDS_WITH |
문자열 값으로 끝납니다. |
CONTAINS |
문자열 값을 포함합니다. |
FULL_REGEXP |
정규 표현식과 문자열 값의 전체 일치입니다. |
PARTIAL_REGEXP |
정규 표현식과 문자열 값의 부분 일치입니다. |
InListFilter
결과는 문자열 값 목록에 있어야 합니다.
JSON 표현 |
---|
{ "values": [ string ], "caseSensitive": boolean } |
필드 | |
---|---|
values[] |
문자열 값 목록입니다. 비어 있지 않아야 합니다. |
case |
true이면 문자열 값이 대소문자를 구분합니다. |
NumericFilter
숫자 또는 날짜 값을 필터링합니다.
JSON 표현 |
---|
{ "operation": enum ( |
필드 | |
---|---|
operation |
이 필터의 작업 유형입니다. |
value |
숫자 값 또는 날짜 값입니다. |
작업
숫자 필터에 적용되는 작업
열거형 | |
---|---|
OPERATION_UNSPECIFIED |
지정되지 않았습니다. |
EQUAL |
같음 |
LESS_THAN |
미만 |
LESS_THAN_OR_EQUAL |
작거나 같음 |
GREATER_THAN |
초과 |
GREATER_THAN_OR_EQUAL |
이상 |
NumericValue
숫자를 나타냅니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 one_value . 숫자 값 one_value 중 하나는 다음 중 하나여야 합니다. |
|
int64 |
정수 값 |
double |
이중 값 |
BetweenFilter
결과가 두 숫자 사이여야 함을 나타냅니다 (양 끝값 포함).
JSON 표현 |
---|
{ "fromValue": { object ( |
필드 | |
---|---|
from |
이 숫자로 시작합니다. |
to |
이 숫자로 끝납니다. |
EmptyFilter
이 유형에는 필드가 없습니다.
빈 값을 필터링합니다.
MetricAggregation
측정항목의 집계를 나타냅니다.
열거형 | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
지정되지 않은 연산자입니다. |
TOTAL |
SUM 연산자 |
MINIMUM |
최솟값 연산자입니다. |
MAXIMUM |
최대 연산자입니다. |
COUNT |
개수 연산자 |
OrderBy
정렬 기준은 응답에서 행이 정렬되는 방식을 정의합니다. 예를 들어 이벤트 수를 내림차순으로 정렬하는 것은 한 가지 정렬이고 이벤트 이름 문자열로 행을 정렬하는 것은 다른 정렬입니다.
JSON 표현 |
---|
{ "desc": boolean, // Union field |
필드 | |
---|---|
desc |
true이면 내림차순으로 정렬됩니다. |
통합 필드 one_order_by . OrderBy 의 정렬 기준 유형을 하나 지정합니다. one_order_by 은 다음 중 하나일 수 있습니다. |
|
metric |
측정항목 값을 기준으로 결과를 정렬합니다. |
dimension |
측정기준 값을 기준으로 결과를 정렬합니다. |
MetricOrderBy
측정항목 값을 기준으로 정렬합니다.
JSON 표현 |
---|
{ "metricName": string } |
필드 | |
---|---|
metric |
정렬 기준으로 요청된 측정항목 이름입니다. |
DimensionOrderBy
측정기준 값을 기준으로 정렬합니다.
JSON 표현 |
---|
{
"dimensionName": string,
"orderType": enum ( |
필드 | |
---|---|
dimension |
정렬할 요청의 측정기준 이름입니다. |
order |
측정기준 값 정렬 규칙을 제어합니다. |
OrderType
문자열 측정기준 값을 정렬하는 규칙입니다.
열거형 | |
---|---|
ORDER_TYPE_UNSPECIFIED |
지정되지 않았습니다. |
ALPHANUMERIC |
유니코드 코드 포인트를 기준으로 한 영숫자 정렬 예를 들어 '2' < 'A' < 'X' < 'b' < 'z'입니다. |
CASE_INSENSITIVE_ALPHANUMERIC |
소문자 유니코드 코드 포인트 기준으로 대소문자를 구분하지 않는 영숫자 정렬 예를 들어 '2' < 'A' < 'b' < 'X' < 'z'입니다. |
NUMERIC |
측정기준 값은 정렬하기 전에 숫자로 변환됩니다. 예를 들어 숫자 정렬에서는 '25' < '100'이고 ALPHANUMERIC 정렬에서는 '100' < '25'입니다. 숫자가 아닌 측정기준 값은 모두 숫자 값 아래에서 동일한 순서 값을 갖습니다. |
CohortSpec
동질 집단 보고서의 동질 집단 사양입니다.
동질 집단 보고서는 동질 집단의 사용자 유지율 시계열을 만듭니다. 예를 들어 9월 첫째 주에 획득한 사용자 동질 집단을 선택하고 다음 6주 동안 해당 동질 집단을 추적할 수 있습니다. 9월 첫째 주 동질 집단에서 획득한 사용자를 선택하는 것은 cohort
객체에 지정됩니다. 다음 6주 동안의 해당 사용자 집단은 cohortsRange
객체에 지정됩니다.
예시는 동질 집단 보고서 예시를 참고하세요.
보고서 응답에는 앱이 3주 후에는 이 사용자 집단의 60% 를 유지하고 6주 후에는 이 사용자 집단의 25% 를 유지했다고 표시되는 주간 시계열이 표시될 수 있습니다. 이 두 비율은 측정항목 cohortActiveUsers/cohortTotalUsers
로 계산할 수 있으며 보고서에 별도의 행으로 표시됩니다.
JSON 표현 |
---|
{ "cohorts": [ { object ( |
필드 | |
---|---|
cohorts[] |
사용자를 사용자 집단으로 그룹화하기 위한 선택 기준을 정의합니다. 대부분의 동질 집단 보고서는 단일 동질 집단만 정의합니다. 여러 사용자 집단을 지정하면 보고서에서 각 사용자 집단을 이름으로 식별할 수 있습니다. |
cohorts |
동질 집단 보고서는 연장된 보고 기간 동안 동질 집단을 추적합니다. 이 범위는 사용자 집단을 추적할 오프셋 기간을 지정합니다. |
cohort |
사용자 집단 보고서의 선택적 설정입니다. |
코호트
사용자 집단 선택 기준을 정의합니다. 동질 집단이란 공통된 특징을 공유하는 사용자 그룹을 말합니다. 예를 들어 firstSessionDate
가 동일한 사용자는 동일한 동질 집단에 속합니다.
JSON 표현 |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
필드 | |
---|---|
name |
이 동질 집단에 이름을 할당합니다. 보고서 응답에서 측정기준 |
dimension |
동질 집단에서 사용하는 측정기준입니다. 필수이며 |
date |
이 사용자 집단은 첫 터치 날짜가 사용자 집단 요청에서 이 이 |
CohortsRange
사용자 집단 보고서의 연장된 보고 기간을 구성합니다. 사용자 집단을 추적할 오프셋 기간을 지정합니다.
JSON 표현 |
---|
{
"granularity": enum ( |
필드 | |
---|---|
granularity |
필수 항목입니다. 동질 집단 보고서의 연장된 보고 기간에 대해 |
start |
|
end |
필수 항목입니다.
|
세부사항
동질 집단 보고서의 연장된 보고 기간에 대해 startOffset
및 endOffset
를 해석하는 데 사용되는 세부사항입니다.
열거형 | |
---|---|
GRANULARITY_UNSPECIFIED |
지정하면 안 됩니다. |
DAILY |
일별 세부사항 사용자 집단의 dateRange 가 하루이고 요청에 cohortNthDay 가 포함된 경우 일반적으로 사용됩니다. |
WEEKLY |
주간 세부사항 사용자 집단의 dateRange 가 일주일 (일요일에 시작하여 토요일에 종료)이고 요청에 cohortNthWeek 가 포함된 경우 일반적으로 사용됩니다. |
MONTHLY |
월별 세부사항 사용자 집단의 dateRange 가 1개월이고 요청에 cohortNthMonth 가 포함된 경우 일반적으로 사용됩니다. |
CohortReportSettings
사용자 집단 보고서의 선택적 설정입니다.
JSON 표현 |
---|
{ "accumulate": boolean } |
필드 | |
---|---|
accumulate |
true인 경우 첫 번째 터치 날짜부터 종료일까지 결과를 누적합니다. |
SamplingLevel
요청의 샘플링 수준 카테고리입니다.
열거형 | |
---|---|
SAMPLING_LEVEL_UNSPECIFIED |
알 수 없는 유형. |
LOW |
표준 속성에는 샘플링 수준 1,000만 개, Google 애널리틱스 360 속성에는 1억 개를 적용합니다. |
MEDIUM |
샘플링 수준이 10억인 Google 애널리틱스 360 속성에만 제공됩니다. |
UNSAMPLED |
Google 애널리틱스 360 속성에만 제공됩니다. 전체 데이터 탐색 분석은 더 정확하며 표준 탐색 분석에서는 보이지 않는 유용한 정보를 제공할 수 있습니다. 자세한 내용은 https://support.google.com/analytics/answer/10896953을 참고하세요. |
ReportMetadata
특정 보고서 작업의 보고서 메타데이터입니다.
JSON 표현 |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
필드 | |
---|---|
creation |
출력 전용입니다. 보고서를 만들 때 청구된 총 할당량 토큰입니다. 이 토큰 수는 |
state |
출력 전용입니다. 이 보고서 작업의 현재 상태입니다. |
begin |
출력 전용입니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
task |
출력 전용입니다. 보고서 결과의 총 행 수입니다. 이 필드는 상태가 활성 상태일 때 채워집니다. 기존 보고서의 범위 내에서 |
error |
출력 전용입니다. 생성 중에 보고서 태스크가 실패하면 오류 메시지가 채워집니다. |
total |
출력 전용입니다. Google 애널리틱스 저장소의 총 행 수입니다. 현재 보고서 외의 데이터 행을 추가로 쿼리하려면
예를 들어 현재 보고서의 |
주
처리 상태입니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
지정되지 않은 상태는 사용되지 않습니다. |
CREATING |
보고서는 현재 생성 중이며 향후 사용할 수 있습니다. 생성은 CreateReport 호출 직후에 발생합니다. |
ACTIVE |
보고서가 완전히 생성되어 쿼리할 준비가 되었습니다. |
FAILED |
보고서를 만들 수 없습니다. |
메서드 |
|
---|---|
|
보고서 작업 생성을 시작합니다. |
|
특정 보고서 작업에 관한 보고서 메타데이터를 가져옵니다. |
|
속성의 모든 보고서 작업을 나열합니다. |
|
신고 작업의 콘텐츠를 검색합니다. |