REST Resource: accountTypes.accounts.userLists

    Resource: UserList

    A user list resource.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "readOnly" 
 : 
 boolean 
 , 
 "membershipDuration" 
 : 
 string 
 , 
 "accessReason" 
 : 
 enum (  AccessReason 
 
) 
 , 
 "sizeInfo" 
 : 
 { 
 object (  SizeInfo 
 
) 
 } 
 , 
 "targetNetworkInfo" 
 : 
 { 
 object (  TargetNetworkInfo 
 
) 
 } 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "membershipStatus" 
 : 
 enum (  MembershipStatus 
 
) 
 , 
 "integrationCode" 
 : 
 string 
 , 
 "closingReason" 
 : 
 enum (  ClosingReason 
 
) 
 , 
 "accountAccessStatus" 
 : 
 enum (  AccessStatus 
 
) 
 , 
 // Union field user_list_info 
can be only one of the following: 
 "ingestedUserListInfo" 
 : 
 { 
 object (  IngestedUserListInfo 
 
) 
 } 
 // End of list of possible types for union field user_list_info 
. 
 }
    Fields
    name

    string

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

    id

    string ( int64 format)

    Output only. The unique ID of the user list.

    readOnly

    boolean

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

    membershipDuration

    string ( Duration format)

    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.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

    accessReason

    enum ( AccessReason )

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

    sizeInfo

    object ( SizeInfo )

    Output only. Estimated number of members in this user list in different target networks.

    targetNetworkInfo

    object ( TargetNetworkInfo )

    Optional. Eligibility information for different target networks.

    displayName

    string

    Required. The display name of the user list.

    description

    string

    Optional. A description of the user list.

    membershipStatus

    enum ( MembershipStatus )

    Optional. Membership status of this user list.

    integrationCode

    string

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

    closingReason

    enum ( ClosingReason )

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

    accountAccessStatus

    enum ( AccessStatus )

    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 .

    Union field user_list_info . Additional information about the user list. user_list_info can be only one of the following:
    ingestedUserListInfo

    object ( IngestedUserListInfo )

    Optional. Represents a user list that is populated by user ingested data.

    MembershipStatus

    Status of the user list.

    Enums
    MEMBERSHIP_STATUS_UNSPECIFIED Not specified.
    OPEN Open status - User list is accruing members and can be targeted to.
    CLOSED Closed status - No new members being added.

    ClosingReason

    Indicates the reason why the user list was closed. This enum is only used when a list is auto-closed by the system.

    Enums
    CLOSING_REASON_UNSPECIFIED Not specified.
    UNUSED The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details.

    AccessReason

    Enum describing possible access reasons.

    Enums
    ACCESS_REASON_UNSPECIFIED Not specified.
    OWNED The resource is owned by the user.
    SHARED The resource is shared to the user.
    LICENSED The resource is licensed to the user.
    SUBSCRIBED The user subscribed to the resource.
    AFFILIATED The resource is accessible to the user.

    AccessStatus

    Indicates if this client still has access to the list.

    Enums
    ACCESS_STATUS_UNSPECIFIED Not specified.
    ENABLED The access is enabled.
    DISABLED The access is disabled.

    SizeInfo

    Estimated number of members in this user list in different target networks.

    JSON representation 
     { 
 "displayNetworkMembersCount" 
 : 
 string 
 , 
 "searchNetworkMembersCount" 
 : 
 string 
 }
    Fields
    displayNetworkMembersCount

    string ( int64 format)

    Output only. Estimated number of members in this user list, on the Google Display Network.
    searchNetworkMembersCount

    string ( int64 format)

    Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.

    TargetNetworkInfo

    Eligibility information for different target networks.

    JSON representation 
     { 
 "eligibleForDisplay" 
 : 
 boolean 
 , 
 "eligibleForSearch" 
 : 
 boolean 
 }
    Fields
    eligibleForDisplay

    boolean

    Output only. Indicates this user list is eligible for Google Display Network.

    IngestedUserListInfo

    Represents a user list that is populated by user provided data.

    JSON representation 
     { 
 "uploadKeyTypes" 
 : 
 [ 
 enum (  UploadKeyType 
 
) 
 ] 
 , 
 "contactIdInfo" 
 : 
 { 
 object (  ContactIdInfo 
 
) 
 } 
 , 
 "mobileIdInfo" 
 : 
 { 
 object (  MobileIdInfo 
 
) 
 } 
 , 
 "userIdInfo" 
 : 
 { 
 object (  UserIdInfo 
 
) 
 } 
 , 
 "pairIdInfo" 
 : 
 { 
 object (  PairIdInfo 
 
) 
 } 
 , 
 "pseudonymousIdInfo" 
 : 
 { 
 object (  PseudonymousIdInfo 
 
) 
 } 
 , 
 "partnerAudienceInfo" 
 : 
 { 
 object (  PartnerAudienceInfo 
 
) 
 } 
 }
    Fields
    uploadKeyTypes[]

    enum ( UploadKeyType )

    Required. Immutable. Upload key types of this user list.
    contactIdInfo

    object ( ContactIdInfo )

    Optional. Additional information when CONTACT_ID is one of the uploadKeyTypes .
    mobileIdInfo

    object ( MobileIdInfo )

    Optional. Additional information when MOBILE_ID is one of the uploadKeyTypes .
    userIdInfo

    object ( UserIdInfo )

    Optional. Additional information when USER_ID is one of the uploadKeyTypes .
    pairIdInfo

    object ( PairIdInfo )

    Optional. Additional information when PAIR_ID is one of the uploadKeyTypes .

    This feature is only available to data partners.
    pseudonymousIdInfo

    object ( PseudonymousIdInfo )

    Optional. Additional information for PSEUDONYMOUS_ID is one of the uploadKeyTypes .
    partnerAudienceInfo

    object ( PartnerAudienceInfo )

    Optional. Additional information for partner audiences.

    This feature is only available to data partners.

    UploadKeyType

    Enum containing the possible upload key types of a user list.

    Enums
    UPLOAD_KEY_TYPE_UNSPECIFIED Not specified.
    CONTACT_ID Customer info such as email address, phone number or physical address.
    MOBILE_ID Mobile advertising ids.
    USER_ID Third party provided user ids.
    PAIR_ID Publisher advertiser identity reconciliation ids.
    PSEUDONYMOUS_ID Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID

    ContactIdInfo

    Additional information when CONTACT_ID is one of the uploadKeyTypes .

    JSON representation 
     { 
 "matchRatePercentage" 
 : 
 integer 
 , 
 "dataSourceType" 
 : 
 enum (  DataSourceType 
 
) 
 }
    Fields
    matchRatePercentage

    integer

    Output only. Match rate for customer match user lists.
    dataSourceType

    enum ( DataSourceType )

    Optional. Immutable. Source of the upload data

    DataSourceType

    Indicates source of upload data.

    Enums
    DATA_SOURCE_TYPE_UNSPECIFIED Not specified.
    DATA_SOURCE_TYPE_FIRST_PARTY The uploaded data is first-party data.
    DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU The uploaded data is from a third-party credit bureau.
    DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE The uploaded data is from a third-party voter file.
    DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA The uploaded data is third party partner data.

    MobileIdInfo

    Additional information when MOBILE_ID is one of the uploadKeyTypes .

    JSON representation 
     { 
 "dataSourceType" 
 : 
 enum (  DataSourceType 
 
) 
 , 
 "keySpace" 
 : 
 enum (  KeySpace 
 
) 
 , 
 "appId" 
 : 
 string 
 }
    Fields
    dataSourceType

    enum ( DataSourceType )

    Optional. Immutable. Source of the upload data.
    keySpace

    enum ( KeySpace )

    Required. Immutable. The key space of mobile IDs.
    appId

    string

    Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.

    KeySpace

    Key space for mobile ID.

    Enums
    KEY_SPACE_UNSPECIFIED Not specified.
    IOS The iOS keyspace.
    ANDROID The Android keyspace.

    UserIdInfo

    Additional information when USER_ID is one of the uploadKeyTypes .

    JSON representation 
     { 
 "dataSourceType" 
 : 
 enum (  DataSourceType 
 
) 
 }
    Fields
    dataSourceType

    enum ( DataSourceType )

    Optional. Immutable. Source of the upload data.

    PairIdInfo

    Additional information when PAIR_ID is one of the uploadKeyTypes .

    This feature is only available to data partners.

    JSON representation 
     { 
 "publisherId" 
 : 
 string 
 , 
 "publisherName" 
 : 
 string 
 , 
 "matchRatePercentage" 
 : 
 integer 
 , 
 "advertiserIdentifierCount" 
 : 
 string 
 , 
 "cleanRoomIdentifier" 
 : 
 string 
 }
    Fields
    publisherId

    string ( int64 format)

    Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
    publisherName

    string

    Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
    matchRatePercentage

    integer

    Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
    advertiserIdentifierCount

    string ( int64 format)

    Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
    cleanRoomIdentifier

    string

    Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.

    PseudonymousIdInfo

    Additional information when PSEUDONYMOUS_ID is one of the uploadKeyTypes .

    JSON representation 
     { 
 "syncStatus" 
 : 
 enum (  SyncStatus 
 
) 
 , 
 "billableRecordCount" 
 : 
 string 
 }
    Fields
    syncStatus

    enum ( SyncStatus )

    Output only. Sync status of the user list.
    billableRecordCount

    string ( int64 format)

    Optional. Immutable. The number of billable records (e.g. uploaded or matched).

    SyncStatus

    Sync status of the user list.

    Enums
    SYNC_STATUS_UNSPECIFIED Not specified.
    CREATED The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.
    READY_FOR_USE The user list is ready for use. Contents and cookies have been synced correctly.
    FAILED An error has occurred syncing user list contents and/or metadata. The user list cannot be used.

    PartnerAudienceInfo

    Additional information for partner audiences.

    This feature is only available to data partners.

    JSON representation 
     { 
 "partnerAudienceSource" 
 : 
 enum (  PartnerAudienceSource 
 
) 
 , 
 "commercePartner" 
 : 
 string 
 }
    Fields
    partnerAudienceSource

    enum ( PartnerAudienceSource )

    Required. Immutable. The source of the partner audience.
    commercePartner

    string

    Optional. The commerce partner name. Only allowed if partnerAudienceSource is COMMERCE_AUDIENCE .

    PartnerAudienceSource

    Partner audience source.

    Enums
    PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Not specified.
    COMMERCE_AUDIENCE Partner Audience source is commerce audience.
    LINEAR_TV_AUDIENCE Partner Audience source is linear TV audience.
    AGENCY_PROVIDER_AUDIENCE Partner Audience source is agency/provider audience.

    Methods

    create

    		Creates a UserList.

    delete

    		Deletes a UserList.

    get

    		Gets a UserList.

    list

    		Lists UserLists.

    patch

    		Updates a UserList.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: