Gcp/curationpartners
@swamp/gcp/curationpartnersv2026.10.23.1
01README
Google Cloud curationpartners infrastructure models
02Release Notes
- Updated: curators_curatedpackages, curators_datasegments, curators_reports, mediaplanners
03Behaviors
@swamp/gcp/curationpartners/curators-curatedpackagesv2026.10.23.1curators_curatedpackages.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| accessSettings? | object | Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource. |
| curationFeeVisibility? | enum | Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). |
| description? | string | Optional. A description of the curated package, provided by the curator. |
| displayName? | string | Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. |
| feeCpm? | object | Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. |
| floorPriceCpm? | object | Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method. |
| millipercentOfMediaFee? | string | Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. |
| name? | string | Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` |
| targeting? | object | Optional. Targeting criteria for the curated package. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a curatedPackages
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a curatedPackages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the curatedPackages |
fn update(identifier?: string, waitForReady?: boolean)
Update curatedPackages attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific curatedPackages by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync(identifier?: string)
Sync curatedPackages state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific curatedPackages by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List curatedPackages resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | 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 |
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn activate()
activate
fn deactivate()
deactivate
Resources
state(infinite)— Represents a curated package of inventory created and managed by a Curator.
@swamp/gcp/curationpartners/curators-datasegmentsv2026.10.23.1curators_datasegments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| cpmFee? | object | Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. |
| millipercentOfMediaFee? | string | Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. |
| name? | string | 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}` |
| userListId? | string | Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a dataSegments
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a dataSegments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataSegments |
fn update(identifier?: string, waitForReady?: boolean)
Update dataSegments attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataSegments by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync(identifier?: string)
Sync dataSegments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataSegments by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List dataSegments resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn activate()
activate
fn deactivate()
deactivate
Resources
state(infinite)— Defines an identifier for a segment of inventory that can be targeted by cura...
@swamp/gcp/curationpartners/curators-reportsv2026.10.23.1curators_reports.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| displayName? | string | Optional. Display name for the report. |
| name? | string | Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}` |
| reportDefinition? | object | Required. The report definition of the report. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a reports
fn get(identifier: string)
Get a reports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the reports |
fn update(identifier?: string)
Update reports attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific reports by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the reports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the reports |
fn sync(identifier?: string)
Sync reports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific reports by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, skip?: number, maxPages?: number)
List reports resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters |
| orderBy? | string | Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order |
| pageSize? | number | 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. |
| skip? | number | Optional. Number of individual resources to skip while paginating. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn run()
run
Resources
state(infinite)— The `Report` resource.
@swamp/gcp/curationpartners/mediaplannersv2026.10.23.1mediaplanners.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a mediaPlanners
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mediaPlanners |
fn sync(identifier?: string)
Sync mediaPlanners state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific mediaPlanners by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List mediaPlanners resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` |
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn search(dspSeatId?: any, pageSize?: any, pageToken?: any)
search
| Argument | Type | Description |
|---|---|---|
| dspSeatId? | any | |
| pageSize? | any | |
| pageToken? | any |
Resources
state(infinite)— Represents a media planner account.
04Previous Versions
2026.10.21.1AGPL-3.0-or-later(was none)
- Updated: mediaplanners
Modified 1 behaviors
2026.10.13.1
- Updated: curators_curatedpackages, curators_datasegments, curators_reports, mediaplanners
2026.08.29.1
- Added: curators_curatedpackages, curators_datasegments, curators_reports, mediaplanners
05Stats
A
100 / 100
Downloads
25
Archive size
59.6 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels