API Báo cáo Search Ads 360 cũ sẽ ngừng hoạt động và ngừng hoạt động từ ngày 30 tháng 6 năm 2024. Xin lưu ý rằng API Lượt chuyển đổi Search Ads 360 không bị ảnh hưởng và sẽ tiếp tục được hỗ trợ. Mọi hoạt động phát triển báo cáo mới đều phải sử dụng API Báo cáo Search Ads 360 mới.

Kể từ tháng 4 năm 2024, hệ thống sẽ trả về lỗi supportedApiVersion trong khi yêu cầu báo cáo. Xem chi tiết tại đây.

Bạn cũng nên di chuyển mọi hoạt động triển khai Search Ads 360 hiện có sang API mới. Hãy xem Bắt đầu và Hướng dẫn di chuyển API Báo cáo Search Ads 360 mới để biết thêm thông tin.

Trang này được dịch bởi Cloud Translation API.

Reports

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

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, chẳng hạn 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ả
`files[]`	`list`	Chỉ báo cáo không đồng bộ. Chứa danh sách các tệp báo cáo đã 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`	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ã báo cáo.
`isReportReady`	`boolean`	Chỉ báo cáo không đồng bộ. Đúng nếu 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 để được 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 bạn muốn đưa vào báo cáo. Dữ liệu này bao gồm cả cột DoubleClick Search và cột đã lưu. Đối với cột DoubleClick Search, chỉ cần có thông số `columnName`. Đối với các cột đã lưu, bạn chỉ cần sử dụng tham số `savedColumnName`. Không thể đặt cả `columnName` và `savedColumnName` trong cùng một khổ thơ. 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 để đưa vào báo cáo.
`request.columns[].customDimensionName`	`string`	Phân đoạn báo cáo theo phương diện tùy chỉnh. Báo cáo phải được giới hạn cho một nhà quảng cáo hoặc thấp hơn và phương diện tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tùy chỉnh, xuất hiện trong DoubleClick Search, có phân biệt chữ hoa chữ thường. Nếu được sử dụng trong báo cáo lượt chuyển đổi, thì trường này sẽ trả về giá trị của phương diện tùy 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 cần đưa vào báo cáo. Báo cáo phải được giới hạn 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ố tuỳ 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp cùng với `startDate`.
`request.columns[].groupByColumn`	`boolean`	Chỉ báo cáo đồng bộ. Hãy đặ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. Bạn có thể sử dụng công cụ này để ngă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. Các giá trị được chấp nhận là "lũ lụt".
`request.columns[].productReportPerspective`	`string`	Chỉ trả về những chỉ số 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ề những chỉ số cho các sản phẩm đã bán được "`advertised`": chỉ trả về những 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ể hoặc không được bán
`request.columns[].savedColumnName`	`string`	Tên của một cột đã lưu để đưa vào báo cáo. Báo cáo phải nằm trong phạm vi nhà quảng cáo hoặc thấp hơn 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp cùng với `endDate`.
`request.downloadFormat`	`string`	Định dạng mà báo cáo được trả về. Hiện tại, chúng tôi hỗ trợ `csv` hoặc `tsv`.
`request.filters[]`	`list`	Danh sách các bộ lọc sẽ á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 để thực hiện bộ lọc. Đây có thể là cột DoubleClick Search hoặc cột đã lưu.
`request.filters[].column.columnName`	`string`	Tên của một cột DoubleClick Search để đư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 tùy chỉnh. Báo cáo phải được giới hạn cho một nhà quảng cáo hoặc thấp hơn và phương diện tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tùy chỉnh, xuất hiện trong DoubleClick Search, có phân biệt chữ hoa chữ thường. Nếu được sử dụng trong báo cáo lượt chuyển đổi, thì trường này sẽ trả về giá trị của phương diện tùy 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 cần đưa vào báo cáo. Báo cáo phải được giới hạn 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ố tuỳ 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp cùng với `startDate`.
`request.filters[].column.groupByColumn`	`boolean`	Chỉ báo cáo đồng bộ. Hãy đặ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. Bạn có thể sử dụng công cụ này để ngă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. Các giá trị được chấp nhận là "lũ lụt".
`request.filters[].column.productReportPerspective`	`string`	Chỉ trả về những chỉ số 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ề những chỉ số cho các sản phẩm đã bán được "`advertised`": chỉ trả về những 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ể hoặc không được bán
`request.filters[].column.savedColumnName`	`string`	Tên của một cột đã lưu để đưa vào báo cáo. Báo cáo phải nằm trong phạm vi nhà quảng cáo hoặc thấp hơn 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp cùng với `endDate`.
`request.filters[].operator`	`string`	Toán tử để sử dụng trong bộ lọc. Hãy tham khảo bộ lọc để biết danh sách các toán tử có sẵn.
`request.filters[].values[]`	`list`	Danh sách các giá trị để lọc giá trị của 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 các thực thể đã xoá vào báo cáo hay không. Giá trị mặc định là `false`. Đã ngừng sử dụng, vui lòng sử dụng `includeRemovedEntities`.
`request.includeRemovedEntities`	`boolean`	Xác định xem có nên đưa các 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 được chia thành nhiều tệp dựa trên trường này. Giá trị được chấp nhận là từ `1000000` đến `100000000`, bao gồm cả hai giá trị này.
`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 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 để đư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 tùy chỉnh. Báo cáo phải được giới hạn cho một nhà quảng cáo hoặc thấp hơn và phương diện tùy chỉnh phải được thiết lập trong DoubleClick Search. Tên phương diện tùy chỉnh, xuất hiện trong DoubleClick Search, có phân biệt chữ hoa chữ thường. Nếu được sử dụng trong báo cáo lượt chuyển đổi, thì trường này sẽ trả về giá trị của phương diện tùy 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 cần đưa vào báo cáo. Báo cáo phải được giới hạn 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ố tuỳ 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp cùng với `startDate`.
`request.orderBy[].column.groupByColumn`	`boolean`	Chỉ báo cáo đồng bộ. Hãy đặ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. Bạn có thể sử dụng công cụ này để ngă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. Các giá trị được chấp nhận là "lũ lụt".
`request.orderBy[].column.productReportPerspective`	`string`	Chỉ trả về những chỉ số 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ề những chỉ số cho các sản phẩm đã bán được "`advertised`": chỉ trả về những 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ể hoặc không được bán
`request.orderBy[].column.savedColumnName`	`string`	Tên của một cột đã lưu để đưa vào báo cáo. Báo cáo phải nằm trong phạm vi nhà quảng cáo hoặc thấp hơn 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 trọn gói ở định dạng YYYY-MM-DD. Khi được cung cấp, thông tin này sẽ ghi đè phạm vi thời gian tổng thể của báo cáo chỉ cho cột này. Phải được cung cấp 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 mã được dùng để xác định tập hợp con thực thể nào sẽ được trả về trong báo cáo. Bắt buộc phải cung cấp đầy đủ các mã nhận dạng ở cấp thấp nhất mà đại lý muốn giới thiệu.
`request.reportScope.adGroupId`	`long`	Mã nhóm quảng cáo DS.
`request.reportScope.adId`	`long`	ID quảng cáo DS.
`request.reportScope.advertiserId`	`long`	ID nhà quảng cáo DS.
`request.reportScope.agencyId`	`long`	ID đại lý 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`	ID từ khóa 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á. Hãy xem phần tham khảo Loại báo cáo để biết các cột có sẵn cho mỗi 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 bị loại bỏ. Giá trị được chấp nhận là từ `0` đến `10000`, bao gồm cả hai giá trị này. Mặc định là `10000`.
`request.startRow`	`integer`	Chỉ báo cáo đồng bộ. Chỉ mục dựa trên 0 của hàng đầu tiên sẽ trả về. Giá trị được chấp nhận là từ `0` đến `50000`, bao gồm cả hai giá trị này. Mặc định là `0`.
`request.statisticsCurrency`	`string`	Chỉ định đơn vị tiền tệ mà tiền sẽ được trả lại. Các giá trị có thể là: `usd`, `agency` (có hiệu lực nếu báo cáo nằm trong phạm vi đại lý trở xuống), `advertiser` (có hiệu lực nếu báo cáo nằm trong phạm vi * nhà quảng cáo trở xuống) hoặc `account` (có hiệu lực nếu báo cáo nằm trong phạm vi tài khoản công cụ hoặc thấp hơn).
`request.timeRange`	`object`	Nếu các chỉ số được yêu cầu trong một báo cáo, đối số này sẽ được dùng để hạn chế 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 tổng hợp ở đị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 tổng hợp ở định dạng RFC, ví dụ: `2013-07-16T10:16:23.555Z`. Xem thêm thông tin tham khảo về cách hoạt động của báo cáo chỉ số được thay đổi.
`request.timeRange.endDate`	`string`	Ngày trọn gói ở định dạng YYYY-MM-DD.
`request.timeRange.startDate`	`string`	Ngày trọn gói ở định dạng YYYY-MM-DD.
`request.verifySingleTimeZone`	`boolean`	Nếu `true`, báo cáo sẽ chỉ được tạo nếu tất cả dữ liệu thống kê được yêu cầu được lấy 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 tạo ra từ báo cáo, không bao gồm tiêu đề.
`rows[]`	`list`	Chỉ báo cáo đồng bộ. Hàng báo cáo đã tạo.
`rows[].(key)`	`any value`	Cho biết các cột được thể hiện trong hàng này. Tức là mỗi khoá tương ứng với một cột có ô không trống trong hàng này.
`statisticsCurrencyCode`	`string`	Mã đơn vị tiền tệ của tất cả các giá trị tiền tệ được tạo trong báo cáo, bao gồm cả các giá trị do người dùng đặt (ví dụ: cài đặt giá thầu từ khóa) và chỉ số (ví dụ: chi phí và doanh thu). Mã đơn vị tiền tệ của báo cáo được xác định bởi trường `statisticsCurrency` của yêu cầu báo cáo.
`statisticsTimeZone`	`string`	Nếu tất cả số liệu thống kê của báo cáo đều đến từ cùng một múi giờ, thì đó sẽ là báo cáo. Nếu không, trường này sẽ không được đặt.

Phương pháp

tạo: Tạo và trả về báo cáo ngay lập tức.
tải: Cuộc thăm dò ý kiến về 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á bằng UTF-8 xuống.
getIdMappingFile: Tải tệp CSV xuống (được mã hoá bằng UTF-8) có chứa 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 chứa tất 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.