REST Resource: properties.audienceLists

리소스: AudienceList

잠재고객 목록은 목록 생성 시점의 잠재고객에 속한 사용자 목록입니다. 한 잠재고객에 서로 다른 날짜에 대해 생성된 여러 잠재고객 목록이 있을 수 있습니다.

JSON 표현 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
필드
name

string

출력 전용입니다. 식별자. 생성 중에 할당된 잠재고객 목록 리소스 이름입니다. 이 리소스 이름은 이 AudienceList을 식별합니다.

형식: properties/{property}/audienceLists/{audienceList}
audience

string

필수입니다. 잠재고객 리소스 이름입니다. 이 리소스 이름은 나열되는 잠재고객을 식별하며 애널리틱스 데이터 및 관리 API 간에 공유됩니다.

형식: properties/{property}/audiences/{audience}
audienceDisplayName

string

출력 전용입니다. 이 잠재고객의 설명이 포함된 표시 이름입니다. 예: '구매자'
dimensions[]

object (AudienceDimension)

필수입니다. 요청되고 쿼리 응답에 표시되는 측정기준입니다.
creationQuotaTokensCharged

integer

출력 전용입니다. AudienceList 생성 중에 청구된 총 할당량 토큰입니다. 이 토큰 수는 CREATING 상태의 활동을 기반으로 하므로 AudienceList가 ACTIVE 또는 FAILED 상태로 전환되면 청구되는 토큰 수가 고정됩니다.
state

enum (State)

출력 전용입니다. 이 AudienceList의 현재 상태입니다.
beginCreatingTime

string (Timestamp format)

출력 전용입니다. audienceLists.create가 호출되고 AudienceList가 CREATING 상태를 시작한 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
rowCount

integer

출력 전용입니다. AudienceList 결과의 총 행 수입니다.
errorMessage

string

출력 전용입니다. 잠재고객 목록이 생성 중에 실패하면 오류 메시지가 채워집니다. 이러한 실패의 일반적인 이유는 할당량 소진입니다.
percentageCompleted

number

출력 전용입니다. 이 잠재고객 내보내기의 완료 비율입니다(0~100).
recurringAudienceList

string

출력 전용입니다. 이 잠재고객 목록을 만든 반복 잠재고객 목록입니다. 반복 잠재고객 목록은 매일 잠재고객 목록을 만듭니다.

잠재고객 목록이 직접 생성된 경우 연결된 반복 잠재고객 목록이 없으며 이 필드는 비어 있습니다.
webhookNotification

object (WebhookNotification)

선택사항입니다. Google 애널리틱스 Data API에서 웹훅 서버로 전송되는 웹훅 알림을 구성합니다. 웹훅 사용은 선택사항입니다. 사용하지 않는 경우 이 API를 폴링하여 잠재고객 목록을 사용할 준비가 되었는지 확인해야 합니다. 웹훅을 사용하면 서버에 알림을 전송하고 폴링할 필요가 없습니다.

웹훅으로 POST 요청이 하나 또는 두 개 전송됩니다. 첫 번째 POST 요청이 즉시 전송되어 새로 생성된 잠재고객 목록이 CREATING 상태로 표시됩니다. 두 번째 POST 요청은 잠재고객 목록 생성이 완료된 후 (ACTIVE 또는 FAILED 상태) 전송됩니다.

동일한 잠재고객 목록이 연속으로 요청되면 두 번째 및 후속 잠재고객 목록은 캐시에서 제공될 수 있습니다. 이 경우 잠재고객 목록 생성 메서드는 잠재고객 목록이 이미 활성 상태임을 반환할 수 있습니다. 이 시나리오에서는 웹훅에 하나의 POST 요청만 전송됩니다.

주

AudienceList가 현재 이 상태로 존재합니다.

열거형
STATE_UNSPECIFIED 지정되지 않은 상태는 사용되지 않습니다.
CREATING AudienceList가 현재 생성 중이며 향후 제공될 예정입니다. 생성은 audienceLists.create 호출 직후에 발생합니다.
ACTIVE AudienceList가 완전히 생성되어 쿼리할 준비가 되었습니다. AudienceList는 요청에서 비동기식으로 활성 상태로 업데이트됩니다. 이는 초기 생성 호출 후 일정 시간 (예: 15분)이 지나면 발생합니다.
FAILED AudienceList를 만들 수 없습니다. 이 잠재고객 목록을 다시 요청하면 성공할 수 있습니다.

메서드

create

 나중에 검색할 수 있는 잠재고객 목록을 만듭니다.

get

 특정 잠재고객 목록에 관한 구성 메타데이터를 가져옵니다.

list

 속성의 모든 잠재고객 목록을 나열합니다.

query

 사용자의 잠재고객 목록을 가져옵니다.