Method: listPlannableUserLists

Returns the list of plannable user lists with their plannable status. User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users.

List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

HTTP request

POST https://googleads.googleapis.com/v20:listPlannableUserLists

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "customerId": string,
  "customerReachGroup": string
}
Fields
customerId

string

Required. The ID of the customer.
customerReachGroup

string

The name of the customer being planned for. This is a user-defined value.

Response body

A response with all available user lists with their plannable status.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ]
}
Fields
plannableUserLists[]

object (PlannableUserList)

The list of user lists available for planning and related targeting metadata.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PlannableUserList

A plannable user list.

JSON representation 
{
  "userListInfo": {
    object (UserListInfo)
  },
  "displayName": string,
  "userListType": enum (UserListType),
  "plannableStatus": enum (ReachPlanPlannableUserListStatus)
}
Fields
userListInfo

object (UserListInfo)

The user list ID.
displayName

string

The name of the user list.
userListType

enum (UserListType)

The user list type.
plannableStatus

enum (ReachPlanPlannableUserListStatus)

The plannable status of the user list.

ReachPlanPlannableUserListStatus

The plannable user list status.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PLANNABLE The user list is plannable.
UNPLANNABLE The user list is not plannable.