Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a user list direct license. This feature is only available to data partners.
Retrieves a user list direct license. This feature is only available to data partners.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a user list direct license. This feature is only available to data partners.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a user list direct license. This feature is only available to data partners.
Args:
parent: string, Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
body: object, The request body.
The object takes the form of:
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
}
get(name, x__xgafv=None)
Retrieves a user list direct license. This feature is only available to data partners.
Args:
name: string, Required. The resource name of the user list direct license. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.
Args:
parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
pageSize: integer, Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from the ListUserListDirectLicensesRequest.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"userListDirectLicenses": [ # The licenses for the given user list in the request.
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a user list direct license. This feature is only available to data partners.
Args:
name: string, Identifier. The resource name of the user list direct license. (required)
body: object, The request body.
The object takes the form of:
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
}
updateMask: string, Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A user list direct license. This feature is only available to data partners.
"clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
"clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
"clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
"historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
{ # A user list license pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
],
"metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
"clickCount": "A String", # Output only. The number of clicks for the user list license.
"endDate": "A String", # 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.
"impressionCount": "A String", # Output only. The number of impressions for the user list license.
"revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
"startDate": "A String", # 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.
},
"name": "A String", # Identifier. The resource name of the user list direct license.
"pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
"buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
"costMicros": "A String", # 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`.
"costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
"currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
"endTime": "A String", # Optional. End time of the pricing.
"maxCostMicros": "A String", # 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.
"pricingActive": True or False, # Output only. Whether this pricing is active.
"pricingId": "A String", # Output only. The ID of this pricing.
"startTime": "A String", # Output only. Start time of the pricing.
},
"status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
"userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
"userListId": "A String", # Immutable. ID of the user list being licensed.
}