openapi: 3.0.0 info: contact: email: hello@unified.to url: https://unified.to/contact description: One API to Rule Them All termsOfService: https://unified.to/tos title: Unified.to account group API version: '1.0' servers: - description: North American data region url: https://api.unified.to - description: European data region url: https://api-eu.unified.to - description: Australian data region url: https://api-au.unified.to security: - jwt: [] tags: - name: group paths: /ads/{connection_id}/group: get: operationId: listAdsGroups parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The org ID to filter by (reference to AdsOrganization) in: query name: org_id required: false schema: type: string - description: The campaign ID to filter by in: query name: campaign_id required: false schema: type: string - description: The parent ID to filter by in: query name: parent_id required: false schema: type: string - description: The IO ID to filter by in: query name: io_id required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - parent_id - campaign_id - organization_id - insertionorder_id - status - targeting - bid_amount - bid_strategy - budget_amount - budget_period - budget_allocation_type - start_at - end_at - budget_unit - budget_max_amount - type - has_eu_political_ads - pacing - frequency_cap - creative_ids - optimization_goal - billing_event - currency - promoted - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsGroups' description: Successful security: - jwt: [] summary: List All Groups tags: - group post: operationId: createAdsGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - parent_id - campaign_id - organization_id - insertionorder_id - status - targeting - bid_amount - bid_strategy - budget_amount - budget_period - budget_allocation_type - start_at - end_at - budget_unit - budget_max_amount - type - has_eu_political_ads - pacing - frequency_cap - creative_ids - optimization_goal - billing_event - currency - promoted - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdsGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsGroup' description: Successful security: - jwt: [] summary: Create a Group tags: - group /ads/{connection_id}/group/{id}: delete: operationId: removeAdsGroup parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Group tags: - group get: operationId: getAdsGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - parent_id - campaign_id - organization_id - insertionorder_id - status - targeting - bid_amount - bid_strategy - budget_amount - budget_period - budget_allocation_type - start_at - end_at - budget_unit - budget_max_amount - type - has_eu_political_ads - pacing - frequency_cap - creative_ids - optimization_goal - billing_event - currency - promoted - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsGroup' description: Successful security: - jwt: [] summary: Retrieve a Group tags: - group patch: operationId: patchAdsGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - parent_id - campaign_id - organization_id - insertionorder_id - status - targeting - bid_amount - bid_strategy - budget_amount - budget_period - budget_allocation_type - start_at - end_at - budget_unit - budget_max_amount - type - has_eu_political_ads - pacing - frequency_cap - creative_ids - optimization_goal - billing_event - currency - promoted - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdsGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsGroup' description: Successful security: - jwt: [] summary: Update a Group tags: - group put: operationId: updateAdsGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - parent_id - campaign_id - organization_id - insertionorder_id - status - targeting - bid_amount - bid_strategy - budget_amount - budget_period - budget_allocation_type - start_at - end_at - budget_unit - budget_max_amount - type - has_eu_political_ads - pacing - frequency_cap - creative_ids - optimization_goal - billing_event - currency - promoted - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdsGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsGroup' description: Successful security: - jwt: [] summary: Update a Group tags: - group /hris/{connection_id}/group: get: operationId: listHrisGroups parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The company ID to filter by (reference to HrisCompany) in: query name: company_id required: false schema: type: string - description: The type to filter by in: query name: type required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - parent_id - type - user_ids - manager_ids - is_active - company_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HrisGroups' description: Successful security: - jwt: [] summary: List All Groups tags: - group post: operationId: createHrisGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - parent_id - type - user_ids - manager_ids - is_active - company_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HrisGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/HrisGroup' description: Successful security: - jwt: [] summary: Create a Group tags: - group /hris/{connection_id}/group/{id}: delete: operationId: removeHrisGroup parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Group tags: - group get: operationId: getHrisGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - parent_id - type - user_ids - manager_ids - is_active - company_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HrisGroup' description: Successful security: - jwt: [] summary: Retrieve a Group tags: - group patch: operationId: patchHrisGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - parent_id - type - user_ids - manager_ids - is_active - company_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HrisGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/HrisGroup' description: Successful security: - jwt: [] summary: Update a Group tags: - group put: operationId: updateHrisGroup parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - parent_id - type - user_ids - manager_ids - is_active - company_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HrisGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/HrisGroup' description: Successful security: - jwt: [] summary: Update a Group tags: - group /scim/{connection_id}/groups: get: operationId: listScimGroups parameters: - in: query name: filter required: false schema: type: string - in: query name: sortBy required: false schema: type: string - in: query name: sortOrder required: false schema: type: string - in: query name: startIndex required: false schema: type: number - in: query name: count required: false schema: type: number - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScimGroups' description: Successful security: - jwt: [] summary: List Groups tags: - group post: operationId: createScimGroups parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ScimGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScimGroup' description: Successful security: - jwt: [] summary: Create Group tags: - group /scim/{connection_id}/groups/{id}: delete: operationId: removeScimGroups parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Delete Group tags: - group get: operationId: getScimGroups parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScimGroup' description: Successful security: - jwt: [] summary: Get Group tags: - group patch: operationId: patchScimGroups parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ScimGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScimGroup' description: Successful security: - jwt: [] summary: Update Group tags: - group put: operationId: updateScimGroups parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ScimGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScimGroup' description: Successful security: - jwt: [] summary: Update Group tags: - group components: schemas: property_AdsGroup_targeting_language_codes: items: type: string type: array property_ScimGroup_schemas: description: Array of schema URIs items: enum: - urn:ietf:params:scim:schemas:core:2.0:Group type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_placement_facebook_positions: items: type: string type: array property_AdsGroup_targeting_placement_messenger_positions: items: type: string type: array property_AdsGroup_targeting_geographic_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsGroup_targeting_audience: properties: behaviors: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_behaviors' combination_spec: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_combination_spec' custom_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_custom_audiences' excluded_behaviors: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_behaviors' excluded_custom_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_custom_audiences' excluded_interests: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_interests' interests: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_interests' lookalike_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_lookalike_audiences' type: object property_AdsGroup_targeting_content_urls: items: type: string type: array ScimGroupMember: properties: $ref: type: string display: type: string operation: enum: - add - delete type: string x-speakeasy-unknown-values: allow type: enum: - User - Group type: string x-speakeasy-unknown-values: allow value: type: string required: - value type: object property_AdsGroup_targeting_content_video_excluded_youtube_videos: items: type: string type: array property_AdsGroup_targeting_geographic_us_dmas: items: type: string type: array property_AdsGroup_targeting_brand_safety_excluded_content_labels: description: Google Ads ContentLabelType items: type: string type: array property_AdsGroup_targeting_content_video_durations: items: enum: - SHORT - MEDIUM - LONG type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_brand_safety_block_list_ids: items: type: string type: array property_AdsGroup_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsGroup_targeting_audience_lookalike_audiences: items: $ref: '#/components/schemas/LookalikeAudience' type: array property_HrisGroup_manager_ids: items: type: string type: array CityTarget: properties: id: type: string name: type: string radius: type: number radius_unit: enum: - MILES - KILOMETERS type: string x-speakeasy-unknown-values: allow required: - id type: object HrisGroup: properties: company_id: type: string created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean manager_ids: $ref: '#/components/schemas/property_HrisGroup_manager_ids' name: type: string parent_id: type: string raw: additionalProperties: true type: object type: enum: - TEAM - GROUP - DEPARTMENT - DIVISION - BUSINESS_UNIT - BRANCH - SUB_DEPARTMENT type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_HrisGroup_user_ids' type: object property_AdsGroup_targeting_placement: properties: audience_network_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_audience_network_positions' facebook_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_facebook_positions' instagram_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_instagram_positions' messenger_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_messenger_positions' platforms: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_platforms' type: object property_AdsGroup_pacing: properties: daily_max_amount: type: number daily_max_impressions: type: number period: enum: - UNSPECIFIED - DAILY - FLIGHT type: string x-speakeasy-unknown-values: allow type: type: string type: object property_AdsGroup_targeting_language: description: Language targeting (Meta properties: codes: $ref: '#/components/schemas/property_AdsGroup_targeting_language_codes' locale_ids: $ref: '#/components/schemas/property_AdsGroup_targeting_language_locale_ids' type: object AudienceSegment: description: 'Audience targeting (Meta: custom_audiences, lookalike_audiences, flexible_spec)' properties: id: type: string name: type: string required: - id type: object property_AdsGroup_targeting_content_video_youtube_videos: items: type: string type: array property_AdsGroup_targeting_content_video_positions: items: enum: - PREROLL - MIDROLL - POSTROLL - INSTREAM - OUTSTREAM type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_audience_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array ScimGroup: properties: displayName: type: string externalId: type: string groupType: type: string id: type: string members: $ref: '#/components/schemas/property_ScimGroup_members' meta: $ref: '#/components/schemas/property_ScimGroup_meta' schemas: $ref: '#/components/schemas/property_ScimGroup_schemas' required: - displayName type: object property_ScimGroup_meta: properties: created: type: string lastModified: type: string location: type: string resourceType: enum: - User - Group type: string x-speakeasy-unknown-values: allow version: type: string type: object property_AdsGroup_targeting_geographic: properties: cities: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_cities' countries: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_countries' excluded_cities: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_cities' excluded_countries: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_countries' excluded_postal_codes: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_postal_codes' excluded_regions: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_regions' excluded_us_dmas: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_us_dmas' location_types: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_location_types' postal_codes: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_postal_codes' presence_type: enum: - PRESENCE - PRESENCE_OR_INTEREST type: string x-speakeasy-unknown-values: allow regions: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_regions' us_dmas: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_us_dmas' type: object AudienceCombination: properties: behaviors: $ref: '#/components/schemas/property_AudienceCombination_behaviors' demographics: $ref: '#/components/schemas/property_AudienceCombination_demographics' interests: $ref: '#/components/schemas/property_AudienceCombination_interests' life_events: $ref: '#/components/schemas/property_AudienceCombination_life_events' type: object property_AdsGroup_targeting_content_video_excluded_youtube_channels: items: type: string type: array property_AdsGroup_targeting_placement_audience_network_positions: items: type: string type: array property_AdsGroup_targeting_audience_combination_spec: items: $ref: '#/components/schemas/AudienceCombination' type: array property_AdsGroup_targeting_content_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AudienceCombination_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array LookalikeAudience: properties: id: type: string name: type: string similarity: type: number source_audience_id: type: string required: - id type: object property_AdsGroup_targeting_schedule: items: $ref: '#/components/schemas/AdSchedule' type: array property_AudienceCombination_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_content_topics: items: type: string type: array RegionTarget: description: states, provinces, regions properties: id: type: string name: type: string required: - id type: object property_AdsGroup_targeting_optimization: description: 'Optimization (Meta: targeting_automation; Google: observation vs targeting mode)' properties: advantage_audience: type: boolean advantage_placements: type: boolean mode: enum: - TARGETING - OBSERVATION type: string x-speakeasy-unknown-values: allow targeting_optimization_expansion_all: type: boolean type: object property_AdsGroup_targeting_content_excluded_topics: items: type: string type: array property_AdsGroup_targeting_brand_safety: description: 'Brand safety (Meta: excluded_publisher_categories, etc.; Google' properties: block_list_ids: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_block_list_ids' brand_safety_content_filter_levels: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels' excluded_content_labels: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_excluded_content_labels' excluded_publisher_categories: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_excluded_publisher_categories' publisher_visibility_categories: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_publisher_visibility_categories' type: object property_AdsGroup_targeting_geographic_excluded_us_dmas: items: type: string type: array AdsPromoted: description: Promoted entity (e.g. page, app, product, tweet) for ads create properties: id: type: string name: type: string raw: additionalProperties: true type: object type: enum: - PAGE_ID - APP_ID - STORE_URL - PIXEL_ID - CUSTOM_CONVERSION_ID - CATALOG_ID - PRODUCT_SET_ID - PRIORITIZED_SET_ID - EVENT_ID - OFFER_ID - LEAD_FORM_ID - MESSAGING_CHANNEL_ID - PRODUCT_ID - TWEET_ID - AD_GROUP_TYPE type: string x-speakeasy-unknown-values: allow required: - id - type type: object property_HrisGroup_user_ids: items: type: string type: array property_AdsGroup_targeting_audience_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_excluded_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_geographic_excluded_postal_codes: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_countries: items: type: string type: array property_ScimGroup_members: description: An array of members items: $ref: '#/components/schemas/ScimGroupMember' type: array AdSchedule: properties: bid_modifier: type: number day_of_week: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string x-speakeasy-unknown-values: allow end_hour: type: number end_minute: type: number start_hour: type: number start_minute: type: number required: - day_of_week - start_hour - end_hour type: object property_AdsGroup_targeting_content: properties: excluded_keywords: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_keywords' excluded_topics: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_topics' excluded_urls: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_urls' keywords: $ref: '#/components/schemas/property_AdsGroup_targeting_content_keywords' topics: $ref: '#/components/schemas/property_AdsGroup_targeting_content_topics' urls: $ref: '#/components/schemas/property_AdsGroup_targeting_content_urls' video: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video' type: object property_AdsGroup_targeting_geographic_location_types: items: enum: - HOME - RECENT - TRAVEL type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_content_video_youtube_channels: items: type: string type: array property_AdsGroup_targeting_audience_excluded_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_brand_safety_publisher_visibility_categories: items: enum: - limited - standard - expanded type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_device_user_os: items: type: string type: array property_AdsGroup_targeting: properties: audience: $ref: '#/components/schemas/property_AdsGroup_targeting_audience' brand_safety: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety' content: $ref: '#/components/schemas/property_AdsGroup_targeting_content' demographic: $ref: '#/components/schemas/property_AdsGroup_targeting_demographic' device: $ref: '#/components/schemas/property_AdsGroup_targeting_device' geographic: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic' language: $ref: '#/components/schemas/property_AdsGroup_targeting_language' optimization: $ref: '#/components/schemas/property_AdsGroup_targeting_optimization' placement: $ref: '#/components/schemas/property_AdsGroup_targeting_placement' schedule: $ref: '#/components/schemas/property_AdsGroup_targeting_schedule' type: object property_AdsGroup_targeting_device_types: items: type: string type: array property_AudienceCombination_life_events: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_language_locale_ids: items: type: number type: array property_AdsGroup_targeting_device: properties: carriers: $ref: '#/components/schemas/property_AdsGroup_targeting_device_carriers' types: $ref: '#/components/schemas/property_AdsGroup_targeting_device_types' user_device: $ref: '#/components/schemas/property_AdsGroup_targeting_device_user_device' user_os: $ref: '#/components/schemas/property_AdsGroup_targeting_device_user_os' type: object property_AdsGroup_targeting_geographic_postal_codes: items: type: string type: array property_AdsGroup_targeting_device_user_device: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsGroup_targeting_content_video: properties: durations: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_durations' excluded_youtube_channels: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_excluded_youtube_channels' excluded_youtube_videos: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_excluded_youtube_videos' player_sizes: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_player_sizes' positions: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_positions' youtube_channels: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_youtube_channels' youtube_videos: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_youtube_videos' type: object property_AdsGroup_targeting_content_video_player_sizes: items: enum: - SMALL - LARGE - HD type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels: items: type: string type: array property_AudienceCombination_demographics: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_device_carriers: items: type: string type: array property_AdsGroup_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsGroup_targeting_content_excluded_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array AdsGroup: properties: bid_amount: type: number bid_strategy: $ref: '#/components/schemas/property_AdsGroup_bid_strategy' billing_event: enum: - IMPRESSIONS - LINK_CLICKS - VIDEO_VIEWS - APP_INSTALLS - ENGAGEMENT - PAGE_LIKES - MESSAGES - POST_ENGAGEMENT - PURCHASE - NONE type: string x-speakeasy-unknown-values: allow budget_allocation_type: enum: - UNSPECIFIED - AUTOMATIC - FIXED - UNLIMITED type: string x-speakeasy-unknown-values: allow budget_amount: type: number budget_max_amount: type: number budget_period: enum: - DAILY - MONTHLY - TOTAL - LIFETIME type: string x-speakeasy-unknown-values: allow budget_unit: enum: - UNSPECIFIED - CURRENCY - IMPRESSIONS type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string creative_ids: $ref: '#/components/schemas/property_AdsGroup_creative_ids' currency: type: string end_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsGroup_frequency_cap' has_eu_political_ads: type: boolean id: type: string insertionorder_id: type: string name: type: string optimization_goal: enum: - REACH - IMPRESSIONS - LINK_CLICKS - LANDING_PAGE_VIEWS - CONVERSIONS - LEAD_GENERATION - APP_INSTALLS - APP_ENGAGEMENT - VIDEO_VIEWS - ENGAGEMENT - PAGE_LIKES - MESSAGES type: string x-speakeasy-unknown-values: allow organization_id: type: string pacing: $ref: '#/components/schemas/property_AdsGroup_pacing' parent_id: type: string promoted: $ref: '#/components/schemas/property_AdsGroup_promoted' raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow targeting: $ref: '#/components/schemas/property_AdsGroup_targeting' type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AdsGroup_targeting_geographic_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsGroup_targeting_demographic: description: 'Demographic targeting (Meta: age_min, age_max, genders)' properties: age_max: type: number age_min: type: number female: type: boolean male: type: boolean type: object property_AdsGroup_targeting_placement_platforms: items: type: string type: array property_AdsGroup_targeting_geographic_countries: items: type: string type: array ScimGroups: items: $ref: '#/components/schemas/ScimGroup' type: array property_AdsGroup_targeting_audience_excluded_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array HrisGroups: items: $ref: '#/components/schemas/HrisGroup' type: array AdsGroups: items: $ref: '#/components/schemas/AdsGroup' type: array property_AdsGroup_targeting_content_excluded_urls: items: type: string type: array AdsKeyword: description: Content targeting (keywords, topics, placements, video) properties: match_type: enum: - BROAD - PHRASE - EXACT type: string x-speakeasy-unknown-values: allow text: type: string required: - text type: object property_AdsGroup_bid_strategy: description: YOUTUBE_AND_PARTNERS properties: custom_bidding_algorithm_id: type: string fixed_bid_amount: type: number max_average_cpm_bid_amount: type: number performance_goal_amount: type: number performance_goal_type: enum: - UNSPECIFIED - CPA - CPC - VIEWABLE_CPM - CUSTOM_ALGO - CIVA - IVO_TEN - AV_VIEWED - REACH type: string x-speakeasy-unknown-values: allow raise_bid_for_deals: type: boolean target_roas: type: number type: enum: - FIXED_BID - MAXIMIZE_SPEND - PERFORMANCE_GOAL - YOUTUBE_AND_PARTNERS type: string x-speakeasy-unknown-values: allow youtube_and_partners_type: enum: - UNSPECIFIED - MANUAL_CPV - MANUAL_CPM - TARGET_CPA - TARGET_CPM - RESERVE_CPM - MAXIMIZE_LIFT - MAXIMIZE_CONVERSIONS - TARGET_CPV - TARGET_ROAS - MAXIMIZE_CONVERSION_VALUE type: string x-speakeasy-unknown-values: allow youtube_and_partners_value: type: string required: - type type: object property_AdsGroup_targeting_brand_safety_excluded_publisher_categories: items: type: string type: array property_AdsGroup_creative_ids: items: type: string type: array property_AdsGroup_targeting_placement_instagram_positions: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_regions: items: $ref: '#/components/schemas/RegionTarget' type: array securitySchemes: jwt: in: header name: authorization type: apiKey externalDocs: description: API Documentation url: https://docs.unified.to