Reports

Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.

Biểu diễn tài nguyên

Báo cáo DoubleClick Search. Đối tượng này chứa yêu cầu báo cáo, một số siêu dữ liệu báo cáo như mã đơn vị tiền tệ và các hàng báo cáo hoặc tệp báo cáo đã tạo.

{
  "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)
    }
  ]
}
Tên tài sản Giá trị Mô tả Ghi chú
files[] list Chỉ báo cáo không đồng bộ. Chứa danh sách các tệp báo cáo được tạo sau khi báo cáo hoàn tất thành công.
files[].byteCount long Kích thước của tệp báo cáo này tính bằng byte.
files[].url string Hãy sử dụng URL này để tải tệp báo cáo xuống.
id string Chỉ báo cáo không đồng bộ. Mã của báo cáo.
isReportReady boolean Chỉ báo cáo không đồng bộ. Đúng khi và chỉ khi báo cáo đã hoàn tất thành công và các tệp báo cáo đã sẵn sàng để tải xuống.
kind string Xác định đây là một Tài nguyên báo cáo. Giá trị: chuỗi cố định doubleclicksearch#report.
request nested object Yêu cầu đã tạo báo cáo. Các trường không bắt buộc không được chỉ định trong yêu cầu ban đầu sẽ được điền giá trị mặc định.
request.columns[] list Các cột cần đưa vào báo cáo. Số liệu này bao gồm cả các cột trong DoubleClick Search và các cột đã lưu. Đối với các cột trong DoubleClick Search, bạn chỉ cần tham số columnName. Đối với các cột đã lưu, bạn chỉ cần có tham số savedColumnName. Không được đặt cả columnName và savedColumnName trong cùng một khổ.

Số cột tối đa cho mỗi yêu cầu là 300.
request.columns[].columnName string Tên của một cột DoubleClick Search cần đưa vào báo cáo.
request.columns[].customDimensionName string Phân đoạn báo cáo theo phương diện tuỳ chỉnh. Báo cáo phải dành cho một nhà quảng cáo trở xuống và thứ nguyên tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tuỳ chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.

Nếu mục tiêu này được sử dụng trong báo cáo lượt chuyển đổi, thì hệ thống sẽ trả về giá trị của phương diện tuỳ chỉnh đã chỉ định cho lượt chuyển đổi nhất định (nếu có). Cột này không phân đoạn báo cáo lượt chuyển đổi.
request.columns[].customMetricName string Tên của một chỉ số tuỳ chỉnh mà bạn muốn đưa vào báo cáo. Báo cáo phải dành cho một nhà quảng cáo trở xuống và chỉ số tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên chỉ số tùy chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.
request.columns[].endDate string Ngày không phân biệt đối xử ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với startDate.
request.columns[].groupByColumn boolean Chỉ báo cáo đồng bộ. Đặt thành true để nhóm theo cột này. Giá trị mặc định là false.
request.columns[].headerText string Văn bản dùng để xác định cột này trong kết quả báo cáo; mặc định là columnName hoặc savedColumnName khi không được chỉ định. Tính năng này có thể được sử dụng để ngăn chặn xung đột giữa các cột DoubleClick Search và các cột đã lưu có cùng tên.
request.columns[].platformSource string Nền tảng được dùng để cung cấp dữ liệu cho phương diện tuỳ chỉnh. Giá trị có thể chấp nhận là "lũ lụt".
request.columns[].productReportPerspective string Trả về chỉ số chỉ cho một loại hoạt động sản phẩm cụ thể. Các giá trị được chấp nhận là:
  • "sold": chỉ trả về chỉ số của những sản phẩm đã bán
  • "advertised": chỉ trả về các chỉ số cho các sản phẩm đã được quảng cáo trong chiến dịch Mua sắm và có thể đã được bán hoặc chưa bán
request.columns[].savedColumnName string Tên của cột đã lưu để đưa vào báo cáo. Báo cáo phải thuộc phạm vi của nhà quảng cáo trở xuống và cột đã lưu này phải được tạo trong giao diện người dùng DoubleClick Search.
request.columns[].startDate string Ngày bao gồm ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với endDate.
request.downloadFormat string Định dạng mà báo cáo sẽ được trả về. Hiện tại, csv hoặc tsv được hỗ trợ.
request.filters[] list Danh sách bộ lọc sẽ được áp dụng cho báo cáo.

Số lượng bộ lọc tối đa cho mỗi yêu cầu là 300.
request.filters[].column nested object Cột để áp dụng bộ lọc. Đây có thể là một cột trong DoubleClick Search hoặc một cột đã lưu.
request.filters[].column.columnName string Tên của một cột DoubleClick Search cần đưa vào báo cáo.
request.filters[].column.customDimensionName string Phân đoạn báo cáo theo phương diện tuỳ chỉnh. Báo cáo phải dành cho một nhà quảng cáo trở xuống và thứ nguyên tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tuỳ chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.

Nếu mục tiêu này được sử dụng trong báo cáo lượt chuyển đổi, thì hệ thống sẽ trả về giá trị của phương diện tuỳ chỉnh đã chỉ định cho lượt chuyển đổi nhất định (nếu có). Cột này không phân đoạn báo cáo lượt chuyển đổi.
request.filters[].column.customMetricName string Tên của một chỉ số tuỳ chỉnh mà bạn muốn đưa vào báo cáo. Báo cáo phải dành cho một nhà quảng cáo trở xuống và chỉ số tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên chỉ số tùy chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.
request.filters[].column.endDate string Ngày không phân biệt đối xử ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với startDate.
request.filters[].column.groupByColumn boolean Chỉ báo cáo đồng bộ. Đặt thành true để nhóm theo cột này. Giá trị mặc định là false.
request.filters[].column.headerText string Văn bản dùng để xác định cột này trong kết quả báo cáo; mặc định là columnName hoặc savedColumnName khi không được chỉ định. Tính năng này có thể được sử dụng để ngăn chặn xung đột giữa các cột DoubleClick Search và các cột đã lưu có cùng tên.
request.filters[].column.platformSource string Nền tảng được dùng để cung cấp dữ liệu cho phương diện tuỳ chỉnh. Giá trị có thể chấp nhận là "lũ lụt".
request.filters[].column.productReportPerspective string Trả về chỉ số chỉ cho một loại hoạt động sản phẩm cụ thể. Các giá trị được chấp nhận là:
  • "sold": chỉ trả về chỉ số của những sản phẩm đã bán
  • "advertised": chỉ trả về các chỉ số cho các sản phẩm đã được quảng cáo trong chiến dịch Mua sắm và có thể đã được bán hoặc chưa bán
request.filters[].column.savedColumnName string Tên của cột đã lưu để đưa vào báo cáo. Báo cáo phải thuộc phạm vi của nhà quảng cáo trở xuống và cột đã lưu này phải được tạo trong giao diện người dùng DoubleClick Search.
request.filters[].column.startDate string Ngày bao gồm ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với endDate.
request.filters[].operator string Toán tử sẽ sử dụng trong bộ lọc. Hãy xem tài liệu tham khảo về bộ lọc để biết danh sách các toán tử có thể sử dụng.
request.filters[].values[] list Danh sách các giá trị để lọc giá trị cột.

Số lượng giá trị bộ lọc tối đa cho mỗi yêu cầu là 300.
request.includeDeletedEntities boolean Xác định xem có nên đưa thực thể đã xoá vào báo cáo hay không. Giá trị mặc định là false. Không được dùng nữa, vui lòng sử dụng includeRemovedEntities.
request.includeRemovedEntities boolean Xác định xem có nên đưa thực thể đã xoá vào báo cáo hay không. Giá trị mặc định là false.
request.maxRowsPerFile integer Chỉ báo cáo không đồng bộ. Số hàng tối đa cho mỗi tệp báo cáo. Một báo cáo lớn sẽ được chia thành nhiều tệp dựa trên trường này. Giá trị có thể chấp nhận là từ 1000000 đến 100000000.
request.orderBy[] list Chỉ báo cáo đồng bộ. Danh sách các cột và hướng dẫn xác định cách sắp xếp sẽ được thực hiện trên các hàng báo cáo.

Số lượng đơn đặt hàng tối đa cho mỗi yêu cầu là 300.
request.orderBy[].column nested object Cột để sắp xếp. Đây có thể là cột do DoubleClick Search xác định hoặc cột đã lưu.
request.orderBy[].column.columnName string Tên của một cột DoubleClick Search cần đưa vào báo cáo.
request.orderBy[].column.customDimensionName string Phân đoạn báo cáo theo phương diện tuỳ chỉnh. Báo cáo phải dành cho một nhà quảng cáo trở xuống và thứ nguyên tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tuỳ chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.

Nếu mục tiêu này được sử dụng trong báo cáo lượt chuyển đổi, thì hệ thống sẽ trả về giá trị của phương diện tuỳ chỉnh đã chỉ định cho lượt chuyển đổi nhất định (nếu có). Cột này không phân đoạn báo cáo lượt chuyển đổi.
request.orderBy[].column.customMetricName string Tên của một chỉ số tuỳ chỉnh mà bạn muốn đưa vào báo cáo. Báo cáo phải dành cho một nhà quảng cáo trở xuống và chỉ số tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên chỉ số tùy chỉnh (xuất hiện trong DoubleClick Search) có phân biệt chữ hoa chữ thường.
request.orderBy[].column.endDate string Ngày không phân biệt đối xử ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với startDate.
request.orderBy[].column.groupByColumn boolean Chỉ báo cáo đồng bộ. Đặt thành true để nhóm theo cột này. Giá trị mặc định là false.
request.orderBy[].column.headerText string Văn bản dùng để xác định cột này trong kết quả báo cáo; mặc định là columnName hoặc savedColumnName khi không được chỉ định. Tính năng này có thể được sử dụng để ngăn chặn xung đột giữa các cột DoubleClick Search và các cột đã lưu có cùng tên.
request.orderBy[].column.platformSource string Nền tảng được dùng để cung cấp dữ liệu cho phương diện tuỳ chỉnh. Giá trị có thể chấp nhận là "lũ lụt".
request.orderBy[].column.productReportPerspective string Trả về chỉ số chỉ cho một loại hoạt động sản phẩm cụ thể. Các giá trị được chấp nhận là:
  • "sold": chỉ trả về chỉ số của những sản phẩm đã bán
  • "advertised": chỉ trả về các chỉ số cho các sản phẩm đã được quảng cáo trong chiến dịch Mua sắm và có thể đã được bán hoặc chưa bán
request.orderBy[].column.savedColumnName string Tên của cột đã lưu để đưa vào báo cáo. Báo cáo phải thuộc phạm vi của nhà quảng cáo trở xuống và cột đã lưu này phải được tạo trong giao diện người dùng DoubleClick Search.
request.orderBy[].column.startDate string Ngày bao gồm ở định dạng YYYY-MM-DD. Khi được cung cấp, giá trị này sẽ chỉ ghi đè phạm vi thời gian tổng thể của báo cáo cho cột này. Bạn phải cung cấp thông tin này cùng với endDate.
request.orderBy[].sortOrder string Hướng sắp xếp, là ascending hoặc descending.
request.reportScope object reportScope là một tập hợp các mã nhận dạng được dùng để xác định một nhóm nhỏ các thực thể sẽ được trả về trong báo cáo. Bạn phải điền toàn bộ các mã nhận dạng từ cấp có phạm vi thấp nhất mà bạn muốn thông qua công ty quảng cáo.
request.reportScope.adGroupId long Mã nhóm quảng cáo DS.
request.reportScope.adId long Mã quảng cáo DS.
request.reportScope.advertiserId long Mã nhận dạng nhà quảng cáo DS.
request.reportScope.agencyId long Mã công ty quảng cáo DS.
request.reportScope.campaignId long Mã chiến dịch DS.
request.reportScope.engineAccountId long Mã tài khoản công cụ DS.
request.reportScope.keywordId long Mã từ khoá DS.
request.reportType string Xác định loại hàng được trả về trong báo cáo. Ví dụ: nếu bạn chỉ định reportType: keyword, mỗi hàng trong báo cáo sẽ chứa dữ liệu về một từ khoá. Xem tài liệu tham khảo về Các loại báo cáo để biết những cột có sẵn cho từng loại.
request.rowCount integer Chỉ báo cáo đồng bộ. Số hàng tối đa cần trả về; hàng bổ sung sẽ bị loại bỏ. Giá trị có thể chấp nhận là từ 0 đến 10000. Mặc định là 10000.
request.startRow integer Chỉ báo cáo đồng bộ. Chỉ mục từ 0 của hàng đầu tiên cần trả về. Giá trị có thể chấp nhận là từ 0 đến 50000. Mặc định là 0.
request.statisticsCurrency string Chỉ định đơn vị tiền tệ mà hệ thống sẽ trả về số tiền. Các giá trị có thể là: usd, agency (hợp lệ nếu báo cáo thuộc về công ty quảng cáo trở xuống), advertiser (hợp lệ nếu báo cáo là * nhà quảng cáo trở xuống) hoặc account (hợp lệ nếu báo cáo là ở phạm vi tài khoản công cụ trở xuống).
request.timeRange object Nếu một báo cáo yêu cầu các chỉ số, thì đối số này sẽ được dùng để giới hạn các chỉ số trong một phạm vi thời gian cụ thể.
request.timeRange.changedAttributesSinceTimestamp datetime Dấu thời gian UTC bao gồm ở định dạng RFC, ví dụ: 2013-07-16T10:16:23.555Z. Xem thêm tài liệu tham khảo về cách hoạt động của báo cáo thuộc tính đã thay đổi.
request.timeRange.changedMetricsSinceTimestamp datetime Dấu thời gian UTC bao gồm ở định dạng RFC, ví dụ: 2013-07-16T10:16:23.555Z. Xem thêm tài liệu tham khảo về cách hoạt động của báo cáo chỉ số đã thay đổi.
request.timeRange.endDate string Ngày bao gồm ở định dạng YYYY-MM-DD.
request.timeRange.startDate string Ngày bao gồm ở định dạng YYYY-MM-DD.
request.verifySingleTimeZone boolean Nếu giá trị là true, báo cáo sẽ chỉ được tạo nếu tất cả dữ liệu số liệu thống kê yêu cầu đều bắt nguồn từ một múi giờ duy nhất. Giá trị mặc định là false.
rowCount integer Số hàng báo cáo được tạo bởi báo cáo, không bao gồm tiêu đề.
rows[] list Chỉ báo cáo đồng bộ. Các hàng báo cáo đã tạo.
rows[].(key) any value Cho biết các cột được biểu thị trong hàng này. Tức là mỗi khoá tương ứng với một cột có một ô không trống trong hàng này.
statisticsCurrencyCode string Mã đơn vị tiền tệ của tất cả giá trị tiền tệ được tạo ra trong báo cáo, bao gồm cả giá trị do người dùng đặt (ví dụ: chế độ cài đặt giá thầu từ khoá) và chỉ số (ví dụ: chi phí và doanh thu). Mã đơn vị tiền tệ của báo cáo là do trường statisticsCurrency của yêu cầu báo cáo xác định.
statisticsTimeZone string Nếu tất cả số liệu thống kê của báo cáo đều được lấy từ cùng một múi giờ, thì cấu hình chung là theo múi giờ đó. Nếu không, trường này sẽ không được đặt.

Phương thức

tạo
Tạo và trả về báo cáo ngay lập tức.
nhận
Cuộc thăm dò ý kiến để biết trạng thái của yêu cầu báo cáo.
getFile
Tải tệp báo cáo được mã hoá theo UTF-8 xuống.
getIdMappingFile
Tải tệp CSV (được mã hoá bằng UTF-8) chứa mối liên kết mã nhận dạng giữa Search Ads 360 cũ và Search Ads 360 mới. Đối với nhà quảng cáo được yêu cầu, tệp này bao gồm tất cả các thực thể con (ví dụ: tài khoản công cụ, chiến dịch, nhóm quảng cáo, v.v.) có trong cả Search Ads 360 cũ và Search Ads 360 mới.
yêu cầu
Chèn một yêu cầu báo cáo vào hệ thống báo cáo.