Method: properties.audienceLists.query

사용자의 잠재고객 목록을 검색합니다. 잠재고객을 만든 후에 이 사용자를 목록에 바로 등록할 수는 없습니다. 먼저 사용자의 잠재고객 목록을 만들려면 audienceLists.create에 요청해야 합니다. 그런 다음 이 메서드는 잠재고객 목록에 있는 사용자를 검색하는 데 사용됩니다.

잠재고객 목록에 대한 소개와 예제는 잠재고객 목록 만들기를 참조하세요.

Google 애널리틱스 4의 잠재고객을 사용하면 비즈니스에 중요한 방식으로 사용자를 분류할 수 있습니다. 자세한 내용은 https://support.google.com/analytics/answer/9267572를 참고하세요.

이 메서드는 audienceExports.query에서 베타 안정성으로 제공됩니다. 이 API에 대한 의견을 제공하려면 Google 애널리틱스 Audience Export API 의견 양식을 작성하세요.

HTTP 요청

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

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

경로 매개변수

매개변수
name

string

필수 항목입니다. 사용자를 가져올 잠재고객 목록의 이름입니다. 형식: properties/{property}/audienceLists/{audienceList}

요청 본문

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

JSON 표현 
{
  "offset": string,
  "limit": string
}
필드
offset

string (int64 format)

선택사항입니다. 시작 행의 행 수입니다. 첫 번째 행은 0행으로 계산됩니다.

페이징할 때 첫 번째 요청은 오프셋을 지정하지 않습니다. 또는 이와 동등하게 오프셋을 0으로 설정합니다. 첫 번째 요청은 행의 처음 limit를 반환합니다. 두 번째 요청은 첫 번째 요청의 limit로 오프셋을 설정합니다. 두 번째 요청은 행의 두 번째 limit를 반환합니다.

페이지로 나누기 매개변수에 관한 자세한 내용은 페이지로 나누기를 참고하세요.
limit

string (int64 format)

선택사항입니다. 반환할 행의 개수입니다. 지정하지 않으면 10,000행이 반환됩니다. API는 요청 수에 관계없이 요청당 최대 250,000개의 행을 반환합니다. limit 값은 양수여야 합니다.

측정기준 값이 limit만큼 많지 않은 경우 API는 요청된 limit보다 적은 수의 행을 반환할 수도 있습니다.

페이지로 나누기 매개변수에 관한 자세한 내용은 페이지로 나누기를 참고하세요.

응답 본문

잠재고객 목록의 사용자 목록입니다.

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

JSON 표현 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
필드
audienceRows[]

object (AudienceRow)

잠재고객 목록에 있는 각 사용자의 행입니다. 이 응답의 행 수는 요청의 페이지 크기보다 작거나 같습니다.
audienceList

object (AudienceList)

쿼리되는 AudienceList에 대한 구성 데이터입니다. 이 응답의 잠재고객 행을 해석하기 위해 반환됩니다. 예를 들어 이 AudienceList의 측정기준은 AudienceRows의 열에 해당합니다.
rowCount

integer

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

페이지로 나누기 매개변수에 관한 자세한 내용은 페이지로 나누기를 참고하세요.

승인 범위

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

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

AudienceRow

잠재고객 사용자 행의 측정기준 값 속성입니다.

JSON 표현 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
필드
dimensionValues[]

object (AudienceDimensionValue)

잠재고객 사용자의 각 측정기준 값 속성입니다. 요청된 각 측정기준 열에 대해 하나의 측정기준 값이 추가됩니다.

AudienceDimensionValue

측정기준의 값입니다.

JSON 표현 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
필드
통합 필드 one_value. 측정기준 값의 한 가지 종류입니다. one_value은 다음 중 하나여야 합니다.
value

string

측정기준 유형이 문자열인 경우 문자열인 값입니다.