Reports

이 리소스에 대한 메소드 목록은 이 페이지의 하단에 나와 있습니다.

리소스 표현

DoubleClick Search 보고서 이 객체에는 보고서 요청, 통화 코드 등의 일부 보고서 메타데이터, 생성된 보고서 행 또는 보고서 파일이 포함됩니다.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "reportScope": {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "adGroupId": long,
      "keywordId": long,
      "adId": long
    },
    "reportType": string,
    "columns": [
      {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      }
    ],
    "timeRange": {
      "startDate": string,
      "endDate": string,
      "changedMetricsSinceTimestamp": datetime,
      "changedAttributesSinceTimestamp": datetime
    },
    "filters": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "operator": string,
        "values": [
          (value)
        ]
      }
    ],
    "orderBy": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "sortOrder": string
      }
    ],
    "includeDeletedEntities": boolean,
    "includeRemovedEntities": boolean,
    "verifySingleTimeZone": boolean,
    "downloadFormat": string,
    "statisticsCurrency": string,
    "startRow": integer,
    "rowCount": integer,
    "maxRowsPerFile": integer
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}
숙소 이름 설명 메모
files[] list 비동기 보고서에만 해당합니다. 보고서가 성공적으로 완료되면 생성된 보고서 파일 목록이 포함됩니다.
files[].byteCount long 이 보고서 파일의 크기(바이트)입니다.
files[].url string 이 URL을 사용하여 보고서 파일을 다운로드하세요.
id string 비동기 보고서에만 해당합니다. 보고서의 ID입니다.
isReportReady boolean 비동기 보고서에만 해당합니다. 보고서가 정상적으로 완료되고 보고서 파일을 다운로드할 수 있는 경우에만 true입니다.
kind string 이를 보고서 리소스로 식별합니다. 값은 고정 문자열 doubleclicksearch#report입니다.
request nested object 보고서를 생성한 요청입니다. 원래 요청에 지정되지 않은 선택적 필드는 기본값으로 채워집니다.
request.columns[] list 보고서에 포함할 열 여기에는 DoubleClick Search 열과 저장된 열이 모두 포함됩니다. DoubleClick Search 열의 경우 columnName 매개변수만 필요합니다. 저장된 열의 경우 savedColumnName 매개변수만 필요합니다. columnNamesavedColumnName을 동일한 스탠자에 설정할 수 없습니다.

요청당 최대 열 수는 300개입니다.

request.columns[].columnName string 보고서에 포함할 DoubleClick Search 열의 이름입니다.
request.columns[].customDimensionName string 맞춤 측정기준별로 보고서를 분류합니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정기준이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정기준 이름은 대소문자를 구분합니다.

전환 보고서에서 사용하는 경우 설정된 경우 지정된 전환에 대해 지정된 맞춤 측정기준의 값을 반환합니다. 이 열은 전환 보고서를 분류하지 않습니다.

request.columns[].customMetricName string 보고서에 포함할 맞춤 측정항목의 이름입니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정항목이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정항목 이름은 대소문자를 구분합니다.
request.columns[].endDate string YYYY-MM-DD 형식으로 된 날짜입니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. startDate과 함께 제공해야 합니다.
request.columns[].groupByColumn boolean 동기식 보고서만 이 열로 그룹화하려면 true로 설정합니다. 기본값은 false입니다.
request.columns[].headerText string 보고서 출력에서 이 열을 식별하는 데 사용되는 텍스트입니다. 지정되지 않은 경우 기본값은 columnName 또는 savedColumnName입니다. 이는 DoubleClick Search 열과 이름이 같은 저장된 열 간의 충돌을 방지하는 데 사용할 수 있습니다.
request.columns[].platformSource string 맞춤 측정기준에 데이터를 제공하는 데 사용되는 플랫폼입니다. 사용 가능한 값은 '플러드라이트'입니다.
request.columns[].productReportPerspective string 특정 유형의 제품 활동에 대한 측정항목만 반환합니다. 허용되는 값은 다음과 같습니다.
  • 'sold': 판매된 제품의 측정항목만 반환합니다.
  • 'advertised': 쇼핑 캠페인에서 광고되었으며 판매되었을 수도 있고 판매되지 않았을 수 있는 제품의 측정항목만 반환합니다.
request.columns[].savedColumnName string 보고서에 포함할 저장된 열의 이름입니다. 보고서의 범위를 광고주 이하로 지정해야 하며, 이렇게 저장된 열은 DoubleClick Search UI에서 미리 만들어 두어야 합니다.
request.columns[].startDate string YYYY-MM-DD 형식의 날짜를 포함합니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. endDate과 함께 제공해야 합니다.
request.downloadFormat string 보고서를 반환해야 하는 형식입니다. 현재 csv 또는 tsv가 지원됩니다.
request.filters[] list 보고서에 적용할 필터의 목록입니다.

요청당 최대 필터 수는 300입니다.

request.filters[].column nested object 필터를 수행할 열입니다. DoubleClick Search 열이거나 저장된 열일 수 있습니다.
request.filters[].column.columnName string 보고서에 포함할 DoubleClick Search 열의 이름입니다.
request.filters[].column.customDimensionName string 맞춤 측정기준별로 보고서를 분류합니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정기준이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정기준 이름은 대소문자를 구분합니다.

전환 보고서에서 사용하는 경우 설정된 경우 지정된 전환에 대해 지정된 맞춤 측정기준의 값을 반환합니다. 이 열은 전환 보고서를 분류하지 않습니다.

request.filters[].column.customMetricName string 보고서에 포함할 맞춤 측정항목의 이름입니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정항목이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정항목 이름은 대소문자를 구분합니다.
request.filters[].column.endDate string YYYY-MM-DD 형식으로 된 날짜입니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. startDate과 함께 제공해야 합니다.
request.filters[].column.groupByColumn boolean 동기식 보고서만 이 열로 그룹화하려면 true로 설정합니다. 기본값은 false입니다.
request.filters[].column.headerText string 보고서 출력에서 이 열을 식별하는 데 사용되는 텍스트입니다. 지정되지 않은 경우 기본값은 columnName 또는 savedColumnName입니다. 이는 DoubleClick Search 열과 이름이 같은 저장된 열 간의 충돌을 방지하는 데 사용할 수 있습니다.
request.filters[].column.platformSource string 맞춤 측정기준에 데이터를 제공하는 데 사용되는 플랫폼입니다. 사용 가능한 값은 '플러드라이트'입니다.
request.filters[].column.productReportPerspective string 특정 유형의 제품 활동에 대한 측정항목만 반환합니다. 허용되는 값은 다음과 같습니다.
  • 'sold': 판매된 제품의 측정항목만 반환합니다.
  • 'advertised': 쇼핑 캠페인에서 광고되었으며 판매되었을 수도 있고 판매되지 않았을 수 있는 제품의 측정항목만 반환합니다.
request.filters[].column.savedColumnName string 보고서에 포함할 저장된 열의 이름입니다. 보고서의 범위를 광고주 이하로 지정해야 하며, 이렇게 저장된 열은 DoubleClick Search UI에서 미리 만들어 두어야 합니다.
request.filters[].column.startDate string YYYY-MM-DD 형식의 날짜를 포함합니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. endDate과 함께 제공해야 합니다.
request.filters[].operator string 필터에서 사용할 연산자입니다. 사용 가능한 연산자 목록은 필터 참조를 확인하세요.
request.filters[].values[] list 열 값을 필터링할 값 목록입니다.

요청당 최대 필터 값은 300입니다.

request.includeDeletedEntities boolean 삭제된 항목을 보고서에 포함해야 하는지를 결정합니다. 기본값은 false입니다. 지원 중단되었습니다. 대신 includeRemovedEntities를 사용하세요.
request.includeRemovedEntities boolean 삭제된 항목을 보고서에 포함해야 하는지를 결정합니다. 기본값은 false입니다.
request.maxRowsPerFile integer 비동기 보고서에만 해당합니다. 보고서 파일당 최대 행 수입니다. 큰 보고서는 이 필드를 기준으로 여러 파일로 나뉩니다. 사용 가능한 값: 1000000~100000000.
request.orderBy[] list 동기식 보고서만 보고서 행에 수행할 정렬을 정의하는 열 및 방향 목록입니다.

요청당 최대 주문 수는 300개입니다.

request.orderBy[].column nested object 정렬을 수행할 열입니다. DoubleClick Search에서 정의한 열이거나 저장된 열일 수 있습니다.
request.orderBy[].column.columnName string 보고서에 포함할 DoubleClick Search 열의 이름입니다.
request.orderBy[].column.customDimensionName string 맞춤 측정기준별로 보고서를 분류합니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정기준이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정기준 이름은 대소문자를 구분합니다.

전환 보고서에서 사용하는 경우 설정된 경우 지정된 전환에 대해 지정된 맞춤 측정기준의 값을 반환합니다. 이 열은 전환 보고서를 분류하지 않습니다.

request.orderBy[].column.customMetricName string 보고서에 포함할 맞춤 측정항목의 이름입니다. 보고서의 범위가 광고주 이하로 지정되어야 하며, 맞춤 측정항목이 이미 DoubleClick Search에서 설정되어 있어야 합니다. DoubleClick Search에 표시되는 맞춤 측정항목 이름은 대소문자를 구분합니다.
request.orderBy[].column.endDate string YYYY-MM-DD 형식으로 된 날짜입니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. startDate과 함께 제공해야 합니다.
request.orderBy[].column.groupByColumn boolean 동기식 보고서만 이 열로 그룹화하려면 true로 설정합니다. 기본값은 false입니다.
request.orderBy[].column.headerText string 보고서 출력에서 이 열을 식별하는 데 사용되는 텍스트입니다. 지정되지 않은 경우 기본값은 columnName 또는 savedColumnName입니다. 이는 DoubleClick Search 열과 이름이 같은 저장된 열 간의 충돌을 방지하는 데 사용할 수 있습니다.
request.orderBy[].column.platformSource string 맞춤 측정기준에 데이터를 제공하는 데 사용되는 플랫폼입니다. 사용 가능한 값은 '플러드라이트'입니다.
request.orderBy[].column.productReportPerspective string 특정 유형의 제품 활동에 대한 측정항목만 반환합니다. 허용되는 값은 다음과 같습니다.
  • 'sold': 판매된 제품의 측정항목만 반환합니다.
  • 'advertised': 쇼핑 캠페인에서 광고되었으며 판매되었을 수도 있고 판매되지 않았을 수 있는 제품의 측정항목만 반환합니다.
request.orderBy[].column.savedColumnName string 보고서에 포함할 저장된 열의 이름입니다. 보고서의 범위를 광고주 이하로 지정해야 하며, 이렇게 저장된 열은 DoubleClick Search UI에서 미리 만들어 두어야 합니다.
request.orderBy[].column.startDate string YYYY-MM-DD 형식의 날짜를 포함합니다. 제공되는 경우 이 열에 대해서만 보고서의 전체 기간이 재정의됩니다. endDate과 함께 제공해야 합니다.
request.orderBy[].sortOrder string 정렬 방향입니다(ascending 또는 descending).
request.reportScope object reportScope는 보고서에 반환될 항목의 하위 집합을 결정하는 데 사용되는 ID 집합입니다. 대행사를 통해 원하는 가장 낮은 범위 수준의 ID에 대한 전체 계보가 필요합니다.
request.reportScope.adGroupId long DS 광고그룹 ID입니다.
request.reportScope.adId long DS 광고 ID
request.reportScope.advertiserId long DS 광고주 ID
request.reportScope.agencyId long DS 대행사 ID
request.reportScope.campaignId long DS 캠페인 ID
request.reportScope.engineAccountId long DS 엔진 계정 ID입니다.
request.reportScope.keywordId long DS 키워드 ID
request.reportType string 보고서에 반환되는 행의 유형을 결정합니다. 예를 들어 reportType: keyword를 지정하면 보고서의 각 행에 키워드에 대한 데이터가 포함됩니다. 각 유형에서 사용할 수 있는 항목은 보고서 유형 참조를 확인하세요.
request.rowCount integer 동기식 보고서만 반환할 최대 행 수입니다. 추가 행은 삭제됩니다. 사용 가능한 값: 0~10000. 기본값은 10000입니다.
request.startRow integer 동기식 보고서만 반환할 첫 번째 행의 0부터 시작하는 색인입니다. 사용 가능한 값: 0~50000. 기본값은 0입니다.
request.statisticsCurrency string 금액을 반환할 통화를 지정합니다. 가능한 값은 usd, agency(보고서의 범위가 대행사 또는 이보다 낮은 경우 유효), advertiser(보고서의 범위가 * 광고주로 범위가 지정된 경우 유효), account(보고서의 범위가 엔진 계정 이하로 지정된 경우 유효함)입니다.
request.timeRange object 보고서에서 측정항목을 요청하면 이 인수를 사용하여 측정항목을 특정 기간으로 제한할 수 있습니다.
request.timeRange.changedAttributesSinceTimestamp datetime RFC 형식의 포괄적인 UTC 타임스탬프입니다(예: 2013-07-16T10:16:23.555Z 변경된 속성 보고서의 작동 방식에 대한 추가 참조를 확인하세요.
request.timeRange.changedMetricsSinceTimestamp datetime RFC 형식의 포괄적인 UTC 타임스탬프입니다(예: 2013-07-16T10:16:23.555Z 변경된 측정항목 보고서의 작동 방식에 대해 자세히 알아보세요.
request.timeRange.endDate string YYYY-MM-DD 형식의 날짜를 포함합니다.
request.timeRange.startDate string YYYY-MM-DD 형식의 날짜를 포함합니다.
request.verifySingleTimeZone boolean true이면 요청된 모든 통계 데이터를 단일 시간대에서 가져온 경우에만 보고서가 생성됩니다. 기본값은 false입니다.
rowCount integer 보고서에서 생성된 보고서 행의 수(헤더 제외)입니다.
rows[] list 동기식 보고서만 생성된 보고서 행
rows[].(key) any value 이 행에 표시되는 열을 나타냅니다. 즉, 각 키는 이 행에 비어 있지 않은 셀이 있는 열에 해당합니다.
statisticsCurrencyCode string 사용자가 설정한 값 (예: 키워드 입찰가 설정)과 측정항목 (예: 비용 및 수익)을 비롯하여 보고서에서 생성된 모든 금전적 값의 통화 코드입니다. 보고서의 통화 코드는 보고서 요청의 statisticsCurrency 필드에 따라 결정됩니다.
statisticsTimeZone string 보고서의 모든 통계가 동일한 시간대에서 제공된 경우 표시됩니다. 그렇지 않으면 필드가 설정되지 않습니다.

방법

생성
보고서를 즉시 생성하고 반환합니다.
가져오기
보고서 요청 상태에 대한 설문조사입니다.
getFile
UTF-8로 인코딩된 보고서 파일을 다운로드합니다.
getIdMappingFile
이전 Search Ads 360과 새 Search Ads 360 간의 ID 매핑이 포함된 CSV 파일 (UTF-8로 인코딩됨)을 다운로드합니다. 요청된 광고주의 경우 파일에는 이전 Search Ads 360 및 새 Search Ads 360에 있는 모든 하위 항목 (예: 엔진 계정, 캠페인, 광고그룹 등)이 포함됩니다.
요청
보고 시스템에 보고 요청을 삽입합니다.