Reports: generate

승인 필요

검색어 매개변수에서 전송한 보고서 요청을 바탕으로 애드센스 보고서를 생성합니다. JSON 형식으로 결과를 반환합니다. CSV 형식으로 출력을 검색하려면 'alt=csv'를 검색어 매개변수로 지정합니다. 직접 해보기

요청

HTTP 요청

GET https://www.googleapis.com/adsensehost/v4.1/reports

매개변수

매개변수 이름 설명
필수 매개변수
endDate string 'YYYY-MM-DD' 형식의 보고서 기간 종료일(이 날짜를 기간에 포함)
startDate string 'YYYY-MM-DD' 형식의 보고서 기간 시작일(이 날짜를 기간에 포함)
선택 매개변수
dimension string

보고서의 기초가 되는 측정기준. 다음과 같은 측정기준을 사용할 수 있습니다.

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string 보고서에서 실행할 필터
locale string 보고서 출력물을 현지 언어로 번역할 때 사용할 선택 언어. 지정하지 않으면 기본값인 'en_US'가 사용됩니다.
maxResults unsigned integer

반환할 보고서 데이터의 최대 행 수입니다.

startIndex가 설정하지 않은 상태이거나 0이면 API에서 maxResults 값에 의해 지정된 수만큼 행을 반환합니다. maxResults가 설정되지 않으면 최대 50,000행 내에서 해당되는 모든 행이 반환됩니다.

startIndex가 0 이외의 값으로 설정되는 경우 startIndexmaxResults의 합계는 5,000을 넘을 수 없습니다. 이 수치를 넘을 경우 5,000개를 초과하는 페이지는 지원되지 않는다는 내용의 오류가 반환됩니다.

사용 가능한 값: 0~50000
metric string 보고서에 포함할 숫자 항목입니다. 다음과 같은 측정항목을 사용할 수 있습니다.
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

결과 보고서를 정렬할 측정기준 또는 측정항목 이름입니다(오름차순 정렬 시 '+' 프리픽스 설정, 내림차순 정렬 시 '-' 프리픽스 설정). 프리픽스가 지정되지 않으면 항목이 오름차순으로 정렬됩니다.

다음은 측정기준과 측정항목의 결합입니다.

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

반환할 보고서 데이터의 첫 번째 행입니다.

startIndex가 설정하지 않은 상태이거나 0이면 API에서 maxResults 값에 의해 지정된 수만큼 행을 반환합니다. maxResults가 설정되지 않으면 최대 50,000행 내에서 해당되는 모든 행이 반환됩니다.

startIndex가 0 이외의 값으로 설정되는 경우 startIndexmaxResults의 합계는 5,000을 넘을 수 없습니다. 이 수치를 넘을 경우 5,000개를 초과하는 페이지는 지원되지 않는다는 내용의 오류가 반환됩니다.

사용 가능한 값: 0~5000

승인

이 요청을 처리하려면 아래 범위 중 하나 이상에서 승인을 받아야 합니다(인증 및 승인에 대해 자세히 알아보기).

범위
https://www.googleapis.com/auth/adsensehost

요청 본문

요청 본문에서 이 메소드를 사용하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
속성 이름 설명 참고
kind string 목록의 유형(이 경우 adsensehost#report)
totalMatchedRows long 보고서 요청과 일치하는 총 행 수입니다. 요청된 행의 수 또는 보고서 행 수 한도에 따라 응답에서 일부 행만 반환될 수 있습니다.
headers[] list 보고서 연산에서 요청된 항목의 헤더 정보입니다. 헤더의 목록으로 요청된 각 측정기준 및 보고서의 각 측정항목에 대해 헤더가 하나씩 포함됩니다.
headers[].name string 헤더의 이름입니다.
headers[].type string 헤더의 유형으로, DIMENSION, METRIC_TALLY, METRIC_RATIO 또는 METRIC_CURRENCY 중 하나입니다.
headers[].currency string 이 항목의 통화 단위입니다. 헤더 유형이 METRIC_CURRENCY인 경우에만 표시됩니다.
rows[] list 보고서 연산의 결과 행입니다. 각 행은 셀의 목록입니다. 한 행에 요청의 측정기준 하나가 들어가고, 그 다음 행에 요청의 측정항목 하나가 들어갑니다. 측정기준 셀에는 문자열이 포함되고, 측정항목 셀에는 숫자가 포함됩니다.
totals[] list 보고서의 총 합계입니다. 보고서의 다른 행과 동일한 길이로, 측정기준에 해당하는 셀은 빈 값입니다.
averages[] list 보고서의 평균입니다. 보고서의 다른 행과 동일한 길이로, 측정기준에 해당하는 셀은 빈 값입니다.
warnings[] list 보고서 생성 시 발생한 경고 메시지입니다.

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
속성 이름 설명 참고
(dynamic)"> (dynamic) (any)

직접 해보기

아래의 API Explorer를 이용해 실제 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.