diff --git a/Makefile b/Makefile index a39836d..0c109c7 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ codegen: openapi-generator generate \ -i https://developer.digiseg.net/openapi.json \ -g python -o ${GENERATED_DIR} \ - --additional-properties packageName=digiseg_api,projectName=digiseg-api-client,library=asyncio \ + --additional-properties packageName=digiseg_api,projectName=digiseg-api-client \ --git-user-id digiseg-labs \ --git-repo-id api-client-python cp -r ${GENERATED_DIR}/digiseg_api . diff --git a/digiseg_api/__init__.py b/digiseg_api/__init__.py index 4cf4158..2883b07 100644 --- a/digiseg_api/__init__.py +++ b/digiseg_api/__init__.py @@ -5,7 +5,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:

API client for Python

API client for Go

## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:

API client for Python

API client for TypeScript

API client for Go

## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -25,6 +25,7 @@ from digiseg_api.api.measurement_labels_api import MeasurementLabelsApi from digiseg_api.api.populations_api import PopulationsApi from digiseg_api.api.studies_api import StudiesApi +from digiseg_api.api.subscriptions_api import SubscriptionsApi from digiseg_api.api.usage_api import UsageApi from digiseg_api.api.users_api import UsersApi @@ -46,11 +47,23 @@ from digiseg_api.models.account_creation import AccountCreation from digiseg_api.models.account_creation_aux import AccountCreationAux from digiseg_api.models.account_full import AccountFull +from digiseg_api.models.account_include_aux import AccountIncludeAux +from digiseg_api.models.account_include_param import AccountIncludeParam from digiseg_api.models.account_item import AccountItem from digiseg_api.models.account_links import AccountLinks from digiseg_api.models.account_mutation import AccountMutation from digiseg_api.models.account_mutation_aux import AccountMutationAux from digiseg_api.models.account_owner_creation import AccountOwnerCreation +from digiseg_api.models.account_sort_option import AccountSortOption +from digiseg_api.models.account_stripe_billing_info import AccountStripeBillingInfo +from digiseg_api.models.account_subscription_base import AccountSubscriptionBase +from digiseg_api.models.account_subscription_creation import AccountSubscriptionCreation +from digiseg_api.models.account_subscription_full import AccountSubscriptionFull +from digiseg_api.models.account_subscription_full_aux import AccountSubscriptionFullAux +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.account_subscription_item_aux import AccountSubscriptionItemAux +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.account_subscriptions_summary import AccountSubscriptionsSummary from digiseg_api.models.api_key_aux import ApiKeyAux from digiseg_api.models.api_key_base import ApiKeyBase from digiseg_api.models.api_key_creation import ApiKeyCreation @@ -72,6 +85,7 @@ from digiseg_api.models.audience_response import AudienceResponse from digiseg_api.models.audience_response_status import AudienceResponseStatus from digiseg_api.models.audience_stats import AudienceStats +from digiseg_api.models.audiences_include_param import AudiencesIncludeParam from digiseg_api.models.auth_token_request import AuthTokenRequest from digiseg_api.models.auth_token_response import AuthTokenResponse from digiseg_api.models.business_audience_stats import BusinessAudienceStats @@ -91,11 +105,14 @@ from digiseg_api.models.error_response import ErrorResponse from digiseg_api.models.frequency_stats import FrequencyStats from digiseg_api.models.get_account_by_id200_response import GetAccountById200Response +from digiseg_api.models.get_account_subscription_by_id200_response import GetAccountSubscriptionById200Response +from digiseg_api.models.get_account_subscriptions200_response import GetAccountSubscriptions200Response from digiseg_api.models.get_api_key_by_id200_response import GetApiKeyById200Response from digiseg_api.models.get_popuplation_by_key200_response import GetPopuplationByKey200Response from digiseg_api.models.hour_of_day_stats import HourOfDayStats from digiseg_api.models.identifyable_object import IdentifyableObject from digiseg_api.models.identifyable_object1 import IdentifyableObject1 +from digiseg_api.models.limited_or_full_feature import LimitedOrFullFeature from digiseg_api.models.list_api_keys_by_account_id200_response import ListApiKeysByAccountId200Response from digiseg_api.models.list_audience_data_daily_usage200_response import ListAudienceDataDailyUsage200Response from digiseg_api.models.list_audience_data_monthly_usage200_response import ListAudienceDataMonthlyUsage200Response @@ -107,6 +124,7 @@ from digiseg_api.models.list_pagination_meta_page import ListPaginationMetaPage from digiseg_api.models.list_popuplations200_response import ListPopuplations200Response from digiseg_api.models.list_studies200_response import ListStudies200Response +from digiseg_api.models.list_subscription_plans200_response import ListSubscriptionPlans200Response from digiseg_api.models.list_users_by_account_id200_response import ListUsersByAccountId200Response from digiseg_api.models.measurement import Measurement from digiseg_api.models.measurement_client_base import MeasurementClientBase @@ -121,6 +139,7 @@ from digiseg_api.models.measurements_container import MeasurementsContainer from digiseg_api.models.passwordless_auth_request import PasswordlessAuthRequest from digiseg_api.models.permission_scopes import PermissionScopes +from digiseg_api.models.plan_feature_set import PlanFeatureSet from digiseg_api.models.population_audience_category_set_business_section import PopulationAudienceCategorySetBusinessSection from digiseg_api.models.population_audience_category_set_private_section import PopulationAudienceCategorySetPrivateSection from digiseg_api.models.population_audience_category_set_section import PopulationAudienceCategorySetSection @@ -161,6 +180,8 @@ from digiseg_api.models.resolve_audiences_of_multiple_request_item import ResolveAudiencesOfMultipleRequestItem from digiseg_api.models.resolve_audiences_of_multiple_response import ResolveAudiencesOfMultipleResponse from digiseg_api.models.resolve_audiences_of_multiple_response_item import ResolveAudiencesOfMultipleResponseItem +from digiseg_api.models.stripe_account_subscription_checkout_session import StripeAccountSubscriptionCheckoutSession +from digiseg_api.models.stripe_account_subscription_purchase_creation import StripeAccountSubscriptionPurchaseCreation from digiseg_api.models.study_audience_stats import StudyAudienceStats from digiseg_api.models.study_aux import StudyAux from digiseg_api.models.study_base import StudyBase @@ -178,9 +199,20 @@ from digiseg_api.models.study_permissions import StudyPermissions from digiseg_api.models.study_summary_stats import StudySummaryStats from digiseg_api.models.study_timing_stats import StudyTimingStats +from digiseg_api.models.subscription_plan_aux import SubscriptionPlanAux +from digiseg_api.models.subscription_plan_base import SubscriptionPlanBase +from digiseg_api.models.subscription_plan_full import SubscriptionPlanFull +from digiseg_api.models.subscription_plan_item import SubscriptionPlanItem +from digiseg_api.models.subscription_price import SubscriptionPrice +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.subscription_price_interval import SubscriptionPriceInterval +from digiseg_api.models.subscription_product_type import SubscriptionProductType +from digiseg_api.models.tax_id import TaxId from digiseg_api.models.timestamped_object import TimestampedObject from digiseg_api.models.timestamped_object1 import TimestampedObject1 from digiseg_api.models.user_account_membership import UserAccountMembership +from digiseg_api.models.user_account_membership_base import UserAccountMembershipBase +from digiseg_api.models.user_account_membership_include_aux import UserAccountMembershipIncludeAux from digiseg_api.models.user_account_role import UserAccountRole from digiseg_api.models.user_aux import UserAux from digiseg_api.models.user_base import UserBase @@ -188,6 +220,7 @@ from digiseg_api.models.user_creation_notification import UserCreationNotification from digiseg_api.models.user_credentials import UserCredentials from digiseg_api.models.user_full import UserFull +from digiseg_api.models.user_include_param import UserIncludeParam from digiseg_api.models.user_item import UserItem from digiseg_api.models.user_links import UserLinks from digiseg_api.models.user_mutation import UserMutation diff --git a/digiseg_api/api/__init__.py b/digiseg_api/api/__init__.py index 7e1f567..2700b20 100644 --- a/digiseg_api/api/__init__.py +++ b/digiseg_api/api/__init__.py @@ -8,6 +8,7 @@ from digiseg_api.api.measurement_labels_api import MeasurementLabelsApi from digiseg_api.api.populations_api import PopulationsApi from digiseg_api.api.studies_api import StudiesApi +from digiseg_api.api.subscriptions_api import SubscriptionsApi from digiseg_api.api.usage_api import UsageApi from digiseg_api.api.users_api import UsersApi diff --git a/digiseg_api/api/accounts_api.py b/digiseg_api/api/accounts_api.py index 21ed68d..9b20cce 100644 --- a/digiseg_api/api/accounts_api.py +++ b/digiseg_api/api/accounts_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,11 +18,14 @@ from typing_extensions import Annotated from pydantic import Field, StrictBytes, StrictStr -from typing import Optional, Union +from typing import List, Optional, Union from typing_extensions import Annotated +from digiseg_api.models.account_include_param import AccountIncludeParam from digiseg_api.models.account_mutation import AccountMutation from digiseg_api.models.create_user_in_account201_response import CreateUserInAccount201Response from digiseg_api.models.get_account_by_id200_response import GetAccountById200Response +from digiseg_api.models.get_account_subscription_by_id200_response import GetAccountSubscriptionById200Response +from digiseg_api.models.get_account_subscriptions200_response import GetAccountSubscriptions200Response from digiseg_api.models.list_api_keys_by_account_id200_response import ListApiKeysByAccountId200Response from digiseg_api.models.list_users_by_account_id200_response import ListUsersByAccountId200Response from digiseg_api.models.user_creation import UserCreation @@ -48,7 +51,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def create_user_in_account( + def create_user_in_account( self, account_id: StrictStr, user_creation: UserCreation, @@ -110,11 +113,11 @@ async def create_user_in_account( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -122,7 +125,7 @@ async def create_user_in_account( @validate_call - async def create_user_in_account_with_http_info( + def create_user_in_account_with_http_info( self, account_id: StrictStr, user_creation: UserCreation, @@ -184,11 +187,11 @@ async def create_user_in_account_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -196,7 +199,7 @@ async def create_user_in_account_with_http_info( @validate_call - async def create_user_in_account_without_preload_content( + def create_user_in_account_without_preload_content( self, account_id: StrictStr, user_creation: UserCreation, @@ -258,7 +261,7 @@ async def create_user_in_account_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -346,7 +349,7 @@ def _create_user_in_account_serialize( @validate_call - async def delete_account_logo( + def delete_account_logo( self, account_id: StrictStr, _request_timeout: Union[ @@ -401,11 +404,11 @@ async def delete_account_logo( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -413,7 +416,7 @@ async def delete_account_logo( @validate_call - async def delete_account_logo_with_http_info( + def delete_account_logo_with_http_info( self, account_id: StrictStr, _request_timeout: Union[ @@ -468,11 +471,11 @@ async def delete_account_logo_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -480,7 +483,7 @@ async def delete_account_logo_with_http_info( @validate_call - async def delete_account_logo_without_preload_content( + def delete_account_logo_without_preload_content( self, account_id: StrictStr, _request_timeout: Union[ @@ -535,7 +538,7 @@ async def delete_account_logo_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -601,9 +604,10 @@ def _delete_account_logo_serialize( @validate_call - async def get_account_by_id( + def get_account_by_id( self, account_id: StrictStr, + include: Annotated[Optional[List[AccountIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -622,6 +626,8 @@ async def get_account_by_id( :param account_id: (required) :type account_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[AccountIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -646,6 +652,7 @@ async def get_account_by_id( _param = self._get_account_by_id_serialize( account_id=account_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -657,11 +664,11 @@ async def get_account_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -669,9 +676,10 @@ async def get_account_by_id( @validate_call - async def get_account_by_id_with_http_info( + def get_account_by_id_with_http_info( self, account_id: StrictStr, + include: Annotated[Optional[List[AccountIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -690,6 +698,8 @@ async def get_account_by_id_with_http_info( :param account_id: (required) :type account_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[AccountIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -714,6 +724,7 @@ async def get_account_by_id_with_http_info( _param = self._get_account_by_id_serialize( account_id=account_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -725,11 +736,11 @@ async def get_account_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -737,9 +748,10 @@ async def get_account_by_id_with_http_info( @validate_call - async def get_account_by_id_without_preload_content( + def get_account_by_id_without_preload_content( self, account_id: StrictStr, + include: Annotated[Optional[List[AccountIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -758,6 +770,8 @@ async def get_account_by_id_without_preload_content( :param account_id: (required) :type account_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[AccountIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -782,6 +796,7 @@ async def get_account_by_id_without_preload_content( _param = self._get_account_by_id_serialize( account_id=account_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -793,7 +808,7 @@ async def get_account_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -803,6 +818,7 @@ async def get_account_by_id_without_preload_content( def _get_account_by_id_serialize( self, account_id, + include, _request_auth, _content_type, _headers, @@ -812,6 +828,7 @@ def _get_account_by_id_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} @@ -825,6 +842,10 @@ def _get_account_by_id_serialize( if account_id is not None: _path_params['account_id'] = account_id # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + # process the header parameters # process the form parameters # process the body parameter @@ -865,7 +886,7 @@ def _get_account_by_id_serialize( @validate_call - async def get_account_logo( + def get_account_logo( self, account_id: StrictStr, _request_timeout: Union[ @@ -921,11 +942,11 @@ async def get_account_logo( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -933,7 +954,7 @@ async def get_account_logo( @validate_call - async def get_account_logo_with_http_info( + def get_account_logo_with_http_info( self, account_id: StrictStr, _request_timeout: Union[ @@ -989,11 +1010,11 @@ async def get_account_logo_with_http_info( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1001,7 +1022,7 @@ async def get_account_logo_with_http_info( @validate_call - async def get_account_logo_without_preload_content( + def get_account_logo_without_preload_content( self, account_id: StrictStr, _request_timeout: Union[ @@ -1057,7 +1078,7 @@ async def get_account_logo_without_preload_content( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1123,7 +1144,556 @@ def _get_account_logo_serialize( @validate_call - async def list_api_keys_by_account_id( + def get_account_subscription_by_id( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetAccountSubscriptionById200Response: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_account_subscription_by_id_with_http_info( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetAccountSubscriptionById200Response]: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_account_subscription_by_id_without_preload_content( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_account_subscription_by_id_serialize( + self, + account_id, + subscription_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if account_id is not None: + _path_params['account_id'] = account_id + if subscription_id is not None: + _path_params['subscription_id'] = subscription_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'oAuth', + 'bearerAuth', + 'apiKeyHeaderAuth', + 'apiKeyQueryParamAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/accounts/{account_id}/subscriptions/{subscription_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_account_subscriptions( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetAccountSubscriptions200Response: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_account_subscriptions_with_http_info( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetAccountSubscriptions200Response]: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_account_subscriptions_without_preload_content( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_account_subscriptions_serialize( + self, + account_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if account_id is not None: + _path_params['account_id'] = account_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'oAuth', + 'bearerAuth', + 'apiKeyHeaderAuth', + 'apiKeyQueryParamAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/accounts/{account_id}/subscriptions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_api_keys_by_account_id( self, account_id: StrictStr, _request_timeout: Union[ @@ -1179,11 +1749,11 @@ async def list_api_keys_by_account_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1191,7 +1761,7 @@ async def list_api_keys_by_account_id( @validate_call - async def list_api_keys_by_account_id_with_http_info( + def list_api_keys_by_account_id_with_http_info( self, account_id: StrictStr, _request_timeout: Union[ @@ -1247,11 +1817,11 @@ async def list_api_keys_by_account_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1259,7 +1829,7 @@ async def list_api_keys_by_account_id_with_http_info( @validate_call - async def list_api_keys_by_account_id_without_preload_content( + def list_api_keys_by_account_id_without_preload_content( self, account_id: StrictStr, _request_timeout: Union[ @@ -1315,7 +1885,7 @@ async def list_api_keys_by_account_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1387,7 +1957,7 @@ def _list_api_keys_by_account_id_serialize( @validate_call - async def list_users_by_account_id( + def list_users_by_account_id( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -1463,11 +2033,11 @@ async def list_users_by_account_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1475,7 +2045,7 @@ async def list_users_by_account_id( @validate_call - async def list_users_by_account_id_with_http_info( + def list_users_by_account_id_with_http_info( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -1551,11 +2121,11 @@ async def list_users_by_account_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1563,7 +2133,7 @@ async def list_users_by_account_id_with_http_info( @validate_call - async def list_users_by_account_id_without_preload_content( + def list_users_by_account_id_without_preload_content( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -1639,7 +2209,7 @@ async def list_users_by_account_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1736,7 +2306,7 @@ def _list_users_by_account_id_serialize( @validate_call - async def update_account_by_id( + def update_account_by_id( self, account_id: StrictStr, account_mutation: AccountMutation, @@ -1797,11 +2367,11 @@ async def update_account_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1809,7 +2379,7 @@ async def update_account_by_id( @validate_call - async def update_account_by_id_with_http_info( + def update_account_by_id_with_http_info( self, account_id: StrictStr, account_mutation: AccountMutation, @@ -1870,11 +2440,11 @@ async def update_account_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1882,7 +2452,7 @@ async def update_account_by_id_with_http_info( @validate_call - async def update_account_by_id_without_preload_content( + def update_account_by_id_without_preload_content( self, account_id: StrictStr, account_mutation: AccountMutation, @@ -1943,7 +2513,7 @@ async def update_account_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2031,7 +2601,7 @@ def _update_account_by_id_serialize( @validate_call - async def upload_account_logo( + def upload_account_logo( self, account_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2090,11 +2660,11 @@ async def upload_account_logo( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2102,7 +2672,7 @@ async def upload_account_logo( @validate_call - async def upload_account_logo_with_http_info( + def upload_account_logo_with_http_info( self, account_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2161,11 +2731,11 @@ async def upload_account_logo_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2173,7 +2743,7 @@ async def upload_account_logo_with_http_info( @validate_call - async def upload_account_logo_without_preload_content( + def upload_account_logo_without_preload_content( self, account_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2232,7 +2802,7 @@ async def upload_account_logo_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/audiences_api.py b/digiseg_api/api/audiences_api.py index 13c570a..98d11af 100644 --- a/digiseg_api/api/audiences_api.py +++ b/digiseg_api/api/audiences_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,9 +18,10 @@ from typing_extensions import Annotated from pydantic import Field, StrictStr, field_validator -from typing import Optional +from typing import List, Optional from typing_extensions import Annotated from digiseg_api.models.audience_response import AudienceResponse +from digiseg_api.models.audiences_include_param import AudiencesIncludeParam from digiseg_api.models.resolve_audiences_of_multiple_request import ResolveAudiencesOfMultipleRequest from digiseg_api.models.resolve_audiences_of_multiple_response import ResolveAudiencesOfMultipleResponse @@ -43,9 +44,9 @@ def __init__(self, api_client=None) -> None: @validate_call - async def resolve_audiences_of_client( + def resolve_audiences_of_client( self, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, type: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional parameter to set to `jsonp` if a JSONP response format is needed.")] = None, _request_timeout: Union[ None, @@ -64,7 +65,7 @@ async def resolve_audiences_of_client( :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param type: Optional parameter to set to `jsonp` if a JSONP response format is needed. :type type: str :param _request_timeout: timeout setting for this request. If one @@ -103,11 +104,11 @@ async def resolve_audiences_of_client( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -115,9 +116,9 @@ async def resolve_audiences_of_client( @validate_call - async def resolve_audiences_of_client_with_http_info( + def resolve_audiences_of_client_with_http_info( self, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, type: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional parameter to set to `jsonp` if a JSONP response format is needed.")] = None, _request_timeout: Union[ None, @@ -136,7 +137,7 @@ async def resolve_audiences_of_client_with_http_info( :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param type: Optional parameter to set to `jsonp` if a JSONP response format is needed. :type type: str :param _request_timeout: timeout setting for this request. If one @@ -175,11 +176,11 @@ async def resolve_audiences_of_client_with_http_info( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -187,9 +188,9 @@ async def resolve_audiences_of_client_with_http_info( @validate_call - async def resolve_audiences_of_client_without_preload_content( + def resolve_audiences_of_client_without_preload_content( self, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, type: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional parameter to set to `jsonp` if a JSONP response format is needed.")] = None, _request_timeout: Union[ None, @@ -208,7 +209,7 @@ async def resolve_audiences_of_client_without_preload_content( :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param type: Optional parameter to set to `jsonp` if a JSONP response format is needed. :type type: str :param _request_timeout: timeout setting for this request. If one @@ -247,7 +248,7 @@ async def resolve_audiences_of_client_without_preload_content( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -267,6 +268,7 @@ def _resolve_audiences_of_client_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} @@ -326,10 +328,10 @@ def _resolve_audiences_of_client_serialize( @validate_call - async def resolve_audiences_of_multiple( + def resolve_audiences_of_multiple( self, resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -349,7 +351,7 @@ async def resolve_audiences_of_multiple( :param resolve_audiences_of_multiple_request: (required) :type resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -386,11 +388,11 @@ async def resolve_audiences_of_multiple( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -398,10 +400,10 @@ async def resolve_audiences_of_multiple( @validate_call - async def resolve_audiences_of_multiple_with_http_info( + def resolve_audiences_of_multiple_with_http_info( self, resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -421,7 +423,7 @@ async def resolve_audiences_of_multiple_with_http_info( :param resolve_audiences_of_multiple_request: (required) :type resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -458,11 +460,11 @@ async def resolve_audiences_of_multiple_with_http_info( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -470,10 +472,10 @@ async def resolve_audiences_of_multiple_with_http_info( @validate_call - async def resolve_audiences_of_multiple_without_preload_content( + def resolve_audiences_of_multiple_without_preload_content( self, resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest, - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -493,7 +495,7 @@ async def resolve_audiences_of_multiple_without_preload_content( :param resolve_audiences_of_multiple_request: (required) :type resolve_audiences_of_multiple_request: ResolveAudiencesOfMultipleRequest :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -530,7 +532,7 @@ async def resolve_audiences_of_multiple_without_preload_content( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -550,6 +552,7 @@ def _resolve_audiences_of_multiple_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} @@ -620,10 +623,10 @@ def _resolve_audiences_of_multiple_serialize( @validate_call - async def resolve_audiences_of_single( + def resolve_audiences_of_single( self, user_ip: Annotated[StrictStr, Field(description="The IP address to look up.")], - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -643,7 +646,7 @@ async def resolve_audiences_of_single( :param user_ip: The IP address to look up. (required) :type user_ip: str :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -680,11 +683,11 @@ async def resolve_audiences_of_single( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -692,10 +695,10 @@ async def resolve_audiences_of_single( @validate_call - async def resolve_audiences_of_single_with_http_info( + def resolve_audiences_of_single_with_http_info( self, user_ip: Annotated[StrictStr, Field(description="The IP address to look up.")], - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -715,7 +718,7 @@ async def resolve_audiences_of_single_with_http_info( :param user_ip: The IP address to look up. (required) :type user_ip: str :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -752,11 +755,11 @@ async def resolve_audiences_of_single_with_http_info( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -764,10 +767,10 @@ async def resolve_audiences_of_single_with_http_info( @validate_call - async def resolve_audiences_of_single_without_preload_content( + def resolve_audiences_of_single_without_preload_content( self, user_ip: Annotated[StrictStr, Field(description="The IP address to look up.")], - include: Annotated[Optional[StrictStr], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, + include: Annotated[Optional[List[AudiencesIncludeParam]], Field(description="Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -787,7 +790,7 @@ async def resolve_audiences_of_single_without_preload_content( :param user_ip: The IP address to look up. (required) :type user_ip: str :param include: Optional parameter used to specify which audience information to be returned. The value is comprised of comma-separated values, each indicating a set of audiences: * `core` represents the core audiences that are directly linked to household characteristics * `composite` represents the composite audiences, used to model likely behaviours or buying needs associated with the household characteristics. * `name` and `category` refer to the fields of the same names in the returned Audience objects. There is a slight performance gain in leaving these out when they are not needed. - :type include: str + :type include: List[AudiencesIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -824,7 +827,7 @@ async def resolve_audiences_of_single_without_preload_content( '400': "ErrorResponse", '500': "ErrorResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -844,6 +847,7 @@ def _resolve_audiences_of_single_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} diff --git a/digiseg_api/api/auth_api.py b/digiseg_api/api/auth_api.py index 19f3094..cb70ae3 100644 --- a/digiseg_api/api/auth_api.py +++ b/digiseg_api/api/auth_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -45,7 +45,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def create_access_token( + def create_access_token( self, auth_token_request: AuthTokenRequest, _request_timeout: Union[ @@ -99,11 +99,11 @@ async def create_access_token( _response_types_map: Dict[str, Optional[str]] = { '200': "AuthTokenResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -111,7 +111,7 @@ async def create_access_token( @validate_call - async def create_access_token_with_http_info( + def create_access_token_with_http_info( self, auth_token_request: AuthTokenRequest, _request_timeout: Union[ @@ -165,11 +165,11 @@ async def create_access_token_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "AuthTokenResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -177,7 +177,7 @@ async def create_access_token_with_http_info( @validate_call - async def create_access_token_without_preload_content( + def create_access_token_without_preload_content( self, auth_token_request: AuthTokenRequest, _request_timeout: Union[ @@ -231,7 +231,7 @@ async def create_access_token_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "AuthTokenResponse", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -313,7 +313,7 @@ def _create_access_token_serialize( @validate_call - async def create_api_key( + def create_api_key( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -374,11 +374,11 @@ async def create_api_key( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -386,7 +386,7 @@ async def create_api_key( @validate_call - async def create_api_key_with_http_info( + def create_api_key_with_http_info( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -447,11 +447,11 @@ async def create_api_key_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -459,7 +459,7 @@ async def create_api_key_with_http_info( @validate_call - async def create_api_key_without_preload_content( + def create_api_key_without_preload_content( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -520,7 +520,7 @@ async def create_api_key_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -608,7 +608,7 @@ def _create_api_key_serialize( @validate_call - async def delete_api_key_by_id( + def delete_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -668,11 +668,11 @@ async def delete_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -680,7 +680,7 @@ async def delete_api_key_by_id( @validate_call - async def delete_api_key_by_id_with_http_info( + def delete_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -740,11 +740,11 @@ async def delete_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -752,7 +752,7 @@ async def delete_api_key_by_id_with_http_info( @validate_call - async def delete_api_key_by_id_without_preload_content( + def delete_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -812,7 +812,7 @@ async def delete_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -881,7 +881,7 @@ def _delete_api_key_by_id_serialize( @validate_call - async def get_api_key_by_id( + def get_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -941,11 +941,11 @@ async def get_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -953,7 +953,7 @@ async def get_api_key_by_id( @validate_call - async def get_api_key_by_id_with_http_info( + def get_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -1013,11 +1013,11 @@ async def get_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1025,7 +1025,7 @@ async def get_api_key_by_id_with_http_info( @validate_call - async def get_api_key_by_id_without_preload_content( + def get_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -1085,7 +1085,7 @@ async def get_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1160,7 +1160,7 @@ def _get_api_key_by_id_serialize( @validate_call - async def list_api_keys_by_account_id( + def list_api_keys_by_account_id( self, account_id: StrictStr, _request_timeout: Union[ @@ -1216,11 +1216,11 @@ async def list_api_keys_by_account_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1228,7 +1228,7 @@ async def list_api_keys_by_account_id( @validate_call - async def list_api_keys_by_account_id_with_http_info( + def list_api_keys_by_account_id_with_http_info( self, account_id: StrictStr, _request_timeout: Union[ @@ -1284,11 +1284,11 @@ async def list_api_keys_by_account_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1296,7 +1296,7 @@ async def list_api_keys_by_account_id_with_http_info( @validate_call - async def list_api_keys_by_account_id_without_preload_content( + def list_api_keys_by_account_id_without_preload_content( self, account_id: StrictStr, _request_timeout: Union[ @@ -1352,7 +1352,7 @@ async def list_api_keys_by_account_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1424,7 +1424,7 @@ def _list_api_keys_by_account_id_serialize( @validate_call - async def list_api_keys_by_user_id( + def list_api_keys_by_user_id( self, user_id: StrictStr, _request_timeout: Union[ @@ -1480,11 +1480,11 @@ async def list_api_keys_by_user_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1492,7 +1492,7 @@ async def list_api_keys_by_user_id( @validate_call - async def list_api_keys_by_user_id_with_http_info( + def list_api_keys_by_user_id_with_http_info( self, user_id: StrictStr, _request_timeout: Union[ @@ -1548,11 +1548,11 @@ async def list_api_keys_by_user_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1560,7 +1560,7 @@ async def list_api_keys_by_user_id_with_http_info( @validate_call - async def list_api_keys_by_user_id_without_preload_content( + def list_api_keys_by_user_id_without_preload_content( self, user_id: StrictStr, _request_timeout: Union[ @@ -1616,7 +1616,7 @@ async def list_api_keys_by_user_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1688,7 +1688,7 @@ def _list_api_keys_by_user_id_serialize( @validate_call - async def update_api_key_by_id( + def update_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -1752,11 +1752,11 @@ async def update_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1764,7 +1764,7 @@ async def update_api_key_by_id( @validate_call - async def update_api_key_by_id_with_http_info( + def update_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -1828,11 +1828,11 @@ async def update_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1840,7 +1840,7 @@ async def update_api_key_by_id_with_http_info( @validate_call - async def update_api_key_by_id_without_preload_content( + def update_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -1904,7 +1904,7 @@ async def update_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/measurement_clients_api.py b/digiseg_api/api/measurement_clients_api.py index bb61117..ac75226 100644 --- a/digiseg_api/api/measurement_clients_api.py +++ b/digiseg_api/api/measurement_clients_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -43,7 +43,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def create_measurement_client( + def create_measurement_client( self, measurement_client_mutation: MeasurementClientMutation, _request_timeout: Union[ @@ -98,11 +98,11 @@ async def create_measurement_client( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -110,7 +110,7 @@ async def create_measurement_client( @validate_call - async def create_measurement_client_with_http_info( + def create_measurement_client_with_http_info( self, measurement_client_mutation: MeasurementClientMutation, _request_timeout: Union[ @@ -165,11 +165,11 @@ async def create_measurement_client_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -177,7 +177,7 @@ async def create_measurement_client_with_http_info( @validate_call - async def create_measurement_client_without_preload_content( + def create_measurement_client_without_preload_content( self, measurement_client_mutation: MeasurementClientMutation, _request_timeout: Union[ @@ -232,7 +232,7 @@ async def create_measurement_client_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -317,7 +317,7 @@ def _create_measurement_client_serialize( @validate_call - async def delete_client_logo( + def delete_client_logo( self, client_id: StrictStr, _request_timeout: Union[ @@ -372,11 +372,11 @@ async def delete_client_logo( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -384,7 +384,7 @@ async def delete_client_logo( @validate_call - async def delete_client_logo_with_http_info( + def delete_client_logo_with_http_info( self, client_id: StrictStr, _request_timeout: Union[ @@ -439,11 +439,11 @@ async def delete_client_logo_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -451,7 +451,7 @@ async def delete_client_logo_with_http_info( @validate_call - async def delete_client_logo_without_preload_content( + def delete_client_logo_without_preload_content( self, client_id: StrictStr, _request_timeout: Union[ @@ -506,7 +506,7 @@ async def delete_client_logo_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -572,7 +572,7 @@ def _delete_client_logo_serialize( @validate_call - async def delete_measurement_client_by_id( + def delete_measurement_client_by_id( self, client_id: StrictStr, _request_timeout: Union[ @@ -627,11 +627,11 @@ async def delete_measurement_client_by_id( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -639,7 +639,7 @@ async def delete_measurement_client_by_id( @validate_call - async def delete_measurement_client_by_id_with_http_info( + def delete_measurement_client_by_id_with_http_info( self, client_id: StrictStr, _request_timeout: Union[ @@ -694,11 +694,11 @@ async def delete_measurement_client_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -706,7 +706,7 @@ async def delete_measurement_client_by_id_with_http_info( @validate_call - async def delete_measurement_client_by_id_without_preload_content( + def delete_measurement_client_by_id_without_preload_content( self, client_id: StrictStr, _request_timeout: Union[ @@ -761,7 +761,7 @@ async def delete_measurement_client_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -827,7 +827,7 @@ def _delete_measurement_client_by_id_serialize( @validate_call - async def get_client_logo( + def get_client_logo( self, client_id: StrictStr, _request_timeout: Union[ @@ -883,11 +883,11 @@ async def get_client_logo( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -895,7 +895,7 @@ async def get_client_logo( @validate_call - async def get_client_logo_with_http_info( + def get_client_logo_with_http_info( self, client_id: StrictStr, _request_timeout: Union[ @@ -951,11 +951,11 @@ async def get_client_logo_with_http_info( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -963,7 +963,7 @@ async def get_client_logo_with_http_info( @validate_call - async def get_client_logo_without_preload_content( + def get_client_logo_without_preload_content( self, client_id: StrictStr, _request_timeout: Union[ @@ -1019,7 +1019,7 @@ async def get_client_logo_without_preload_content( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1085,7 +1085,7 @@ def _get_client_logo_serialize( @validate_call - async def get_measurement_client_by_id( + def get_measurement_client_by_id( self, client_id: StrictStr, _request_timeout: Union[ @@ -1140,11 +1140,11 @@ async def get_measurement_client_by_id( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1152,7 +1152,7 @@ async def get_measurement_client_by_id( @validate_call - async def get_measurement_client_by_id_with_http_info( + def get_measurement_client_by_id_with_http_info( self, client_id: StrictStr, _request_timeout: Union[ @@ -1207,11 +1207,11 @@ async def get_measurement_client_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1219,7 +1219,7 @@ async def get_measurement_client_by_id_with_http_info( @validate_call - async def get_measurement_client_by_id_without_preload_content( + def get_measurement_client_by_id_without_preload_content( self, client_id: StrictStr, _request_timeout: Union[ @@ -1274,7 +1274,7 @@ async def get_measurement_client_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1346,7 +1346,7 @@ def _get_measurement_client_by_id_serialize( @validate_call - async def list_measurement_clients( + def list_measurement_clients( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement clients by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, filter_name_contains: Annotated[Optional[StrictStr], Field(description="Optional parameter used to search for clients where the name contains a substring (case insensitive)")] = None, @@ -1413,11 +1413,11 @@ async def list_measurement_clients( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementClients200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1425,7 +1425,7 @@ async def list_measurement_clients( @validate_call - async def list_measurement_clients_with_http_info( + def list_measurement_clients_with_http_info( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement clients by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, filter_name_contains: Annotated[Optional[StrictStr], Field(description="Optional parameter used to search for clients where the name contains a substring (case insensitive)")] = None, @@ -1492,11 +1492,11 @@ async def list_measurement_clients_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementClients200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1504,7 +1504,7 @@ async def list_measurement_clients_with_http_info( @validate_call - async def list_measurement_clients_without_preload_content( + def list_measurement_clients_without_preload_content( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement clients by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, filter_name_contains: Annotated[Optional[StrictStr], Field(description="Optional parameter used to search for clients where the name contains a substring (case insensitive)")] = None, @@ -1571,7 +1571,7 @@ async def list_measurement_clients_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementClients200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1660,7 +1660,7 @@ def _list_measurement_clients_serialize( @validate_call - async def update_measurement_client_by_id( + def update_measurement_client_by_id( self, client_id: StrictStr, measurement_client_mutation: MeasurementClientMutation, @@ -1719,11 +1719,11 @@ async def update_measurement_client_by_id( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1731,7 +1731,7 @@ async def update_measurement_client_by_id( @validate_call - async def update_measurement_client_by_id_with_http_info( + def update_measurement_client_by_id_with_http_info( self, client_id: StrictStr, measurement_client_mutation: MeasurementClientMutation, @@ -1790,11 +1790,11 @@ async def update_measurement_client_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1802,7 +1802,7 @@ async def update_measurement_client_by_id_with_http_info( @validate_call - async def update_measurement_client_by_id_without_preload_content( + def update_measurement_client_by_id_without_preload_content( self, client_id: StrictStr, measurement_client_mutation: MeasurementClientMutation, @@ -1861,7 +1861,7 @@ async def update_measurement_client_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateMeasurementClient201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1949,7 +1949,7 @@ def _update_measurement_client_by_id_serialize( @validate_call - async def upload_client_logo( + def upload_client_logo( self, client_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2008,11 +2008,11 @@ async def upload_client_logo( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2020,7 +2020,7 @@ async def upload_client_logo( @validate_call - async def upload_client_logo_with_http_info( + def upload_client_logo_with_http_info( self, client_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2079,11 +2079,11 @@ async def upload_client_logo_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2091,7 +2091,7 @@ async def upload_client_logo_with_http_info( @validate_call - async def upload_client_logo_without_preload_content( + def upload_client_logo_without_preload_content( self, client_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -2150,7 +2150,7 @@ async def upload_client_logo_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/measurement_labels_api.py b/digiseg_api/api/measurement_labels_api.py index b92c2f0..a262d27 100644 --- a/digiseg_api/api/measurement_labels_api.py +++ b/digiseg_api/api/measurement_labels_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -41,7 +41,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def list_measurement_labels( + def list_measurement_labels( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement labels by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, _request_timeout: Union[ @@ -96,11 +96,11 @@ async def list_measurement_labels( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementLabels200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -108,7 +108,7 @@ async def list_measurement_labels( @validate_call - async def list_measurement_labels_with_http_info( + def list_measurement_labels_with_http_info( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement labels by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, _request_timeout: Union[ @@ -163,11 +163,11 @@ async def list_measurement_labels_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementLabels200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -175,7 +175,7 @@ async def list_measurement_labels_with_http_info( @validate_call - async def list_measurement_labels_without_preload_content( + def list_measurement_labels_without_preload_content( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query measurement labels by specific account IDs (only available to super admins). The value `*` is synonymous for \"all accounts\". ")] = None, _request_timeout: Union[ @@ -230,7 +230,7 @@ async def list_measurement_labels_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListMeasurementLabels200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/populations_api.py b/digiseg_api/api/populations_api.py index 2fcac4e..372860d 100644 --- a/digiseg_api/api/populations_api.py +++ b/digiseg_api/api/populations_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -41,7 +41,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def get_popuplation_by_key( + def get_popuplation_by_key( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], population_key: Annotated[StrictStr, Field(description="An identifier for the population")], @@ -100,11 +100,11 @@ async def get_popuplation_by_key( _response_types_map: Dict[str, Optional[str]] = { '200': "GetPopuplationByKey200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -112,7 +112,7 @@ async def get_popuplation_by_key( @validate_call - async def get_popuplation_by_key_with_http_info( + def get_popuplation_by_key_with_http_info( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], population_key: Annotated[StrictStr, Field(description="An identifier for the population")], @@ -171,11 +171,11 @@ async def get_popuplation_by_key_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "GetPopuplationByKey200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -183,7 +183,7 @@ async def get_popuplation_by_key_with_http_info( @validate_call - async def get_popuplation_by_key_without_preload_content( + def get_popuplation_by_key_without_preload_content( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], population_key: Annotated[StrictStr, Field(description="An identifier for the population")], @@ -242,7 +242,7 @@ async def get_popuplation_by_key_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "GetPopuplationByKey200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -317,7 +317,7 @@ def _get_popuplation_by_key_serialize( @validate_call - async def list_popuplations( + def list_popuplations( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], _request_timeout: Union[ @@ -372,11 +372,11 @@ async def list_popuplations( _response_types_map: Dict[str, Optional[str]] = { '200': "ListPopuplations200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -384,7 +384,7 @@ async def list_popuplations( @validate_call - async def list_popuplations_with_http_info( + def list_popuplations_with_http_info( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], _request_timeout: Union[ @@ -439,11 +439,11 @@ async def list_popuplations_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListPopuplations200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -451,7 +451,7 @@ async def list_popuplations_with_http_info( @validate_call - async def list_popuplations_without_preload_content( + def list_popuplations_without_preload_content( self, category_key: Annotated[StrictStr, Field(description="An identifier for the category")], _request_timeout: Union[ @@ -506,7 +506,7 @@ async def list_popuplations_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListPopuplations200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/studies_api.py b/digiseg_api/api/studies_api.py index d814103..889dc3a 100644 --- a/digiseg_api/api/studies_api.py +++ b/digiseg_api/api/studies_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -48,7 +48,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def create_study( + def create_study( self, study_creation: StudyCreation, _request_timeout: Union[ @@ -103,11 +103,11 @@ async def create_study( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -115,7 +115,7 @@ async def create_study( @validate_call - async def create_study_with_http_info( + def create_study_with_http_info( self, study_creation: StudyCreation, _request_timeout: Union[ @@ -170,11 +170,11 @@ async def create_study_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -182,7 +182,7 @@ async def create_study_with_http_info( @validate_call - async def create_study_without_preload_content( + def create_study_without_preload_content( self, study_creation: StudyCreation, _request_timeout: Union[ @@ -237,7 +237,7 @@ async def create_study_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '201': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -322,7 +322,7 @@ def _create_study_serialize( @validate_call - async def delete_study_banner_image( + def delete_study_banner_image( self, study_id: StrictStr, _request_timeout: Union[ @@ -377,11 +377,11 @@ async def delete_study_banner_image( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -389,7 +389,7 @@ async def delete_study_banner_image( @validate_call - async def delete_study_banner_image_with_http_info( + def delete_study_banner_image_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -444,11 +444,11 @@ async def delete_study_banner_image_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -456,7 +456,7 @@ async def delete_study_banner_image_with_http_info( @validate_call - async def delete_study_banner_image_without_preload_content( + def delete_study_banner_image_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -511,7 +511,7 @@ async def delete_study_banner_image_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -577,7 +577,7 @@ def _delete_study_banner_image_serialize( @validate_call - async def delete_study_by_id( + def delete_study_by_id( self, study_id: StrictStr, _request_timeout: Union[ @@ -632,11 +632,11 @@ async def delete_study_by_id( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -644,7 +644,7 @@ async def delete_study_by_id( @validate_call - async def delete_study_by_id_with_http_info( + def delete_study_by_id_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -699,11 +699,11 @@ async def delete_study_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -711,7 +711,7 @@ async def delete_study_by_id_with_http_info( @validate_call - async def delete_study_by_id_without_preload_content( + def delete_study_by_id_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -766,7 +766,7 @@ async def delete_study_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -832,7 +832,7 @@ def _delete_study_by_id_serialize( @validate_call - async def get_study_banner_image( + def get_study_banner_image( self, study_id: StrictStr, _request_timeout: Union[ @@ -888,11 +888,11 @@ async def get_study_banner_image( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -900,7 +900,7 @@ async def get_study_banner_image( @validate_call - async def get_study_banner_image_with_http_info( + def get_study_banner_image_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -956,11 +956,11 @@ async def get_study_banner_image_with_http_info( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -968,7 +968,7 @@ async def get_study_banner_image_with_http_info( @validate_call - async def get_study_banner_image_without_preload_content( + def get_study_banner_image_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -1024,7 +1024,7 @@ async def get_study_banner_image_without_preload_content( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1090,7 +1090,7 @@ def _get_study_banner_image_serialize( @validate_call - async def get_study_by_id( + def get_study_by_id( self, study_id: StrictStr, _request_timeout: Union[ @@ -1145,11 +1145,11 @@ async def get_study_by_id( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1157,7 +1157,7 @@ async def get_study_by_id( @validate_call - async def get_study_by_id_with_http_info( + def get_study_by_id_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -1212,11 +1212,11 @@ async def get_study_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1224,7 +1224,7 @@ async def get_study_by_id_with_http_info( @validate_call - async def get_study_by_id_without_preload_content( + def get_study_by_id_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -1279,7 +1279,7 @@ async def get_study_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1351,7 +1351,7 @@ def _get_study_by_id_serialize( @validate_call - async def list_studies( + def list_studies( self, sort: Annotated[Optional[StrictStr], Field(description="Defines the field to sort the result items by. Ascending order is applied by default, but the minus character can be used to indicate descending order instead. ")] = None, filter_is_example: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter for example studies")] = None, @@ -1430,11 +1430,11 @@ async def list_studies( _response_types_map: Dict[str, Optional[str]] = { '200': "ListStudies200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1442,7 +1442,7 @@ async def list_studies( @validate_call - async def list_studies_with_http_info( + def list_studies_with_http_info( self, sort: Annotated[Optional[StrictStr], Field(description="Defines the field to sort the result items by. Ascending order is applied by default, but the minus character can be used to indicate descending order instead. ")] = None, filter_is_example: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter for example studies")] = None, @@ -1521,11 +1521,11 @@ async def list_studies_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListStudies200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1533,7 +1533,7 @@ async def list_studies_with_http_info( @validate_call - async def list_studies_without_preload_content( + def list_studies_without_preload_content( self, sort: Annotated[Optional[StrictStr], Field(description="Defines the field to sort the result items by. Ascending order is applied by default, but the minus character can be used to indicate descending order instead. ")] = None, filter_is_example: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter for example studies")] = None, @@ -1612,7 +1612,7 @@ async def list_studies_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListStudies200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1716,7 +1716,7 @@ def _list_studies_serialize( @validate_call - async def query_study_audience_stats( + def query_study_audience_stats( self, study_id: StrictStr, _request_timeout: Union[ @@ -1771,11 +1771,11 @@ async def query_study_audience_stats( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyAudienceStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1783,7 +1783,7 @@ async def query_study_audience_stats( @validate_call - async def query_study_audience_stats_with_http_info( + def query_study_audience_stats_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -1838,11 +1838,11 @@ async def query_study_audience_stats_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyAudienceStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1850,7 +1850,7 @@ async def query_study_audience_stats_with_http_info( @validate_call - async def query_study_audience_stats_without_preload_content( + def query_study_audience_stats_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -1905,7 +1905,7 @@ async def query_study_audience_stats_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyAudienceStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1977,7 +1977,7 @@ def _query_study_audience_stats_serialize( @validate_call - async def query_study_country_stats( + def query_study_country_stats( self, study_id: StrictStr, _request_timeout: Union[ @@ -2032,11 +2032,11 @@ async def query_study_country_stats( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyCountryStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2044,7 +2044,7 @@ async def query_study_country_stats( @validate_call - async def query_study_country_stats_with_http_info( + def query_study_country_stats_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -2099,11 +2099,11 @@ async def query_study_country_stats_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyCountryStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2111,7 +2111,7 @@ async def query_study_country_stats_with_http_info( @validate_call - async def query_study_country_stats_without_preload_content( + def query_study_country_stats_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -2166,7 +2166,7 @@ async def query_study_country_stats_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyCountryStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2238,7 +2238,7 @@ def _query_study_country_stats_serialize( @validate_call - async def query_study_frequency_stats( + def query_study_frequency_stats( self, study_id: StrictStr, _request_timeout: Union[ @@ -2293,11 +2293,11 @@ async def query_study_frequency_stats( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyFrequencyStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2305,7 +2305,7 @@ async def query_study_frequency_stats( @validate_call - async def query_study_frequency_stats_with_http_info( + def query_study_frequency_stats_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -2360,11 +2360,11 @@ async def query_study_frequency_stats_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyFrequencyStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2372,7 +2372,7 @@ async def query_study_frequency_stats_with_http_info( @validate_call - async def query_study_frequency_stats_without_preload_content( + def query_study_frequency_stats_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -2427,7 +2427,7 @@ async def query_study_frequency_stats_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyFrequencyStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2499,7 +2499,7 @@ def _query_study_frequency_stats_serialize( @validate_call - async def query_study_timing_stats( + def query_study_timing_stats( self, study_id: StrictStr, _request_timeout: Union[ @@ -2554,11 +2554,11 @@ async def query_study_timing_stats( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyTimingStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2566,7 +2566,7 @@ async def query_study_timing_stats( @validate_call - async def query_study_timing_stats_with_http_info( + def query_study_timing_stats_with_http_info( self, study_id: StrictStr, _request_timeout: Union[ @@ -2621,11 +2621,11 @@ async def query_study_timing_stats_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyTimingStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2633,7 +2633,7 @@ async def query_study_timing_stats_with_http_info( @validate_call - async def query_study_timing_stats_without_preload_content( + def query_study_timing_stats_without_preload_content( self, study_id: StrictStr, _request_timeout: Union[ @@ -2688,7 +2688,7 @@ async def query_study_timing_stats_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "QueryStudyTimingStats200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2760,7 +2760,7 @@ def _query_study_timing_stats_serialize( @validate_call - async def update_study_by_id( + def update_study_by_id( self, study_id: StrictStr, study_mutation: StudyMutation, @@ -2819,11 +2819,11 @@ async def update_study_by_id( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2831,7 +2831,7 @@ async def update_study_by_id( @validate_call - async def update_study_by_id_with_http_info( + def update_study_by_id_with_http_info( self, study_id: StrictStr, study_mutation: StudyMutation, @@ -2890,11 +2890,11 @@ async def update_study_by_id_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2902,7 +2902,7 @@ async def update_study_by_id_with_http_info( @validate_call - async def update_study_by_id_without_preload_content( + def update_study_by_id_without_preload_content( self, study_id: StrictStr, study_mutation: StudyMutation, @@ -2961,7 +2961,7 @@ async def update_study_by_id_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "CreateStudy201Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3049,7 +3049,7 @@ def _update_study_by_id_serialize( @validate_call - async def upload_study_banner_image( + def upload_study_banner_image( self, study_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3108,11 +3108,11 @@ async def upload_study_banner_image( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3120,7 +3120,7 @@ async def upload_study_banner_image( @validate_call - async def upload_study_banner_image_with_http_info( + def upload_study_banner_image_with_http_info( self, study_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3179,11 +3179,11 @@ async def upload_study_banner_image_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3191,7 +3191,7 @@ async def upload_study_banner_image_with_http_info( @validate_call - async def upload_study_banner_image_without_preload_content( + def upload_study_banner_image_without_preload_content( self, study_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3250,7 +3250,7 @@ async def upload_study_banner_image_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/subscriptions_api.py b/digiseg_api/api/subscriptions_api.py new file mode 100644 index 0000000..927e125 --- /dev/null +++ b/digiseg_api/api/subscriptions_api.py @@ -0,0 +1,939 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr +from typing import Optional +from typing_extensions import Annotated +from digiseg_api.models.get_account_subscription_by_id200_response import GetAccountSubscriptionById200Response +from digiseg_api.models.get_account_subscriptions200_response import GetAccountSubscriptions200Response +from digiseg_api.models.list_subscription_plans200_response import ListSubscriptionPlans200Response +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.subscription_price_interval import SubscriptionPriceInterval +from digiseg_api.models.subscription_product_type import SubscriptionProductType + +from digiseg_api.api_client import ApiClient, RequestSerialized +from digiseg_api.api_response import ApiResponse +from digiseg_api.rest import RESTResponseType + + +class SubscriptionsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_account_subscription_by_id( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetAccountSubscriptionById200Response: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_account_subscription_by_id_with_http_info( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetAccountSubscriptionById200Response]: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_account_subscription_by_id_without_preload_content( + self, + account_id: StrictStr, + subscription_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get account subscription + + Gets a specific subscription for an account + + :param account_id: (required) + :type account_id: str + :param subscription_id: (required) + :type subscription_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscription_by_id_serialize( + account_id=account_id, + subscription_id=subscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptionById200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_account_subscription_by_id_serialize( + self, + account_id, + subscription_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if account_id is not None: + _path_params['account_id'] = account_id + if subscription_id is not None: + _path_params['subscription_id'] = subscription_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'oAuth', + 'bearerAuth', + 'apiKeyHeaderAuth', + 'apiKeyQueryParamAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/accounts/{account_id}/subscriptions/{subscription_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_account_subscriptions( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetAccountSubscriptions200Response: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_account_subscriptions_with_http_info( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetAccountSubscriptions200Response]: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_account_subscriptions_without_preload_content( + self, + account_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get account subscriptions summary + + Get a summary of subscriptions for an account + + :param account_id: (required) + :type account_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_account_subscriptions_serialize( + account_id=account_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetAccountSubscriptions200Response", + '403': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_account_subscriptions_serialize( + self, + account_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if account_id is not None: + _path_params['account_id'] = account_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'oAuth', + 'bearerAuth', + 'apiKeyHeaderAuth', + 'apiKeyQueryParamAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/accounts/{account_id}/subscriptions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_subscription_plans( + self, + page_size: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="The desired page size")] = None, + page_after: Annotated[Optional[StrictStr], Field(description="Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. ")] = None, + filter_is_public: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter on the `is_public` field")] = None, + filter_product_type: Annotated[Optional[SubscriptionProductType], Field(description="Optional parameter used to filter on the `product_type` field")] = None, + filter_list_price_currency: Annotated[Optional[SubscriptionPriceCurrency], Field(description="Optional parameter used to filter on the list price's currency")] = None, + filter_list_price_interval: Annotated[Optional[SubscriptionPriceInterval], Field(description="Optional parameter used to filter on the list price's interval")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListSubscriptionPlans200Response: + """List subscription plans + + + :param page_size: The desired page size + :type page_size: int + :param page_after: Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. + :type page_after: str + :param filter_is_public: Optional parameter used to filter on the `is_public` field + :type filter_is_public: bool + :param filter_product_type: Optional parameter used to filter on the `product_type` field + :type filter_product_type: SubscriptionProductType + :param filter_list_price_currency: Optional parameter used to filter on the list price's currency + :type filter_list_price_currency: SubscriptionPriceCurrency + :param filter_list_price_interval: Optional parameter used to filter on the list price's interval + :type filter_list_price_interval: SubscriptionPriceInterval + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_subscription_plans_serialize( + page_size=page_size, + page_after=page_after, + filter_is_public=filter_is_public, + filter_product_type=filter_product_type, + filter_list_price_currency=filter_list_price_currency, + filter_list_price_interval=filter_list_price_interval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSubscriptionPlans200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_subscription_plans_with_http_info( + self, + page_size: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="The desired page size")] = None, + page_after: Annotated[Optional[StrictStr], Field(description="Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. ")] = None, + filter_is_public: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter on the `is_public` field")] = None, + filter_product_type: Annotated[Optional[SubscriptionProductType], Field(description="Optional parameter used to filter on the `product_type` field")] = None, + filter_list_price_currency: Annotated[Optional[SubscriptionPriceCurrency], Field(description="Optional parameter used to filter on the list price's currency")] = None, + filter_list_price_interval: Annotated[Optional[SubscriptionPriceInterval], Field(description="Optional parameter used to filter on the list price's interval")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListSubscriptionPlans200Response]: + """List subscription plans + + + :param page_size: The desired page size + :type page_size: int + :param page_after: Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. + :type page_after: str + :param filter_is_public: Optional parameter used to filter on the `is_public` field + :type filter_is_public: bool + :param filter_product_type: Optional parameter used to filter on the `product_type` field + :type filter_product_type: SubscriptionProductType + :param filter_list_price_currency: Optional parameter used to filter on the list price's currency + :type filter_list_price_currency: SubscriptionPriceCurrency + :param filter_list_price_interval: Optional parameter used to filter on the list price's interval + :type filter_list_price_interval: SubscriptionPriceInterval + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_subscription_plans_serialize( + page_size=page_size, + page_after=page_after, + filter_is_public=filter_is_public, + filter_product_type=filter_product_type, + filter_list_price_currency=filter_list_price_currency, + filter_list_price_interval=filter_list_price_interval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSubscriptionPlans200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_subscription_plans_without_preload_content( + self, + page_size: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="The desired page size")] = None, + page_after: Annotated[Optional[StrictStr], Field(description="Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. ")] = None, + filter_is_public: Annotated[Optional[StrictBool], Field(description="Optional parameter used to filter on the `is_public` field")] = None, + filter_product_type: Annotated[Optional[SubscriptionProductType], Field(description="Optional parameter used to filter on the `product_type` field")] = None, + filter_list_price_currency: Annotated[Optional[SubscriptionPriceCurrency], Field(description="Optional parameter used to filter on the list price's currency")] = None, + filter_list_price_interval: Annotated[Optional[SubscriptionPriceInterval], Field(description="Optional parameter used to filter on the list price's interval")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List subscription plans + + + :param page_size: The desired page size + :type page_size: int + :param page_after: Optional pagination parameter, indicating the previous cursor value to paginate beyond. The value to provide here is opaque, but can be found in previous requests in the `meta.page.last_cursor` field. + :type page_after: str + :param filter_is_public: Optional parameter used to filter on the `is_public` field + :type filter_is_public: bool + :param filter_product_type: Optional parameter used to filter on the `product_type` field + :type filter_product_type: SubscriptionProductType + :param filter_list_price_currency: Optional parameter used to filter on the list price's currency + :type filter_list_price_currency: SubscriptionPriceCurrency + :param filter_list_price_interval: Optional parameter used to filter on the list price's interval + :type filter_list_price_interval: SubscriptionPriceInterval + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_subscription_plans_serialize( + page_size=page_size, + page_after=page_after, + filter_is_public=filter_is_public, + filter_product_type=filter_product_type, + filter_list_price_currency=filter_list_price_currency, + filter_list_price_interval=filter_list_price_interval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSubscriptionPlans200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_subscription_plans_serialize( + self, + page_size, + page_after, + filter_is_public, + filter_product_type, + filter_list_price_currency, + filter_list_price_interval, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if page_size is not None: + + _query_params.append(('page[size]', page_size)) + + if page_after is not None: + + _query_params.append(('page[after]', page_after)) + + if filter_is_public is not None: + + _query_params.append(('filter[is_public]', filter_is_public)) + + if filter_product_type is not None: + + _query_params.append(('filter[product_type]', filter_product_type.value)) + + if filter_list_price_currency is not None: + + _query_params.append(('filter[list_price.currency]', filter_list_price_currency.value)) + + if filter_list_price_interval is not None: + + _query_params.append(('filter[list_price.interval]', filter_list_price_interval.value)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'oAuth', + 'bearerAuth', + 'apiKeyHeaderAuth', + 'apiKeyQueryParamAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/subscription_plans', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/digiseg_api/api/usage_api.py b/digiseg_api/api/usage_api.py index fe8ff7c..7287af7 100644 --- a/digiseg_api/api/usage_api.py +++ b/digiseg_api/api/usage_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -44,7 +44,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def list_audience_data_daily_usage( + def list_audience_data_daily_usage( self, filter_date_from: Annotated[Optional[date], Field(description="Date to query from")] = None, filter_date_to: Annotated[Optional[date], Field(description="Date to query to")] = None, @@ -107,11 +107,11 @@ async def list_audience_data_daily_usage( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataDailyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -119,7 +119,7 @@ async def list_audience_data_daily_usage( @validate_call - async def list_audience_data_daily_usage_with_http_info( + def list_audience_data_daily_usage_with_http_info( self, filter_date_from: Annotated[Optional[date], Field(description="Date to query from")] = None, filter_date_to: Annotated[Optional[date], Field(description="Date to query to")] = None, @@ -182,11 +182,11 @@ async def list_audience_data_daily_usage_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataDailyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -194,7 +194,7 @@ async def list_audience_data_daily_usage_with_http_info( @validate_call - async def list_audience_data_daily_usage_without_preload_content( + def list_audience_data_daily_usage_without_preload_content( self, filter_date_from: Annotated[Optional[date], Field(description="Date to query from")] = None, filter_date_to: Annotated[Optional[date], Field(description="Date to query to")] = None, @@ -257,7 +257,7 @@ async def list_audience_data_daily_usage_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataDailyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -359,7 +359,7 @@ def _list_audience_data_daily_usage_serialize( @validate_call - async def list_audience_data_monthly_usage( + def list_audience_data_monthly_usage( self, filter_year: Annotated[Optional[StrictInt], Field(description="Year to filter by")] = None, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, @@ -418,11 +418,11 @@ async def list_audience_data_monthly_usage( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataMonthlyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -430,7 +430,7 @@ async def list_audience_data_monthly_usage( @validate_call - async def list_audience_data_monthly_usage_with_http_info( + def list_audience_data_monthly_usage_with_http_info( self, filter_year: Annotated[Optional[StrictInt], Field(description="Year to filter by")] = None, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, @@ -489,11 +489,11 @@ async def list_audience_data_monthly_usage_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataMonthlyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -501,7 +501,7 @@ async def list_audience_data_monthly_usage_with_http_info( @validate_call - async def list_audience_data_monthly_usage_without_preload_content( + def list_audience_data_monthly_usage_without_preload_content( self, filter_year: Annotated[Optional[StrictInt], Field(description="Year to filter by")] = None, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, @@ -560,7 +560,7 @@ async def list_audience_data_monthly_usage_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataMonthlyUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -639,7 +639,7 @@ def _list_audience_data_monthly_usage_serialize( @validate_call - async def list_audience_data_realtime_usage( + def list_audience_data_realtime_usage( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, _request_timeout: Union[ @@ -657,7 +657,7 @@ async def list_audience_data_realtime_usage( ) -> ListAudienceDataRealtimeUsage200Response: """List realtime usage of Audience Data - Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. + Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. The results will be returned in usage objects, each representing 5 minutes of non-zero usage. :param filter_account_id: Optional parameter used to query usage of specific account IDs (only available to super admins). :type filter_account_id: str @@ -694,11 +694,11 @@ async def list_audience_data_realtime_usage( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataRealtimeUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -706,7 +706,7 @@ async def list_audience_data_realtime_usage( @validate_call - async def list_audience_data_realtime_usage_with_http_info( + def list_audience_data_realtime_usage_with_http_info( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, _request_timeout: Union[ @@ -724,7 +724,7 @@ async def list_audience_data_realtime_usage_with_http_info( ) -> ApiResponse[ListAudienceDataRealtimeUsage200Response]: """List realtime usage of Audience Data - Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. + Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. The results will be returned in usage objects, each representing 5 minutes of non-zero usage. :param filter_account_id: Optional parameter used to query usage of specific account IDs (only available to super admins). :type filter_account_id: str @@ -761,11 +761,11 @@ async def list_audience_data_realtime_usage_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataRealtimeUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -773,7 +773,7 @@ async def list_audience_data_realtime_usage_with_http_info( @validate_call - async def list_audience_data_realtime_usage_without_preload_content( + def list_audience_data_realtime_usage_without_preload_content( self, filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional parameter used to query usage of specific account IDs (only available to super admins). ")] = None, _request_timeout: Union[ @@ -791,7 +791,7 @@ async def list_audience_data_realtime_usage_without_preload_content( ) -> RESTResponseType: """List realtime usage of Audience Data - Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. + Provides usage stats on a near-realtime basis. Results available for the last 24 hours, provided with as short delay as possible. The results will be returned in usage objects, each representing 5 minutes of non-zero usage. :param filter_account_id: Optional parameter used to query usage of specific account IDs (only available to super admins). :type filter_account_id: str @@ -828,7 +828,7 @@ async def list_audience_data_realtime_usage_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "ListAudienceDataRealtimeUsage200Response", } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api/users_api.py b/digiseg_api/api/users_api.py index a3e6579..f6a8ffe 100644 --- a/digiseg_api/api/users_api.py +++ b/digiseg_api/api/users_api.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,7 +18,7 @@ from typing_extensions import Annotated from pydantic import Field, StrictBytes, StrictStr -from typing import Optional, Union +from typing import List, Optional, Union from typing_extensions import Annotated from digiseg_api.models.api_key_creation import ApiKeyCreation from digiseg_api.models.api_key_mutation import ApiKeyMutation @@ -28,6 +28,7 @@ from digiseg_api.models.list_api_keys_by_account_id200_response import ListApiKeysByAccountId200Response from digiseg_api.models.list_users_by_account_id200_response import ListUsersByAccountId200Response from digiseg_api.models.user_creation import UserCreation +from digiseg_api.models.user_include_param import UserIncludeParam from digiseg_api.models.user_mutation import UserMutation from digiseg_api.models.user_platform_role import UserPlatformRole from digiseg_api.models.user_sort_option import UserSortOption @@ -51,7 +52,7 @@ def __init__(self, api_client=None) -> None: @validate_call - async def create_api_key( + def create_api_key( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -112,11 +113,11 @@ async def create_api_key( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -124,7 +125,7 @@ async def create_api_key( @validate_call - async def create_api_key_with_http_info( + def create_api_key_with_http_info( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -185,11 +186,11 @@ async def create_api_key_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -197,7 +198,7 @@ async def create_api_key_with_http_info( @validate_call - async def create_api_key_without_preload_content( + def create_api_key_without_preload_content( self, user_id: StrictStr, api_key_creation: ApiKeyCreation, @@ -258,7 +259,7 @@ async def create_api_key_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -346,7 +347,7 @@ def _create_api_key_serialize( @validate_call - async def create_user_in_account( + def create_user_in_account( self, account_id: StrictStr, user_creation: UserCreation, @@ -408,11 +409,11 @@ async def create_user_in_account( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -420,7 +421,7 @@ async def create_user_in_account( @validate_call - async def create_user_in_account_with_http_info( + def create_user_in_account_with_http_info( self, account_id: StrictStr, user_creation: UserCreation, @@ -482,11 +483,11 @@ async def create_user_in_account_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -494,7 +495,7 @@ async def create_user_in_account_with_http_info( @validate_call - async def create_user_in_account_without_preload_content( + def create_user_in_account_without_preload_content( self, account_id: StrictStr, user_creation: UserCreation, @@ -556,7 +557,7 @@ async def create_user_in_account_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -644,7 +645,7 @@ def _create_user_in_account_serialize( @validate_call - async def delete_api_key_by_id( + def delete_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -704,11 +705,11 @@ async def delete_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -716,7 +717,7 @@ async def delete_api_key_by_id( @validate_call - async def delete_api_key_by_id_with_http_info( + def delete_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -776,11 +777,11 @@ async def delete_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -788,7 +789,7 @@ async def delete_api_key_by_id_with_http_info( @validate_call - async def delete_api_key_by_id_without_preload_content( + def delete_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -848,7 +849,7 @@ async def delete_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -917,7 +918,7 @@ def _delete_api_key_by_id_serialize( @validate_call - async def delete_user_avatar( + def delete_user_avatar( self, user_id: StrictStr, _request_timeout: Union[ @@ -972,11 +973,11 @@ async def delete_user_avatar( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -984,7 +985,7 @@ async def delete_user_avatar( @validate_call - async def delete_user_avatar_with_http_info( + def delete_user_avatar_with_http_info( self, user_id: StrictStr, _request_timeout: Union[ @@ -1039,11 +1040,11 @@ async def delete_user_avatar_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1051,7 +1052,7 @@ async def delete_user_avatar_with_http_info( @validate_call - async def delete_user_avatar_without_preload_content( + def delete_user_avatar_without_preload_content( self, user_id: StrictStr, _request_timeout: Union[ @@ -1106,7 +1107,7 @@ async def delete_user_avatar_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1172,7 +1173,7 @@ def _delete_user_avatar_serialize( @validate_call - async def delete_user_by_id( + def delete_user_by_id( self, user_id: StrictStr, _request_timeout: Union[ @@ -1228,11 +1229,11 @@ async def delete_user_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1240,7 +1241,7 @@ async def delete_user_by_id( @validate_call - async def delete_user_by_id_with_http_info( + def delete_user_by_id_with_http_info( self, user_id: StrictStr, _request_timeout: Union[ @@ -1296,11 +1297,11 @@ async def delete_user_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1308,7 +1309,7 @@ async def delete_user_by_id_with_http_info( @validate_call - async def delete_user_by_id_without_preload_content( + def delete_user_by_id_without_preload_content( self, user_id: StrictStr, _request_timeout: Union[ @@ -1364,7 +1365,7 @@ async def delete_user_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1430,7 +1431,7 @@ def _delete_user_by_id_serialize( @validate_call - async def get_api_key_by_id( + def get_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -1490,11 +1491,11 @@ async def get_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1502,7 +1503,7 @@ async def get_api_key_by_id( @validate_call - async def get_api_key_by_id_with_http_info( + def get_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -1562,11 +1563,11 @@ async def get_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1574,7 +1575,7 @@ async def get_api_key_by_id_with_http_info( @validate_call - async def get_api_key_by_id_without_preload_content( + def get_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -1634,7 +1635,7 @@ async def get_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1709,8 +1710,9 @@ def _get_api_key_by_id_serialize( @validate_call - async def get_current_user( + def get_current_user( self, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1728,6 +1730,8 @@ async def get_current_user( Get information about the currently authenticated user + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1751,6 +1755,7 @@ async def get_current_user( """ # noqa: E501 _param = self._get_current_user_serialize( + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1761,11 +1766,11 @@ async def get_current_user( '200': "CreateUserInAccount201Response", '403': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1773,8 +1778,9 @@ async def get_current_user( @validate_call - async def get_current_user_with_http_info( + def get_current_user_with_http_info( self, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1792,6 +1798,8 @@ async def get_current_user_with_http_info( Get information about the currently authenticated user + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1815,6 +1823,7 @@ async def get_current_user_with_http_info( """ # noqa: E501 _param = self._get_current_user_serialize( + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1825,11 +1834,11 @@ async def get_current_user_with_http_info( '200': "CreateUserInAccount201Response", '403': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -1837,8 +1846,9 @@ async def get_current_user_with_http_info( @validate_call - async def get_current_user_without_preload_content( + def get_current_user_without_preload_content( self, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1856,6 +1866,8 @@ async def get_current_user_without_preload_content( Get information about the currently authenticated user + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1879,6 +1891,7 @@ async def get_current_user_without_preload_content( """ # noqa: E501 _param = self._get_current_user_serialize( + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1889,7 +1902,7 @@ async def get_current_user_without_preload_content( '200': "CreateUserInAccount201Response", '403': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1898,6 +1911,7 @@ async def get_current_user_without_preload_content( def _get_current_user_serialize( self, + include, _request_auth, _content_type, _headers, @@ -1907,6 +1921,7 @@ def _get_current_user_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} @@ -1918,6 +1933,10 @@ def _get_current_user_serialize( # process the path parameters # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + # process the header parameters # process the form parameters # process the body parameter @@ -1958,7 +1977,7 @@ def _get_current_user_serialize( @validate_call - async def get_user_avatar( + def get_user_avatar( self, user_id: StrictStr, _request_timeout: Union[ @@ -2014,11 +2033,11 @@ async def get_user_avatar( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2026,7 +2045,7 @@ async def get_user_avatar( @validate_call - async def get_user_avatar_with_http_info( + def get_user_avatar_with_http_info( self, user_id: StrictStr, _request_timeout: Union[ @@ -2082,11 +2101,11 @@ async def get_user_avatar_with_http_info( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2094,7 +2113,7 @@ async def get_user_avatar_with_http_info( @validate_call - async def get_user_avatar_without_preload_content( + def get_user_avatar_without_preload_content( self, user_id: StrictStr, _request_timeout: Union[ @@ -2150,7 +2169,7 @@ async def get_user_avatar_without_preload_content( '200': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2216,9 +2235,10 @@ def _get_user_avatar_serialize( @validate_call - async def get_user_by_id( + def get_user_by_id( self, user_id: StrictStr, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2237,6 +2257,8 @@ async def get_user_by_id( :param user_id: (required) :type user_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2261,6 +2283,7 @@ async def get_user_by_id( _param = self._get_user_by_id_serialize( user_id=user_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2272,11 +2295,11 @@ async def get_user_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2284,9 +2307,10 @@ async def get_user_by_id( @validate_call - async def get_user_by_id_with_http_info( + def get_user_by_id_with_http_info( self, user_id: StrictStr, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2305,6 +2329,8 @@ async def get_user_by_id_with_http_info( :param user_id: (required) :type user_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2329,6 +2355,7 @@ async def get_user_by_id_with_http_info( _param = self._get_user_by_id_serialize( user_id=user_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2340,11 +2367,11 @@ async def get_user_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2352,9 +2379,10 @@ async def get_user_by_id_with_http_info( @validate_call - async def get_user_by_id_without_preload_content( + def get_user_by_id_without_preload_content( self, user_id: StrictStr, + include: Annotated[Optional[List[UserIncludeParam]], Field(description="Optional parameter used to define aux properties to load in the response")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2373,6 +2401,8 @@ async def get_user_by_id_without_preload_content( :param user_id: (required) :type user_id: str + :param include: Optional parameter used to define aux properties to load in the response + :type include: List[UserIncludeParam] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2397,6 +2427,7 @@ async def get_user_by_id_without_preload_content( _param = self._get_user_by_id_serialize( user_id=user_id, + include=include, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2408,7 +2439,7 @@ async def get_user_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2418,6 +2449,7 @@ async def get_user_by_id_without_preload_content( def _get_user_by_id_serialize( self, user_id, + include, _request_auth, _content_type, _headers, @@ -2427,6 +2459,7 @@ def _get_user_by_id_serialize( _host = None _collection_formats: Dict[str, str] = { + 'include': 'csv', } _path_params: Dict[str, str] = {} @@ -2440,6 +2473,10 @@ def _get_user_by_id_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if include is not None: + + _query_params.append(('include', include)) + # process the header parameters # process the form parameters # process the body parameter @@ -2480,7 +2517,7 @@ def _get_user_by_id_serialize( @validate_call - async def list_api_keys_by_user_id( + def list_api_keys_by_user_id( self, user_id: StrictStr, _request_timeout: Union[ @@ -2536,11 +2573,11 @@ async def list_api_keys_by_user_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2548,7 +2585,7 @@ async def list_api_keys_by_user_id( @validate_call - async def list_api_keys_by_user_id_with_http_info( + def list_api_keys_by_user_id_with_http_info( self, user_id: StrictStr, _request_timeout: Union[ @@ -2604,11 +2641,11 @@ async def list_api_keys_by_user_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2616,7 +2653,7 @@ async def list_api_keys_by_user_id_with_http_info( @validate_call - async def list_api_keys_by_user_id_without_preload_content( + def list_api_keys_by_user_id_without_preload_content( self, user_id: StrictStr, _request_timeout: Union[ @@ -2672,7 +2709,7 @@ async def list_api_keys_by_user_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2744,7 +2781,7 @@ def _list_api_keys_by_user_id_serialize( @validate_call - async def list_users_by_account_id( + def list_users_by_account_id( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -2820,11 +2857,11 @@ async def list_users_by_account_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2832,7 +2869,7 @@ async def list_users_by_account_id( @validate_call - async def list_users_by_account_id_with_http_info( + def list_users_by_account_id_with_http_info( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -2908,11 +2945,11 @@ async def list_users_by_account_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -2920,7 +2957,7 @@ async def list_users_by_account_id_with_http_info( @validate_call - async def list_users_by_account_id_without_preload_content( + def list_users_by_account_id_without_preload_content( self, account_id: StrictStr, filter_platform_roles: Annotated[Optional[UserPlatformRole], Field(description="Filter based on platform roles, e.g. super_admin")] = None, @@ -2996,7 +3033,7 @@ async def list_users_by_account_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3093,7 +3130,7 @@ def _list_users_by_account_id_serialize( @validate_call - async def update_api_key_by_id( + def update_api_key_by_id( self, user_id: StrictStr, key_id: StrictStr, @@ -3157,11 +3194,11 @@ async def update_api_key_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3169,7 +3206,7 @@ async def update_api_key_by_id( @validate_call - async def update_api_key_by_id_with_http_info( + def update_api_key_by_id_with_http_info( self, user_id: StrictStr, key_id: StrictStr, @@ -3233,11 +3270,11 @@ async def update_api_key_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3245,7 +3282,7 @@ async def update_api_key_by_id_with_http_info( @validate_call - async def update_api_key_by_id_without_preload_content( + def update_api_key_by_id_without_preload_content( self, user_id: StrictStr, key_id: StrictStr, @@ -3309,7 +3346,7 @@ async def update_api_key_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3400,7 +3437,7 @@ def _update_api_key_by_id_serialize( @validate_call - async def update_user_by_id( + def update_user_by_id( self, user_id: StrictStr, user_mutation: UserMutation, @@ -3461,11 +3498,11 @@ async def update_user_by_id( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3473,7 +3510,7 @@ async def update_user_by_id( @validate_call - async def update_user_by_id_with_http_info( + def update_user_by_id_with_http_info( self, user_id: StrictStr, user_mutation: UserMutation, @@ -3534,11 +3571,11 @@ async def update_user_by_id_with_http_info( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3546,7 +3583,7 @@ async def update_user_by_id_with_http_info( @validate_call - async def update_user_by_id_without_preload_content( + def update_user_by_id_without_preload_content( self, user_id: StrictStr, user_mutation: UserMutation, @@ -3607,7 +3644,7 @@ async def update_user_by_id_without_preload_content( '403': None, '404': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3695,7 +3732,7 @@ def _update_user_by_id_serialize( @validate_call - async def upload_user_avatar( + def upload_user_avatar( self, user_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3754,11 +3791,11 @@ async def upload_user_avatar( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3766,7 +3803,7 @@ async def upload_user_avatar( @validate_call - async def upload_user_avatar_with_http_info( + def upload_user_avatar_with_http_info( self, user_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3825,11 +3862,11 @@ async def upload_user_avatar_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) - await response_data.read() + response_data.read() return self.api_client.response_deserialize( response_data=response_data, response_types_map=_response_types_map, @@ -3837,7 +3874,7 @@ async def upload_user_avatar_with_http_info( @validate_call - async def upload_user_avatar_without_preload_content( + def upload_user_avatar_without_preload_content( self, user_id: StrictStr, body: Union[StrictBytes, StrictStr], @@ -3896,7 +3933,7 @@ async def upload_user_avatar_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, } - response_data = await self.api_client.call_api( + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/digiseg_api/api_client.py b/digiseg_api/api_client.py index 2858ecb..e9b921a 100644 --- a/digiseg_api/api_client.py +++ b/digiseg_api/api_client.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -92,14 +92,11 @@ def __init__( self.user_agent = 'OpenAPI-Generator/1.0.0/python' self.client_side_validation = configuration.client_side_validation - async def __aenter__(self): + def __enter__(self): return self - async def __aexit__(self, exc_type, exc_value, traceback): - await self.close() - - async def close(self): - await self.rest_client.close() + def __exit__(self, exc_type, exc_value, traceback): + pass @property def user_agent(self): @@ -249,7 +246,7 @@ def param_serialize( return method, url, header_params, body, post_params - async def call_api( + def call_api( self, method, url, @@ -272,7 +269,7 @@ async def call_api( try: # perform request and return response - response_data = await self.rest_client.request( + response_data = self.rest_client.request( method, url, headers=header_params, body=body, post_params=post_params, diff --git a/digiseg_api/configuration.py b/digiseg_api/configuration.py index 4fcdc39..e42ea5e 100644 --- a/digiseg_api/configuration.py +++ b/digiseg_api/configuration.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -16,6 +16,7 @@ import copy import logging from logging import FileHandler +import multiprocessing import sys from typing import Optional import urllib3 @@ -169,9 +170,12 @@ def __init__(self, host=None, Set this to the SNI value expected by the server. """ - self.connection_pool_maxsize = 100 - """This value is passed to the aiohttp to limit simultaneous connections. - Default values is 100, None means no-limit. + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. """ self.proxy: Optional[str] = None diff --git a/digiseg_api/exceptions.py b/digiseg_api/exceptions.py index e845dec..e847b3a 100644 --- a/digiseg_api/exceptions.py +++ b/digiseg_api/exceptions.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/__init__.py b/digiseg_api/models/__init__.py index a0a9968..f8bfca9 100644 --- a/digiseg_api/models/__init__.py +++ b/digiseg_api/models/__init__.py @@ -4,7 +4,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -21,11 +21,23 @@ from digiseg_api.models.account_creation import AccountCreation from digiseg_api.models.account_creation_aux import AccountCreationAux from digiseg_api.models.account_full import AccountFull +from digiseg_api.models.account_include_aux import AccountIncludeAux +from digiseg_api.models.account_include_param import AccountIncludeParam from digiseg_api.models.account_item import AccountItem from digiseg_api.models.account_links import AccountLinks from digiseg_api.models.account_mutation import AccountMutation from digiseg_api.models.account_mutation_aux import AccountMutationAux from digiseg_api.models.account_owner_creation import AccountOwnerCreation +from digiseg_api.models.account_sort_option import AccountSortOption +from digiseg_api.models.account_stripe_billing_info import AccountStripeBillingInfo +from digiseg_api.models.account_subscription_base import AccountSubscriptionBase +from digiseg_api.models.account_subscription_creation import AccountSubscriptionCreation +from digiseg_api.models.account_subscription_full import AccountSubscriptionFull +from digiseg_api.models.account_subscription_full_aux import AccountSubscriptionFullAux +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.account_subscription_item_aux import AccountSubscriptionItemAux +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.account_subscriptions_summary import AccountSubscriptionsSummary from digiseg_api.models.api_key_aux import ApiKeyAux from digiseg_api.models.api_key_base import ApiKeyBase from digiseg_api.models.api_key_creation import ApiKeyCreation @@ -47,6 +59,7 @@ from digiseg_api.models.audience_response import AudienceResponse from digiseg_api.models.audience_response_status import AudienceResponseStatus from digiseg_api.models.audience_stats import AudienceStats +from digiseg_api.models.audiences_include_param import AudiencesIncludeParam from digiseg_api.models.auth_token_request import AuthTokenRequest from digiseg_api.models.auth_token_response import AuthTokenResponse from digiseg_api.models.business_audience_stats import BusinessAudienceStats @@ -66,11 +79,14 @@ from digiseg_api.models.error_response import ErrorResponse from digiseg_api.models.frequency_stats import FrequencyStats from digiseg_api.models.get_account_by_id200_response import GetAccountById200Response +from digiseg_api.models.get_account_subscription_by_id200_response import GetAccountSubscriptionById200Response +from digiseg_api.models.get_account_subscriptions200_response import GetAccountSubscriptions200Response from digiseg_api.models.get_api_key_by_id200_response import GetApiKeyById200Response from digiseg_api.models.get_popuplation_by_key200_response import GetPopuplationByKey200Response from digiseg_api.models.hour_of_day_stats import HourOfDayStats from digiseg_api.models.identifyable_object import IdentifyableObject from digiseg_api.models.identifyable_object1 import IdentifyableObject1 +from digiseg_api.models.limited_or_full_feature import LimitedOrFullFeature from digiseg_api.models.list_api_keys_by_account_id200_response import ListApiKeysByAccountId200Response from digiseg_api.models.list_audience_data_daily_usage200_response import ListAudienceDataDailyUsage200Response from digiseg_api.models.list_audience_data_monthly_usage200_response import ListAudienceDataMonthlyUsage200Response @@ -82,6 +98,7 @@ from digiseg_api.models.list_pagination_meta_page import ListPaginationMetaPage from digiseg_api.models.list_popuplations200_response import ListPopuplations200Response from digiseg_api.models.list_studies200_response import ListStudies200Response +from digiseg_api.models.list_subscription_plans200_response import ListSubscriptionPlans200Response from digiseg_api.models.list_users_by_account_id200_response import ListUsersByAccountId200Response from digiseg_api.models.measurement import Measurement from digiseg_api.models.measurement_client_base import MeasurementClientBase @@ -96,6 +113,7 @@ from digiseg_api.models.measurements_container import MeasurementsContainer from digiseg_api.models.passwordless_auth_request import PasswordlessAuthRequest from digiseg_api.models.permission_scopes import PermissionScopes +from digiseg_api.models.plan_feature_set import PlanFeatureSet from digiseg_api.models.population_audience_category_set_business_section import PopulationAudienceCategorySetBusinessSection from digiseg_api.models.population_audience_category_set_private_section import PopulationAudienceCategorySetPrivateSection from digiseg_api.models.population_audience_category_set_section import PopulationAudienceCategorySetSection @@ -136,6 +154,8 @@ from digiseg_api.models.resolve_audiences_of_multiple_request_item import ResolveAudiencesOfMultipleRequestItem from digiseg_api.models.resolve_audiences_of_multiple_response import ResolveAudiencesOfMultipleResponse from digiseg_api.models.resolve_audiences_of_multiple_response_item import ResolveAudiencesOfMultipleResponseItem +from digiseg_api.models.stripe_account_subscription_checkout_session import StripeAccountSubscriptionCheckoutSession +from digiseg_api.models.stripe_account_subscription_purchase_creation import StripeAccountSubscriptionPurchaseCreation from digiseg_api.models.study_audience_stats import StudyAudienceStats from digiseg_api.models.study_aux import StudyAux from digiseg_api.models.study_base import StudyBase @@ -153,9 +173,20 @@ from digiseg_api.models.study_permissions import StudyPermissions from digiseg_api.models.study_summary_stats import StudySummaryStats from digiseg_api.models.study_timing_stats import StudyTimingStats +from digiseg_api.models.subscription_plan_aux import SubscriptionPlanAux +from digiseg_api.models.subscription_plan_base import SubscriptionPlanBase +from digiseg_api.models.subscription_plan_full import SubscriptionPlanFull +from digiseg_api.models.subscription_plan_item import SubscriptionPlanItem +from digiseg_api.models.subscription_price import SubscriptionPrice +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.subscription_price_interval import SubscriptionPriceInterval +from digiseg_api.models.subscription_product_type import SubscriptionProductType +from digiseg_api.models.tax_id import TaxId from digiseg_api.models.timestamped_object import TimestampedObject from digiseg_api.models.timestamped_object1 import TimestampedObject1 from digiseg_api.models.user_account_membership import UserAccountMembership +from digiseg_api.models.user_account_membership_base import UserAccountMembershipBase +from digiseg_api.models.user_account_membership_include_aux import UserAccountMembershipIncludeAux from digiseg_api.models.user_account_role import UserAccountRole from digiseg_api.models.user_aux import UserAux from digiseg_api.models.user_base import UserBase @@ -163,6 +194,7 @@ from digiseg_api.models.user_creation_notification import UserCreationNotification from digiseg_api.models.user_credentials import UserCredentials from digiseg_api.models.user_full import UserFull +from digiseg_api.models.user_include_param import UserIncludeParam from digiseg_api.models.user_item import UserItem from digiseg_api.models.user_links import UserLinks from digiseg_api.models.user_mutation import UserMutation diff --git a/digiseg_api/models/access_token_data.py b/digiseg_api/models/access_token_data.py index 3a314f4..15e8d9e 100644 --- a/digiseg_api/models/access_token_data.py +++ b/digiseg_api/models/access_token_data.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/account_aux.py b/digiseg_api/models/account_aux.py index 57b658d..f710d68 100644 --- a/digiseg_api/models/account_aux.py +++ b/digiseg_api/models/account_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -21,6 +21,8 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.postal_address import PostalAddress +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.tax_id import TaxId from typing import Optional, Set from typing_extensions import Self @@ -31,7 +33,11 @@ class AccountAux(BaseModel): owner_id: Optional[StrictStr] = Field(default=None, description="ID of the user who is the ultimate owner of the account. Deprecated in favor of the `owner` role of the user's account membership.") billing_email: Optional[StrictStr] = Field(default=None, description="The email address to send billing information to. Requires `owner` role to change.") billing_address: Optional[PostalAddress] = None - __properties: ClassVar[List[str]] = ["owner_id", "billing_email", "billing_address"] + billing_tax_ids: Optional[List[TaxId]] = Field(default=None, description="A list of Tax IDs used by the account, for billing purposes.") + billing_currency: Optional[SubscriptionPriceCurrency] = None + billing_name: Optional[StrictStr] = Field(default=None, description="An optional official name to use for billing purposes. Requires `owner` role to change.") + stripe_customer_id: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["owner_id", "billing_email", "billing_address", "billing_tax_ids", "billing_currency", "billing_name", "stripe_customer_id"] model_config = ConfigDict( populate_by_name=True, @@ -63,8 +69,12 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "billing_tax_ids", + "stripe_customer_id", ]) _dict = self.model_dump( @@ -75,6 +85,13 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of billing_address if self.billing_address: _dict['billing_address'] = self.billing_address.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in billing_tax_ids (list) + _items = [] + if self.billing_tax_ids: + for _item in self.billing_tax_ids: + if _item: + _items.append(_item.to_dict()) + _dict['billing_tax_ids'] = _items return _dict @classmethod @@ -89,7 +106,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "owner_id": obj.get("owner_id"), "billing_email": obj.get("billing_email"), - "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None + "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None, + "billing_tax_ids": [TaxId.from_dict(_item) for _item in obj["billing_tax_ids"]] if obj.get("billing_tax_ids") is not None else None, + "billing_currency": obj.get("billing_currency"), + "billing_name": obj.get("billing_name"), + "stripe_customer_id": obj.get("stripe_customer_id") }) return _obj diff --git a/digiseg_api/models/account_base.py b/digiseg_api/models/account_base.py index 73f8510..9eab6fc 100644 --- a/digiseg_api/models/account_base.py +++ b/digiseg_api/models/account_base.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/account_creation.py b/digiseg_api/models/account_creation.py index 465611a..b13fd37 100644 --- a/digiseg_api/models/account_creation.py +++ b/digiseg_api/models/account_creation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -40,12 +40,12 @@ class AccountCreation(BaseModel): company_size: Optional[CompanySize] = None has_clients: Optional[StrictBool] = Field(default=None, description="Determines whether the account has clients that they work for, or if their activities are for themselves.") slug: Optional[Annotated[str, Field(min_length=4, strict=True, max_length=12)]] = Field(default=None, description="A short human-readable name to identify the account. Must be lower-case and between 4 and 16 characters.") + owner: Optional[AccountOwnerCreation] = None owner_id: Optional[StrictStr] = Field(default=None, description="ID of the user who is the ultimate owner of the account. Deprecated in favor of the `owner` role of the user's account membership.") billing_email: Optional[StrictStr] = Field(default=None, description="The email address to send billing information to. Requires `owner` role to change.") billing_address: Optional[PostalAddress] = None - owner: Optional[AccountOwnerCreation] = None notify_user: Optional[StrictBool] = Field(default=True, description="Whether or not to notify the user that they have been registered") - __properties: ClassVar[List[str]] = ["name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner_id", "billing_email", "billing_address", "owner", "notify_user"] + __properties: ClassVar[List[str]] = ["name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner", "owner_id", "billing_email", "billing_address", "notify_user"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -96,12 +96,12 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of billing_address - if self.billing_address: - _dict['billing_address'] = self.billing_address.to_dict() # override the default output from pydantic by calling `to_dict()` of owner if self.owner: _dict['owner'] = self.owner.to_dict() + # override the default output from pydantic by calling `to_dict()` of billing_address + if self.billing_address: + _dict['billing_address'] = self.billing_address.to_dict() return _dict @classmethod @@ -122,10 +122,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "company_size": obj.get("company_size"), "has_clients": obj.get("has_clients"), "slug": obj.get("slug"), + "owner": AccountOwnerCreation.from_dict(obj["owner"]) if obj.get("owner") is not None else None, "owner_id": obj.get("owner_id"), "billing_email": obj.get("billing_email"), "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None, - "owner": AccountOwnerCreation.from_dict(obj["owner"]) if obj.get("owner") is not None else None, "notify_user": obj.get("notify_user") if obj.get("notify_user") is not None else True }) return _obj diff --git a/digiseg_api/models/account_creation_aux.py b/digiseg_api/models/account_creation_aux.py index e6ab9cb..1bacb4a 100644 --- a/digiseg_api/models/account_creation_aux.py +++ b/digiseg_api/models/account_creation_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,9 +18,10 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.account_owner_creation import AccountOwnerCreation +from digiseg_api.models.postal_address import PostalAddress from typing import Optional, Set from typing_extensions import Self @@ -29,7 +30,10 @@ class AccountCreationAux(BaseModel): AccountCreationAux """ # noqa: E501 owner: Optional[AccountOwnerCreation] = None - __properties: ClassVar[List[str]] = ["owner"] + owner_id: Optional[StrictStr] = Field(default=None, description="ID of the user who is the ultimate owner of the account. Deprecated in favor of the `owner` role of the user's account membership.") + billing_email: Optional[StrictStr] = Field(default=None, description="The email address to send billing information to. Requires `owner` role to change.") + billing_address: Optional[PostalAddress] = None + __properties: ClassVar[List[str]] = ["owner", "owner_id", "billing_email", "billing_address"] model_config = ConfigDict( populate_by_name=True, @@ -73,6 +77,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of owner if self.owner: _dict['owner'] = self.owner.to_dict() + # override the default output from pydantic by calling `to_dict()` of billing_address + if self.billing_address: + _dict['billing_address'] = self.billing_address.to_dict() return _dict @classmethod @@ -85,7 +92,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "owner": AccountOwnerCreation.from_dict(obj["owner"]) if obj.get("owner") is not None else None + "owner": AccountOwnerCreation.from_dict(obj["owner"]) if obj.get("owner") is not None else None, + "owner_id": obj.get("owner_id"), + "billing_email": obj.get("billing_email"), + "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None }) return _obj diff --git a/digiseg_api/models/account_full.py b/digiseg_api/models/account_full.py index 2abdd65..d169798 100644 --- a/digiseg_api/models/account_full.py +++ b/digiseg_api/models/account_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -22,8 +22,12 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem from digiseg_api.models.company_size import CompanySize +from digiseg_api.models.plan_feature_set import PlanFeatureSet from digiseg_api.models.postal_address import PostalAddress +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.tax_id import TaxId from typing import Optional, Set from typing_extensions import Self @@ -43,11 +47,17 @@ class AccountFull(BaseModel): owner_id: Optional[StrictStr] = Field(default=None, description="ID of the user who is the ultimate owner of the account. Deprecated in favor of the `owner` role of the user's account membership.") billing_email: Optional[StrictStr] = Field(default=None, description="The email address to send billing information to. Requires `owner` role to change.") billing_address: Optional[PostalAddress] = None + billing_tax_ids: Optional[List[TaxId]] = Field(default=None, description="A list of Tax IDs used by the account, for billing purposes.") + billing_currency: Optional[SubscriptionPriceCurrency] = None + billing_name: Optional[StrictStr] = Field(default=None, description="An optional official name to use for billing purposes. Requires `owner` role to change.") + stripe_customer_id: Optional[StrictStr] = None + feature_set: Optional[PlanFeatureSet] = None + subscriptions: Optional[List[AccountSubscriptionItem]] = None created_at: Optional[datetime] = Field(default=None, description="Date and time of the object creation") created_by: Optional[StrictStr] = Field(default=None, description="ID of the user who created the object") updated_at: Optional[datetime] = Field(default=None, description="Date and time of the latest update to the object") updated_by: Optional[StrictStr] = Field(default=None, description="ID of the user who last updated the object") - __properties: ClassVar[List[str]] = ["id", "name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner_id", "billing_email", "billing_address", "created_at", "created_by", "updated_at", "updated_by"] + __properties: ClassVar[List[str]] = ["id", "name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner_id", "billing_email", "billing_address", "billing_tax_ids", "billing_currency", "billing_name", "stripe_customer_id", "feature_set", "subscriptions", "created_at", "created_by", "updated_at", "updated_by"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -89,8 +99,24 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", + "billing_tax_ids", + "stripe_customer_id", + "subscriptions", + "created_at", + "created_by", + "updated_at", + "updated_by", ]) _dict = self.model_dump( @@ -101,6 +127,23 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of billing_address if self.billing_address: _dict['billing_address'] = self.billing_address.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in billing_tax_ids (list) + _items = [] + if self.billing_tax_ids: + for _item in self.billing_tax_ids: + if _item: + _items.append(_item.to_dict()) + _dict['billing_tax_ids'] = _items + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items return _dict @classmethod @@ -125,6 +168,12 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "owner_id": obj.get("owner_id"), "billing_email": obj.get("billing_email"), "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None, + "billing_tax_ids": [TaxId.from_dict(_item) for _item in obj["billing_tax_ids"]] if obj.get("billing_tax_ids") is not None else None, + "billing_currency": obj.get("billing_currency"), + "billing_name": obj.get("billing_name"), + "stripe_customer_id": obj.get("stripe_customer_id"), + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None, + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None, "created_at": obj.get("created_at"), "created_by": obj.get("created_by"), "updated_at": obj.get("updated_at"), diff --git a/digiseg_api/models/account_include_aux.py b/digiseg_api/models/account_include_aux.py new file mode 100644 index 0000000..18b2c66 --- /dev/null +++ b/digiseg_api/models/account_include_aux.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.plan_feature_set import PlanFeatureSet +from typing import Optional, Set +from typing_extensions import Self + +class AccountIncludeAux(BaseModel): + """ + Additional properties that may appear as read-only properties depending on the `include` parameter + """ # noqa: E501 + feature_set: Optional[PlanFeatureSet] = None + subscriptions: Optional[List[AccountSubscriptionItem]] = None + __properties: ClassVar[List[str]] = ["feature_set", "subscriptions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountIncludeAux from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "subscriptions", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountIncludeAux from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None, + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/account_include_param.py b/digiseg_api/models/account_include_param.py new file mode 100644 index 0000000..2aa617a --- /dev/null +++ b/digiseg_api/models/account_include_param.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AccountIncludeParam(str, Enum): + """ + AccountIncludeParam + """ + + """ + allowed enum values + """ + NONE = 'none' + SUBSCRIPTIONS = 'subscriptions' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AccountIncludeParam from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/account_item.py b/digiseg_api/models/account_item.py index 19e0df9..4bbc54a 100644 --- a/digiseg_api/models/account_item.py +++ b/digiseg_api/models/account_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -21,7 +21,9 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem from digiseg_api.models.company_size import CompanySize +from digiseg_api.models.plan_feature_set import PlanFeatureSet from typing import Optional, Set from typing_extensions import Self @@ -38,7 +40,9 @@ class AccountItem(BaseModel): company_size: Optional[CompanySize] = None has_clients: Optional[StrictBool] = Field(default=None, description="Determines whether the account has clients that they work for, or if their activities are for themselves.") slug: Optional[Annotated[str, Field(min_length=4, strict=True, max_length=12)]] = Field(default=None, description="A short human-readable name to identify the account. Must be lower-case and between 4 and 16 characters.") - __properties: ClassVar[List[str]] = ["id", "name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug"] + feature_set: Optional[PlanFeatureSet] = None + subscriptions: Optional[List[AccountSubscriptionItem]] = None + __properties: ClassVar[List[str]] = ["id", "name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "feature_set", "subscriptions"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -80,8 +84,12 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", + "subscriptions", ]) _dict = self.model_dump( @@ -89,6 +97,16 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items return _dict @classmethod @@ -109,7 +127,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "company_type": obj.get("company_type"), "company_size": obj.get("company_size"), "has_clients": obj.get("has_clients"), - "slug": obj.get("slug") + "slug": obj.get("slug"), + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None, + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None }) return _obj diff --git a/digiseg_api/models/account_links.py b/digiseg_api/models/account_links.py index 4f00f18..139d62a 100644 --- a/digiseg_api/models/account_links.py +++ b/digiseg_api/models/account_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/account_mutation.py b/digiseg_api/models/account_mutation.py index 6c149c3..1484941 100644 --- a/digiseg_api/models/account_mutation.py +++ b/digiseg_api/models/account_mutation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -24,6 +24,8 @@ from digiseg_api.models.company_size import CompanySize from digiseg_api.models.company_type import CompanyType from digiseg_api.models.postal_address import PostalAddress +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.tax_id import TaxId from typing import Optional, Set from typing_extensions import Self @@ -42,7 +44,11 @@ class AccountMutation(BaseModel): owner_id: Optional[StrictStr] = Field(default=None, description="ID of the user who is the ultimate owner of the account. Deprecated in favor of the `owner` role of the user's account membership.") billing_email: Optional[StrictStr] = Field(default=None, description="The email address to send billing information to. Requires `owner` role to change.") billing_address: Optional[PostalAddress] = None - __properties: ClassVar[List[str]] = ["name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner_id", "billing_email", "billing_address"] + billing_tax_ids: Optional[List[TaxId]] = Field(default=None, description="A list of Tax IDs used by the account, for billing purposes.") + billing_currency: Optional[SubscriptionPriceCurrency] = None + billing_name: Optional[StrictStr] = Field(default=None, description="An optional official name to use for billing purposes. Requires `owner` role to change.") + stripe_customer_id: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["name", "logo_url", "website_url", "billing_country", "company_type", "company_size", "has_clients", "slug", "owner_id", "billing_email", "billing_address", "billing_tax_ids", "billing_currency", "billing_name", "stripe_customer_id"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -84,8 +90,12 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "billing_tax_ids", + "stripe_customer_id", ]) _dict = self.model_dump( @@ -96,6 +106,13 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of billing_address if self.billing_address: _dict['billing_address'] = self.billing_address.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in billing_tax_ids (list) + _items = [] + if self.billing_tax_ids: + for _item in self.billing_tax_ids: + if _item: + _items.append(_item.to_dict()) + _dict['billing_tax_ids'] = _items return _dict @classmethod @@ -118,7 +135,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "slug": obj.get("slug"), "owner_id": obj.get("owner_id"), "billing_email": obj.get("billing_email"), - "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None + "billing_address": PostalAddress.from_dict(obj["billing_address"]) if obj.get("billing_address") is not None else None, + "billing_tax_ids": [TaxId.from_dict(_item) for _item in obj["billing_tax_ids"]] if obj.get("billing_tax_ids") is not None else None, + "billing_currency": obj.get("billing_currency"), + "billing_name": obj.get("billing_name"), + "stripe_customer_id": obj.get("stripe_customer_id") }) return _obj diff --git a/digiseg_api/models/account_mutation_aux.py b/digiseg_api/models/account_mutation_aux.py index d3c90a9..c3e1fbc 100644 --- a/digiseg_api/models/account_mutation_aux.py +++ b/digiseg_api/models/account_mutation_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/account_owner_creation.py b/digiseg_api/models/account_owner_creation.py index 6992e28..8169ce9 100644 --- a/digiseg_api/models/account_owner_creation.py +++ b/digiseg_api/models/account_owner_creation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/account_sort_option.py b/digiseg_api/models/account_sort_option.py new file mode 100644 index 0000000..1edb512 --- /dev/null +++ b/digiseg_api/models/account_sort_option.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AccountSortOption(str, Enum): + """ + AccountSortOption + """ + + """ + allowed enum values + """ + CREATED_AT = 'created_at' + MINUS_CREATED_AT = '-created_at' + NAME = 'name' + MINUS_NAME = '-name' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AccountSortOption from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/account_stripe_billing_info.py b/digiseg_api/models/account_stripe_billing_info.py new file mode 100644 index 0000000..dd69726 --- /dev/null +++ b/digiseg_api/models/account_stripe_billing_info.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AccountStripeBillingInfo(BaseModel): + """ + AccountStripeBillingInfo + """ # noqa: E501 + billing_portal_url: Optional[StrictStr] = Field(default=None, description="The URL to take the user to, to configure their billing information") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["billing_portal_url"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountStripeBillingInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountStripeBillingInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "billing_portal_url": obj.get("billing_portal_url") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/digiseg_api/models/account_subscription_base.py b/digiseg_api/models/account_subscription_base.py new file mode 100644 index 0000000..e71a3a2 --- /dev/null +++ b/digiseg_api/models/account_subscription_base.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.subscription_price import SubscriptionPrice +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionBase(BaseModel): + """ + AccountSubscriptionBase + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the subscription") + start_date: date + end_date: Optional[date] = None + is_active: StrictBool = Field(description="Is the subscription currently active or not?") + actual_price: Optional[SubscriptionPrice] = None + payment_configuration: Optional[AccountSubscriptionPaymentConfiguration] = None + __properties: ClassVar[List[str]] = ["id", "start_date", "end_date", "is_active", "actual_price", "payment_configuration"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionBase from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "is_active", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of actual_price + if self.actual_price: + _dict['actual_price'] = self.actual_price.to_dict() + # override the default output from pydantic by calling `to_dict()` of payment_configuration + if self.payment_configuration: + _dict['payment_configuration'] = self.payment_configuration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionBase from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "is_active": obj.get("is_active"), + "actual_price": SubscriptionPrice.from_dict(obj["actual_price"]) if obj.get("actual_price") is not None else None, + "payment_configuration": AccountSubscriptionPaymentConfiguration.from_dict(obj["payment_configuration"]) if obj.get("payment_configuration") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_creation.py b/digiseg_api/models/account_subscription_creation.py new file mode 100644 index 0000000..dac5169 --- /dev/null +++ b/digiseg_api/models/account_subscription_creation.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.subscription_price import SubscriptionPrice +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionCreation(BaseModel): + """ + AccountSubscriptionCreation + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the subscription") + start_date: date + end_date: Optional[date] = None + is_active: StrictBool = Field(description="Is the subscription currently active or not?") + actual_price: Optional[SubscriptionPrice] = None + payment_configuration: Optional[AccountSubscriptionPaymentConfiguration] = None + plan_id: StrictStr = Field(description="The ID of the plan to subscribe to") + __properties: ClassVar[List[str]] = ["id", "start_date", "end_date", "is_active", "actual_price", "payment_configuration", "plan_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionCreation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "is_active", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of actual_price + if self.actual_price: + _dict['actual_price'] = self.actual_price.to_dict() + # override the default output from pydantic by calling `to_dict()` of payment_configuration + if self.payment_configuration: + _dict['payment_configuration'] = self.payment_configuration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionCreation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "is_active": obj.get("is_active"), + "actual_price": SubscriptionPrice.from_dict(obj["actual_price"]) if obj.get("actual_price") is not None else None, + "payment_configuration": AccountSubscriptionPaymentConfiguration.from_dict(obj["payment_configuration"]) if obj.get("payment_configuration") is not None else None, + "plan_id": obj.get("plan_id") + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_full.py b/digiseg_api/models/account_subscription_full.py new file mode 100644 index 0000000..71ac630 --- /dev/null +++ b/digiseg_api/models/account_subscription_full.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.subscription_plan_full import SubscriptionPlanFull +from digiseg_api.models.subscription_price import SubscriptionPrice +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionFull(BaseModel): + """ + AccountSubscriptionFull + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the subscription") + start_date: date + end_date: Optional[date] = None + is_active: StrictBool = Field(description="Is the subscription currently active or not?") + actual_price: Optional[SubscriptionPrice] = None + payment_configuration: Optional[AccountSubscriptionPaymentConfiguration] = None + plan: SubscriptionPlanFull + account_id: StrictStr = Field(description="The ID of the account") + last_paid_at: Optional[datetime] = Field(default=None, description="Timestamp of the last processed payment") + created_at: Optional[datetime] = Field(default=None, description="Date and time of the object creation") + created_by: Optional[StrictStr] = Field(default=None, description="ID of the user who created the object") + updated_at: Optional[datetime] = Field(default=None, description="Date and time of the latest update to the object") + updated_by: Optional[StrictStr] = Field(default=None, description="ID of the user who last updated the object") + __properties: ClassVar[List[str]] = ["id", "start_date", "end_date", "is_active", "actual_price", "payment_configuration", "plan", "account_id", "last_paid_at", "created_at", "created_by", "updated_at", "updated_by"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionFull from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "is_active", + "account_id", + "created_at", + "created_by", + "updated_at", + "updated_by", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of actual_price + if self.actual_price: + _dict['actual_price'] = self.actual_price.to_dict() + # override the default output from pydantic by calling `to_dict()` of payment_configuration + if self.payment_configuration: + _dict['payment_configuration'] = self.payment_configuration.to_dict() + # override the default output from pydantic by calling `to_dict()` of plan + if self.plan: + _dict['plan'] = self.plan.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionFull from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "is_active": obj.get("is_active"), + "actual_price": SubscriptionPrice.from_dict(obj["actual_price"]) if obj.get("actual_price") is not None else None, + "payment_configuration": AccountSubscriptionPaymentConfiguration.from_dict(obj["payment_configuration"]) if obj.get("payment_configuration") is not None else None, + "plan": SubscriptionPlanFull.from_dict(obj["plan"]) if obj.get("plan") is not None else None, + "account_id": obj.get("account_id"), + "last_paid_at": obj.get("last_paid_at"), + "created_at": obj.get("created_at"), + "created_by": obj.get("created_by"), + "updated_at": obj.get("updated_at"), + "updated_by": obj.get("updated_by") + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_full_aux.py b/digiseg_api/models/account_subscription_full_aux.py new file mode 100644 index 0000000..44ffacd --- /dev/null +++ b/digiseg_api/models/account_subscription_full_aux.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.subscription_plan_full import SubscriptionPlanFull +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionFullAux(BaseModel): + """ + AccountSubscriptionFullAux + """ # noqa: E501 + account_id: StrictStr = Field(description="The ID of the account") + plan: SubscriptionPlanFull + last_paid_at: Optional[datetime] = Field(default=None, description="Timestamp of the last processed payment") + __properties: ClassVar[List[str]] = ["account_id", "plan", "last_paid_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionFullAux from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "account_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of plan + if self.plan: + _dict['plan'] = self.plan.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionFullAux from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "account_id": obj.get("account_id"), + "plan": SubscriptionPlanFull.from_dict(obj["plan"]) if obj.get("plan") is not None else None, + "last_paid_at": obj.get("last_paid_at") + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_item.py b/digiseg_api/models/account_subscription_item.py new file mode 100644 index 0000000..4f08e7a --- /dev/null +++ b/digiseg_api/models/account_subscription_item.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_payment_configuration import AccountSubscriptionPaymentConfiguration +from digiseg_api.models.subscription_plan_item import SubscriptionPlanItem +from digiseg_api.models.subscription_price import SubscriptionPrice +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionItem(BaseModel): + """ + AccountSubscriptionItem + """ # noqa: E501 + id: StrictStr = Field(description="The ID of the subscription") + start_date: date + end_date: Optional[date] = None + is_active: StrictBool = Field(description="Is the subscription currently active or not?") + actual_price: Optional[SubscriptionPrice] = None + payment_configuration: Optional[AccountSubscriptionPaymentConfiguration] = None + plan: Optional[SubscriptionPlanItem] = None + __properties: ClassVar[List[str]] = ["id", "start_date", "end_date", "is_active", "actual_price", "payment_configuration", "plan"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "is_active", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of actual_price + if self.actual_price: + _dict['actual_price'] = self.actual_price.to_dict() + # override the default output from pydantic by calling `to_dict()` of payment_configuration + if self.payment_configuration: + _dict['payment_configuration'] = self.payment_configuration.to_dict() + # override the default output from pydantic by calling `to_dict()` of plan + if self.plan: + _dict['plan'] = self.plan.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "is_active": obj.get("is_active"), + "actual_price": SubscriptionPrice.from_dict(obj["actual_price"]) if obj.get("actual_price") is not None else None, + "payment_configuration": AccountSubscriptionPaymentConfiguration.from_dict(obj["payment_configuration"]) if obj.get("payment_configuration") is not None else None, + "plan": SubscriptionPlanItem.from_dict(obj["plan"]) if obj.get("plan") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_item_aux.py b/digiseg_api/models/account_subscription_item_aux.py new file mode 100644 index 0000000..dc62284 --- /dev/null +++ b/digiseg_api/models/account_subscription_item_aux.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.subscription_plan_item import SubscriptionPlanItem +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionItemAux(BaseModel): + """ + AccountSubscriptionItemAux + """ # noqa: E501 + plan: Optional[SubscriptionPlanItem] = None + __properties: ClassVar[List[str]] = ["plan"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionItemAux from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of plan + if self.plan: + _dict['plan'] = self.plan.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionItemAux from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "plan": SubscriptionPlanItem.from_dict(obj["plan"]) if obj.get("plan") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/account_subscription_payment_configuration.py b/digiseg_api/models/account_subscription_payment_configuration.py new file mode 100644 index 0000000..79cd445 --- /dev/null +++ b/digiseg_api/models/account_subscription_payment_configuration.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionPaymentConfiguration(BaseModel): + """ + Describes the payment configuration of an account subscription + """ # noqa: E501 + platform: StrictStr + timing: StrictStr = Field(description="Is the subscription pre-paid or post-paid?") + stripe_subscription_id: Optional[StrictStr] = None + stripe_subscription_item_id: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["platform", "timing", "stripe_subscription_id", "stripe_subscription_item_id"] + + @field_validator('platform') + def platform_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['stripe', 'manual']): + raise ValueError("must be one of enum values ('stripe', 'manual')") + return value + + @field_validator('timing') + def timing_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['pre', 'post']): + raise ValueError("must be one of enum values ('pre', 'post')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionPaymentConfiguration from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "stripe_subscription_id", + "stripe_subscription_item_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionPaymentConfiguration from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "platform": obj.get("platform"), + "timing": obj.get("timing"), + "stripe_subscription_id": obj.get("stripe_subscription_id"), + "stripe_subscription_item_id": obj.get("stripe_subscription_item_id") + }) + return _obj + + diff --git a/digiseg_api/models/account_subscriptions_summary.py b/digiseg_api/models/account_subscriptions_summary.py new file mode 100644 index 0000000..bbb7b01 --- /dev/null +++ b/digiseg_api/models/account_subscriptions_summary.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.plan_feature_set import PlanFeatureSet +from typing import Optional, Set +from typing_extensions import Self + +class AccountSubscriptionsSummary(BaseModel): + """ + Summarizes an account's current subscription(s) and the feature set available + """ # noqa: E501 + account_id: StrictStr = Field(description="The ID of the account") + subscriptions: List[AccountSubscriptionItem] + feature_set: PlanFeatureSet + __properties: ClassVar[List[str]] = ["account_id", "subscriptions", "feature_set"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AccountSubscriptionsSummary from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "account_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AccountSubscriptionsSummary from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "account_id": obj.get("account_id"), + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None, + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/api_key_aux.py b/digiseg_api/models/api_key_aux.py index a12f677..1366802 100644 --- a/digiseg_api/models/api_key_aux.py +++ b/digiseg_api/models/api_key_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_base.py b/digiseg_api/models/api_key_base.py index da10420..903a5d6 100644 --- a/digiseg_api/models/api_key_base.py +++ b/digiseg_api/models/api_key_base.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_creation.py b/digiseg_api/models/api_key_creation.py index 18eb7b1..508fc59 100644 --- a/digiseg_api/models/api_key_creation.py +++ b/digiseg_api/models/api_key_creation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_full.py b/digiseg_api/models/api_key_full.py index 8bd3fd2..54c7dbd 100644 --- a/digiseg_api/models/api_key_full.py +++ b/digiseg_api/models/api_key_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -78,11 +78,21 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", "user_id", "last_used_at", "token_prefix", + "created_at", + "created_by", + "updated_at", + "updated_by", ]) _dict = self.model_dump( diff --git a/digiseg_api/models/api_key_full_with_token.py b/digiseg_api/models/api_key_full_with_token.py index d9ee054..1ada78b 100644 --- a/digiseg_api/models/api_key_full_with_token.py +++ b/digiseg_api/models/api_key_full_with_token.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -79,11 +79,21 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", "user_id", "last_used_at", "token_prefix", + "created_at", + "created_by", + "updated_at", + "updated_by", ]) _dict = self.model_dump( diff --git a/digiseg_api/models/api_key_item.py b/digiseg_api/models/api_key_item.py index c97e517..8a3676a 100644 --- a/digiseg_api/models/api_key_item.py +++ b/digiseg_api/models/api_key_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -72,8 +72,10 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", "user_id", "last_used_at", "token_prefix", diff --git a/digiseg_api/models/api_key_links.py b/digiseg_api/models/api_key_links.py index bf9b75d..7e95593 100644 --- a/digiseg_api/models/api_key_links.py +++ b/digiseg_api/models/api_key_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_mutation.py b/digiseg_api/models/api_key_mutation.py index d350590..08488db 100644 --- a/digiseg_api/models/api_key_mutation.py +++ b/digiseg_api/models/api_key_mutation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_status.py b/digiseg_api/models/api_key_status.py index 5a34fce..32f9fd6 100644 --- a/digiseg_api/models/api_key_status.py +++ b/digiseg_api/models/api_key_status.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/api_key_token.py b/digiseg_api/models/api_key_token.py index ee1281a..689b31d 100644 --- a/digiseg_api/models/api_key_token.py +++ b/digiseg_api/models/api_key_token.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience.py b/digiseg_api/models/audience.py index f1be745..1f55129 100644 --- a/digiseg_api/models/audience.py +++ b/digiseg_api/models/audience.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_category_stats.py b/digiseg_api/models/audience_category_stats.py index a2ebd84..ef41e39 100644 --- a/digiseg_api/models/audience_category_stats.py +++ b/digiseg_api/models/audience_category_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_data_daily_usage.py b/digiseg_api/models/audience_data_daily_usage.py index bad6ba8..ef10f06 100644 --- a/digiseg_api/models/audience_data_daily_usage.py +++ b/digiseg_api/models/audience_data_daily_usage.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_data_monthly_usage.py b/digiseg_api/models/audience_data_monthly_usage.py index 5da849a..bae0718 100644 --- a/digiseg_api/models/audience_data_monthly_usage.py +++ b/digiseg_api/models/audience_data_monthly_usage.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_data_realtime_usage.py b/digiseg_api/models/audience_data_realtime_usage.py index f8a1c4f..57e2381 100644 --- a/digiseg_api/models/audience_data_realtime_usage.py +++ b/digiseg_api/models/audience_data_realtime_usage.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_data_usage.py b/digiseg_api/models/audience_data_usage.py index 6813bc1..2784a8a 100644 --- a/digiseg_api/models/audience_data_usage.py +++ b/digiseg_api/models/audience_data_usage.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_example_input.py b/digiseg_api/models/audience_example_input.py index 4ad0fac..382b85e 100644 --- a/digiseg_api/models/audience_example_input.py +++ b/digiseg_api/models/audience_example_input.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_example_inputs_response.py b/digiseg_api/models/audience_example_inputs_response.py index 5d42aa7..d168b4b 100644 --- a/digiseg_api/models/audience_example_inputs_response.py +++ b/digiseg_api/models/audience_example_inputs_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_response.py b/digiseg_api/models/audience_response.py index 2a625d6..b90f117 100644 --- a/digiseg_api/models/audience_response.py +++ b/digiseg_api/models/audience_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_response_status.py b/digiseg_api/models/audience_response_status.py index dde7998..a42bfc6 100644 --- a/digiseg_api/models/audience_response_status.py +++ b/digiseg_api/models/audience_response_status.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audience_stats.py b/digiseg_api/models/audience_stats.py index 31f725f..c3842a2 100644 --- a/digiseg_api/models/audience_stats.py +++ b/digiseg_api/models/audience_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/audiences_include_param.py b/digiseg_api/models/audiences_include_param.py new file mode 100644 index 0000000..d3084a3 --- /dev/null +++ b/digiseg_api/models/audiences_include_param.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AudiencesIncludeParam(str, Enum): + """ + AudiencesIncludeParam + """ + + """ + allowed enum values + """ + CORE = 'core' + COMPOSITE = 'composite' + NAME = 'name' + CATEGORY = 'category' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AudiencesIncludeParam from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/auth_token_request.py b/digiseg_api/models/auth_token_request.py index a6bff6b..49ff912 100644 --- a/digiseg_api/models/auth_token_request.py +++ b/digiseg_api/models/auth_token_request.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/auth_token_response.py b/digiseg_api/models/auth_token_response.py index d9eccf2..22ace54 100644 --- a/digiseg_api/models/auth_token_response.py +++ b/digiseg_api/models/auth_token_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/business_audience_stats.py b/digiseg_api/models/business_audience_stats.py index 89785a1..dcb6e47 100644 --- a/digiseg_api/models/business_audience_stats.py +++ b/digiseg_api/models/business_audience_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/business_audience_stats_audience_categories.py b/digiseg_api/models/business_audience_stats_audience_categories.py index cc4ed3e..b83e786 100644 --- a/digiseg_api/models/business_audience_stats_audience_categories.py +++ b/digiseg_api/models/business_audience_stats_audience_categories.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/category_populations_full.py b/digiseg_api/models/category_populations_full.py index 86a0aa9..24214eb 100644 --- a/digiseg_api/models/category_populations_full.py +++ b/digiseg_api/models/category_populations_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/company_size.py b/digiseg_api/models/company_size.py index 7ece00b..255b4e0 100644 --- a/digiseg_api/models/company_size.py +++ b/digiseg_api/models/company_size.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/company_type.py b/digiseg_api/models/company_type.py index 7a1c426..61cd443 100644 --- a/digiseg_api/models/company_type.py +++ b/digiseg_api/models/company_type.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/comparison.py b/digiseg_api/models/comparison.py index c29ee7d..a9b06f8 100644 --- a/digiseg_api/models/comparison.py +++ b/digiseg_api/models/comparison.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/comparisons_container.py b/digiseg_api/models/comparisons_container.py index 30355a9..c63d522 100644 --- a/digiseg_api/models/comparisons_container.py +++ b/digiseg_api/models/comparisons_container.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/country_stats.py b/digiseg_api/models/country_stats.py index 2a6c93e..e8f0d76 100644 --- a/digiseg_api/models/country_stats.py +++ b/digiseg_api/models/country_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/create_api_key201_response.py b/digiseg_api/models/create_api_key201_response.py index f860e30..c61a74b 100644 --- a/digiseg_api/models/create_api_key201_response.py +++ b/digiseg_api/models/create_api_key201_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/create_measurement_client201_response.py b/digiseg_api/models/create_measurement_client201_response.py index 97ecb5f..0cf6669 100644 --- a/digiseg_api/models/create_measurement_client201_response.py +++ b/digiseg_api/models/create_measurement_client201_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/create_study201_response.py b/digiseg_api/models/create_study201_response.py index 6e2f647..74892f0 100644 --- a/digiseg_api/models/create_study201_response.py +++ b/digiseg_api/models/create_study201_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/create_user_in_account201_response.py b/digiseg_api/models/create_user_in_account201_response.py index 20273e9..daa6b5d 100644 --- a/digiseg_api/models/create_user_in_account201_response.py +++ b/digiseg_api/models/create_user_in_account201_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/day_of_month_stats.py b/digiseg_api/models/day_of_month_stats.py index 28916cd..c8c4583 100644 --- a/digiseg_api/models/day_of_month_stats.py +++ b/digiseg_api/models/day_of_month_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/day_of_week_stats.py b/digiseg_api/models/day_of_week_stats.py index 2835d73..7713e26 100644 --- a/digiseg_api/models/day_of_week_stats.py +++ b/digiseg_api/models/day_of_week_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/error_response.py b/digiseg_api/models/error_response.py index a39c518..2396476 100644 --- a/digiseg_api/models/error_response.py +++ b/digiseg_api/models/error_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/frequency_stats.py b/digiseg_api/models/frequency_stats.py index fffe047..f906939 100644 --- a/digiseg_api/models/frequency_stats.py +++ b/digiseg_api/models/frequency_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/get_account_by_id200_response.py b/digiseg_api/models/get_account_by_id200_response.py index 8a03025..fbf2e53 100644 --- a/digiseg_api/models/get_account_by_id200_response.py +++ b/digiseg_api/models/get_account_by_id200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/get_account_subscription_by_id200_response.py b/digiseg_api/models/get_account_subscription_by_id200_response.py new file mode 100644 index 0000000..2f608dd --- /dev/null +++ b/digiseg_api/models/get_account_subscription_by_id200_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscription_full import AccountSubscriptionFull +from typing import Optional, Set +from typing_extensions import Self + +class GetAccountSubscriptionById200Response(BaseModel): + """ + GetAccountSubscriptionById200Response + """ # noqa: E501 + data: Optional[AccountSubscriptionFull] = None + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetAccountSubscriptionById200Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetAccountSubscriptionById200Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": AccountSubscriptionFull.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/get_account_subscriptions200_response.py b/digiseg_api/models/get_account_subscriptions200_response.py new file mode 100644 index 0000000..47d661b --- /dev/null +++ b/digiseg_api/models/get_account_subscriptions200_response.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_subscriptions_summary import AccountSubscriptionsSummary +from typing import Optional, Set +from typing_extensions import Self + +class GetAccountSubscriptions200Response(BaseModel): + """ + GetAccountSubscriptions200Response + """ # noqa: E501 + data: Optional[AccountSubscriptionsSummary] = None + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetAccountSubscriptions200Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetAccountSubscriptions200Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": AccountSubscriptionsSummary.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/get_api_key_by_id200_response.py b/digiseg_api/models/get_api_key_by_id200_response.py index c0e8ff4..ea370b9 100644 --- a/digiseg_api/models/get_api_key_by_id200_response.py +++ b/digiseg_api/models/get_api_key_by_id200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/get_popuplation_by_key200_response.py b/digiseg_api/models/get_popuplation_by_key200_response.py index 4cf7add..a4be945 100644 --- a/digiseg_api/models/get_popuplation_by_key200_response.py +++ b/digiseg_api/models/get_popuplation_by_key200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/hour_of_day_stats.py b/digiseg_api/models/hour_of_day_stats.py index d37db53..b8ede25 100644 --- a/digiseg_api/models/hour_of_day_stats.py +++ b/digiseg_api/models/hour_of_day_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/identifyable_object.py b/digiseg_api/models/identifyable_object.py index 537f82e..461d7a1 100644 --- a/digiseg_api/models/identifyable_object.py +++ b/digiseg_api/models/identifyable_object.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -60,8 +60,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", ]) _dict = self.model_dump( diff --git a/digiseg_api/models/identifyable_object1.py b/digiseg_api/models/identifyable_object1.py index 72631de..6f9475f 100644 --- a/digiseg_api/models/identifyable_object1.py +++ b/digiseg_api/models/identifyable_object1.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/limited_or_full_feature.py b/digiseg_api/models/limited_or_full_feature.py new file mode 100644 index 0000000..4791760 --- /dev/null +++ b/digiseg_api/models/limited_or_full_feature.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class LimitedOrFullFeature(str, Enum): + """ + LimitedOrFullFeature + """ + + """ + allowed enum values + """ + FULL = 'full' + LIMITED = 'limited' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of LimitedOrFullFeature from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/list_api_keys_by_account_id200_response.py b/digiseg_api/models/list_api_keys_by_account_id200_response.py index 1d6855e..f793b5b 100644 --- a/digiseg_api/models/list_api_keys_by_account_id200_response.py +++ b/digiseg_api/models/list_api_keys_by_account_id200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_audience_data_daily_usage200_response.py b/digiseg_api/models/list_audience_data_daily_usage200_response.py index a79916c..49c667b 100644 --- a/digiseg_api/models/list_audience_data_daily_usage200_response.py +++ b/digiseg_api/models/list_audience_data_daily_usage200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_audience_data_monthly_usage200_response.py b/digiseg_api/models/list_audience_data_monthly_usage200_response.py index d32e7d1..d1f193a 100644 --- a/digiseg_api/models/list_audience_data_monthly_usage200_response.py +++ b/digiseg_api/models/list_audience_data_monthly_usage200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_audience_data_realtime_usage200_response.py b/digiseg_api/models/list_audience_data_realtime_usage200_response.py index 02783c7..2451ee1 100644 --- a/digiseg_api/models/list_audience_data_realtime_usage200_response.py +++ b/digiseg_api/models/list_audience_data_realtime_usage200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_measurement_clients200_response.py b/digiseg_api/models/list_measurement_clients200_response.py index 553febf..ca610d2 100644 --- a/digiseg_api/models/list_measurement_clients200_response.py +++ b/digiseg_api/models/list_measurement_clients200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_measurement_labels200_response.py b/digiseg_api/models/list_measurement_labels200_response.py index 454a831..aee609a 100644 --- a/digiseg_api/models/list_measurement_labels200_response.py +++ b/digiseg_api/models/list_measurement_labels200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_pagination_links.py b/digiseg_api/models/list_pagination_links.py index 7e65610..c2648bf 100644 --- a/digiseg_api/models/list_pagination_links.py +++ b/digiseg_api/models/list_pagination_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_pagination_meta.py b/digiseg_api/models/list_pagination_meta.py index 89b652a..4b34125 100644 --- a/digiseg_api/models/list_pagination_meta.py +++ b/digiseg_api/models/list_pagination_meta.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_pagination_meta_page.py b/digiseg_api/models/list_pagination_meta_page.py index 8bf52ea..6ceb8c2 100644 --- a/digiseg_api/models/list_pagination_meta_page.py +++ b/digiseg_api/models/list_pagination_meta_page.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_popuplations200_response.py b/digiseg_api/models/list_popuplations200_response.py index d95167f..f153c32 100644 --- a/digiseg_api/models/list_popuplations200_response.py +++ b/digiseg_api/models/list_popuplations200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_studies200_response.py b/digiseg_api/models/list_studies200_response.py index 8e87d3e..4166481 100644 --- a/digiseg_api/models/list_studies200_response.py +++ b/digiseg_api/models/list_studies200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/list_subscription_plans200_response.py b/digiseg_api/models/list_subscription_plans200_response.py new file mode 100644 index 0000000..77ef109 --- /dev/null +++ b/digiseg_api/models/list_subscription_plans200_response.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.list_pagination_links import ListPaginationLinks +from digiseg_api.models.list_pagination_meta import ListPaginationMeta +from digiseg_api.models.subscription_plan_item import SubscriptionPlanItem +from typing import Optional, Set +from typing_extensions import Self + +class ListSubscriptionPlans200Response(BaseModel): + """ + ListSubscriptionPlans200Response + """ # noqa: E501 + data: Optional[List[SubscriptionPlanItem]] = None + meta: Optional[ListPaginationMeta] = None + links: Optional[ListPaginationLinks] = None + __properties: ClassVar[List[str]] = ["data", "meta", "links"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListSubscriptionPlans200Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item in self.data: + if _item: + _items.append(_item.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of meta + if self.meta: + _dict['meta'] = self.meta.to_dict() + # override the default output from pydantic by calling `to_dict()` of links + if self.links: + _dict['links'] = self.links.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListSubscriptionPlans200Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [SubscriptionPlanItem.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "meta": ListPaginationMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None, + "links": ListPaginationLinks.from_dict(obj["links"]) if obj.get("links") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/list_users_by_account_id200_response.py b/digiseg_api/models/list_users_by_account_id200_response.py index d58abb3..ef4f325 100644 --- a/digiseg_api/models/list_users_by_account_id200_response.py +++ b/digiseg_api/models/list_users_by_account_id200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement.py b/digiseg_api/models/measurement.py index 1702e87..d5f3d39 100644 --- a/digiseg_api/models/measurement.py +++ b/digiseg_api/models/measurement.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated from typing import Optional, Set @@ -29,10 +29,11 @@ class Measurement(BaseModel): Represents a single measurement """ # noqa: E501 event: StrictStr = Field(description="The event that triggered the measurement, typically `impression` or `click`") + restricted: Optional[StrictBool] = Field(default=None, description="An indicator that will be `true` when the measurement is not delivered because the account is limited (typically due to subscription terms). ") count: Optional[StrictInt] = Field(default=None, description="The real value of the measurement, typically a counter value (integer)") fraction_of_total: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=None, description="The fraction of events that fall within this object compared to the total of the category or segment (usually represented by the measurement's parent's parent). For example, if the measurement is \"impression\" on the `home_type` \"Apartment\" object, then the `fraction_of_total` represents the number of impressions on apartments compared to impressions from other `home_type` values. ") conversion_rate: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=None, description="The rate of conversion to this measurement. Typically applies to measurements like \"click\" where it will represent the rate of impressions that turn into a click. ") - __properties: ClassVar[List[str]] = ["event", "count", "fraction_of_total", "conversion_rate"] + __properties: ClassVar[List[str]] = ["event", "restricted", "count", "fraction_of_total", "conversion_rate"] model_config = ConfigDict( populate_by_name=True, @@ -86,6 +87,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "event": obj.get("event"), + "restricted": obj.get("restricted"), "count": obj.get("count"), "fraction_of_total": obj.get("fraction_of_total"), "conversion_rate": obj.get("conversion_rate") diff --git a/digiseg_api/models/measurement_client_base.py b/digiseg_api/models/measurement_client_base.py index 89a156a..0f3b6a2 100644 --- a/digiseg_api/models/measurement_client_base.py +++ b/digiseg_api/models/measurement_client_base.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_client_full.py b/digiseg_api/models/measurement_client_full.py index 59f098a..0f13076 100644 --- a/digiseg_api/models/measurement_client_full.py +++ b/digiseg_api/models/measurement_client_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_client_item.py b/digiseg_api/models/measurement_client_item.py index 1dbbeb1..636902e 100644 --- a/digiseg_api/models/measurement_client_item.py +++ b/digiseg_api/models/measurement_client_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_client_mutation.py b/digiseg_api/models/measurement_client_mutation.py index 9f59ee9..201572c 100644 --- a/digiseg_api/models/measurement_client_mutation.py +++ b/digiseg_api/models/measurement_client_mutation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_event_link.py b/digiseg_api/models/measurement_event_link.py index 6143f90..08a8b60 100644 --- a/digiseg_api/models/measurement_event_link.py +++ b/digiseg_api/models/measurement_event_link.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_event_link_parameter_info.py b/digiseg_api/models/measurement_event_link_parameter_info.py index cba89fa..4faf46d 100644 --- a/digiseg_api/models/measurement_event_link_parameter_info.py +++ b/digiseg_api/models/measurement_event_link_parameter_info.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_event_links.py b/digiseg_api/models/measurement_event_links.py index d6ab34e..844d2e9 100644 --- a/digiseg_api/models/measurement_event_links.py +++ b/digiseg_api/models/measurement_event_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_event_set.py b/digiseg_api/models/measurement_event_set.py index ea2acde..14eef38 100644 --- a/digiseg_api/models/measurement_event_set.py +++ b/digiseg_api/models/measurement_event_set.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurement_integration_platform.py b/digiseg_api/models/measurement_integration_platform.py index 1b4ba19..b5a6b5e 100644 --- a/digiseg_api/models/measurement_integration_platform.py +++ b/digiseg_api/models/measurement_integration_platform.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/measurements_container.py b/digiseg_api/models/measurements_container.py index 9421cf4..5082e88 100644 --- a/digiseg_api/models/measurements_container.py +++ b/digiseg_api/models/measurements_container.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/passwordless_auth_request.py b/digiseg_api/models/passwordless_auth_request.py index 782dfad..ece3761 100644 --- a/digiseg_api/models/passwordless_auth_request.py +++ b/digiseg_api/models/passwordless_auth_request.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/permission_scopes.py b/digiseg_api/models/permission_scopes.py index 4558b05..2718c05 100644 --- a/digiseg_api/models/permission_scopes.py +++ b/digiseg_api/models/permission_scopes.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/plan_feature_set.py b/digiseg_api/models/plan_feature_set.py new file mode 100644 index 0000000..f6be424 --- /dev/null +++ b/digiseg_api/models/plan_feature_set.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List +from digiseg_api.models.limited_or_full_feature import LimitedOrFullFeature +from typing import Optional, Set +from typing_extensions import Self + +class PlanFeatureSet(BaseModel): + """ + PlanFeatureSet + """ # noqa: E501 + max_users: StrictInt + max_clients: StrictInt + max_active_studies: StrictInt + max_events_per_study: StrictInt + max_audience_lookups_per_month: StrictInt + study_audience_set: LimitedOrFullFeature + study_event_set: LimitedOrFullFeature + has_audience_recommendations: StrictBool + has_report_customization: StrictBool + has_report_sharing_clients: StrictBool + has_report_sharing_public: StrictBool + __properties: ClassVar[List[str]] = ["max_users", "max_clients", "max_active_studies", "max_events_per_study", "max_audience_lookups_per_month", "study_audience_set", "study_event_set", "has_audience_recommendations", "has_report_customization", "has_report_sharing_clients", "has_report_sharing_public"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanFeatureSet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanFeatureSet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "max_users": obj.get("max_users"), + "max_clients": obj.get("max_clients"), + "max_active_studies": obj.get("max_active_studies"), + "max_events_per_study": obj.get("max_events_per_study"), + "max_audience_lookups_per_month": obj.get("max_audience_lookups_per_month"), + "study_audience_set": obj.get("study_audience_set"), + "study_event_set": obj.get("study_event_set"), + "has_audience_recommendations": obj.get("has_audience_recommendations"), + "has_report_customization": obj.get("has_report_customization"), + "has_report_sharing_clients": obj.get("has_report_sharing_clients"), + "has_report_sharing_public": obj.get("has_report_sharing_public") + }) + return _obj + + diff --git a/digiseg_api/models/population_audience_category_set_business_section.py b/digiseg_api/models/population_audience_category_set_business_section.py index 69b0fd5..0b24147 100644 --- a/digiseg_api/models/population_audience_category_set_business_section.py +++ b/digiseg_api/models/population_audience_category_set_business_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_audience_category_set_private_section.py b/digiseg_api/models/population_audience_category_set_private_section.py index 2e8be6d..66f72af 100644 --- a/digiseg_api/models/population_audience_category_set_private_section.py +++ b/digiseg_api/models/population_audience_category_set_private_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_audience_category_set_section.py b/digiseg_api/models/population_audience_category_set_section.py index a3aa91c..9e8b68c 100644 --- a/digiseg_api/models/population_audience_category_set_section.py +++ b/digiseg_api/models/population_audience_category_set_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_full.py b/digiseg_api/models/population_full.py index 8507c7d..af49121 100644 --- a/digiseg_api/models/population_full.py +++ b/digiseg_api/models/population_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_item.py b/digiseg_api/models/population_item.py index 9ecbd82..87efac1 100644 --- a/digiseg_api/models/population_item.py +++ b/digiseg_api/models/population_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source.py b/digiseg_api/models/population_source.py index 4b5d8f3..2960e7a 100644 --- a/digiseg_api/models/population_source.py +++ b/digiseg_api/models/population_source.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_business_category_set.py b/digiseg_api/models/population_source_business_category_set.py index c9f808b..a6fced4 100644 --- a/digiseg_api/models/population_source_business_category_set.py +++ b/digiseg_api/models/population_source_business_category_set.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_business_category_set_size.py b/digiseg_api/models/population_source_business_category_set_size.py index b2d2745..6a8188e 100644 --- a/digiseg_api/models/population_source_business_category_set_size.py +++ b/digiseg_api/models/population_source_business_category_set_size.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_business_section.py b/digiseg_api/models/population_source_business_section.py index f559af6..826228b 100644 --- a/digiseg_api/models/population_source_business_section.py +++ b/digiseg_api/models/population_source_business_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_not_resolved_section.py b/digiseg_api/models/population_source_not_resolved_section.py index f5c52c2..2af61de 100644 --- a/digiseg_api/models/population_source_not_resolved_section.py +++ b/digiseg_api/models/population_source_not_resolved_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set.py b/digiseg_api/models/population_source_private_category_set.py index 1c2b4a3..7fefae8 100644 --- a/digiseg_api/models/population_source_private_category_set.py +++ b/digiseg_api/models/population_source_private_category_set.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_building_age.py b/digiseg_api/models/population_source_private_category_set_building_age.py index 69936e6..595c41e 100644 --- a/digiseg_api/models/population_source_private_category_set_building_age.py +++ b/digiseg_api/models/population_source_private_category_set_building_age.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_cars.py b/digiseg_api/models/population_source_private_category_set_cars.py index 4185696..3b692b3 100644 --- a/digiseg_api/models/population_source_private_category_set_cars.py +++ b/digiseg_api/models/population_source_private_category_set_cars.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_children.py b/digiseg_api/models/population_source_private_category_set_children.py index e9f39c6..1154bc6 100644 --- a/digiseg_api/models/population_source_private_category_set_children.py +++ b/digiseg_api/models/population_source_private_category_set_children.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_education.py b/digiseg_api/models/population_source_private_category_set_education.py index ac6cf2a..fa7eb1d 100644 --- a/digiseg_api/models/population_source_private_category_set_education.py +++ b/digiseg_api/models/population_source_private_category_set_education.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_home_ownership.py b/digiseg_api/models/population_source_private_category_set_home_ownership.py index e96d3a6..06bf998 100644 --- a/digiseg_api/models/population_source_private_category_set_home_ownership.py +++ b/digiseg_api/models/population_source_private_category_set_home_ownership.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_home_type.py b/digiseg_api/models/population_source_private_category_set_home_type.py index ecb008f..b244b94 100644 --- a/digiseg_api/models/population_source_private_category_set_home_type.py +++ b/digiseg_api/models/population_source_private_category_set_home_type.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_income.py b/digiseg_api/models/population_source_private_category_set_income.py index 89d780c..023c040 100644 --- a/digiseg_api/models/population_source_private_category_set_income.py +++ b/digiseg_api/models/population_source_private_category_set_income.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_lifecycle.py b/digiseg_api/models/population_source_private_category_set_lifecycle.py index e2c9519..e2f2f12 100644 --- a/digiseg_api/models/population_source_private_category_set_lifecycle.py +++ b/digiseg_api/models/population_source_private_category_set_lifecycle.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_living_space.py b/digiseg_api/models/population_source_private_category_set_living_space.py index bae851e..3142cb8 100644 --- a/digiseg_api/models/population_source_private_category_set_living_space.py +++ b/digiseg_api/models/population_source_private_category_set_living_space.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_neighbourhood_type.py b/digiseg_api/models/population_source_private_category_set_neighbourhood_type.py index 0f15095..4901d72 100644 --- a/digiseg_api/models/population_source_private_category_set_neighbourhood_type.py +++ b/digiseg_api/models/population_source_private_category_set_neighbourhood_type.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_savings.py b/digiseg_api/models/population_source_private_category_set_savings.py index d2ddddb..f1e2581 100644 --- a/digiseg_api/models/population_source_private_category_set_savings.py +++ b/digiseg_api/models/population_source_private_category_set_savings.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_category_set_tech_level.py b/digiseg_api/models/population_source_private_category_set_tech_level.py index 4cde35c..ecbfe86 100644 --- a/digiseg_api/models/population_source_private_category_set_tech_level.py +++ b/digiseg_api/models/population_source_private_category_set_tech_level.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/population_source_private_section.py b/digiseg_api/models/population_source_private_section.py index bc31ff9..1f42252 100644 --- a/digiseg_api/models/population_source_private_section.py +++ b/digiseg_api/models/population_source_private_section.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/postal_address.py b/digiseg_api/models/postal_address.py index 203db22..40610a6 100644 --- a/digiseg_api/models/postal_address.py +++ b/digiseg_api/models/postal_address.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/private_audience_stats.py b/digiseg_api/models/private_audience_stats.py index 2dc803f..040bf46 100644 --- a/digiseg_api/models/private_audience_stats.py +++ b/digiseg_api/models/private_audience_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/private_audience_stats_audience_categories.py b/digiseg_api/models/private_audience_stats_audience_categories.py index 822552f..944c403 100644 --- a/digiseg_api/models/private_audience_stats_audience_categories.py +++ b/digiseg_api/models/private_audience_stats_audience_categories.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/query_study_audience_stats200_response.py b/digiseg_api/models/query_study_audience_stats200_response.py index 5aeaacf..a11a389 100644 --- a/digiseg_api/models/query_study_audience_stats200_response.py +++ b/digiseg_api/models/query_study_audience_stats200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/query_study_country_stats200_response.py b/digiseg_api/models/query_study_country_stats200_response.py index 8a408b8..a16a032 100644 --- a/digiseg_api/models/query_study_country_stats200_response.py +++ b/digiseg_api/models/query_study_country_stats200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/query_study_frequency_stats200_response.py b/digiseg_api/models/query_study_frequency_stats200_response.py index cd91802..52921e6 100644 --- a/digiseg_api/models/query_study_frequency_stats200_response.py +++ b/digiseg_api/models/query_study_frequency_stats200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/query_study_timing_stats200_response.py b/digiseg_api/models/query_study_timing_stats200_response.py index a203216..a92500e 100644 --- a/digiseg_api/models/query_study_timing_stats200_response.py +++ b/digiseg_api/models/query_study_timing_stats200_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/registration_by_id_response_data.py b/digiseg_api/models/registration_by_id_response_data.py index 89f50f7..ebc1cfc 100644 --- a/digiseg_api/models/registration_by_id_response_data.py +++ b/digiseg_api/models/registration_by_id_response_data.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/registration_creation_response_data.py b/digiseg_api/models/registration_creation_response_data.py index 5b26546..27e191e 100644 --- a/digiseg_api/models/registration_creation_response_data.py +++ b/digiseg_api/models/registration_creation_response_data.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/registration_request.py b/digiseg_api/models/registration_request.py index f57fdf9..f3c1eac 100644 --- a/digiseg_api/models/registration_request.py +++ b/digiseg_api/models/registration_request.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/registration_verification_response_data.py b/digiseg_api/models/registration_verification_response_data.py index 1ab0a50..ee3e43f 100644 --- a/digiseg_api/models/registration_verification_response_data.py +++ b/digiseg_api/models/registration_verification_response_data.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/registration_verification_response_links.py b/digiseg_api/models/registration_verification_response_links.py index e87496d..21c223a 100644 --- a/digiseg_api/models/registration_verification_response_links.py +++ b/digiseg_api/models/registration_verification_response_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/resolve_audiences_of_multiple_request.py b/digiseg_api/models/resolve_audiences_of_multiple_request.py index 5ea1365..a6c0f11 100644 --- a/digiseg_api/models/resolve_audiences_of_multiple_request.py +++ b/digiseg_api/models/resolve_audiences_of_multiple_request.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/resolve_audiences_of_multiple_request_item.py b/digiseg_api/models/resolve_audiences_of_multiple_request_item.py index dd53e00..11d99d5 100644 --- a/digiseg_api/models/resolve_audiences_of_multiple_request_item.py +++ b/digiseg_api/models/resolve_audiences_of_multiple_request_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/resolve_audiences_of_multiple_response.py b/digiseg_api/models/resolve_audiences_of_multiple_response.py index b2618b7..ad587ac 100644 --- a/digiseg_api/models/resolve_audiences_of_multiple_response.py +++ b/digiseg_api/models/resolve_audiences_of_multiple_response.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/resolve_audiences_of_multiple_response_item.py b/digiseg_api/models/resolve_audiences_of_multiple_response_item.py index 3b2a197..58ef18a 100644 --- a/digiseg_api/models/resolve_audiences_of_multiple_response_item.py +++ b/digiseg_api/models/resolve_audiences_of_multiple_response_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/stripe_account_subscription_checkout_session.py b/digiseg_api/models/stripe_account_subscription_checkout_session.py new file mode 100644 index 0000000..f5d4ab5 --- /dev/null +++ b/digiseg_api/models/stripe_account_subscription_checkout_session.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class StripeAccountSubscriptionCheckoutSession(BaseModel): + """ + StripeAccountSubscriptionCheckoutSession + """ # noqa: E501 + session_id: Optional[StrictStr] = None + redirect_url: Optional[StrictStr] = Field(default=None, description="The URL to take the user to, to set up payment") + __properties: ClassVar[List[str]] = ["session_id", "redirect_url"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StripeAccountSubscriptionCheckoutSession from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StripeAccountSubscriptionCheckoutSession from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "session_id": obj.get("session_id"), + "redirect_url": obj.get("redirect_url") + }) + return _obj + + diff --git a/digiseg_api/models/stripe_account_subscription_purchase_creation.py b/digiseg_api/models/stripe_account_subscription_purchase_creation.py new file mode 100644 index 0000000..3a819cd --- /dev/null +++ b/digiseg_api/models/stripe_account_subscription_purchase_creation.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StripeAccountSubscriptionPurchaseCreation(BaseModel): + """ + StripeAccountSubscriptionPurchaseCreation + """ # noqa: E501 + plan_id: StrictStr = Field(description="The ID of the plan to subscribe to") + __properties: ClassVar[List[str]] = ["plan_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StripeAccountSubscriptionPurchaseCreation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StripeAccountSubscriptionPurchaseCreation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "plan_id": obj.get("plan_id") + }) + return _obj + + diff --git a/digiseg_api/models/study_audience_stats.py b/digiseg_api/models/study_audience_stats.py index 319867b..a64f2a7 100644 --- a/digiseg_api/models/study_audience_stats.py +++ b/digiseg_api/models/study_audience_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_aux.py b/digiseg_api/models/study_aux.py index 67aa6bc..6ef1f3b 100644 --- a/digiseg_api/models/study_aux.py +++ b/digiseg_api/models/study_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.measurement_event_links import MeasurementEventLinks from digiseg_api.models.measurement_integration_platform import MeasurementIntegrationPlatform @@ -30,10 +30,11 @@ class StudyAux(BaseModel): StudyAux """ # noqa: E501 event_links: Optional[MeasurementEventLinks] = None + event_cap: Optional[StrictInt] = Field(default=None, description="If present, an upper limit on the number of events that will be processed in this study.") banner_image_url: Optional[StrictStr] = Field(default=None, description="The URL to a banner image for the study. Note that the banner image is used only for Digiseg study reporting and presentation, it does NOT represent any delivered banner ad creatives or similar. ") integration_platform: Optional[MeasurementIntegrationPlatform] = None is_example: Optional[StrictBool] = Field(default=None, description="Determines if the study is an example study, used to demonstrate product capabilities") - __properties: ClassVar[List[str]] = ["event_links", "banner_image_url", "integration_platform", "is_example"] + __properties: ClassVar[List[str]] = ["event_links", "event_cap", "banner_image_url", "integration_platform", "is_example"] model_config = ConfigDict( populate_by_name=True, @@ -97,6 +98,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "event_links": MeasurementEventLinks.from_dict(obj["event_links"]) if obj.get("event_links") is not None else None, + "event_cap": obj.get("event_cap"), "banner_image_url": obj.get("banner_image_url"), "integration_platform": MeasurementIntegrationPlatform.from_dict(obj["integration_platform"]) if obj.get("integration_platform") is not None else None, "is_example": obj.get("is_example") diff --git a/digiseg_api/models/study_base.py b/digiseg_api/models/study_base.py index 9820ceb..c64ea0d 100644 --- a/digiseg_api/models/study_base.py +++ b/digiseg_api/models/study_base.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -36,11 +36,12 @@ class StudyBase(BaseModel): labels: Optional[List[StrictStr]] = Field(default=None, description="A set of labels that users can use to categorize their measurements. Can be used to indicate type of study, customer names or other traits. ") account_id: Optional[StrictStr] = Field(default=None, description="The ID of the account that owns this study") start_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will start") + end_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will end") life_cycle_stage: Optional[StudyLifecycleStage] = None ingestion_status: Optional[StudyIngestionStatus] = None summary_stats: Optional[StudySummaryStats] = None client: Optional[MeasurementClientItem] = None - __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client"] + __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "end_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client"] model_config = ConfigDict( populate_by_name=True, @@ -73,11 +74,9 @@ def to_dict(self) -> Dict[str, Any]: were set at model initialization. Other fields with value `None` are ignored. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "account_id", - "start_date", ]) _dict = self.model_dump( @@ -107,6 +106,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "labels": obj.get("labels"), "account_id": obj.get("account_id"), "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), "life_cycle_stage": obj.get("life_cycle_stage"), "ingestion_status": obj.get("ingestion_status"), "summary_stats": StudySummaryStats.from_dict(obj["summary_stats"]) if obj.get("summary_stats") is not None else None, diff --git a/digiseg_api/models/study_country_stats.py b/digiseg_api/models/study_country_stats.py index 83a6dc1..9cee94c 100644 --- a/digiseg_api/models/study_country_stats.py +++ b/digiseg_api/models/study_country_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_creation.py b/digiseg_api/models/study_creation.py index 2f4fe96..b33c459 100644 --- a/digiseg_api/models/study_creation.py +++ b/digiseg_api/models/study_creation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -19,7 +19,7 @@ import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.measurement_client_item import MeasurementClientItem from digiseg_api.models.measurement_event_links import MeasurementEventLinks @@ -39,17 +39,19 @@ class StudyCreation(BaseModel): labels: Optional[List[StrictStr]] = Field(default=None, description="A set of labels that users can use to categorize their measurements. Can be used to indicate type of study, customer names or other traits. ") account_id: Optional[StrictStr] = Field(default=None, description="The ID of the account that owns this study") start_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will start") + end_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will end") life_cycle_stage: Optional[StudyLifecycleStage] = None ingestion_status: Optional[StudyIngestionStatus] = None summary_stats: Optional[StudySummaryStats] = None client: Optional[MeasurementClientItem] = None event_links: Optional[MeasurementEventLinks] = None + event_cap: Optional[StrictInt] = Field(default=None, description="If present, an upper limit on the number of events that will be processed in this study.") banner_image_url: Optional[StrictStr] = Field(default=None, description="The URL to a banner image for the study. Note that the banner image is used only for Digiseg study reporting and presentation, it does NOT represent any delivered banner ad creatives or similar. ") integration_platform: Optional[MeasurementIntegrationPlatform] = None is_example: Optional[StrictBool] = Field(default=None, description="Determines if the study is an example study, used to demonstrate product capabilities") event_set: MeasurementEventSet client_id: Optional[StrictStr] = Field(default=None, description="The ID of the measurement client that this study is for") - __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "banner_image_url", "integration_platform", "is_example", "event_set", "client_id"] + __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "end_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "event_cap", "banner_image_url", "integration_platform", "is_example", "event_set", "client_id"] model_config = ConfigDict( populate_by_name=True, @@ -84,11 +86,9 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "account_id", - "start_date", "banner_image_url", "is_example", ]) @@ -126,11 +126,13 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "labels": obj.get("labels"), "account_id": obj.get("account_id"), "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), "life_cycle_stage": obj.get("life_cycle_stage"), "ingestion_status": obj.get("ingestion_status"), "summary_stats": StudySummaryStats.from_dict(obj["summary_stats"]) if obj.get("summary_stats") is not None else None, "client": MeasurementClientItem.from_dict(obj["client"]) if obj.get("client") is not None else None, "event_links": MeasurementEventLinks.from_dict(obj["event_links"]) if obj.get("event_links") is not None else None, + "event_cap": obj.get("event_cap"), "banner_image_url": obj.get("banner_image_url"), "integration_platform": MeasurementIntegrationPlatform.from_dict(obj["integration_platform"]) if obj.get("integration_platform") is not None else None, "is_example": obj.get("is_example"), diff --git a/digiseg_api/models/study_creation_data.py b/digiseg_api/models/study_creation_data.py index 66a173a..28c1309 100644 --- a/digiseg_api/models/study_creation_data.py +++ b/digiseg_api/models/study_creation_data.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_frequency_stats.py b/digiseg_api/models/study_frequency_stats.py index 45f01e2..180b971 100644 --- a/digiseg_api/models/study_frequency_stats.py +++ b/digiseg_api/models/study_frequency_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_full.py b/digiseg_api/models/study_full.py index afec1b0..0bdc875 100644 --- a/digiseg_api/models/study_full.py +++ b/digiseg_api/models/study_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -19,7 +19,7 @@ import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.measurement_client_item import MeasurementClientItem from digiseg_api.models.measurement_event_links import MeasurementEventLinks @@ -39,11 +39,13 @@ class StudyFull(BaseModel): labels: Optional[List[StrictStr]] = Field(default=None, description="A set of labels that users can use to categorize their measurements. Can be used to indicate type of study, customer names or other traits. ") account_id: Optional[StrictStr] = Field(default=None, description="The ID of the account that owns this study") start_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will start") + end_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will end") life_cycle_stage: Optional[StudyLifecycleStage] = None ingestion_status: Optional[StudyIngestionStatus] = None summary_stats: Optional[StudySummaryStats] = None client: Optional[MeasurementClientItem] = None event_links: Optional[MeasurementEventLinks] = None + event_cap: Optional[StrictInt] = Field(default=None, description="If present, an upper limit on the number of events that will be processed in this study.") banner_image_url: Optional[StrictStr] = Field(default=None, description="The URL to a banner image for the study. Note that the banner image is used only for Digiseg study reporting and presentation, it does NOT represent any delivered banner ad creatives or similar. ") integration_platform: Optional[MeasurementIntegrationPlatform] = None is_example: Optional[StrictBool] = Field(default=None, description="Determines if the study is an example study, used to demonstrate product capabilities") @@ -51,7 +53,7 @@ class StudyFull(BaseModel): created_by: StrictStr = Field(description="ID of the user who created the object") updated_at: Optional[datetime] = Field(default=None, description="Date and time of the latest update to the object") updated_by: Optional[StrictStr] = Field(default=None, description="ID of the user who last updated the object") - __properties: ClassVar[List[str]] = ["id", "name", "labels", "account_id", "start_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "banner_image_url", "integration_platform", "is_example", "created_at", "created_by", "updated_at", "updated_by"] + __properties: ClassVar[List[str]] = ["id", "name", "labels", "account_id", "start_date", "end_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "event_cap", "banner_image_url", "integration_platform", "is_example", "created_at", "created_by", "updated_at", "updated_by"] model_config = ConfigDict( populate_by_name=True, @@ -86,11 +88,9 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "account_id", - "start_date", "banner_image_url", "is_example", ]) @@ -129,11 +129,13 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "labels": obj.get("labels"), "account_id": obj.get("account_id"), "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), "life_cycle_stage": obj.get("life_cycle_stage"), "ingestion_status": obj.get("ingestion_status"), "summary_stats": StudySummaryStats.from_dict(obj["summary_stats"]) if obj.get("summary_stats") is not None else None, "client": MeasurementClientItem.from_dict(obj["client"]) if obj.get("client") is not None else None, "event_links": MeasurementEventLinks.from_dict(obj["event_links"]) if obj.get("event_links") is not None else None, + "event_cap": obj.get("event_cap"), "banner_image_url": obj.get("banner_image_url"), "integration_platform": MeasurementIntegrationPlatform.from_dict(obj["integration_platform"]) if obj.get("integration_platform") is not None else None, "is_example": obj.get("is_example"), diff --git a/digiseg_api/models/study_ingestion_status.py b/digiseg_api/models/study_ingestion_status.py index 6b965de..34b794a 100644 --- a/digiseg_api/models/study_ingestion_status.py +++ b/digiseg_api/models/study_ingestion_status.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -21,7 +21,7 @@ class StudyIngestionStatus(str, Enum): """ - The status of the data collection of the study, indicating whether stats are available and representative. * `no_data` means that the study has been created but no data has been received. * `active_ramping_up` means that data has been received, but not enough to provide meaningful stats yet. * `active_fulfilled` means that the study has received a good amount of data, but more data can still be added. * `finished_complete` means that the study has finished and is no longer open to receive data. * `finished_expired` means that the study has finished but not enough data was collected to provide meaningful stats. + The status of the data collection of the study, indicating whether stats are available and representative. * `no_data` means that the study has been created but no data has been received. * `active_ramping_up` means that data has been received, but not enough to provide meaningful stats yet. * `active_fulfilled` means that the study has received a good amount of data, but more data can still be added. * `paused_limited` means that the study was paused because of exceeded limits (typically when `event_cap` is exceeded) * `finished_complete` means that the study has finished and is no longer open to receive data. * `finished_expired` means that the study has finished but not enough data was collected to provide meaningful stats. """ """ @@ -30,6 +30,7 @@ class StudyIngestionStatus(str, Enum): NO_DATA = 'no_data' ACTIVE_RAMPING_UP = 'active_ramping_up' ACTIVE_FULFILLED = 'active_fulfilled' + PAUSED_LIMITED = 'paused_limited' FINISHED_COMPLETE = 'finished_complete' FINISHED_EXPIRED = 'finished_expired' diff --git a/digiseg_api/models/study_item.py b/digiseg_api/models/study_item.py index 6aec894..bb14345 100644 --- a/digiseg_api/models/study_item.py +++ b/digiseg_api/models/study_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -37,11 +37,12 @@ class StudyItem(BaseModel): labels: Optional[List[StrictStr]] = Field(default=None, description="A set of labels that users can use to categorize their measurements. Can be used to indicate type of study, customer names or other traits. ") account_id: Optional[StrictStr] = Field(default=None, description="The ID of the account that owns this study") start_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will start") + end_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will end") life_cycle_stage: Optional[StudyLifecycleStage] = None ingestion_status: Optional[StudyIngestionStatus] = None summary_stats: Optional[StudySummaryStats] = None client: Optional[MeasurementClientItem] = None - __properties: ClassVar[List[str]] = ["id", "name", "labels", "account_id", "start_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client"] + __properties: ClassVar[List[str]] = ["id", "name", "labels", "account_id", "start_date", "end_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client"] model_config = ConfigDict( populate_by_name=True, @@ -74,11 +75,9 @@ def to_dict(self) -> Dict[str, Any]: were set at model initialization. Other fields with value `None` are ignored. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "account_id", - "start_date", ]) _dict = self.model_dump( @@ -109,6 +108,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "labels": obj.get("labels"), "account_id": obj.get("account_id"), "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), "life_cycle_stage": obj.get("life_cycle_stage"), "ingestion_status": obj.get("ingestion_status"), "summary_stats": StudySummaryStats.from_dict(obj["summary_stats"]) if obj.get("summary_stats") is not None else None, diff --git a/digiseg_api/models/study_lifecycle_stage.py b/digiseg_api/models/study_lifecycle_stage.py index bc1e5b2..84d8693 100644 --- a/digiseg_api/models/study_lifecycle_stage.py +++ b/digiseg_api/models/study_lifecycle_stage.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_links.py b/digiseg_api/models/study_links.py index f913f4b..7a10829 100644 --- a/digiseg_api/models/study_links.py +++ b/digiseg_api/models/study_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_meta.py b/digiseg_api/models/study_meta.py index a39a256..cb38e58 100644 --- a/digiseg_api/models/study_meta.py +++ b/digiseg_api/models/study_meta.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_mutation.py b/digiseg_api/models/study_mutation.py index ca6c1de..7b0d344 100644 --- a/digiseg_api/models/study_mutation.py +++ b/digiseg_api/models/study_mutation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -19,7 +19,7 @@ import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from digiseg_api.models.measurement_client_item import MeasurementClientItem from digiseg_api.models.measurement_event_links import MeasurementEventLinks @@ -38,15 +38,17 @@ class StudyMutation(BaseModel): labels: Optional[List[StrictStr]] = Field(default=None, description="A set of labels that users can use to categorize their measurements. Can be used to indicate type of study, customer names or other traits. ") account_id: Optional[StrictStr] = Field(default=None, description="The ID of the account that owns this study") start_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will start") + end_date: Optional[datetime] = Field(default=None, description="The date for which the study and its data ingestion will end") life_cycle_stage: Optional[StudyLifecycleStage] = None ingestion_status: Optional[StudyIngestionStatus] = None summary_stats: Optional[StudySummaryStats] = None client: Optional[MeasurementClientItem] = None event_links: Optional[MeasurementEventLinks] = None + event_cap: Optional[StrictInt] = Field(default=None, description="If present, an upper limit on the number of events that will be processed in this study.") banner_image_url: Optional[StrictStr] = Field(default=None, description="The URL to a banner image for the study. Note that the banner image is used only for Digiseg study reporting and presentation, it does NOT represent any delivered banner ad creatives or similar. ") integration_platform: Optional[MeasurementIntegrationPlatform] = None is_example: Optional[StrictBool] = Field(default=None, description="Determines if the study is an example study, used to demonstrate product capabilities") - __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "banner_image_url", "integration_platform", "is_example"] + __properties: ClassVar[List[str]] = ["name", "labels", "account_id", "start_date", "end_date", "life_cycle_stage", "ingestion_status", "summary_stats", "client", "event_links", "event_cap", "banner_image_url", "integration_platform", "is_example"] model_config = ConfigDict( populate_by_name=True, @@ -81,11 +83,9 @@ def to_dict(self) -> Dict[str, Any]: * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "account_id", - "start_date", "banner_image_url", "is_example", ]) @@ -123,11 +123,13 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "labels": obj.get("labels"), "account_id": obj.get("account_id"), "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), "life_cycle_stage": obj.get("life_cycle_stage"), "ingestion_status": obj.get("ingestion_status"), "summary_stats": StudySummaryStats.from_dict(obj["summary_stats"]) if obj.get("summary_stats") is not None else None, "client": MeasurementClientItem.from_dict(obj["client"]) if obj.get("client") is not None else None, "event_links": MeasurementEventLinks.from_dict(obj["event_links"]) if obj.get("event_links") is not None else None, + "event_cap": obj.get("event_cap"), "banner_image_url": obj.get("banner_image_url"), "integration_platform": MeasurementIntegrationPlatform.from_dict(obj["integration_platform"]) if obj.get("integration_platform") is not None else None, "is_example": obj.get("is_example") diff --git a/digiseg_api/models/study_permissions.py b/digiseg_api/models/study_permissions.py index 559cc2f..7190cce 100644 --- a/digiseg_api/models/study_permissions.py +++ b/digiseg_api/models/study_permissions.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_summary_stats.py b/digiseg_api/models/study_summary_stats.py index 946a75a..cf314f9 100644 --- a/digiseg_api/models/study_summary_stats.py +++ b/digiseg_api/models/study_summary_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/study_timing_stats.py b/digiseg_api/models/study_timing_stats.py index 8618167..5ade8dc 100644 --- a/digiseg_api/models/study_timing_stats.py +++ b/digiseg_api/models/study_timing_stats.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/subscription_plan_aux.py b/digiseg_api/models/subscription_plan_aux.py new file mode 100644 index 0000000..601fe09 --- /dev/null +++ b/digiseg_api/models/subscription_plan_aux.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.plan_feature_set import PlanFeatureSet +from typing import Optional, Set +from typing_extensions import Self + +class SubscriptionPlanAux(BaseModel): + """ + Defines a subscription plan (a feature set at a given pricing configuration) + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The ID of the plan/price that the account is subscribed to") + feature_set: PlanFeatureSet + __properties: ClassVar[List[str]] = ["id", "feature_set"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubscriptionPlanAux from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubscriptionPlanAux from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/subscription_plan_base.py b/digiseg_api/models/subscription_plan_base.py new file mode 100644 index 0000000..9d48c32 --- /dev/null +++ b/digiseg_api/models/subscription_plan_base.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.subscription_price import SubscriptionPrice +from digiseg_api.models.subscription_product_type import SubscriptionProductType +from typing import Optional, Set +from typing_extensions import Self + +class SubscriptionPlanBase(BaseModel): + """ + SubscriptionPlanBase + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the price/plan") + code: Optional[StrictStr] = Field(default=None, description="An optional code, typically provided if the plan/price is public and advertised") + is_public: StrictBool = Field(description="Is the plan/price a public price or custom?") + product_type: SubscriptionProductType + list_price: Optional[SubscriptionPrice] = None + stripe_product_id: Optional[StrictStr] = None + stripe_price_id: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["display_name", "code", "is_public", "product_type", "list_price", "stripe_product_id", "stripe_price_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubscriptionPlanBase from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "stripe_product_id", + "stripe_price_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of list_price + if self.list_price: + _dict['list_price'] = self.list_price.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubscriptionPlanBase from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "display_name": obj.get("display_name"), + "code": obj.get("code"), + "is_public": obj.get("is_public"), + "product_type": obj.get("product_type"), + "list_price": SubscriptionPrice.from_dict(obj["list_price"]) if obj.get("list_price") is not None else None, + "stripe_product_id": obj.get("stripe_product_id"), + "stripe_price_id": obj.get("stripe_price_id") + }) + return _obj + + diff --git a/digiseg_api/models/subscription_plan_full.py b/digiseg_api/models/subscription_plan_full.py new file mode 100644 index 0000000..40051a9 --- /dev/null +++ b/digiseg_api/models/subscription_plan_full.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.plan_feature_set import PlanFeatureSet +from digiseg_api.models.subscription_price import SubscriptionPrice +from digiseg_api.models.subscription_product_type import SubscriptionProductType +from typing import Optional, Set +from typing_extensions import Self + +class SubscriptionPlanFull(BaseModel): + """ + SubscriptionPlanFull + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The ID of the plan/price that the account is subscribed to") + created_at: Optional[datetime] = Field(default=None, description="Date and time of the object creation") + created_by: Optional[StrictStr] = Field(default=None, description="ID of the user who created the object") + updated_at: Optional[datetime] = Field(default=None, description="Date and time of the latest update to the object") + updated_by: Optional[StrictStr] = Field(default=None, description="ID of the user who last updated the object") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the price/plan") + code: Optional[StrictStr] = Field(default=None, description="An optional code, typically provided if the plan/price is public and advertised") + is_public: StrictBool = Field(description="Is the plan/price a public price or custom?") + product_type: SubscriptionProductType + list_price: Optional[SubscriptionPrice] = None + stripe_product_id: Optional[StrictStr] = None + stripe_price_id: Optional[StrictStr] = None + feature_set: PlanFeatureSet + __properties: ClassVar[List[str]] = ["id", "created_at", "created_by", "updated_at", "updated_by", "display_name", "code", "is_public", "product_type", "list_price", "stripe_product_id", "stripe_price_id", "feature_set"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubscriptionPlanFull from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "created_at", + "created_by", + "updated_at", + "updated_by", + "stripe_product_id", + "stripe_price_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of list_price + if self.list_price: + _dict['list_price'] = self.list_price.to_dict() + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubscriptionPlanFull from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "created_at": obj.get("created_at"), + "created_by": obj.get("created_by"), + "updated_at": obj.get("updated_at"), + "updated_by": obj.get("updated_by"), + "display_name": obj.get("display_name"), + "code": obj.get("code"), + "is_public": obj.get("is_public"), + "product_type": obj.get("product_type"), + "list_price": SubscriptionPrice.from_dict(obj["list_price"]) if obj.get("list_price") is not None else None, + "stripe_product_id": obj.get("stripe_product_id"), + "stripe_price_id": obj.get("stripe_price_id"), + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/subscription_plan_item.py b/digiseg_api/models/subscription_plan_item.py new file mode 100644 index 0000000..648031d --- /dev/null +++ b/digiseg_api/models/subscription_plan_item.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.subscription_price import SubscriptionPrice +from digiseg_api.models.subscription_product_type import SubscriptionProductType +from typing import Optional, Set +from typing_extensions import Self + +class SubscriptionPlanItem(BaseModel): + """ + SubscriptionPlanItem + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="Unique ID for the object") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the price/plan") + code: Optional[StrictStr] = Field(default=None, description="An optional code, typically provided if the plan/price is public and advertised") + is_public: StrictBool = Field(description="Is the plan/price a public price or custom?") + product_type: SubscriptionProductType + list_price: Optional[SubscriptionPrice] = None + stripe_product_id: Optional[StrictStr] = None + stripe_price_id: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "display_name", "code", "is_public", "product_type", "list_price", "stripe_product_id", "stripe_price_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubscriptionPlanItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "stripe_product_id", + "stripe_price_id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of list_price + if self.list_price: + _dict['list_price'] = self.list_price.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubscriptionPlanItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "display_name": obj.get("display_name"), + "code": obj.get("code"), + "is_public": obj.get("is_public"), + "product_type": obj.get("product_type"), + "list_price": SubscriptionPrice.from_dict(obj["list_price"]) if obj.get("list_price") is not None else None, + "stripe_product_id": obj.get("stripe_product_id"), + "stripe_price_id": obj.get("stripe_price_id") + }) + return _obj + + diff --git a/digiseg_api/models/subscription_price.py b/digiseg_api/models/subscription_price.py new file mode 100644 index 0000000..f8a622e --- /dev/null +++ b/digiseg_api/models/subscription_price.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from digiseg_api.models.subscription_price_currency import SubscriptionPriceCurrency +from digiseg_api.models.subscription_price_interval import SubscriptionPriceInterval +from typing import Optional, Set +from typing_extensions import Self + +class SubscriptionPrice(BaseModel): + """ + SubscriptionPrice + """ # noqa: E501 + amount: Annotated[int, Field(strict=True, ge=0)] + currency: SubscriptionPriceCurrency + interval: SubscriptionPriceInterval + __properties: ClassVar[List[str]] = ["amount", "currency", "interval"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubscriptionPrice from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubscriptionPrice from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "amount": obj.get("amount"), + "currency": obj.get("currency"), + "interval": obj.get("interval") + }) + return _obj + + diff --git a/digiseg_api/models/subscription_price_currency.py b/digiseg_api/models/subscription_price_currency.py new file mode 100644 index 0000000..bf29986 --- /dev/null +++ b/digiseg_api/models/subscription_price_currency.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class SubscriptionPriceCurrency(str, Enum): + """ + Currency code for the price + """ + + """ + allowed enum values + """ + EUR = 'EUR' + USD = 'USD' + DKK = 'DKK' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of SubscriptionPriceCurrency from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/subscription_price_interval.py b/digiseg_api/models/subscription_price_interval.py new file mode 100644 index 0000000..ed4ea18 --- /dev/null +++ b/digiseg_api/models/subscription_price_interval.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class SubscriptionPriceInterval(str, Enum): + """ + SubscriptionPriceInterval + """ + + """ + allowed enum values + """ + DAILY = 'daily' + WEEKLY = 'weekly' + MONTHLY = 'monthly' + ANNUALLY = 'annually' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of SubscriptionPriceInterval from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/subscription_product_type.py b/digiseg_api/models/subscription_product_type.py new file mode 100644 index 0000000..9af10bb --- /dev/null +++ b/digiseg_api/models/subscription_product_type.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class SubscriptionProductType(str, Enum): + """ + SubscriptionProductType + """ + + """ + allowed enum values + """ + BASE = 'base' + ADD_MINUS_ON = 'add-on' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of SubscriptionProductType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/tax_id.py b/digiseg_api/models/tax_id.py new file mode 100644 index 0000000..8d553b6 --- /dev/null +++ b/digiseg_api/models/tax_id.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class TaxId(BaseModel): + """ + Represents a Tax ID used for account billing + """ # noqa: E501 + value: StrictStr = Field(description="The Tax ID number / code") + type: StrictStr = Field(description="The type of Tax ID") + __properties: ClassVar[List[str]] = ["value", "type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TaxId from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TaxId from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": obj.get("value"), + "type": obj.get("type") + }) + return _obj + + diff --git a/digiseg_api/models/timestamped_object.py b/digiseg_api/models/timestamped_object.py index 4b69bf0..a41937f 100644 --- a/digiseg_api/models/timestamped_object.py +++ b/digiseg_api/models/timestamped_object.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -64,8 +64,16 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "created_at", + "created_by", + "updated_at", + "updated_by", ]) _dict = self.model_dump( diff --git a/digiseg_api/models/timestamped_object1.py b/digiseg_api/models/timestamped_object1.py index 26f91e5..e8c42a2 100644 --- a/digiseg_api/models/timestamped_object1.py +++ b/digiseg_api/models/timestamped_object1.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_account_membership.py b/digiseg_api/models/user_account_membership.py index 9bc19dc..402fe4d 100644 --- a/digiseg_api/models/user_account_membership.py +++ b/digiseg_api/models/user_account_membership.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -20,18 +20,24 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_full import AccountFull +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.plan_feature_set import PlanFeatureSet from digiseg_api.models.user_account_role import UserAccountRole from typing import Optional, Set from typing_extensions import Self class UserAccountMembership(BaseModel): """ - Describes a user's membership of an account + UserAccountMembership """ # noqa: E501 account_id: StrictStr = Field(description="The ID of the account") account_name: Optional[StrictStr] = Field(default=None, description="The name of the account") roles: List[UserAccountRole] = Field(description="The roles that the user has within the account") - __properties: ClassVar[List[str]] = ["account_id", "account_name", "roles"] + account: Optional[AccountFull] = None + feature_set: Optional[PlanFeatureSet] = None + subscriptions: Optional[List[AccountSubscriptionItem]] = None + __properties: ClassVar[List[str]] = ["account_id", "account_name", "roles", "account", "feature_set", "subscriptions"] model_config = ConfigDict( populate_by_name=True, @@ -63,8 +69,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "subscriptions", ]) _dict = self.model_dump( @@ -72,6 +80,19 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of account + if self.account: + _dict['account'] = self.account.to_dict() + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items return _dict @classmethod @@ -86,7 +107,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "account_id": obj.get("account_id"), "account_name": obj.get("account_name"), - "roles": obj.get("roles") + "roles": obj.get("roles"), + "account": AccountFull.from_dict(obj["account"]) if obj.get("account") is not None else None, + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None, + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None }) return _obj diff --git a/digiseg_api/models/user_account_membership_base.py b/digiseg_api/models/user_account_membership_base.py new file mode 100644 index 0000000..4b5fc76 --- /dev/null +++ b/digiseg_api/models/user_account_membership_base.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.user_account_role import UserAccountRole +from typing import Optional, Set +from typing_extensions import Self + +class UserAccountMembershipBase(BaseModel): + """ + Describes a user's membership of an account + """ # noqa: E501 + account_id: StrictStr = Field(description="The ID of the account") + account_name: Optional[StrictStr] = Field(default=None, description="The name of the account") + roles: List[UserAccountRole] = Field(description="The roles that the user has within the account") + __properties: ClassVar[List[str]] = ["account_id", "account_name", "roles"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserAccountMembershipBase from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserAccountMembershipBase from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "account_id": obj.get("account_id"), + "account_name": obj.get("account_name"), + "roles": obj.get("roles") + }) + return _obj + + diff --git a/digiseg_api/models/user_account_membership_include_aux.py b/digiseg_api/models/user_account_membership_include_aux.py new file mode 100644 index 0000000..3e0a591 --- /dev/null +++ b/digiseg_api/models/user_account_membership_include_aux.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from digiseg_api.models.account_full import AccountFull +from digiseg_api.models.account_subscription_item import AccountSubscriptionItem +from digiseg_api.models.plan_feature_set import PlanFeatureSet +from typing import Optional, Set +from typing_extensions import Self + +class UserAccountMembershipIncludeAux(BaseModel): + """ + Additional properties that may appear as read-only properties depending on the `include` parameter + """ # noqa: E501 + account: Optional[AccountFull] = None + feature_set: Optional[PlanFeatureSet] = None + subscriptions: Optional[List[AccountSubscriptionItem]] = None + __properties: ClassVar[List[str]] = ["account", "feature_set", "subscriptions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserAccountMembershipIncludeAux from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "subscriptions", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of account + if self.account: + _dict['account'] = self.account.to_dict() + # override the default output from pydantic by calling `to_dict()` of feature_set + if self.feature_set: + _dict['feature_set'] = self.feature_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in subscriptions (list) + _items = [] + if self.subscriptions: + for _item in self.subscriptions: + if _item: + _items.append(_item.to_dict()) + _dict['subscriptions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserAccountMembershipIncludeAux from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "account": AccountFull.from_dict(obj["account"]) if obj.get("account") is not None else None, + "feature_set": PlanFeatureSet.from_dict(obj["feature_set"]) if obj.get("feature_set") is not None else None, + "subscriptions": [AccountSubscriptionItem.from_dict(_item) for _item in obj["subscriptions"]] if obj.get("subscriptions") is not None else None + }) + return _obj + + diff --git a/digiseg_api/models/user_account_role.py b/digiseg_api/models/user_account_role.py index 6d7d7ce..03f02f4 100644 --- a/digiseg_api/models/user_account_role.py +++ b/digiseg_api/models/user_account_role.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_aux.py b/digiseg_api/models/user_aux.py index 4e3e6ce..30b614c 100644 --- a/digiseg_api/models/user_aux.py +++ b/digiseg_api/models/user_aux.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_base.py b/digiseg_api/models/user_base.py index 7aa5725..b5dab30 100644 --- a/digiseg_api/models/user_base.py +++ b/digiseg_api/models/user_base.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_creation.py b/digiseg_api/models/user_creation.py index b657082..ab32a0e 100644 --- a/digiseg_api/models/user_creation.py +++ b/digiseg_api/models/user_creation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_creation_notification.py b/digiseg_api/models/user_creation_notification.py index 6e96dbd..f78966a 100644 --- a/digiseg_api/models/user_creation_notification.py +++ b/digiseg_api/models/user_creation_notification.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_credentials.py b/digiseg_api/models/user_credentials.py index 260640e..e126412 100644 --- a/digiseg_api/models/user_credentials.py +++ b/digiseg_api/models/user_credentials.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_full.py b/digiseg_api/models/user_full.py index 53cce41..f78afde 100644 --- a/digiseg_api/models/user_full.py +++ b/digiseg_api/models/user_full.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -79,10 +79,20 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", "logged_in_at", "account_memberships", + "created_at", + "created_by", + "updated_at", + "updated_by", ]) _dict = self.model_dump( diff --git a/digiseg_api/models/user_include_param.py b/digiseg_api/models/user_include_param.py new file mode 100644 index 0000000..9d30c80 --- /dev/null +++ b/digiseg_api/models/user_include_param.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Digiseg API + + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + + The version of the OpenAPI document: 1.0.0 + Contact: support@digiseg.io + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class UserIncludeParam(str, Enum): + """ + UserIncludeParam + """ + + """ + allowed enum values + """ + NONE = 'none' + SUBSCRIPTIONS = 'subscriptions' + ACCOUNT = 'account' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of UserIncludeParam from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/digiseg_api/models/user_item.py b/digiseg_api/models/user_item.py index 4f6644f..7714c81 100644 --- a/digiseg_api/models/user_item.py +++ b/digiseg_api/models/user_item.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -69,8 +69,10 @@ def to_dict(self) -> Dict[str, Any]: were set at model initialization. Other fields with value `None` are ignored. * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "id", "logged_in_at", ]) diff --git a/digiseg_api/models/user_links.py b/digiseg_api/models/user_links.py index 73e4a86..9880ed6 100644 --- a/digiseg_api/models/user_links.py +++ b/digiseg_api/models/user_links.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_mutation.py b/digiseg_api/models/user_mutation.py index 472add8..b5b15ef 100644 --- a/digiseg_api/models/user_mutation.py +++ b/digiseg_api/models/user_mutation.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_platform_role.py b/digiseg_api/models/user_platform_role.py index 0224213..5f830b4 100644 --- a/digiseg_api/models/user_platform_role.py +++ b/digiseg_api/models/user_platform_role.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/models/user_sort_option.py b/digiseg_api/models/user_sort_option.py index 2f5be22..d5e95e0 100644 --- a/digiseg_api/models/user_sort_option.py +++ b/digiseg_api/models/user_sort_option.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io diff --git a/digiseg_api/rest.py b/digiseg_api/rest.py index 3ddf388..c73f8f8 100644 --- a/digiseg_api/rest.py +++ b/digiseg_api/rest.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -17,16 +17,24 @@ import json import re import ssl -from typing import Optional, Union -import aiohttp -import aiohttp_retry +import urllib3 from digiseg_api.exceptions import ApiException, ApiValueError -RESTResponseType = aiohttp.ClientResponse +SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"} +RESTResponseType = urllib3.HTTPResponse + + +def is_socks_proxy_url(url): + if url is None: + return False + split_section = url.split("://") + if len(split_section) < 2: + return False + else: + return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES -ALLOW_RETRY_METHODS = frozenset({'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PUT', 'TRACE'}) class RESTResponse(io.IOBase): @@ -36,13 +44,13 @@ def __init__(self, resp) -> None: self.reason = resp.reason self.data = None - async def read(self): + def read(self): if self.data is None: - self.data = await self.response.read() + self.data = self.response.data return self.data def getheaders(self): - """Returns a CIMultiDictProxy of the response headers.""" + """Returns a dictionary of the response headers.""" return self.response.headers def getheader(self, name, default=None): @@ -53,57 +61,58 @@ def getheader(self, name, default=None): class RESTClientObject: def __init__(self, configuration) -> None: + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE - # maxsize is number of requests to host that are allowed in parallel - maxsize = configuration.connection_pool_maxsize - - ssl_context = ssl.create_default_context( - cafile=configuration.ssl_ca_cert - ) - if configuration.cert_file: - ssl_context.load_cert_chain( - configuration.cert_file, keyfile=configuration.key_file + pool_args = { + "cert_reqs": cert_reqs, + "ca_certs": configuration.ssl_ca_cert, + "cert_file": configuration.cert_file, + "key_file": configuration.key_file, + } + if configuration.assert_hostname is not None: + pool_args['assert_hostname'] = ( + configuration.assert_hostname ) - if not configuration.verify_ssl: - ssl_context.check_hostname = False - ssl_context.verify_mode = ssl.CERT_NONE + if configuration.retries is not None: + pool_args['retries'] = configuration.retries + + if configuration.tls_server_name: + pool_args['server_hostname'] = configuration.tls_server_name - connector = aiohttp.TCPConnector( - limit=maxsize, - ssl=ssl_context - ) - self.proxy = configuration.proxy - self.proxy_headers = configuration.proxy_headers + if configuration.socket_options is not None: + pool_args['socket_options'] = configuration.socket_options + + if configuration.connection_pool_maxsize is not None: + pool_args['maxsize'] = configuration.connection_pool_maxsize # https pool manager - self.pool_manager = aiohttp.ClientSession( - connector=connector, - trust_env=True - ) - - retries = configuration.retries - self.retry_client: Optional[aiohttp_retry.RetryClient] - if retries is not None: - self.retry_client = aiohttp_retry.RetryClient( - client_session=self.pool_manager, - retry_options=aiohttp_retry.ExponentialRetry( - attempts=retries, - factor=0.0, - start_timeout=0.0, - max_timeout=120.0 - ) - ) + self.pool_manager: urllib3.PoolManager + + if configuration.proxy: + if is_socks_proxy_url(configuration.proxy): + from urllib3.contrib.socks import SOCKSProxyManager + pool_args["proxy_url"] = configuration.proxy + pool_args["headers"] = configuration.proxy_headers + self.pool_manager = SOCKSProxyManager(**pool_args) + else: + pool_args["proxy_url"] = configuration.proxy + pool_args["proxy_headers"] = configuration.proxy_headers + self.pool_manager = urllib3.ProxyManager(**pool_args) else: - self.retry_client = None - - async def close(self): - await self.pool_manager.close() - if self.retry_client is not None: - await self.retry_client.close() + self.pool_manager = urllib3.PoolManager(**pool_args) - async def request( + def request( self, method, url, @@ -112,7 +121,7 @@ async def request( post_params=None, _request_timeout=None ): - """Execute request + """Perform requests. :param method: http request method :param url: http request url @@ -144,73 +153,106 @@ async def request( post_params = post_params or {} headers = headers or {} - # url already contains the URL query string - timeout = _request_timeout or 5 * 60 - if 'Content-Type' not in headers: - headers['Content-Type'] = 'application/json' - - args = { - "method": method, - "url": url, - "timeout": timeout, - "headers": headers - } + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): + timeout = urllib3.Timeout(total=_request_timeout) + elif ( + isinstance(_request_timeout, tuple) + and len(_request_timeout) == 2 + ): + timeout = urllib3.Timeout( + connect=_request_timeout[0], + read=_request_timeout[1] + ) - if self.proxy: - args["proxy"] = self.proxy - if self.proxy_headers: - args["proxy_headers"] = self.proxy_headers - - # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` - if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: - if re.search('json', headers['Content-Type'], re.IGNORECASE): - if body is not None: - body = json.dumps(body) - args["data"] = body - elif headers['Content-Type'] == 'application/x-www-form-urlencoded': - args["data"] = aiohttp.FormData(post_params) - elif headers['Content-Type'] == 'multipart/form-data': - # must del headers['Content-Type'], or the correct - # Content-Type which generated by aiohttp - del headers['Content-Type'] - data = aiohttp.FormData() - for param in post_params: - k, v = param - if isinstance(v, tuple) and len(v) == 3: - data.add_field( - k, - value=v[1], - filename=v[0], - content_type=v[2] - ) - else: - data.add_field(k, v) - args["data"] = data - - # Pass a `bytes` parameter directly in the body to support - # other content types than Json when `body` argument is provided - # in serialized form - elif isinstance(body, bytes): - args["data"] = body + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + + # no content type provided or payload is json + content_type = headers.get('Content-Type') + if ( + not content_type + or re.search('json', content_type, re.IGNORECASE) + ): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, + url, + body=request_body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'application/x-www-form-urlencoded': + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=False, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + # Ensures that dict objects are serialized + post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params] + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=True, + timeout=timeout, + headers=headers, + preload_content=False + ) + # Pass a `string` parameter directly in the body to support + # other content types than JSON when `body` argument is + # provided in serialized form. + elif isinstance(body, str) or isinstance(body, bytes): + r = self.pool_manager.request( + method, + url, + body=body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool): + request_body = "true" if body else "false" + r = self.pool_manager.request( + method, + url, + body=request_body, + preload_content=False, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` else: - # Cannot generate the request from given parameters - msg = """Cannot prepare a request message for provided - arguments. Please check that your arguments match - declared content type.""" - raise ApiException(status=0, reason=msg) - - pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient] - if self.retry_client is not None and method in ALLOW_RETRY_METHODS: - pool_manager = self.retry_client - else: - pool_manager = self.pool_manager - - r = await pool_manager.request(**args) + r = self.pool_manager.request( + method, + url, + fields={}, + timeout=timeout, + headers=headers, + preload_content=False + ) + except urllib3.exceptions.SSLError as e: + msg = "\n".join([type(e).__name__, str(e)]) + raise ApiException(status=0, reason=msg) return RESTResponse(r) - - - - - diff --git a/examples/enrich_csv_file.py b/examples/enrich_csv_file.py index 4b8c457..5c33d86 100644 --- a/examples/enrich_csv_file.py +++ b/examples/enrich_csv_file.py @@ -34,6 +34,7 @@ def enrichLines(lines: List[str], apiKey: str): queries = map(lambda kv: {"id": f"{kv[0]}", "ip_address": kv[1]}, ips.items()) configuration = digiseg_api.Configuration() configuration.api_key['apiKeyHeaderAuth'] = apiKey + api_client = digiseg_api.ApiClient(configuration) with digiseg_api.ApiClient(configuration) as api_client: audiencesApi = digiseg_api.AudiencesApi(api_client) response = audiencesApi.resolve_audiences_of_multiple({ diff --git a/pyproject.toml b/pyproject.toml index 3a89f44..8528907 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,8 +14,6 @@ python = "^3.7" urllib3 = ">= 1.25.3" python-dateutil = ">=2.8.2" -aiohttp = ">= 3.8.4" -aiohttp-retry = ">= 2.8.3" pydantic = ">=2" typing-extensions = ">=4.7.1" diff --git a/requirements.txt b/requirements.txt index bbada26..cc85509 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,5 +3,3 @@ setuptools >= 21.0.0 urllib3 >= 1.25.3, < 2.1.0 pydantic >= 2 typing-extensions >= 4.7.1 -aiohttp >= 3.0.0 -aiohttp-retry >= 2.8.3 diff --git a/setup.py b/setup.py index 93a4e30..5c78be1 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ """ Digiseg API - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages:
## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. The version of the OpenAPI document: 1.0.0 Contact: support@digiseg.io @@ -27,8 +27,6 @@ REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", "python-dateutil", - "aiohttp >= 3.0.0", - "aiohttp-retry >= 2.8.3", "pydantic >= 2", "typing-extensions >= 4.7.1", ] @@ -46,7 +44,7 @@ include_package_data=True, long_description_content_type='text/markdown', long_description="""\ - ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages: <div class=\"api-clients\"> <a class=\"api-client-box\" href=\"https://github.com/digiseg-labs/api-client-python\"> <i class=\"api-client-sdk-logo devicon-python-plain\"></i> <p>API client for Python</p> </a> <a class=\"api-client-box\" href=\"https://github.com/digiseg-labs/api-client-go\"> <i class=\"api-client-sdk-logo devicon-go-original-wordmark\"></i> <p>API client for Go</p> </a> </div> <div class=\"api-clients-breaker\" /> ## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. + ### Digiseg API documentation # Introduction This API let you harness the power of Digisegs powerful and tracking-free segmentation engine. Audiences by Digiseg are available in 50+ countries, probablistically mapping neighborhood characteristics to the IP addresses observed on the internet - Household targeting & measurement for the post-cookie world. ## Developer SDKs In addition to using these APIs directly through any HTTP client, we provide a set of API client SDKs for popular programming languages: <div class=\"api-clients\"> <a class=\"api-client-box\" href=\"https://github.com/digiseg-labs/api-client-python\"> <i class=\"api-client-sdk-logo devicon-python-plain\"></i> <p>API client for Python</p> </a> <a class=\"api-client-box\" href=\"https://github.com/digiseg-labs/api-client-ts\"> <i class=\"api-client-sdk-logo devicon-typescript-plain\"></i> <p>API client for TypeScript</p> </a> <a class=\"api-client-box\" href=\"https://github.com/digiseg-labs/api-client-go\"> <i class=\"api-client-sdk-logo devicon-go-original-wordmark\"></i> <p>API client for Go</p> </a> </div> <div class=\"api-clients-breaker\" /> ## Audience taxonomy Digiseg audiences are grouped into private and business audiences. In each group there are categories that then contain the audiences. The API endpoints that communicate audiences and household characteristics, audience codes are being used. The following table can be used as a reference for audience codes. Note that Digiseg will at times update names of audiences for purposes of internationalization, clarity or other such purposes - but the codes will remain as-is and should be considered a stable point of reference for the audience. | Group | Category | Audience Code | Audience Name | |-------|----------|---------------|---------------| | private | home_type | a1 | Apartment | | | | a2 | House | | | savings | b1 | No Savings | | | | b2 | Smaller Savings | | | | b3 | Larger Savings | | | lifecycle | c1 | Young couples and singles | | | | c2 | Early family life | | | | c3 | Middle-aged families | | | | c4 | Mature families | | | | c5 | Pensioners / Retirees | | | cars | d1 | No cars | | | | d2 | 1 car | | | | d3 | 2 or more cars | | | children | e1 | No children | | | | e2 | 1 child | | | | e3 | 2 or more children | | | education | f1 | Basic | | | | f2 | Medium | | | | f3 | Higher | | | neighbourhood_type | g1 | Countryside | | | | g2 | Village | | | | g3 | Suburban | | | | g4 | City | | | income | h1 | Lowest 20% | | | | h2 | Lowest 20-40% | | | | h3 | Middle 40-60% | | | | h4 | Highest 60-80% | | | | h5 | Top 20% | | | home_ownership | j1 | Rent | | | | j2 | Own | | | building_age | k1 | Pre 1945 | | | | k2 | 1945-1989 | | | | k3 | 1990 until today | | | living_space | l1 | Small | | | | l2 | Medium | | | | l3 | Large | | | tech_level | n1 | Basic | | | | n2 | Medium | | | | n3 | High | | business | size | ba1 | Small Business | | | | ba2 | Medium Business | | | | ba3 | Larger Business | There is also an interactive [Audience builder](https://digiseg.io/cookieless-audience-builder/) which lets you discover the targeting reach and power of combining various household characteristics into composite audiences. """, # noqa: E501 package_data={"digiseg_api": ["py.typed"]}, )