reports

POST /userprofiles/{profileId}/reports/{reportId}/run

Changed on

Runs a report.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfareporting
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfareporting
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

profileIdstring int64 required

The Campaign Manager 360 user profile ID.

reportIdstring int64 required

The ID of the report.

Query parameters

synchronousboolean

If set and true, tries to run the report synchronously.

Response

Successful response

etagstring

Etag of this resource.

fileNamestring

The filename of the file.

format'CSV' | 'EXCEL'

The output format of the report. Only available once the file is available.

idstring int64

The unique ID of this report file.

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".

lastModifiedTimestring int64

The timestamp in milliseconds since epoch when this file was last modified.

reportIdstring int64

The ID of the report this file was generated from.

status'PROCESSING' | 'REPORT_AVAILABLE' | 'FAILED' | 'CANCELLED' | 'QUEUED'

The status of the report file.

Changes