Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131895110.3 KB
accountTypes

Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId} * linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

post/v1/{+parent}/userLists

Path parameters

parentstring required

Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}

Query parameters

validateOnlyboolean

Optional. If true, the request is validated but not executed.

Request body

readOnlyboolean

Output only. An option that indicates if a user may edit a list.

integrationCodestring

Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.

descriptionstring

Optional. A description of the user list.

closingReason'CLOSING_REASON_UNSPECIFIED' | 'UNUSED'

Output only. The reason why this user list membership status is closed.

namestring

Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

displayNamestring

Required. The display name of the user list.

idstring int64

Output only. The unique ID of the user list.

accessReason'ACCESS_REASON_UNSPECIFIED' | 'OWNED' | 'SHARED' | 'LICENSED' | 'SUBSCRIBED' | 'AFFILIATED'

Output only. The reason this account has been granted access to the list.

membershipDurationstring google-duration

Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.

membershipStatus'MEMBERSHIP_STATUS_UNSPECIFIED' | 'OPEN' | 'CLOSED'

Optional. Membership status of this user list.

accountAccessStatus'ACCESS_STATUS_UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED. Later the user list owner can decide to revoke the share and make it DISABLED.

Response

Successful response