2026-08-29
▼ ▲ agenciesandbrands.agencies.reports.patch
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}
Parameters :
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Optional. The list of fields to update.
name
Required : Yes
Pattern : ^agencies/[^/]+/reports/[^/]+$
Location : path
Type : string
Description : Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id}/reports/{report_id}`
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/agencies-and-brands
Parameter Order : name
Path : v1/{+name}
Description : Updates a `Report` object.
▼ ▲ agenciesandbrands.agencies.reports.get
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^agencies/[^/]+/reports/[^/]+$
Description : Required. The resource name of the report. Format: `agencies/{account_id}/reports/{report_id}`
Type : string
Required : Yes
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}
Description : Retrieves a `Report` object.
Scopes : https://www.googleapis.com/auth/agencies-and-brands
▼ ▲ agenciesandbrands.agencies.reports.create
Parameters :
parent
Pattern : ^agencies/[^/]+$
Location : path
Description : Required. The parent resource where this `Report` will be created. Format: `agencies/{account_id}`
Required : Yes
Type : string
Description : Creates a `Report` object.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/agencies-and-brands
Flat Path : v1/agencies/{agenciesId}/reports
Path : v1/{+parent}/reports
Parameter Order : parent
▼ ▲ agenciesandbrands.agencies.reports.delete
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Description : Required. Resource name of the report to delete. Format: `agencies/{account_id}/reports/{report_id}`
Location : path
Pattern : ^agencies/[^/]+/reports/[^/]+$
Required : Yes
Type : string
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}
Description : Deletes a `Report` object.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/agencies-and-brands
▼ ▲ agenciesandbrands.agencies.reports.list
Parameter Order : parent
Path : v1/{+parent}/reports
Flat Path : v1/agencies/{agenciesId}/reports
Scopes : https://www.googleapis.com/auth/agencies-and-brands
HTTP Method : GET
Description : Lists `Report` objects.
Parameters :
parent
Type : string
Location : path
Description : Required. The parent, which owns this collection of reports. Format: `agencies/{account_id}`
Pattern : ^agencies/[^/]+$
Required : Yes
orderBy
Description : Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
Type : string
Location : query
filter
Description : Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Location : query
Type : string
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.
skip
Description : Optional. Number of individual resources to skip while paginating.
Location : query
Format : int32
Type : integer
pageSize
Description : Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
Format : int32
Type : integer
Location : query
▼ ▲ agenciesandbrands.agencies.reports.run
Description : Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a report_result that can be passed to the `FetchReportResultRows` method to retrieve the report data.
Parameters :
name
Location : path
Type : string
Pattern : ^agencies/[^/]+/reports/[^/]+$
Required : Yes
Description : Required. The report to run. Format: `agencies/{account_id}/reports/{report_id}`
HTTP Method : POST
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}:run
Scopes : https://www.googleapis.com/auth/agencies-and-brands
Path : v1/{+name}:run
Parameter Order : name
▼ ▲ agenciesandbrands.agencies.reports.results.fetchRows
HTTP Method : GET
Path : v1/{+name}:fetchRows
Parameter Order : name
Parameters :
pageToken
Description : Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows.
Type : string
Location : query
name
Type : string
Required : Yes
Pattern : ^agencies/[^/]+/reports/[^/]+/results/[^/]+$
Description : The report result being fetched. Format: `agencies/{account_id}/reports/{report_id}/results/{report_result_id}`
Location : path
pageSize
Type : integer
Description : Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.
Location : query
Format : int32
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}/results/{resultsId}:fetchRows
Scopes : https://www.googleapis.com/auth/agencies-and-brands
Description : Returns the result rows from a completed report. The caller must have previously called `RunReport` and waited for that operation to complete. The rows will be returned according to the order specified by the `sorts` member of the report definition.
▼ ▲ agenciesandbrands.agencies.reports.operations.get
Parameter Order : name
Flat Path : v1/agencies/{agenciesId}/reports/{reportsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation resource.
Pattern : ^agencies/[^/]+/reports/[^/]+/operations/[^/]+$
Location : path
Path : v1/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes : https://www.googleapis.com/auth/agencies-and-brands