GenerateAudienceOverlapInsightsRequest

  • The GenerateAudienceOverlapInsights request message is used to calculate the overlap between different audiences.

  • Required fields for this request include customer_id, country_location, primary_attribute, and dimensions.

  • The primary_attribute must be an Affinity or In-Market UserInterest, AgeRange, or Gender.

  • The dimensions array specifies the types of attributes to calculate overlap with the primary_attribute, limited to AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE, and GENDER.

  • Optional fields include customer_insights_group and insights_application_info.

Request message for AudienceInsightsService.GenerateAudienceOverlapInsights.

Fields

customer_id

string

Required. The ID of the customer.

country_location

LocationInfo

Required. The country in which to calculate the sizes and overlaps of audiences.

primary_attribute

AudienceInsightsAttribute

Required. The audience attribute that should be intersected with all other eligible audiences. This must be an Affinity or In-Market UserInterest, an AgeRange or a Gender.

dimensions[]

AudienceInsightsDimension

Required. The types of attributes of which to calculate the overlap with the primary_attribute. The values must be a subset of AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.

customer_insights_group

string

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

insights_application_info

AdditionalApplicationInfo

Optional. Additional information on the application issuing the request.