Skip to main content
The Populations API allows you to create, retrieve, and list populations. A population is provided by a DataProvider and represents a set of individuals or entities.

​
Resource

​
Population

A population provided by a DataProvider.
​
name
string
required
Resource name with pattern dataProviders/{data_provider}/populations/{population}
​
description
string
The Population description.
​
create_time
Timestamp
When the Population was created.
​
population_spec_ref
oneof
required
Reference to the PopulationSpec. One of:
​
population_blob
PopulationBlob
(Deprecated) The blob for the population.This field is immutable after creation.
​
population_blob.blob_uri
string
required
A URI for the population blob.This must be unique across all Population resources for the parent DataProvider.
​
population_spec
PopulationSpec
The specification of this Population. Required for new resources.This must be unique across all Population resources for the parent DataProvider. This field is immutable after creation.
​
event_template
EventTemplate
(Deprecated) The EventTemplate that this population conforms to.The event templates can be determined from the PopulationSpec, as each attributes element corresponds to an event template.

​
Methods

​
CreatePopulation

Creates a new Population.
​
parent
string
required
Resource name of the parent DataProvider.Format: dataProviders/{data_provider}
​
population
Population
required
The Population to create. The name field will be ignored, and the system will assign an ID.Required fields:
  • One of population_blob or population_spec
​
request_id
string
Unique identifier for this request.Limited to 36 ASCII characters. This may be an RFC 4211 UUID. The request is only idempotent if this field is specified.
Response Returns the created Population resource. Example Request 
CreatePopulationRequest {
  parent: "dataProviders/123"
  population: {
    description: "US adult population"
    population_spec: {
      // PopulationSpec fields
    }
  }
  request_id: "550e8400-e29b-41d4-a716-446655440000"
}

​
GetPopulation

Returns the Population with the specified resource key.
​
name
string
required
Resource name of the Population to retrieve.Format: dataProviders/{data_provider}/populations/{population}
Response Returns a Population resource. Example Request 
GetPopulationRequest {
  name: "dataProviders/123/populations/456"
}

​
ListPopulations

Lists Population resources for a DataProvider.
​
parent
string
required
Resource name of the parent DataProvider.Format: dataProviders/{data_provider}
​
page_size
int32
The maximum number of Populations to return. The service may return fewer than this value.
  • If unspecified, at most 50 Populations will be returned
  • Maximum value is 1000; values above 1000 will be coerced to 1000
​
page_token
string
A page token received from a previous ListPopulations call. Provide this to retrieve the subsequent page.When paginating, all other parameters must match the call that provided the page token.
Response
​
populations
Population[]
List of Population resources
​
next_page_token
string
A token that can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.
Example Request 
ListPopulationsRequest {
  parent: "dataProviders/123"
  page_size: 50
}

Build docs developers (and LLMs) love

Get started for freeTalk to us