Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.lifeEvents

Resource: LifeEvent

A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "parent": string,
  "launchedToAll": boolean,
  "availabilities": [
    {
      object (CriterionCategoryAvailability)
    }
  ]
}
Fields
resourceName

string

Output only. The resource name of the life event. Life event resource names have the form:

customers/{customerId}/lifeEvents/{life_event_id}

id

string (int64 format)

Output only. The ID of the life event.

name

string

Output only. The name of the life event. E.g.,"Recently Moved"

parent

string

Output only. The parent of the lifeEvent.

launchedToAll

boolean

Output only. True if the life event is launched to all channels and locales.

availabilities[]

object (CriterionCategoryAvailability)

Output only. Availability information of the life event.

Methods

get

Returns the requested life event in full detail.