2026-08-29
▼ ▲ curationpartners.mediaPlanners.list
Description : Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.
HTTP Method : GET
Flat Path : v1/mediaPlanners
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.
pageSize
Type : integer
Description : The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.
Format : int32
Location : query
filter
Description : Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`
Type : string
Location : query
Path : v1/mediaPlanners
▼ ▲ curationpartners.curators.dataSegments.create
Parameters :
parent
Required : Yes
Pattern : ^curators/[^/]+$
Type : string
Location : path
Description : Required. The parent resource where this data segment will be created. Format: `curators/{accountId}`
Path : v1/{+parent}/dataSegments
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/curation-partners
HTTP Method : POST
Flat Path : v1/curators/{curatorsId}/dataSegments
Description : Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.
▼ ▲ curationpartners.curators.dataSegments.deactivate
Description : Deactivates a data segment.
HTTP Method : POST
Path : v1/{+name}:deactivate
Parameters :
name
Pattern : ^curators/[^/]+/dataSegments/[^/]+$
Description : Required. Name of data segment to deactivate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`
Location : path
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}:deactivate
Parameter Order : name
▼ ▲ curationpartners.curators.dataSegments.activate
Description : Activates a data segment.
HTTP Method : POST
Path : v1/{+name}:activate
Parameter Order : name
Parameters :
name
Description : Required. Name of data segment to activate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`
Required : Yes
Pattern : ^curators/[^/]+/dataSegments/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}:activate
▼ ▲ curationpartners.curators.dataSegments.list
HTTP Method : GET
Flat Path : v1/curators/{curatorsId}/dataSegments
Description : List the data segments owned by a curator.
Parameters :
parent
Description : Required. Name of the parent curator that can access the data segment. Format: `curators/{accountId}`
Pattern : ^curators/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
Location : query
Format : int32
Type : integer
pageToken
Description : Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/curation-partners
Path : v1/{+parent}/dataSegments
Parameter Order : parent
▼ ▲ curationpartners.curators.dataSegments.patch
HTTP Method : PATCH
Flat Path : v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/curation-partners
Parameters :
name
Pattern : ^curators/[^/]+/dataSegments/[^/]+$
Type : string
Description : Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`
Required : Yes
Location : path
updateMask
Description : Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Description : Updates a data segment.
▼ ▲ curationpartners.curators.dataSegments.get
Parameters :
name
Pattern : ^curators/[^/]+/dataSegments/[^/]+$
Type : string
Location : path
Description : Required. Name of data segment to get. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`
Required : Yes
Description : Gets a data segment given its name.
Flat Path : v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
▼ ▲ curationpartners.curators.curatedPackages.create
Parameters :
parent
Required : Yes
Description : Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`
Location : path
Type : string
Pattern : ^curators/[^/]+$
Path : v1/{+parent}/curatedPackages
Flat Path : v1/curators/{curatorsId}/curatedPackages
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/curation-partners
Parameter Order : parent
Description : Creates a new curated package.
▼ ▲ curationpartners.curators.curatedPackages.activate
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate
Parameters :
name
Type : string
Description : Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`
Location : path
Required : Yes
Pattern : ^curators/[^/]+/curatedPackages/[^/]+$
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:activate
Description : Activates an existing curated package.
▼ ▲ curationpartners.curators.curatedPackages.get
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}
Description : Gets a curated package given its resource name.
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Required : Yes
Description : Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`
Pattern : ^curators/[^/]+/curatedPackages/[^/]+$
Location : path
Type : string
▼ ▲ curationpartners.curators.curatedPackages.list
HTTP Method : GET
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/curation-partners
Parameters :
pageSize
Description : Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
Location : query
Format : int32
Type : integer
parent
Location : path
Type : string
Description : Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`
Required : Yes
Pattern : ^curators/[^/]+$
pageToken
Description : Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.
Type : string
Location : query
filter
Description : Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos
Type : string
Location : query
Flat Path : v1/curators/{curatorsId}/curatedPackages
Description : Lists curated packages owned by the specified curator.
Path : v1/{+parent}/curatedPackages
▼ ▲ curationpartners.curators.curatedPackages.deactivate
HTTP Method : POST
Path : v1/{+name}:deactivate
Flat Path : v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate
Description : Deactivates an existing curated package.
Scopes : https://www.googleapis.com/auth/curation-partners
Parameters :
name
Type : string
Pattern : ^curators/[^/]+/curatedPackages/[^/]+$
Location : path
Description : Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`
Required : Yes
Parameter Order : name
▼ ▲ curationpartners.curators.curatedPackages.patch
Parameters :
updateMask
Location : query
Type : string
Description : Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Format : google-fieldmask
name
Pattern : ^curators/[^/]+/curatedPackages/[^/]+$
Type : string
Required : Yes
Description : Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`
Location : path
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}
Description : Updates an existing curated package.
Path : v1/{+name}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ curationpartners.curators.reports.run
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. The report to run. Format: `curators/{account_id}/reports/{report_id}`
Pattern : ^curators/[^/]+/reports/[^/]+$
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/curation-partners
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.
Path : v1/{+name}:run
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}:run
▼ ▲ curationpartners.curators.reports.delete
Parameter Order : name
Description : Deletes a `Report` object.
Parameters :
name
Description : Required. Resource name of the report to delete. Format: `curators/{account_id}/reports/{report_id}`
Pattern : ^curators/[^/]+/reports/[^/]+$
Location : path
Required : Yes
Type : string
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/curation-partners
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}
HTTP Method : DELETE
▼ ▲ curationpartners.curators.reports.create
Flat Path : v1/curators/{curatorsId}/reports
Description : Creates a `Report` object.
Scopes : https://www.googleapis.com/auth/curation-partners
Path : v1/{+parent}/reports
HTTP Method : POST
Parameters :
parent
Type : string
Description : Required. The parent resource where this `Report` will be created. Format: `curators/{account_id}`
Required : Yes
Pattern : ^curators/[^/]+$
Location : path
Parameter Order : parent
▼ ▲ curationpartners.curators.reports.get
Parameters :
name
Description : Required. The resource name of the report. Format: `curators/{account_id}/reports/{report_id}`
Required : Yes
Location : path
Type : string
Pattern : ^curators/[^/]+/reports/[^/]+$
Description : Retrieves a `Report` object.
Scopes : https://www.googleapis.com/auth/curation-partners
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}
HTTP Method : GET
▼ ▲ curationpartners.curators.reports.patch
Description : Updates a `Report` object.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/curation-partners
HTTP Method : PATCH
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}
Parameter Order : name
Parameters :
updateMask
Type : string
Description : Optional. The list of fields to update.
Format : google-fieldmask
Location : query
name
Location : path
Required : Yes
Type : string
Pattern : ^curators/[^/]+/reports/[^/]+$
Description : Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}`
▼ ▲ curationpartners.curators.reports.list
Scopes : https://www.googleapis.com/auth/curation-partners
Description : Lists `Report` objects.
Path : v1/{+parent}/reports
HTTP Method : GET
Flat Path : v1/curators/{curatorsId}/reports
Parameter Order : parent
Parameters :
filter
Description : Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Type : string
Location : query
parent
Location : path
Description : Required. The parent, which owns this collection of reports. Format: `curators/{account_id}`
Required : Yes
Type : string
Pattern : ^curators/[^/]+$
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
Location : query
Type : integer
skip
Description : Optional. Number of individual resources to skip while paginating.
Format : int32
Type : integer
Location : query
orderBy
Description : Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
Location : query
Type : string
pageToken
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.
Location : query
▼ ▲ curationpartners.curators.reports.operations.get
Parameter Order : name
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}/operations/{operationsId}
Path : v1/{+name}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/curation-partners
Parameters :
name
Type : string
Location : path
Required : Yes
Description : The name of the operation resource.
Pattern : ^curators/[^/]+/reports/[^/]+/operations/[^/]+$
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.
▼ ▲ curationpartners.curators.reports.results.fetchRows
Scopes : https://www.googleapis.com/auth/curation-partners
HTTP Method : GET
Flat Path : v1/curators/{curatorsId}/reports/{reportsId}/results/{resultsId}:fetchRows
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.
Location : query
Type : string
name
Type : string
Description : The report result being fetched. Format: `curators/{account_id}/reports/{report_id}/results/{report_result_id}`
Required : Yes
Location : path
Pattern : ^curators/[^/]+/reports/[^/]+/results/[^/]+$
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.
Format : int32
Location : query
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.