Google Search Ads 360 Reporting Reports API

The Reports API from Google Search Ads 360 Reporting — 5 operation(s) for reports.

GitHub OpenAPI

Operations 5

GET /doubleclicksearch/v2/reports/{reportId} Get reports #
GET /doubleclicksearch/v2/reports/{reportId}/files/{reportFragment} Get file reports #
POST /doubleclicksearch/v2/reports Request reports #
GET /doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/idmapping Get id mapping file reports #
POST /doubleclicksearch/v2/reports/generate Generate reports #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-search-ads-360:google-search-ads-360-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-search-ads-360-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Search Ads 360 Reports API
  version: v2
  description: Generated from Google's published Discovery document for Search Ads 360 API (doubleclicksearch v2, revision 20261110). 5 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://doubleclicksearch.googleapis.com
tags:
- name: Reports
paths:
  /doubleclicksearch/v2/reports/{reportId}:
    get:
      operationId: doubleclicksearch.reports.get
      summary: Get reports
      description: Polls for the status of a report request.
      parameters:
      - name: reportId
        in: path
        required: true
        description: ID of the report request being polled.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/doubleclicksearch
      - apiKey: []
      tags:
      - Reports
  /doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}:
    get:
      operationId: doubleclicksearch.reports.getFile
      summary: Get file reports
      description: Downloads a report file encoded in UTF-8.
      parameters:
      - name: reportId
        in: path
        required: true
        description: ID of the report.
        schema:
          type: string
      - name: reportFragment
        in: path
        required: true
        description: The index of the report fragment to download.
        schema:
          type: integer
          format: int32
          minimum: 0
      responses:
        '200':
          description: Successful response
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/doubleclicksearch
      - apiKey: []
      tags:
      - Reports
  /doubleclicksearch/v2/reports:
    post:
      operationId: doubleclicksearch.reports.request
      summary: Request reports
      description: Inserts a report request into the reporting system.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/doubleclicksearch
      - apiKey: []
      tags:
      - Reports
  /doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/idmapping:
    get:
      operationId: doubleclicksearch.reports.getIdMappingFile
      summary: Get id mapping file reports
      description: Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.
      parameters:
      - name: agencyId
        in: path
        required: true
        description: Legacy SA360 agency ID.
        schema:
          type: string
          format: int64
      - name: advertiserId
        in: path
        required: true
        description: Legacy SA360 advertiser ID.
        schema:
          type: string
          format: int64
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdMappingFile'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/doubleclicksearch
      - apiKey: []
      tags:
      - Reports
  /doubleclicksearch/v2/reports/generate:
    post:
      operationId: doubleclicksearch.reports.generate
      summary: Generate reports
      description: Generates and returns a report immediately.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/doubleclicksearch
      - apiKey: []
      tags:
      - Reports
components:
  schemas:
    ReportApiColumnSpec:
      properties:
        groupByColumn:
          description: Synchronous report only. Set to `true` to group by this column. Defaults to `false`.
          type: boolean
        endDate:
          type: string
          description: Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `startDate`.
        columnName:
          description: Name of a DoubleClick Search column to include in the report.
          type: string
        customDimensionName:
          description: Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
          type: string
        platformSource:
          type: string
          description: The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
        startDate:
          type: string
          description: Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `endDate`.
        headerText:
          description: Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
          type: string
        productReportPerspective:
          type: string
          description: 'Returns metrics only for a specific type of product activity. Accepted values are: - "`sold`": returns metrics only for products that were sold - "`advertised`": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold '
        savedColumnName:
          type: string
          description: Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
        customMetricName:
          description: Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
          type: string
      description: A request object used to create a DoubleClick Search report.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    IdMappingFile:
      description: File returned to https://developers.google.com/search-ads/v2/reference/reports/getIdMappingFile.
      type: object
      properties: {}
    Report:
      properties:
        rowCount:
          description: The number of report rows generated by the report, not including headers.
          format: int32
          type: integer
        isReportReady:
          description: Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
          type: boolean
        files:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
                description: Use this url to download the report file.
              byteCount:
                type: string
                description: The size of this report file in bytes.
                format: int64
          description: Asynchronous report only. Contains a list of generated report files once the report has successfully completed.
        statisticsTimeZone:
          description: If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
          type: string
        kind:
          description: 'Identifies this as a Report resource. Value: the fixed string `doubleclicksearch#report`.'
          type: string
        id:
          type: string
          description: Asynchronous report only. Id of the report.
        statisticsCurrencyCode:
          description: The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the `statisticsCurrency` field of the report request.
          type: string
        request:
          $ref: '#/components/schemas/ReportRequest'
          description: The request that created the report. Optional fields not specified in the original request are filled with default values.
        rows:
          type: array
          description: Synchronous report only. Generated report rows.
          items:
            $ref: '#/components/schemas/ReportRow'
      description: A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
      type: object
    ReportRow:
      type: object
      additionalProperties:
        description: Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
      description: A row in a DoubleClick Search report.
    ReportRequest:
      description: A request object used to create a DoubleClick Search report.
      type: object
      properties:
        filters:
          type: array
          items:
            type: object
            properties:
              column:
                $ref: '#/components/schemas/ReportApiColumnSpec'
                description: Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
              values:
                type: array
                items: {}
                description: A list of values to filter the column value against.\ The maximum number of filter values per request is 300.
              operator:
                description: Operator to use in the filter. See the filter reference for a list of available operators.
                type: string
          description: A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
        timeRange:
          description: If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
          properties:
            changedAttributesSinceTimestamp:
              type: string
              description: Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed attribute reports work.
            endDate:
              type: string
              description: Inclusive date in YYYY-MM-DD format.
            changedMetricsSinceTimestamp:
              description: Inclusive UTC timestamp in RFC format, e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics reports work.
              type: string
            startDate:
              description: Inclusive date in YYYY-MM-DD format.
              type: string
          type: object
        maxRowsPerFile:
          description: Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are `1000000` to `100000000`, inclusive.
          format: int32
          type: integer
        columns:
          type: array
          description: The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the `columnName` parameter is required. For saved columns only the `savedColumnName` parameter is required. Both `columnName` and `savedColumnName` cannot be set in the same stanza.\ The maximum number of columns per request is 300.
          items:
            $ref: '#/components/schemas/ReportApiColumnSpec'
        orderBy:
          items:
            properties:
              column:
                $ref: '#/components/schemas/ReportApiColumnSpec'
                description: Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
              sortOrder:
                type: string
                description: The sort direction, which is either `ascending` or `descending`.
            type: object
          description: Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300.
          type: array
        includeDeletedEntities:
          type: boolean
          description: Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.
        statisticsCurrency:
          description: 'Specifies the currency in which monetary will be returned. Possible values are: `usd`, `agency` (valid if the report is scoped to agency or lower), `advertiser` (valid if the report is scoped to * advertiser or lower), or `account` (valid if the report is scoped to engine account or lower).'
          type: string
        reportScope:
          properties:
            keywordId:
              format: int64
              type: string
              description: DS keyword ID.
            advertiserId:
              format: int64
              type: string
              description: DS advertiser ID.
            engineAccountId:
              description: DS engine account ID.
              type: string
              format: int64
            agencyId:
              format: int64
              description: DS agency ID.
              type: string
            adId:
              format: int64
              description: DS ad ID.
              type: string
            adGroupId:
              type: string
              description: DS ad group ID.
              format: int64
            campaignId:
              format: int64
              type: string
              description: DS campaign ID.
          type: object
          description: The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
        includeRemovedEntities:
          description: Determines if removed entities should be included in the report. Defaults to `false`.
          type: boolean
        startRow:
          description: Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.
          type: integer
          format: int32
        downloadFormat:
          type: string
          description: Format that the report should be returned in. Currently `csv` or `tsv` is supported.
        rowCount:
          type: integer
          description: Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.
          format: int32
        reportType:
          description: 'Determines the type of rows that are returned in the report. For example, if you specify `reportType: keyword`, each row in the report will contain data about a keyword. See the [Types of Reports](/search-ads/v2/report-types/) reference for the columns that are available for each type.'
          type: string
        verifySingleTimeZone:
          description: If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.
          type: boolean
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/doubleclicksearch: View and manage your advertising data in DoubleClick Search
externalDocs:
  url: https://developers.google.com/search-ads
x-provenance:
  method: harvested
  publisher: Google
  source: https://doubleclicksearch.googleapis.com/$discovery/rest?version=v2
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)