--- title: "POST /v1/{+parent}/userListDirectLicenses" method: POST path: "/v1/{+parent}/userListDirectLicenses" tags: ["accountTypes"] --- # POST /v1/{+parent}/userListDirectLicenses `POST /v1/{+parent}/userListDirectLicenses` Creates a user list direct license. This feature is only available to data partners. ## Path parameters - `parent` string, required ## Request body - UserListDirectLicense — A user list direct license. This feature is only available to data partners. - `userListId` string, int64 — Immutable. ID of the user list being licensed. - `userListDisplayName` string — Output only. Name of the user list being licensed. This field is read-only. - `status` 'USER_LIST_LICENSE_STATUS_UNSPECIFIED' | 'USER_LIST_LICENSE_STATUS_ENABLED' | 'USER_LIST_LICENSE_STATUS_DISABLED' — Optional. Status of UserListDirectLicense - ENABLED or DISABLED. - `pricing` UserListLicensePricing — A user list license pricing. - `pricingId` string, int64 — Output only. The ID of this pricing. - `buyerApprovalState` 'USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED' | 'PENDING' | 'APPROVED' | 'REJECTED' — Output only. The buyer approval state of this pricing. This field is read-only. - `maxCostMicros` string, int64 — Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - `costType` 'USER_LIST_PRICING_COST_TYPE_UNSPECIFIED' | 'CPC' | 'CPM' | 'MEDIA_SHARE' — Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - `endTime` string, google-datetime — Optional. End time of the pricing. - `pricingActive` boolean — Output only. Whether this pricing is active. - `currencyCode` string — Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - `costMicros` string, int64 — Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - `startTime` string, google-datetime — Output only. Start time of the pricing. - `clientAccountId` string, int64 — Immutable. ID of client customer which the user list is being licensed to. - `clientAccountDisplayName` string — Output only. Name of client customer which the user list is being licensed to. This field is read-only. - `historicalPricings` UserListLicensePricing[] — Output only. Pricing history of this user list license. This field is read-only. - `pricingId` string, int64 — Output only. The ID of this pricing. - `buyerApprovalState` 'USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED' | 'PENDING' | 'APPROVED' | 'REJECTED' — Output only. The buyer approval state of this pricing. This field is read-only. - `maxCostMicros` string, int64 — Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - `costType` 'USER_LIST_PRICING_COST_TYPE_UNSPECIFIED' | 'CPC' | 'CPM' | 'MEDIA_SHARE' — Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - `endTime` string, google-datetime — Optional. End time of the pricing. - `pricingActive` boolean — Output only. Whether this pricing is active. - `currencyCode` string — Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - `costMicros` string, int64 — Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - `startTime` string, google-datetime — Output only. Start time of the pricing. - `metrics` UserListLicenseMetrics — Metrics related to a user list license. - `revenueUsdMicros` string, int64 — Output only. The revenue for the user list license in USD micros. - `startDate` string, int64 — Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - `clickCount` string, int64 — Output only. The number of clicks for the user list license. - `impressionCount` string, int64 — Output only. The number of impressions for the user list license. - `endDate` string, int64 — Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - `name` string — Identifier. The resource name of the user list direct license. - `clientAccountType` 'USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN' | 'USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS' | 'USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER' | 'USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER' | 'USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK' — Immutable. Account type of client customer which the user list is being licensed to. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/datamanager.md) · [All operations](https://skmtc.dev/google/apis/datamanager/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/datamanager/revisions/a26378ca9ba8/schema)