Authorized Buyers Marketplace API (authorizedbuyersmarketplace:v1alpha)

2025-12-12

7 new methods

Additions

    Methods
  • authorizedbuyersmarketplace.mediaPlanners.list

      HTTP Method : GET

      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.

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      Path : v1alpha/mediaPlanners

      Flat Path : v1alpha/mediaPlanners

      Parameters :

        pageToken

          Description : A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.

          Type : string

          Location : query

        pageSize

          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.

          Type : integer

          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

  • authorizedbuyersmarketplace.curators.curatedPackages.activate

      HTTP Method : POST

      Description : Activates an existing curated package.

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      Path : v1alpha/{+name}:activate

      Parameter Order : name

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate

      Parameters :

        name

          Description : Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`

          Required : Yes

          Location : path

          Pattern : ^curators/[^/]+/curatedPackages/[^/]+$

          Type : string

  • authorizedbuyersmarketplace.curators.curatedPackages.create

      Parameter Order : parent

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      Parameters :

        parent

          Type : string

          Required : Yes

          Pattern : ^curators/[^/]+$

          Location : path

          Description : Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`

      Path : v1alpha/{+parent}/curatedPackages

      Description : Creates a new curated package.

      HTTP Method : POST

  • authorizedbuyersmarketplace.curators.curatedPackages.get

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}

      Path : v1alpha/{+name}

      Description : Gets a curated package given its resource name.

      HTTP Method : GET

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      Parameters :

        name

          Location : path

          Description : Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`

          Type : string

          Required : Yes

          Pattern : ^curators/[^/]+/curatedPackages/[^/]+$

  • authorizedbuyersmarketplace.curators.curatedPackages.list

      Parameter Order : parent

      HTTP Method : GET

      Path : v1alpha/{+parent}/curatedPackages

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      Description : Lists curated packages owned by the specified curator.

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages

      Parameters :

        pageSize

          Location : query

          Type : integer

          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.

          Format : int32

        filter

          Type : string

          Location : query

          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

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.

        parent

          Required : Yes

          Description : Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`

          Type : string

          Location : path

          Pattern : ^curators/[^/]+$

  • authorizedbuyersmarketplace.curators.curatedPackages.deactivate

      Description : Deactivates an existing curated package.

      Path : v1alpha/{+name}:deactivate

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate

      HTTP Method : POST

      Parameters :

        name

          Type : string

          Description : Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`

          Required : Yes

          Location : path

          Pattern : ^curators/[^/]+/curatedPackages/[^/]+$

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

  • authorizedbuyersmarketplace.curators.curatedPackages.patch

      Flat Path : v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}

      Description : Updates an existing curated package.

      Path : v1alpha/{+name}

      Parameters :

        name

          Type : string

          Location : path

          Required : Yes

          Pattern : ^curators/[^/]+/curatedPackages/[^/]+$

          Description : Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`

        updateMask

          Type : string

          Format : google-fieldmask

          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

      Scopes : https://www.googleapis.com/auth/authorized-buyers-marketplace

      HTTP Method : PATCH

      Parameter Order : name