Google Search Ads 360 Reporting Customers API

openapi: 3.1.0
info:
  title: Google Search Ads 360 Reporting Customers API
  description: The Search Ads 360 Reporting API enables automated report downloading and programmatic access to search advertising campaign data using search and streaming query methods with a SQL-like query language.
  version: v0
  contact:
    name: Google
    url: https://developers.google.com/search-ads
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
servers:
- url: https://searchads360.googleapis.com
  description: Search Ads 360 Reporting API server
security:
- oauth2:
  - https://www.googleapis.com/auth/doubleclicksearch
tags:
- name: Customers
paths:
  /v0/customers/{customerId}/searchAds360:search:
    post:
      summary: Google Search Ads 360 Reporting Search campaign data
      description: Returns all rows that match the search query using a SQL-like query language for Search Ads 360 data.
      operationId: search
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
      tags:
      - Customers
  /v0/customers/{customerId}/searchAds360:searchStream:
    post:
      summary: Google Search Ads 360 Reporting Stream campaign data
      description: Returns all rows that match the search query as a stream, which is more efficient for large result sets.
      operationId: searchStream
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SearchStreamResponse'
      tags:
      - Customers
  /v0/customers/{customerId}/customColumns:
    get:
      summary: Google Search Ads 360 Reporting List custom columns
      description: Lists the custom columns for a specified customer.
      operationId: listCustomColumns
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomColumnsResponse'
      tags:
      - Customers
components:
  schemas:
    CustomColumn:
      type: object
      properties:
        resourceName:
          type: string
        id:
          type: string
        name:
          type: string
        description:
          type: string
        valueType:
          type: string
    SearchResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchAds360Row'
        nextPageToken:
          type: string
        totalResultsCount:
          type: string
        fieldMask:
          type: string
    SearchRequest:
      type: object
      properties:
        query:
          type: string
          description: The query string using Search Ads 360 Query Language.
        pageToken:
          type: string
          description: Token for paginating through large result sets.
        pageSize:
          type: integer
          description: Number of elements to retrieve in a single page.
      required:
      - query
    ListCustomColumnsResponse:
      type: object
      properties:
        customColumns:
          type: array
          items:
            $ref: '#/components/schemas/CustomColumn'
    SearchAds360Row:
      type: object
      properties:
        campaign:
          type: object
          properties:
            resourceName:
              type: string
            name:
              type: string
            status:
              type: string
            id:
              type: string
        adGroup:
          type: object
          properties:
            resourceName:
              type: string
            name:
              type: string
            status:
              type: string
        metrics:
          type: object
          properties:
            impressions:
              type: string
            clicks:
              type: string
            costMicros:
              type: string
            conversions:
              type: number
    SearchStreamResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchAds360Row'
        fieldMask:
          type: string
        requestId:
          type: string
  securitySchemes:
    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: Manage DoubleClick Search data