Method: reports.batchGet

애널리틱스 데이터를 반환합니다.

HTTP 요청

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
입력란
reportRequests[]

object(ReportRequest)

요청마다 별도의 응답이 있습니다. 최대 5개의 요청을 할 수 있습니다. 모든 요청의 dateRanges, viewId, segments, samplingLevel, cohortGroup가 동일해야 합니다.

useResourceQuotas

boolean

리소스 기반 할당량을 사용 설정합니다(기본값은 False). 이 필드가 True로 설정되면 조회 (프로필)당 할당량에 요청의 계산 비용이 적용됩니다. 비용 기반 할당량을 사용하면 샘플링 레이트가 높아집니다. (SMALL의 경우 1,000만 회, LARGE의 경우 1억). 자세한 내용은 한도 및 할당량 문서를 참조하세요.

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

Reporting API batchGet 호출의 보고서를 보유하는 기본 응답 클래스입니다.

JSON 표현 
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
입력란
reports[]

object(Report)

각 요청에 해당하는 응답입니다.

queryCost

number

쿼리 실행을 위해 공제된 리소스 할당량 토큰의 양입니다. 모든 응답을 포함합니다.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

속성에 남아 있는 리소스 할당량입니다.

승인 범위

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

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

ReportRequest

Reporting API 요청을 지정하는 기본 요청 클래스입니다.

JSON 표현 
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
입력란
viewId

string

데이터를 검색할 애널리틱스 보기 ID입니다. batchGet 메서드 내의 모든 ReportRequest에는 동일한 viewId가 포함되어야 합니다.

dateRanges[]

object(DateRange)

요청의 기간입니다. 요청에는 최대 2개의 기간을 포함할 수 있습니다. 응답에는 요청의 각 기간에 대한 측정기준의 각 조합에 대한 측정항목 값 집합이 포함됩니다. 따라서 두 개의 기간이 있는 경우 두 개의 측정항목 값 세트가 생깁니다. 하나는 원래 기간에 대한 것이고 다른 하나는 두 번째 기간에 대한 값입니다. 동질 집단 또는 평생 가치 요청에는 reportRequest.dateRanges 필드를 지정해서는 안 됩니다. 기간을 제공하지 않으면 기본 기간은 (startDate: 현재 날짜 - 7일, endDate: 현재 날짜 - 1일)입니다. batchGet 메서드 내의 모든 ReportRequest에는 동일한 dateRanges 정의가 포함되어야 합니다.

samplingLevel

enum(Sampling)

원하는 보고서 샘플 크기입니다. samplingLevel 필드가 지정되지 않으면 DEFAULT 샘플링 수준이 사용됩니다. batchGet 메서드 내의 모든 ReportRequest에는 동일한 samplingLevel 정의가 포함되어야 합니다. 자세한 내용은 개발자 가이드를 참고하세요.

dimensions[]

object(Dimension)

요청된 측정기준입니다. 요청에는 총 9개의 측정기준을 포함할 수 있습니다.

dimensionFilterClauses[]

object(DimensionFilterClause)

측정기준 값을 필터링하기 위한 측정기준 필터 절입니다. 이 연산자는 AND 연산자와 논리적으로 결합됩니다. 필터링은 측정기준이 집계되기 전에 수행되므로 반환된 측정항목은 관련 측정기준의 총계만 나타냅니다.

metrics[]

object(Metric)

요청된 측정항목입니다. 요청에서 측정항목을 1개 이상 지정해야 합니다. 요청에는 총 10개의 측정항목을 포함할 수 있습니다.

metricFilterClauses[]

object(MetricFilterClause)

측정항목 필터 절입니다. 이 연산자는 AND 연산자와 논리적으로 결합됩니다. 측정항목 필터는 첫 번째 기간만 확인하고 비교 기간은 고려하지 않습니다. 측정항목 필터링은 측정항목이 집계된 후에 발생합니다.

filtersExpression

string

요청에 대해 반환되는 데이터를 제한하는 측정기준 또는 측정항목 필터입니다. filtersExpression를 사용하려면 필터링할 측정기준 또는 측정항목과 필터 표현식을 차례로 입력합니다. 예를 들어 다음 표현식에서는 Firefox로 시작하는 ga:browser 측정기준인 ga:browser=~^Firefox를 선택합니다. 측정기준 및 측정항목 필터에 대한 자세한 내용은 필터 참조를 확인하세요.

orderBys[]

object(OrderBy)

출력 행의 정렬 순서입니다. 두 행을 비교하기 위해 차이가 발견될 때까지 다음 요소가 순서대로 적용됩니다. 출력의 모든 기간에는 동일한 행 순서가 적용됩니다.

segments[]

object(Segment)

요청에 대해 반환된 데이터를 분류합니다. 세그먼트 정의를 통해 세그먼트 요청의 하위 집합을 확인할 수 있습니다. 한 요청에 최대 4개의 세그먼트를 포함할 수 있습니다. batchGet 메서드 내의 모든 ReportRequest에는 동일한 segments 정의가 포함되어야 합니다. 세그먼트가 포함된 요청에는 ga:segment 측정기준이 있어야 합니다.

pivots[]

object(Pivot)

피벗 정의 요청에는 최대 2개의 피벗을 포함할 수 있습니다.

cohortGroup

object(CohortGroup)

이 요청과 관련된 동질 집단 그룹입니다. 요청에 동질 집단 그룹이 있는 경우 ga:cohort 측정기준이 있어야 합니다. batchGet 메서드 내의 모든 ReportRequest에는 동일한 cohortGroup 정의가 포함되어야 합니다.

pageToken

string

결과의 다음 페이지를 가져오는 연속 토큰입니다. 이 속성을 요청에 추가하면 pageToken 다음에 오는 행이 반환됩니다. pageToken은 reports.batchGet 요청에 대한 응답에서 nextPageToken 매개변수에 반환된 값이어야 합니다.

pageSize

number

페이지 크기는 페이징용이며 반환되는 최대 행 수를 지정합니다. 페이지 크기는 0 이상이어야 합니다. 쿼리는 기본값 1,000개의 행을 반환합니다. Analytics Core Reporting API는 요청 횟수와 관계없이 요청당 최대 100,000개의 행을 반환합니다. 또한 측정기준 세그먼트가 예상보다 적은 경우 요청된 것보다 적은 수의 행이 반환될 수도 있습니다. 예를 들어 ga:country에 사용 가능한 값은 300개 미만이므로 국가별로만 분류할 때는 pageSize을 더 높은 값으로 설정하더라도 300개 이상의 행을 얻을 수 없습니다.

includeEmptyRows

boolean

false로 설정하면 검색된 모든 측정항목이 0인 경우 응답에 행이 포함되지 않습니다. 기본값은 false로, 이 경우 이러한 행이 제외됩니다.

hideTotals

boolean

true로 설정하면 모든 기간에서 일치하는 모든 행의 모든 측정항목의 총계가 숨겨집니다. 기본값은 false이며 합계를 반환합니다.

hideValueRanges

boolean

true로 설정하면 일치하는 모든 행에서 최솟값과 최댓값이 숨겨집니다. 기본값은 false이고 값 범위가 반환됩니다.

샘플링

샘플링 수준의 값입니다.

열거형
SAMPLING_UNSPECIFIED samplingLevel 필드가 지정되지 않으면 DEFAULT 샘플링 수준이 사용됩니다.
DEFAULT 속도와 정확성이 균형을 이루는 샘플 크기를 사용하여 응답을 반환합니다.
SMALL 샘플링 크기가 더 작은 빠른 응답을 반환합니다.
LARGE 큰 샘플링 크기를 사용하여 더 정확한 응답을 반환합니다. 하지만 이로 인해 응답이 느려질 수 있습니다.

측정기준

측정기준은 데이터의 속성입니다. 예를 들어 ga:city 측정기준은 세션이 시작된 도시(예: '파리' 또는 '뉴욕')를 나타냅니다.

JSON 표현 
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
입력란
name

string

가져올 측정기준의 이름입니다(예: ga:browser).

histogramBuckets[]

string (int64 format)

비어 있지 않으면 int64에 대한 문자열 다음의 버킷에 측정기준 값을 배치합니다. 정수 값의 문자열 표현이 아닌 측정기준 값은 0으로 변환됩니다. 버킷 값은 오름차순으로 정렬해야 합니다. 각 버킷은 하단에서 닫혀 있고 위쪽에서는 열립니다. '첫 번째' 버킷에는 첫 번째 경계보다 작은 모든 값이 포함되고 '마지막' 버킷에는 무한대까지의 모든 값이 포함됩니다. 버킷에 속하는 측정기준 값은 새 측정기준 값으로 변환됩니다. 예를 들어 '0, 1, 3, 4, 7'의 목록을 제공하면 다음 버킷을 반환합니다.

  • 버킷 #1: 값 < 0, 측정기준 값 '<0'
  • 버킷 #2: [0,1의 값), 측정기준 값 '0'
  • 버킷 3: [1,3의 값), 측정기준 값 '1~2'
  • 버킷 4: [3,4의 값), 측정기준 값 '3'
  • 버킷 #5: [4,7'의 값), 측정기준 값 '4~6'
  • 버킷 #6: 값 >= 7, 측정기준 값 '7+'

참고: 측정기준에 히스토그램 변형을 적용하고 정렬에서 이 측정기준을 사용하는 경우 정렬 유형 HISTOGRAM_BUCKET를 사용하는 것이 좋습니다. 이렇게 하지 않으면 측정기준 값이 사전 (사전) 순서에 따라 정렬됩니다. 예를 들어 사전의 오름차순 정렬은 다음과 같습니다.

'<50', '1001+', '121~1000', '50~120'

오름차순 HISTOGRAM_BUCKET는 다음과 같습니다.

'<50', '50~120', '121~1000', '1001+'

클라이언트는 히스토그램이 변경된 측정기준에 대해 "orderType": "HISTOGRAM_BUCKET"를 명시적으로 요청해야 합니다.

DimensionFilterClause

측정기준 필터 그룹입니다. 연산자 값을 설정하여 필터를 논리적으로 결합하는 방법을 지정합니다.

JSON 표현 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
입력란
operator

enum(FilterLogicalOperator)

여러 측정기준 필터를 결합하는 연산자입니다. 지정하지 않으면 OR로 처리됩니다.

filters[]

object(DimensionFilter)

반복되는 필터입니다. 지정된 연산자에 따라 논리적으로 결합됩니다.

FilterLogicalOperator

필터를 논리적으로 결합하는 방법입니다.

열거형
OPERATOR_UNSPECIFIED 지정되지 않은 연산자입니다. OR로 취급됩니다.
OR 논리 OR 연산자.
AND 논리 AND 연산자.

DimensionFilter

측정기준 필터는 측정기준의 필터링 옵션을 지정합니다.

JSON 표현 
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
입력란
dimensionName

string

필터링할 측정기준입니다. DimensionFilter에는 측정기준이 포함되어야 합니다.

not

boolean

논리 NOT 연산자. 이 부울이 true로 설정되면 일치하는 측정기준 값이 보고서에서 제외됩니다. 기본값은 false입니다.

operator

enum(Operator)

측정기준을 표현식과 일치시키는 방법입니다. 기본값은 REGEXP입니다.

expressions[]

string

일치시킬 문자열 또는 정규 표현식입니다. 연산자가 IN_LIST가 아닌 경우 목록의 첫 번째 값만 비교에 사용됩니다. IN_LIST 연산자인 경우 전체 목록을 사용하여 IN_LIST 연산자의 설명에 설명된 대로 측정기준을 필터링합니다.

caseSensitive

boolean

검색 시 대소문자를 구분해야 하나요? 기본값은 false입니다.

연산자

다양한 일치 유형이 지원됩니다.

열거형
OPERATOR_UNSPECIFIED 검색 유형을 지정하지 않으면 REGEXP로 처리됩니다.
REGEXP 일치 표현식은 정규 표현식으로 처리됩니다. 모든 검색 유형은 정규 표현식으로 취급되지 않습니다.
BEGINS_WITH 제공된 일치 표현식으로 시작하는 값과 일치합니다.
ENDS_WITH 제공된 일치 표현식으로 끝나는 값과 일치합니다.
PARTIAL 하위 문자열 일치.
EXACT 값은 일치 표현식과 완전히 일치해야 합니다.
NUMERIC_EQUAL

정수 비교 필터입니다. 이러한 필터의 대소문자 구분은 무시되며 표현식은 정수를 나타내는 문자열로 간주됩니다. 실패 조건:

  • 표현식이 유효한 int64가 아닌 경우 클라이언트에 오류가 발생합니다.
  • 유효한 int64 값이 아닌 입력 측정기준은 필터와 일치하지 않습니다.
NUMERIC_GREATER_THAN 측정기준이 일치 표현식보다 큰 숫자인지 확인합니다. 제한사항은 NUMERIC_EQUALS의 설명을 참고하세요.
NUMERIC_LESS_THAN 측정기준이 일치 표현식보다 숫자적으로 작은지 확인합니다. 제한사항은 NUMERIC_EQUALS의 설명을 참고하세요.
IN_LIST

이 옵션은 표현식이 선택된 값 목록에서 값을 가져올 수 있는 측정기준 필터를 지정하는 데 사용됩니다. 이렇게 하면 모든 단일 응답 행에 대해 OR로 연결된 여러 개의 일치검색 측정기준 필터를 평가하는 것을 방지할 수 있습니다. 예를 들면 다음과 같습니다.

expressions: ["A", "B", "C"]

측정기준 값이 A, B 또는 C인 응답 행은 이 DimensionFilter와 일치합니다.

측정항목

측정항목은 정량적 측정값입니다. 예를 들어 ga:users 측정항목은 요청된 기간의 총 사용자 수를 나타냅니다.

JSON 표현 
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
입력란
expression

string

요청의 측정항목 표현식입니다. 표현식은 하나 이상의 측정항목과 숫자로 구성됩니다. 허용되는 연산자에는 더하기 (+), 빼기 (-), 부정 (단항 -), 나누기 (/), 곱하기 (*), 괄호, 양의 기수 (0-9), 소수가 포함될 수 있으며 1,024자로 제한됩니다. 예를 들어 ga:totalRefunds/ga:users입니다. 대부분의 경우 측정항목 표현식은 ga:users와 같은 단일 측정항목 이름일 뿐입니다. 혼합 MetricType (예: CURRENCY + PERCENTAGE) 측정항목으로 인해 예상치 못한 결과가 발생합니다.

alias

string

측정항목 표현식의 별칭은 표현식의 대체 이름입니다. 별칭은 필터링과 정렬에 사용할 수 있습니다. 이 필드는 선택사항이며 표현식이 단일 측정항목이 아니라 필터링과 정렬에 사용할 수 없는 복잡한 표현식인 경우 유용합니다. 별칭은 응답 열 헤더에서도 사용됩니다.

formattingType

enum(MetricType)

측정항목 표현식의 형식을 지정하는 방법을 지정합니다(예: INTEGER).

MetricType

측정항목 유형

열거형
METRIC_TYPE_UNSPECIFIED 측정항목 유형이 지정되지 않았습니다.
INTEGER 정수 측정항목입니다.
FLOAT 부동 측정항목입니다.
CURRENCY 통화 측정항목
PERCENT 백분율 측정항목입니다.
TIME HH:MM:SS 형식의 시간 측정항목입니다.

MetricFilterClause

측정항목 필터 그룹을 나타냅니다. 연산자 값을 설정하여 필터를 논리적으로 결합하는 방법을 지정합니다.

JSON 표현 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
입력란
operator

enum(FilterLogicalOperator)

여러 측정항목 필터를 결합하는 연산자입니다. 지정하지 않으면 OR로 처리됩니다.

filters[]

object(MetricFilter)

반복되는 필터입니다. 지정된 연산자에 따라 논리적으로 결합됩니다.

MetricFilter

MetricFilter는 측정항목에 필터를 지정합니다.

JSON 표현 
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
입력란
metricName

string

필터링의 기준이 되는 측정항목입니다. metricFilter에는 측정항목 이름이 포함되어야 합니다. 측정항목 이름은 이전에 측정항목으로 정의된 별칭이거나 측정항목 표현식일 수도 있습니다.

not

boolean

논리 NOT 연산자. 이 부울이 true로 설정되면 일치하는 측정항목 값이 보고서에서 제외됩니다. 기본값은 false입니다.

operator

enum(Operator)

EQUAL, LESS_THAN 또는 GREATER_THAN 측정항목이 비교값이며 기본값은 EQUAL입니다. 연산자가 IS_MISSING인 경우 측정항목이 누락되었는지 확인하고 matchingValue를 무시합니다.

comparisonValue

string

비교할 값입니다.

연산자

다른 비교 유형 옵션

열거형
OPERATOR_UNSPECIFIED 연산자가 지정되지 않으면 EQUAL로 처리됩니다.
EQUAL 측정항목의 값이 비교 값과 정확히 같아야 합니다.
LESS_THAN 측정항목 값이 비교 값보다 작아야 합니다.
GREATER_THAN 측정항목의 값이 비교 값보다 커야 합니다.
IS_MISSING 측정항목이 누락되었는지 확인합니다. matchingValue는 고려하지 않습니다.

OrderBy

정렬 옵션을 지정합니다.

JSON 표현 
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
입력란
fieldName

string

정렬 기준이 되는 필드입니다. 기본 정렬 순서는 오름차순입니다. 예: ga:browser 여기서 정렬에는 필드를 하나만 지정할 수 있습니다. 예를 들어 ga:browser, ga:city는 유효하지 않습니다.

orderType

enum(OrderType)

주문 유형입니다. 기본 orderType은 VALUE입니다.

sortOrder

enum(SortOrder)

필드의 정렬 순서입니다.

OrderType

OrderType은 정렬 순서가 결정되는 방식을 제어합니다.

열거형
ORDER_TYPE_UNSPECIFIED 지정되지 않은 순서 유형은 값을 기준으로 한 정렬로 처리됩니다.
VALUE 정렬 순서는 선택한 열의 값을 기준으로 하며 첫 번째 기간만 확인합니다.
DELTA 정렬 순서는 처음 두 기간 사이에 선택한 열의 값 차이를 기준으로 합니다. 정확히 두 개의 기간이 있는 경우에만 사용할 수 있습니다.
SMART 정렬 순서는 선택한 열의 가중치가 적용된 값을 기준으로 합니다. 열에 n/d 형식이 있는 경우 이 비율의 가중치 값은 (n + totals.n)/(d + totals.d)이 됩니다. 비율을 나타내는 측정항목에만 사용할 수 있습니다.
HISTOGRAM_BUCKET 히스토그램 순서 유형은 비어 있지 않은 히스토그램 버킷이 있는 측정기준 열에만 적용할 수 있습니다.
DIMENSION_AS_INTEGER 크기가 고정된 숫자인 경우 일반 정렬을 사용해도 됩니다. 측정기준이 가변 길이 숫자인 경우 DIMENSION_AS_INTEGER를 사용할 수 있습니다.

SortOrder

정렬 순서입니다.

열거형
SORT_ORDER_UNSPECIFIED 정렬 순서가 지정되지 않은 경우 기본값은 오름차순입니다.
ASCENDING 오름차순 정렬 필드가 오름차순으로 정렬됩니다.
DESCENDING 내림차순 정렬입니다. 필드가 내림차순으로 정렬됩니다.

세그먼트

세그먼트 정의(보고서를 분류해야 하는 경우) 세그먼트는 애널리틱스 데이터의 하위 집합입니다. 예를 들어 전체 사용자 집합 중에서 특정 국가 또는 도시의 사용자가 될 수 있습니다.

JSON 표현 
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
입력란
통합 필드 dynamicOrById. 세그먼트는 DynamicSegment를 사용하거나 기본 제공 또는 맞춤 세그먼트의 ID를 사용하여 동적으로 정의할 수 있습니다. dynamicOrById은 다음 중 하나여야 합니다.
dynamicSegment

object(DynamicSegment)

요청의 동적 세그먼트 정의입니다.

segmentId

string

기본 제공 또는 맞춤 세그먼트의 세그먼트 ID입니다(예: gaid::-3).

DynamicSegment

요청 내에서 세그먼트를 정의하기 위한 동적 세그먼트 정의입니다. 세그먼트는 사용자, 세션 또는 둘 다를 선택할 수 있습니다.

JSON 표현 
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
입력란
name

string

동적 세그먼트의 이름입니다.

userSegment

object(SegmentDefinition)

세그먼트에 포함할 사용자를 선택하는 사용자 세그먼트입니다.

sessionSegment

object(SegmentDefinition)

세션 세그먼트: 세그먼트에 포함할 세션을 선택합니다.

SegmentDefinition

SegmentDefinition은 논리적 AND 연산과 함께 결합된 SegmentFilters 집합으로 세그먼트를 정의합니다.

JSON 표현 
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
입력란
segmentFilters[]

object(SegmentFilter)

세그먼트는 논리적 AND 연산과 함께 결합된 세그먼트 필터의 집합으로 정의됩니다.

SegmentFilter

SegmentFilter는 단순 세그먼트 또는 시퀀스 세그먼트를 정의합니다. 간단한 세그먼트 조건에는 세션 또는 사용자를 선택하기 위한 측정기준 및 측정항목 조건이 포함됩니다. 시퀀스 세그먼트 조건을 사용하여 순차 조건을 기반으로 사용자 또는 세션을 선택할 수 있습니다.

JSON 표현 
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
입력란
not

boolean

true이면 단순 세그먼트 또는 시퀀스 세그먼트의 보완을 매칭합니다. 예를 들어 '뉴욕'에서 발생하지 않은 모든 방문을 일치시키려면 다음과 같이 세그먼트를 정의할 수 있습니다.

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

통합 필드 simpleOrSequence. 단순한 세그먼트인가요, 시퀀스 세그먼트 정의인가요? simpleOrSequence은 다음 중 하나여야 합니다.
simpleSegment

object(SimpleSegment)

단순 세그먼트 조건은 조합할 수 있는 하나 이상의 측정기준/측정항목 조건으로 구성됩니다.

sequenceSegment

object(SequenceSegment)

시퀀스 조건은 하나 이상의 단계로 구성되며, 각 단계는 하나 이상의 측정기준/측정항목 조건으로 정의됩니다. 여러 단계를 특수 시퀀스 연산자와 결합할 수 있습니다.

SimpleSegment

단순 세그먼트 조건은 조합할 수 있는 하나 이상의 측정기준/측정항목 조건으로 구성됩니다.

JSON 표현 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
입력란
orFiltersForSegment[]

object(OrFiltersForSegment)

논리적 AND 연산자와 결합된 세그먼트 필터 그룹의 목록입니다.

OrFiltersForSegment

OR 그룹의 세그먼트 필터 목록은 논리적 OR 연산자와 결합됩니다.

JSON 표현 
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
입력란
segmentFilterClauses[]

object(SegmentFilterClause)

OR 연산자와 결합할 세그먼트 필터의 목록입니다.

SegmentFilterClause

세그먼트 정의에서 사용되는 필터 절은 측정항목 또는 측정기준 필터와 함께 사용될 수 있습니다.

JSON 표현 
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
입력란
not

boolean

필터의 보완 (!)과 일치합니다.

통합 필드 dimensionOrMetricFilter. 측정기준 또는 측정항목 필터 dimensionOrMetricFilter은 다음 중 하나여야 합니다.
dimensionFilter

object(SegmentDimensionFilter)

세그먼트 정의를 위한 측정기준 필터

metricFilter

object(SegmentMetricFilter)

세그먼트 정의에 대한 측정항목 필터입니다.

SegmentDimensionFilter

측정기준 필터는 측정기준의 필터링 옵션을 지정합니다.

JSON 표현 
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
입력란
dimensionName

string

필터가 적용되는 측정기준의 이름입니다.

operator

enum(Operator)

측정기준과 표현식을 일치시키는 데 사용하는 연산자입니다.

caseSensitive

boolean

일치 항목이 대소문자를 구분해야 하며 IN_LIST 연산자의 경우 무시됩니다.

expressions[]

string

표현식 목록이며 모든 연산자에 첫 번째 요소만 사용됩니다.

minComparisonValue

string

BETWEEN 검색 유형의 최소 비교 값입니다.

maxComparisonValue

string

BETWEEN 검색 유형의 최대 비교 값입니다.

연산자

다양한 일치 유형이 지원됩니다.

열거형
OPERATOR_UNSPECIFIED 일치 유형을 지정하지 않으면 REGEXP로 처리됩니다.
REGEXP 일치 표현식은 정규 표현식으로 처리됩니다. 다른 모든 검색 유형은 정규 표현식으로 취급되지 않습니다.
BEGINS_WITH 제공된 일치 표현식으로 시작하는 값과 일치합니다.
ENDS_WITH 제공된 일치 표현식으로 끝나는 값과 일치합니다.
PARTIAL 하위 문자열 일치.
EXACT 값은 일치 표현식과 완전히 일치해야 합니다.
IN_LIST

이 옵션은 표현식이 선택된 값 목록에서 값을 가져올 수 있는 측정기준 필터를 지정하는 데 사용됩니다. 이렇게 하면 모든 단일 응답 행에 대해 OR로 연결된 여러 개의 일치검색 측정기준 필터를 평가하는 것을 방지할 수 있습니다. 예를 들면 다음과 같습니다.

expressions: ["A", "B", "C"]

측정기준 값이 A, B 또는 C인 응답 행은 이 DimensionFilter와 일치합니다.
NUMERIC_LESS_THAN

정수 비교 필터입니다. 이러한 필터의 대소문자 구분은 무시되며 표현식은 정수를 나타내는 문자열로 간주됩니다. 실패 조건:

  • 표현식이 유효한 int64가 아닌 경우 클라이언트에 오류가 발생합니다.
  • 유효한 int64 값이 아닌 입력 측정기준은 필터와 일치하지 않습니다.

측정기준이 일치 표현식보다 숫자적으로 작은지 확인합니다.
NUMERIC_GREATER_THAN 측정기준이 일치 표현식보다 큰 숫자인지 확인합니다.
NUMERIC_BETWEEN 측정기준이 일치 표현식의 최솟값과 최댓값 사이의 숫자인지 확인합니다. 경계는 제외됩니다.

SegmentMetricFilter

세그먼트 필터 절에 사용할 측정항목 필터입니다.

JSON 표현 
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
입력란
scope

enum(Scope)

측정항목의 범위는 측정항목이 정의되는 수준을 정의합니다. 지정된 측정항목 범위는 데이터 모델에 정의된 기본 범위와 같거나 그보다 커야 합니다. 기본 범위는 세그먼트가 사용자 또는 세션을 선택하는지 여부에 따라 정의됩니다.

metricName

string

필터링의 기준이 되는 측정항목입니다. metricFilter에는 측정항목 이름이 포함되어야 합니다.

operator

enum(Operator)

측정항목을 비교하기 위해 수행할 작업을 지정합니다. 기본값은 EQUAL입니다.

comparisonValue

string

비교할 값입니다. 연산자가 BETWEEN이면 이 값은 최소 비교 값으로 처리됩니다.

maxComparisonValue

string

최댓값 비교 값은 BETWEEN 연산자에만 사용됩니다.

범위

측정항목의 범위는 측정항목이 정의되는 수준(PRODUCT, HIT, SESSION, USER)을 정의합니다. 측정항목 값은 기본 범위보다 큰 범위에서 보고될 수도 있습니다. 예: ga:pageviews 및 ga:transactions는 해당 세션에서 발생하는 각 조회나 사용자에 대해 합산되기만 하면 SESSION 및 USER 수준에서 보고될 수 있습니다.

열거형
UNSPECIFIED_SCOPE 범위를 지정하지 않으면 세그먼트가 사용자 또는 세션을 선택하려고 하는지 여부에 따라 조건 범위(USER 또는 SESSION)가 기본값으로 설정됩니다.
PRODUCT 제품 범위입니다.
HIT 조회 범위
SESSION 세션 범위입니다.
USER 사용자 범위입니다.

연산자

다른 비교 유형 옵션

열거형
UNSPECIFIED_OPERATOR 지정되지 않은 연산자는 LESS_THAN 연산자로 처리됩니다.
LESS_THAN 측정항목 값이 비교 값보다 작은지 확인합니다.
GREATER_THAN 측정항목 값이 비교 값보다 큰지 확인합니다.
EQUAL 같음 연산자입니다.
BETWEEN 사이 연산자의 경우 최솟값과 최댓값은 모두 제외됩니다. 비교를 위해 LT와 GT를 사용합니다.

SequenceSegment

시퀀스 조건은 하나 이상의 단계로 구성되며, 각 단계는 하나 이상의 측정기준/측정항목 조건으로 정의됩니다. 여러 단계를 특수 시퀀스 연산자와 결합할 수 있습니다.

JSON 표현 
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
입력란
segmentSequenceSteps[]

object(SegmentSequenceStep)

시퀀스의 단계 목록입니다.

firstStepShouldMatchFirstHit

boolean

설정하는 경우 1단계 조건이 기간 내 방문자의 첫 번째 조회와 일치해야 합니다.

SegmentSequenceStep

세그먼트 시퀀스 정의입니다.

JSON 표현 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
입력란
orFiltersForSegment[]

object(OrFiltersForSegment)

시퀀스는 AND 연산자와 결합된 OR 그룹화된 필터의 목록을 사용하여 지정됩니다.

matchType

enum(MatchType)

단계가 다음 단계 바로 앞에 오는지 아니면 그 이전 단계이든 상관없습니다.

MatchType

시퀀스의 검색 유형입니다.

열거형
UNSPECIFIED_MATCH_TYPE 검색 유형을 지정하지 않으면 선행으로 처리됩니다.
PRECEDES 연산자는 이전 단계가 다음 단계 앞에 있음을 나타냅니다.
IMMEDIATELY_PRECEDES 연산자는 이전 단계가 다음 단계 직전에 있음을 나타냅니다.

피벗

피벗은 요청의 피벗 섹션을 설명합니다. 피벗을 사용하면 두 번째 측정기준을 기준으로 데이터를 피봇팅하여 일부 보고서에서 표에 있는 정보를 재정렬할 수 있습니다.

JSON 표현 
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
입력란
dimensions[]

object(Dimension)

피벗 열로 표시할 측정기준 목록입니다. 피벗에는 최대 4개의 측정기준을 포함할 수 있습니다. 피벗 측정기준은 요청에서 허용되는 총 측정기준 수에 관한 제한사항의 일부입니다.

dimensionFilterClauses[]

object(DimensionFilterClause)

DimensionFilterClauses는 논리적으로 AND 연산자와 결합됩니다. 이러한 모든 DimensionFilterClauses에 포함된 데이터만 이 피벗 영역의 값에 기여합니다. 측정기준 필터를 사용하여 피벗 영역에 표시되는 열을 제한할 수 있습니다. 예를 들어 피벗 지역에 요청된 측정기준으로 ga:browser가 있고, ga:browser을 'IE' 또는 'Firefox'로만 제한하도록 키 필터를 지정하면 이 두 브라우저만 열로 표시됩니다.

metrics[]

object(Metric)

피벗 측정항목 피벗 측정항목은 요청에서 허용되는 총 측정항목 수에 관한 제한사항의 일부입니다.

startGroup

number

k개의 측정항목이 요청되면 응답에 k개의 열 k개의 일부 데이터 종속 배수가 보고서에 포함됩니다. 예를 들어 측정기준 ga:browser을 기준으로 피봇팅한 경우 'Firefox'의 경우 k개의 열, 'IE'의 경우 k개의 열, 'Chrome'의 경우 k개의 열이 생깁니다. 열 그룹의 순서는 첫 번째 k개의 값인 'total'의 내림차순에 따라 결정됩니다. 첫 번째 피벗 차원의 사전순 순서 다음에 두 번째 피벗 차원의 사전순 순서 등으로 연결이 끊어집니다. 예를 들어 Firefox, IE 및 Chrome에 대한 첫 번째 값의 총계가 각각 8, 2, 8인 경우 열 순서는 Chrome, Firefox, IE가 됩니다.

다음을 사용하면 k개의 열 그룹 중 어느 그룹을 응답에 포함할지 선택할 수 있습니다.
maxGroupCount

number

반환할 최대 그룹 수를 지정합니다. 기본값은 10이고 최댓값은 1,000입니다.

CohortGroup

동질 집단 그룹을 정의합니다. 예를 들면 다음과 같습니다.

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
JSON 표현 
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
입력란
cohorts[]

object(Cohort)

동질 집단의 정의입니다.

lifetimeValue

boolean

평생 가치 (LTV)를 사용 설정합니다. LTV는 다양한 채널을 통해 획득한 사용자의 평생 가치를 측정합니다. 동질 집단 분석 및 평생 가치를 참고하세요. 평생 가치의 값이 false인 경우:

  • 측정항목 값은 웹 인터페이스 동질 집단 보고서의 값과 비슷합니다.
  • 동질 집단 정의 기간은 캘린더 주와 월에 맞게 조정해야 합니다. 즉, ga:cohortNthWeek를 요청하는 동안 동질 집단 정의의 startDate는 일요일, endDate은 다음 토요일이어야 하며, ga:cohortNthMonth의 경우 startDate은 월의 1일, endDate는 마지막 날이어야 합니다.

lifeValue가 true인 경우:

  • 측정항목 값은 웹 인터페이스 평생 가치 보고서의 값에 해당합니다.
  • 평생 가치 보고서에서는 사용자 가치 (수익)와 참여도 (앱 조회수, 목표 달성 횟수, 세션수, 세션 시간)가 사용자 획득 후 90일 동안 어떻게 증가하는지 보여줍니다.
  • 측정항목은 시간 증분마다 사용자당 누적 평균으로 계산됩니다.
  • 동질 집단 정의 기간은 캘린더의 주 및 월 경계에 맞춰 조정할 필요가 없습니다.
  • viewId는 앱 보기 ID여야 합니다.

동질 집단

동질 집단을 정의합니다. 동질 집단은 공통된 특징을 지닌 사용자 그룹입니다. 예를 들어 획득 날짜가 동일한 모든 사용자는 동일한 동질 집단에 속합니다.

JSON 표현 
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
입력란
name

string

동질 집단의 고유한 이름입니다. 정의되지 않은 이름은 cohort_[1234...] 값으로 자동 생성됩니다.

type

enum(Type)

동질 집단의 유형입니다. 현재 지원되는 유일한 유형은 FIRST_VISIT_DATE입니다. 이 필드가 지정되지 않으면 동질 집단이 FIRST_VISIT_DATE 유형 동질 집단으로 간주됩니다.

dateRange

object(DateRange)

이는 FIRST_VISIT_DATE 동질 집단에 사용되며, 동질 집단은 첫 방문 날짜가 기간에서 정의된 시작일과 종료일 사이에 있는 사용자를 선택합니다. 동질 집단 요청에 따라 기간을 조정해야 합니다. 요청에 ga:cohortNthDay가 포함된 경우 정확히 1일이어야 하고 ga:cohortNthWeek인 경우 주 경계 (일요일부터 토요일로 종료)에 맞게 정렬되어야 하며 ga:cohortNthMonth의 경우 기간을 월 (첫 번째 날짜에 시작하고 월의 마지막 날에 종료)과 맞춰야 합니다. LTV 요청의 경우 이러한 제한이 없습니다. reportsRequest.dateRanges 필드에는 기간을 제공하지 않아도 됩니다.

유형

동질 집단 유형입니다.

열거형
UNSPECIFIED_COHORT_TYPE 지정하지 않으면 FIRST_VISIT_DATE로 처리됩니다.
FIRST_VISIT_DATE 첫 방문 날짜를 기준으로 선택된 동질 집단입니다.

신고

요청에 해당하는 데이터 응답입니다.

JSON 표현 
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
입력란
columnHeader

object(ColumnHeader)

열 헤더입니다.

data

object(ReportData)

응답 데이터입니다.

nextPageToken

string

목록에서 다음 결과 페이지를 가져오는 페이지 토큰입니다.

ColumnHeader

열 헤더.

JSON 표현 
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
입력란
dimensions[]

string

응답의 측정기준 이름입니다.

metricHeader

object(MetricHeader)

응답의 측정항목에 대한 측정항목 헤더입니다.

MetricHeader

측정항목의 헤더입니다.

JSON 표현 
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
입력란
metricHeaderEntries[]

object(MetricHeaderEntry)

응답의 측정항목에 대한 헤더입니다.

pivotHeaders[]

object(PivotHeader)

응답의 피벗에 대한 헤더입니다.

MetricHeaderEntry

측정항목의 헤더입니다.

JSON 표현 
{
  "name": string,
  "type": enum(MetricType)
}
입력란
name

string

헤더의 이름입니다.

type

enum(MetricType)

측정항목의 유형입니다(예: INTEGER).

PivotHeader

요청에 정의된 각 피벗 섹션의 헤더입니다.

JSON 표현 
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
입력란
pivotHeaderEntries[]

object(PivotHeaderEntry)

단일 피벗 섹션 헤더입니다.

totalPivotGroupsCount

number

이 피벗의 총 그룹 수입니다.

PivotHeaderEntry

응답의 피봇 섹션에서 요청된 측정항목에 해당하는 각 측정항목 열의 헤더입니다.

JSON 표현 
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
입력란
dimensionNames[]

string

피벗 응답의 측정기준 이름입니다.

dimensionValues[]

string

피벗의 측정기준 값입니다.

metric

object(MetricHeaderEntry)

피벗에 있는 측정항목의 측정항목 헤더입니다.

ReportData

보고서의 데이터 부분입니다.

JSON 표현 
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
입력란
rows[]

object(ReportRow)

고유한 측정기준 조합마다 하나의 ReportRow가 있습니다.

totals[]

object(DateRangeValues)

요청된 각 기간에 대해 쿼리와 일치하는 모든 행 집합에 대해 요청된 모든 값 형식은 합계를 가져옵니다. 값 형식의 총계는 먼저 값 형식에 언급된 측정항목의 합계를 구한 다음 값 형식을 스칼라 표현식으로 평가하여 계산됩니다. 예: 3 / (ga:sessions + 2)의 '총계'는 3 / ((sum of all relevant ga:sessions) + 2)를 계산합니다. 총계는 페이지로 나누기 전에 계산됩니다.

rowCount

number

이 쿼리와 일치하는 총 행 수입니다.

minimums[]

object(DateRangeValues)

일치하는 모든 행에 표시되는 최솟값과 최댓값입니다. 요청의 hideValueRanges가 false인 경우 또는 rowCount가 0인 경우 모두 비어 있습니다.

maximums[]

object(DateRangeValues)

일치하는 모든 행에 표시되는 최솟값과 최댓값입니다. 요청의 hideValueRanges가 false인 경우 또는 rowCount가 0인 경우 모두 비어 있습니다.

samplesReadCounts[]

string (int64 format)

결과가 샘플링되면 읽은 총 샘플 수(날짜 범위당 항목 1개)가 반환됩니다. 결과가 샘플링되지 않으면 이 필드가 정의되지 않습니다. 자세한 내용은 개발자 가이드를 참고하세요.

samplingSpaceSizes[]

string (int64 format)

결과가 샘플링된 경우 존재하는 샘플의 총개수(날짜 범위당 항목 1개)가 반환됩니다. 결과가 샘플링되지 않으면 이 필드가 정의되지 않습니다. 자세한 내용은 개발자 가이드를 참고하세요.

isDataGolden

boolean

이 요청에 대한 응답의 골든 여부를 나타냅니다. 정확히 동일한 요청이 나중에 요청되더라도 새로운 결과를 생성하지 않는 경우 데이터가 황금입니다.

dataLastRefreshed

string (Timestamp format)

보고서의 데이터를 마지막으로 새로고침한 시간입니다. 이 타임스탬프 이전에 수신된 모든 조회가 보고서 계산에 포함됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프로 정밀도는 나노초 수준입니다. 예: "2014-10-02T15:01:23.045123456Z"

ReportRow

보고서의 행입니다.

JSON 표현 
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
입력란
dimensions[]

string

요청된 측정기준의 목록입니다.

metrics[]

object(DateRangeValues)

요청된 각 기간의 측정항목 목록입니다.

DateRangeValues

단일 기간 / 측정기준 조합에 대한 측정항목 목록을 반환하는 데 사용됩니다.

JSON 표현 
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
입력란
values[]

string

각 값은 요청의 각 측정항목에 해당합니다.

pivotValueRegions[]

object(PivotValueRegion)

각 피벗 영역의 값입니다.

PivotValueRegion

피벗 지역의 측정항목 값입니다.

JSON 표현 
{
  "values": [
    string
  ]
}
입력란
values[]

string

각 피벗 지역의 측정항목 값입니다.

ResourceQuotasRemaining

요청이 완료된 후 속성에 남아 있는 리소스 할당량 토큰입니다.

JSON 표현 
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
입력란
dailyQuotaTokensRemaining

number

남은 일일 리소스 할당량입니다.

hourlyQuotaTokensRemaining

number

시간별 리소스 할당량 토큰이 남아 있습니다.

사용해 보기