Can I use X Ads as a CLI?

Yes. KosmoKrator exposes a X Ads CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose X Ads through MCP?

Yes. The KosmoKrator MCP gateway can expose selected X Ads tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are X Ads credentials stored?

X Ads credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for X Ads MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

X Ads Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the X Ads KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.x_ads.*. Use lua_read_doc("integrations.x-ads") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic X Ads workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.x_ads.get_stats_accounts_account_id_active_entities({account_id = "example_account_id", end_time = "example_end_time", entity = "example_entity", start_time = "example_start_time", campaign_ids = "example_campaign_ids", funding_instrument_ids = "example_funding_instrument_ids", line_item_ids = "example_line_item_ids"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("x-ads"))' --json
kosmo integrations:lua --eval 'print(docs.read("x-ads.get_stats_accounts_account_id_active_entities"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local x_ads = app.integrations.x_ads
local result = x_ads.get_stats_accounts_account_id_active_entities({account_id = "example_account_id", end_time = "example_end_time", entity = "example_entity", start_time = "example_start_time", campaign_ids = "example_campaign_ids", funding_instrument_ids = "example_funding_instrument_ids", line_item_ids = "example_line_item_ids"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.x_ads, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.x_ads.default.* or app.integrations.x_ads.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need X Ads, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

X Ads — Lua API Reference

This integration is generated from the official X Ads Postman collection and exposes 190 Ads API operations.

Authentication

Configure OAuth 1.0a user-context credentials:

api_key
api_secret
access_token
access_token_secret

X Ads API access must be approved by X. Tools are marked with required_access_tier=approved_ads_api_access.

Runtime Notes

Campaign, line item, creative, funding, and audience writes are marked billing_sensitive.
Stats job endpoints are marked runtime_mode=async_job.
If account_id is configured, tools with an account_id path parameter can omit it.

Examples

local accounts = app.integrations["x-ads"].x_ads_get_accounts({})
local campaigns = app.integrations["x-ads"].x_ads_get_accounts_account_id_campaigns({
  account_id = "account-id",
  count = "25"
})

Raw agent markdown

# X Ads — Lua API Reference

This integration is generated from the official X Ads Postman collection and exposes 190 Ads API operations.

## Authentication

Configure OAuth 1.0a user-context credentials:

- `api_key`
- `api_secret`
- `access_token`
- `access_token_secret`

X Ads API access must be approved by X. Tools are marked with `required_access_tier=approved_ads_api_access`.

## Runtime Notes

- Campaign, line item, creative, funding, and audience writes are marked `billing_sensitive`.
- Stats job endpoints are marked `runtime_mode=async_job`.
- If `account_id` is configured, tools with an `account_id` path parameter can omit it.

## Examples

```lua
local accounts = app.integrations["x-ads"].x_ads_get_accounts({})
local campaigns = app.integrations["x-ads"].x_ads_get_accounts_account_id_campaigns({
  account_id = "account-id",
  count = "25"
})
```

Metadata-derived Lua example

local result = app.integrations.x_ads.get_stats_accounts_account_id_active_entities({account_id = "example_account_id", end_time = "example_end_time", entity = "example_entity", start_time = "example_start_time", campaign_ids = "example_campaign_ids", funding_instrument_ids = "example_funding_instrument_ids", line_item_ids = "example_line_item_ids"})
print(result)

Functions

get_stats_accounts_account_id_active_entities Read

X Ads API operation: Analytics / Active Entities stats/accounts/:account_id/active_entities.

Lua path: app.integrations.x_ads.get_stats_accounts_account_id_active_entities
Full name: x-ads.x_ads_get_stats_accounts_account_id_active_entities

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`end_time`	string	yes	required
`entity`	string	yes	required
`start_time`	string	yes	required
`campaign_ids`	string	no	optional
`funding_instrument_ids`	string	no	optional
`line_item_ids`	string	no	optional

get_stats_jobs_accounts_account_id Read

X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id.

Lua path: app.integrations.x_ads.get_stats_jobs_accounts_account_id
Full name: x-ads.x_ads_get_stats_jobs_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`job_ids`	string	no	optional

post_stats_jobs_accounts_account_id Write

X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id.

Lua path: app.integrations.x_ads.post_stats_jobs_accounts_account_id
Full name: x-ads.x_ads_post_stats_jobs_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`end_time`	string	yes	required
`entity`	string	yes	required
`entity_ids`	string	yes	required
`granularity`	string	yes	required
`metric_groups`	string	yes	required
`placement`	string	yes	required
`start_time`	string	yes	required
`country`	string	no	sometimes required
`platform`	string	no	sometimes required
`segmentation_type`	string	no	optional

delete_stats_jobs_accounts_account_id_job_id Write

X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id/:job_id.

Lua path: app.integrations.x_ads.delete_stats_jobs_accounts_account_id_job_id
Full name: x-ads.x_ads_delete_stats_jobs_accounts_account_id_job_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`body`	object	no	Request body or form fields for this X Ads API operation.

get_accounts_account_id_auction_insights Read

X Ads API operation: Analytics / Auction Insights accounts/:account_id/auction_insights.

Lua path: app.integrations.x_ads.get_accounts_account_id_auction_insights
Full name: x-ads.x_ads_get_accounts_account_id_auction_insights

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`end_time`	string	yes	required
`granularity`	string	yes	required
`line_item_ids`	string	yes	required
`placement`	string	yes	required
`start_time`	string	yes	required

get_stats_accounts_account_id_reach_campaigns Read

X Ads API operation: Analytics / Reach and Average Frequency stats/accounts/:account_id/reach/campaigns.

Lua path: app.integrations.x_ads.get_stats_accounts_account_id_reach_campaigns
Full name: x-ads.x_ads_get_stats_accounts_account_id_reach_campaigns

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`campaign_ids`	string	yes	required
`end_time`	string	yes	required
`start_time`	string	yes	required

get_stats_accounts_account_id_reach_funding_instruments Read

X Ads API operation: Analytics / Reach and Average Frequency stats/accounts/:account_id/reach/funding_instruments.

Lua path: app.integrations.x_ads.get_stats_accounts_account_id_reach_funding_instruments
Full name: x-ads.x_ads_get_stats_accounts_account_id_reach_funding_instruments

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`funding_instrument_ids`	string	yes	required
`end_time`	string	yes	required
`start_time`	string	yes	required

get_stats_accounts_account_id Read

X Ads API operation: Analytics / Synchronous Analytics stats/accounts/:account_id.

Lua path: app.integrations.x_ads.get_stats_accounts_account_id
Full name: x-ads.x_ads_get_stats_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`end_time`	string	yes	required
`entity`	string	yes	required
`entity_ids`	string	yes	required
`granularity`	string	yes	required
`metric_groups`	string	yes	required
`placement`	string	yes	required
`start_time`	string	yes	required

get_insights_accounts_account_id Read

X Ads API operation: Audience / Insights insights/accounts/:account_id.

Lua path: app.integrations.x_ads.get_insights_accounts_account_id
Full name: x-ads.x_ads_get_insights_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`audience_type`	string	yes	required
`audience_value`	string	no	sometimes required
`interaction_type`	string	no	sometimes required

get_insights_accounts_account_id_available_audiences Read

X Ads API operation: Audience / Insights insights/accounts/:account_id/available_audiences.

Lua path: app.integrations.x_ads.get_insights_accounts_account_id_available_audiences
Full name: x-ads.x_ads_get_insights_accounts_account_id_available_audiences

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_insights_keywords_search Read

X Ads API operation: Audience / Keyword Insights insights/keywords/search.

Lua path: app.integrations.x_ads.get_insights_keywords_search
Full name: x-ads.x_ads_get_insights_keywords_search

Parameter	Type	Required	Description
`granularity`	string	yes	required
`keywords`	string	yes	required
`start_time`	string	yes	required
`end_time`	string	no	optional
`location`	string	no	optional
`negative_keywords`	string	no	optional

get_accounts_account_id_tailored_audiences_tailored_audience_id_permissions Read

X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions.

Lua path: app.integrations.x_ads.get_accounts_account_id_tailored_audiences_tailored_audience_id_permissions
Full name: x-ads.x_ads_get_accounts_account_id_tailored_audiences_tailored_audience_id_permissions

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`granted_account_ids`	string	no	optional
`sort_by`	string	no	optional
`tailored_audience_permission_ids`	string	no	optional
`with_total_count`	string	no	optional

post_accounts_account_id_tailored_audiences_tailored_audience_id_permissions Write

X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions.

Lua path: app.integrations.x_ads.post_accounts_account_id_tailored_audiences_tailored_audience_id_permissions
Full name: x-ads.x_ads_post_accounts_account_id_tailored_audiences_tailored_audience_id_permissions

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`granted_account_id`	string	yes	required
`permission_level`	string	yes	required

delete_accounts_account_id_tailored_audiences_tailored_audience_id_permissions_tailored_audience_permission_id Write

X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_tailored_audiences_tailored_audience_id_permissions_tailored_audience_permission_id
Full name: x-ads.x_ads_delete_accounts_account_id_tailored_audiences_tailored_audience_id_permissions_tailored_audience_permission_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`tailored_audience_permission_id`	string	yes	required
`body`	object	no	Request body or form fields for this X Ads API operation.

get_accounts_account_id_tailored_audiences Read

X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences.

Lua path: app.integrations.x_ads.get_accounts_account_id_tailored_audiences
Full name: x-ads.x_ads_get_accounts_account_id_tailored_audiences

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`permission_scope`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`tailored_audience_ids`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_tailored_audiences_tailored_audience_id Read

X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences/:tailored_audience_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_tailored_audiences_tailored_audience_id
Full name: x-ads.x_ads_get_accounts_account_id_tailored_audiences_tailored_audience_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_tailored_audiences Write

X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences.

Lua path: app.integrations.x_ads.post_accounts_account_id_tailored_audiences
Full name: x-ads.x_ads_post_accounts_account_id_tailored_audiences

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	yes	required

post_batch_accounts_account_id_tailored_audiences Write

X Ads API operation: Audience / Tailored Audiences batch/accounts/:account_id/tailored_audiences.

Lua path: app.integrations.x_ads.post_batch_accounts_account_id_tailored_audiences
Full name: x-ads.x_ads_post_batch_accounts_account_id_tailored_audiences

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`audience_type`	string	yes	required
`child_segments`	string	yes	required
`name`	string	yes	required
`operation_type`	string	yes	required
`params`	string	yes	required
`boolean_operator`	string	no	sometimes required
`lookback_window`	string	no	sometimes required
`segments`	string	no	sometimes required
`tailored_audience_id`	string	no	sometimes required
`frequency`	string	no	optional
`frequency_comparator`	string	no	optional
`negate`	string	no	optional

delete_accounts_account_id_tailored_audiences_tailored_audience_id Write

X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences/:tailored_audience_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_tailored_audiences_tailored_audience_id
Full name: x-ads.x_ads_delete_accounts_account_id_tailored_audiences_tailored_audience_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`body`	object	no	Request body or form fields for this X Ads API operation.

post_accounts_account_id_tailored_audiences_tailored_audience_id_users Write

X Ads API operation: Audience / Tailored Audiences Users accounts/:account_id/tailored_audiences/:tailored_audience_id/users.

Lua path: app.integrations.x_ads.post_accounts_account_id_tailored_audiences_tailored_audience_id_users
Full name: x-ads.x_ads_post_accounts_account_id_tailored_audiences_tailored_audience_id_users

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`operation_type`	string	yes	required
`params`	string	yes	required
`users`	string	yes	required
`effective_at`	string	no	optional
`expires_at`	string	no	optional

get_accounts Read

X Ads API operation: Campaign Management / Accounts accounts.

Lua path: app.integrations.x_ads.get_accounts
Full name: x-ads.x_ads_get_accounts

Parameter	Type	Required	Description
`account_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id Read

X Ads API operation: Campaign Management / Accounts accounts/:account_id.

Lua path: app.integrations.x_ads.get_accounts_account_id
Full name: x-ads.x_ads_get_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts Write

X Ads API operation: Campaign Management / Accounts accounts.

Lua path: app.integrations.x_ads.post_accounts
Full name: x-ads.x_ads_post_accounts

Parameter	Type	Required	Description
No parameters.

put_accounts_account_id Write

X Ads API operation: Campaign Management / Accounts accounts/:account_id.

Lua path: app.integrations.x_ads.put_accounts_account_id
Full name: x-ads.x_ads_put_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	no	optional
`industry_type`	string	no	optional

delete_accounts_account_id Write

X Ads API operation: Campaign Management / Accounts accounts/:account_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id
Full name: x-ads.x_ads_delete_accounts_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_authenticated_user_access Read

X Ads API operation: Campaign Management / Authenticated User Access accounts/:account_id/authenticated_user_access.

Lua path: app.integrations.x_ads.get_accounts_account_id_authenticated_user_access
Full name: x-ads.x_ads_get_accounts_account_id_authenticated_user_access

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_bidding_rules Read

X Ads API operation: Campaign Management / Bidding Rules bidding_rules.

Lua path: app.integrations.x_ads.get_bidding_rules
Full name: x-ads.x_ads_get_bidding_rules

Parameter	Type	Required	Description
`currency`	string	no	optional

get_accounts_account_id_campaigns Read

X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns.

Lua path: app.integrations.x_ads.get_accounts_account_id_campaigns
Full name: x-ads.x_ads_get_accounts_account_id_campaigns

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`campaign_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`funding_instrument_ids`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_draft`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_campaigns_campaign_id Read

X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_campaigns_campaign_id
Full name: x-ads.x_ads_get_accounts_account_id_campaigns_campaign_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_campaigns Write

X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns.

Lua path: app.integrations.x_ads.post_accounts_account_id_campaigns
Full name: x-ads.x_ads_post_accounts_account_id_campaigns

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`funding_instrument_id`	string	yes	required
`name`	string	yes	required
`start_time`	string	yes	required
`daily_budget_amount_local_micro`	string	no	optional
`duration_in_days`	string	no	optional
`end_time`	string	no	optional
`entity_status`	string	no	optional
`frequency_cap`	string	no	optional
`standard_delivery`	string	no	optional
`total_budget_amount_local_micro`	string	no	optional

post_batch_accounts_account_id_campaigns Write

X Ads API operation: Campaign Management / Campaigns batch/accounts/:account_id/campaigns.

Lua path: app.integrations.x_ads.post_batch_accounts_account_id_campaigns
Full name: x-ads.x_ads_post_batch_accounts_account_id_campaigns

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`operation_type`	string	yes	required
`params`	string	yes	required

put_accounts_account_id_campaigns_campaign_id Write

X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_campaigns_campaign_id
Full name: x-ads.x_ads_put_accounts_account_id_campaigns_campaign_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`daily_budget_amount_local_micro`	string	no	optional
`end_time`	string	no	optional
`entity_status`	string	no	optional
`duration_in_days`	string	no	optional
`frequency_cap`	string	no	optional
`name`	string	no	optional
`standard_delivery`	string	no	optional
`start_time`	string	no	optional
`total_budget_amount_local_micro`	string	no	optional

delete_accounts_account_id_campaigns_campaign_id Write

X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_campaigns_campaign_id
Full name: x-ads.x_ads_delete_accounts_account_id_campaigns_campaign_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_content_categories Read

X Ads API operation: Campaign Management / Content Categories content_categories.

Lua path: app.integrations.x_ads.get_content_categories
Full name: x-ads.x_ads_get_content_categories

Parameter	Type	Required	Description
No parameters.

get_accounts_account_id_features Read

X Ads API operation: Campaign Management / Features accounts/:account_id/features.

Lua path: app.integrations.x_ads.get_accounts_account_id_features
Full name: x-ads.x_ads_get_accounts_account_id_features

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`feature_keys`	string	no	optional

post_accounts_account_id_features Write

X Ads API operation: Campaign Management / Features accounts/:account_id/features.

Lua path: app.integrations.x_ads.post_accounts_account_id_features
Full name: x-ads.x_ads_post_accounts_account_id_features

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`feature_keys`	string	yes	required

delete_accounts_account_id_features Write

X Ads API operation: Campaign Management / Features accounts/:account_id/features.

Lua path: app.integrations.x_ads.delete_accounts_account_id_features
Full name: x-ads.x_ads_delete_accounts_account_id_features

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`feature_keys`	string	yes	required

get_accounts_account_id_funding_instruments Read

X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments.

Lua path: app.integrations.x_ads.get_accounts_account_id_funding_instruments
Full name: x-ads.x_ads_get_accounts_account_id_funding_instruments

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`funding_instrument_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_funding_instruments_funding_instrument_id Read

X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments/:funding_instrument_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_funding_instruments_funding_instrument_id
Full name: x-ads.x_ads_get_accounts_account_id_funding_instruments_funding_instrument_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`funding_instrument_id`	string	yes	required
`with_deleted`	string	no	optional

post_accounts_account_id_funding_instruments Write

X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments.

Lua path: app.integrations.x_ads.post_accounts_account_id_funding_instruments
Full name: x-ads.x_ads_post_accounts_account_id_funding_instruments

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`currency`	string	yes	required
`start_time`	string	yes	required
`type`	string	yes	required
`end_time`	string	no	sometimes required
`credit_limit_local_micro`	string	no	optional
`funded_amount_local_micro`	string	no	optional

put_accounts_account_id_funding_instruments_funding_instrument_id Write

X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments/:funding_instrument_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_funding_instruments_funding_instrument_id
Full name: x-ads.x_ads_put_accounts_account_id_funding_instruments_funding_instrument_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`funding_instrument_id`	string	yes	required
`funded_amount_local_micro`	string	no	optional
`paused`	string	no	optional

delete_accounts_account_id_funding_instruments_funding_instrument_id Write

X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments/:funding_instrument_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_funding_instruments_funding_instrument_id
Full name: x-ads.x_ads_delete_accounts_account_id_funding_instruments_funding_instrument_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`funding_instrument_id`	string	yes	required

get_iab_categories Read

X Ads API operation: Campaign Management / IAB Categories iab_categories.

Lua path: app.integrations.x_ads.get_iab_categories
Full name: x-ads.x_ads_get_iab_categories

Parameter	Type	Required	Description
`count`	string	no	optional
`cursor`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_line_items Read

X Ads API operation: Campaign Management / Line Items accounts/:account_id/line_items.

Lua path: app.integrations.x_ads.get_accounts_account_id_line_items
Full name: x-ads.x_ads_get_accounts_account_id_line_items

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`campaign_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`funding_instrument_ids`	string	no	optional
`line_item_ids`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_draft`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_line_items_line_item_id Read

X Ads API operation: Campaign Management / Line Items accounts/:account_id/line_items/:line_item_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_line_items_line_item_id
Full name: x-ads.x_ads_get_accounts_account_id_line_items_line_item_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_line_items Write

X Ads API operation: Campaign Management / Line Items accounts/:account_id/line_items.

Lua path: app.integrations.x_ads.post_accounts_account_id_line_items
Full name: x-ads.x_ads_post_accounts_account_id_line_items

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`campaign_id`	string	yes	required
`objective`	string	yes	required
`placements`	string	yes	required
`product_type`	string	yes	required
`advertiser_domain`	string	no	sometimes required
`bid_amount_local_micro`	string	no	sometimes required
`categories`	string	no	sometimes required
`primary_web_event_tag`	string	no	sometimes required
`advertiser_user_id`	string	no	optional
`automatically_select_bid`	string	no	optional
`bid_type`	string	no	optional
`bid_unit`	string	no	optional
`charge_by`	string	no	optional
`end_time`	string	no	optional
`entity_status`	string	no	optional
`include_sentiment`	string	no	optional
`audience_expansion`	string	no	optional
`name`	string	no	optional
`optimization`	string	no	optional
`start_time`	string	no	optional
`total_budget_amount_local_micro`	string	no	optional
`tracking_tags`	string	no	optional

post_batch_accounts_account_id_line_items Write

X Ads API operation: Campaign Management / Line Items batch/accounts/:account_id/line_items.

Lua path: app.integrations.x_ads.post_batch_accounts_account_id_line_items
Full name: x-ads.x_ads_post_batch_accounts_account_id_line_items

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`operation_type`	string	yes	required
`params`	string	yes	required

put_accounts_account_id_line_items_line_item_id Write

X Ads API operation: Campaign Management / Line Items accounts/:account_id/line_items/:line_item_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_line_items_line_item_id
Full name: x-ads.x_ads_put_accounts_account_id_line_items_line_item_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`advertiser_domain`	string	no	optional
`advertiser_user_id`	string	no	optional
`automatically_select_bid`	string	no	optional
`bid_amount_local_micro`	string	no	optional
`bid_type`	string	no	optional
`categories`	string	no	optional
`end_time`	string	no	optional
`entity_status`	string	no	optional
`include_sentiment`	string	no	optional
`audience_expansion`	string	no	optional
`name`	string	no	optional
`optimization`	string	no	optional
`start_time`	string	no	optional
`total_budget_amount_local_micro`	string	no	optional
`tracking_tags`	string	no	optional

delete_accounts_account_id_line_items_line_item_id Write

X Ads API operation: Campaign Management / Line Items accounts/:account_id/line_items/:line_item_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_line_items_line_item_id
Full name: x-ads.x_ads_delete_accounts_account_id_line_items_line_item_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_line_item_apps Read

X Ads API operation: Campaign Management / Line Item Apps accounts/:account_id/line_item_apps.

Lua path: app.integrations.x_ads.get_accounts_account_id_line_item_apps
Full name: x-ads.x_ads_get_accounts_account_id_line_item_apps

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`line_item_ids`	string	no	optional
`line_item_app_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_line_item_apps_line_item_app_id Read

X Ads API operation: Campaign Management / Line Item Apps accounts/:account_id/line_item_apps/:line_item_app_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_line_item_apps_line_item_app_id
Full name: x-ads.x_ads_get_accounts_account_id_line_item_apps_line_item_app_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_line_item_apps Write

X Ads API operation: Campaign Management / Line Item Apps accounts/:account_id/line_item_apps.

Lua path: app.integrations.x_ads.post_accounts_account_id_line_item_apps
Full name: x-ads.x_ads_post_accounts_account_id_line_item_apps

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_store_identifier`	string	yes	required
`line_item_id`	string	yes	required
`os_type`	string	yes	required

delete_accounts_account_id_line_item_apps_line_item_app_id Write

X Ads API operation: Campaign Management / Line Item Apps accounts/:account_id/line_item_apps/:line_item_app_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_line_item_apps_line_item_app_id
Full name: x-ads.x_ads_delete_accounts_account_id_line_item_apps_line_item_app_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_line_items_placements Read

X Ads API operation: Campaign Management / Line Item Placements line_items/placements.

Lua path: app.integrations.x_ads.get_line_items_placements
Full name: x-ads.x_ads_get_line_items_placements

Parameter	Type	Required	Description
`product_type`	string	no	optional

get_accounts_account_id_media_creatives Read

X Ads API operation: Campaign Management / Media Creatives accounts/:account_id/media_creatives.

Lua path: app.integrations.x_ads.get_accounts_account_id_media_creatives
Full name: x-ads.x_ads_get_accounts_account_id_media_creatives

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`campaign_id`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`line_item_ids`	string	no	optional
`media_creative_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_media_creatives_media_creative_id Read

X Ads API operation: Campaign Management / Media Creatives accounts/:account_id/media_creatives/:media_creative_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_media_creatives_media_creative_id
Full name: x-ads.x_ads_get_accounts_account_id_media_creatives_media_creative_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_media_creatives Write

X Ads API operation: Campaign Management / Media Creatives accounts/:account_id/media_creatives.

Lua path: app.integrations.x_ads.post_accounts_account_id_media_creatives
Full name: x-ads.x_ads_post_accounts_account_id_media_creatives

Parameter	Type	Required	Description
`account_id`	string	yes	required
`account_media_id`	string	yes	required
`line_item_id`	string	yes	required
`landing_url`	string	no	optional

delete_accounts_account_id_media_creatives_media_creative_id Write

X Ads API operation: Campaign Management / Media Creatives accounts/:account_id/media_creatives/:media_creative_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_media_creatives_media_creative_id
Full name: x-ads.x_ads_delete_accounts_account_id_media_creatives_media_creative_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_promoted_accounts Read

X Ads API operation: Campaign Management / Promoted Accounts accounts/:account_id/promoted_accounts.

Lua path: app.integrations.x_ads.get_accounts_account_id_promoted_accounts
Full name: x-ads.x_ads_get_accounts_account_id_promoted_accounts

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`line_item_ids`	string	no	optional
`promoted_account_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_promoted_accounts_promoted_account_id Read

X Ads API operation: Campaign Management / Promoted Accounts accounts/:account_id/promoted_accounts/:promoted_account_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_promoted_accounts_promoted_account_id
Full name: x-ads.x_ads_get_accounts_account_id_promoted_accounts_promoted_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_promoted_accounts Write

X Ads API operation: Campaign Management / Promoted Accounts accounts/:account_id/promoted_accounts.

Lua path: app.integrations.x_ads.post_accounts_account_id_promoted_accounts
Full name: x-ads.x_ads_post_accounts_account_id_promoted_accounts

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_id`	string	yes	required
`user_id`	string	yes	required

delete_accounts_account_id_promoted_accounts_promoted_account_id Write

X Ads API operation: Campaign Management / Promoted Accounts accounts/:account_id/promoted_accounts/:promoted_account_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_promoted_accounts_promoted_account_id
Full name: x-ads.x_ads_delete_accounts_account_id_promoted_accounts_promoted_account_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_promoted_tweets Read

X Ads API operation: Campaign Management / Promoted Tweets accounts/:account_id/promoted_tweets.

Lua path: app.integrations.x_ads.get_accounts_account_id_promoted_tweets
Full name: x-ads.x_ads_get_accounts_account_id_promoted_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`line_item_ids`	string	no	optional
`promoted_tweet_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_promoted_tweets_promoted_tweet_id Read

X Ads API operation: Campaign Management / Promoted Tweets accounts/:account_id/promoted_tweets/:promoted_tweet_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_promoted_tweets_promoted_tweet_id
Full name: x-ads.x_ads_get_accounts_account_id_promoted_tweets_promoted_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_promoted_tweets Write

X Ads API operation: Campaign Management / Promoted Tweets accounts/:account_id/promoted_tweets.

Lua path: app.integrations.x_ads.post_accounts_account_id_promoted_tweets
Full name: x-ads.x_ads_post_accounts_account_id_promoted_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_id`	string	yes	required
`tweet_ids`	string	yes	required

delete_accounts_account_id_promoted_tweets_promoted_tweet_id Write

X Ads API operation: Campaign Management / Promoted Tweets accounts/:account_id/promoted_tweets/:promoted_tweet_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_promoted_tweets_promoted_tweet_id
Full name: x-ads.x_ads_delete_accounts_account_id_promoted_tweets_promoted_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_promotable_users Read

X Ads API operation: Campaign Management / Promotable Users accounts/:account_id/promotable_users.

Lua path: app.integrations.x_ads.get_accounts_account_id_promotable_users
Full name: x-ads.x_ads_get_accounts_account_id_promotable_users

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`promotable_user_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_promotable_users_promotable_user_id Read

X Ads API operation: Campaign Management / Promotable Users accounts/:account_id/promotable_users/:promotable_user_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_promotable_users_promotable_user_id
Full name: x-ads.x_ads_get_accounts_account_id_promotable_users_promotable_user_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`promotable_user_id`	string	no	optional
`with_deleted`	string	no	optional

get_accounts_account_id_scheduled_promoted_tweets Read

X Ads API operation: Campaign Management / Scheduled Promoted Tweets accounts/:account_id/scheduled_promoted_tweets.

Lua path: app.integrations.x_ads.get_accounts_account_id_scheduled_promoted_tweets
Full name: x-ads.x_ads_get_accounts_account_id_scheduled_promoted_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`line_item_ids`	string	no	optional
`scheduled_promoted_tweet_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id Read

X Ads API operation: Campaign Management / Scheduled Promoted Tweets accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id
Full name: x-ads.x_ads_get_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`scheduled_promoted_tweet_id`	string	yes	required
`with_deleted`	string	no	optional

post_accounts_account_id_scheduled_promoted_tweets Write

X Ads API operation: Campaign Management / Scheduled Promoted Tweets accounts/:account_id/scheduled_promoted_tweets.

Lua path: app.integrations.x_ads.post_accounts_account_id_scheduled_promoted_tweets
Full name: x-ads.x_ads_post_accounts_account_id_scheduled_promoted_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_id`	string	yes	required
`scheduled_tweet_id`	string	yes	required

delete_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id Write

X Ads API operation: Campaign Management / Scheduled Promoted Tweets accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id
Full name: x-ads.x_ads_delete_accounts_account_id_scheduled_promoted_tweets_scheduled_promoted_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`scheduled_promoted_tweet_id`	string	yes	required

get_accounts_account_id_targeting_criteria Read

X Ads API operation: Campaign Management / Targeting Criteria accounts/:account_id/targeting_criteria.

Lua path: app.integrations.x_ads.get_accounts_account_id_targeting_criteria
Full name: x-ads.x_ads_get_accounts_account_id_targeting_criteria

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_ids`	string	yes	required
`count`	string	no	optional
`cursor`	string	no	optional
`lang`	string	no	optional
`sort_by`	string	no	optional
`targeting_criterion_ids`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_targeting_criteria_targeting_criterion_id Read

X Ads API operation: Campaign Management / Targeting Criteria accounts/:account_id/targeting_criteria/:targeting_criterion_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_targeting_criteria_targeting_criterion_id
Full name: x-ads.x_ads_get_accounts_account_id_targeting_criteria_targeting_criterion_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`lang`	string	no	optional
`with_deleted`	string	no	optional

post_accounts_account_id_targeting_criteria Write

X Ads API operation: Campaign Management / Targeting Criteria accounts/:account_id/targeting_criteria.

Lua path: app.integrations.x_ads.post_accounts_account_id_targeting_criteria
Full name: x-ads.x_ads_post_accounts_account_id_targeting_criteria

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_id`	string	yes	required
`targeting_type`	string	yes	required
`targeting_value`	string	yes	required
`tailored_audience_expansion`	string	no	optional
`operator_type`	string	no	optional

post_batch_accounts_account_id_targeting_criteria Write

X Ads API operation: Campaign Management / Targeting Criteria batch/accounts/:account_id/targeting_criteria.

Lua path: app.integrations.x_ads.post_batch_accounts_account_id_targeting_criteria
Full name: x-ads.x_ads_post_batch_accounts_account_id_targeting_criteria

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`operation_type`	string	yes	required
`params`	string	yes	required

delete_accounts_account_id_targeting_criteria_targeting_criterion_id Write

X Ads API operation: Campaign Management / Targeting Criteria accounts/:account_id/targeting_criteria/:targeting_criterion_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_targeting_criteria_targeting_criterion_id
Full name: x-ads.x_ads_delete_accounts_account_id_targeting_criteria_targeting_criterion_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_targeting_criteria_app_store_categories Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/app_store_categories.

Lua path: app.integrations.x_ads.get_targeting_criteria_app_store_categories
Full name: x-ads.x_ads_get_targeting_criteria_app_store_categories

Parameter	Type	Required	Description
`q`	string	no	optional
`os_type`	string	no	optional

get_targeting_criteria_behavior_taxonomies Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/behavior_taxonomies.

Lua path: app.integrations.x_ads.get_targeting_criteria_behavior_taxonomies
Full name: x-ads.x_ads_get_targeting_criteria_behavior_taxonomies

Parameter	Type	Required	Description
`count`	string	no	optional
`cursor`	string	no	optional
`parent_behavior_taxonomy_ids`	string	no	optional
`sort_by`	string	no	optional
`with_total_count`	string	no	optional

get_targeting_criteria_behaviors Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/behaviors.

Lua path: app.integrations.x_ads.get_targeting_criteria_behaviors
Full name: x-ads.x_ads_get_targeting_criteria_behaviors

Parameter	Type	Required	Description
`count`	string	no	optional
`country_code`	string	no	optional
`cursor`	string	no	optional
`sort_by`	string	no	optional
`with_total_count`	string	no	optional

get_targeting_criteria_conversations Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/conversations.

Lua path: app.integrations.x_ads.get_targeting_criteria_conversations
Full name: x-ads.x_ads_get_targeting_criteria_conversations

Parameter	Type	Required	Description
`conversation_type`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional

get_targeting_criteria_devices Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/devices.

Lua path: app.integrations.x_ads.get_targeting_criteria_devices
Full name: x-ads.x_ads_get_targeting_criteria_devices

Parameter	Type	Required	Description
`count`	string	no	optional
`q`	string	no	optional
`os_type`	string	no	optional

get_targeting_criteria_events Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/events.

Lua path: app.integrations.x_ads.get_targeting_criteria_events
Full name: x-ads.x_ads_get_targeting_criteria_events

Parameter	Type	Required	Description
`event_types`	string	yes	required
`count`	string	no	optional
`country_codes`	string	no	optional
`cursor`	string	no	optional
`end_time`	string	no	optional
`start_time`	string	no	optional

get_targeting_criteria_interests Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/interests.

Lua path: app.integrations.x_ads.get_targeting_criteria_interests
Full name: x-ads.x_ads_get_targeting_criteria_interests

Parameter	Type	Required	Description
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional

get_targeting_criteria_languages Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/languages.

Lua path: app.integrations.x_ads.get_targeting_criteria_languages
Full name: x-ads.x_ads_get_targeting_criteria_languages

Parameter	Type	Required	Description
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional

get_targeting_criteria_locations Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/locations.

Lua path: app.integrations.x_ads.get_targeting_criteria_locations
Full name: x-ads.x_ads_get_targeting_criteria_locations

Parameter	Type	Required	Description
`count`	string	no	optional
`country_code`	string	no	optional
`cursor`	string	no	optional
`location_type`	string	no	optional
`q`	string	no	optional

get_targeting_criteria_network_operators Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/network_operators.

Lua path: app.integrations.x_ads.get_targeting_criteria_network_operators
Full name: x-ads.x_ads_get_targeting_criteria_network_operators

Parameter	Type	Required	Description
`count`	string	no	optional
`country_code`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional

get_targeting_criteria_platform_versions Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/platform_versions.

Lua path: app.integrations.x_ads.get_targeting_criteria_platform_versions
Full name: x-ads.x_ads_get_targeting_criteria_platform_versions

Parameter	Type	Required	Description
`q`	string	no	optional
`os_type`	string	no	optional

get_targeting_criteria_platforms Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/platforms.

Lua path: app.integrations.x_ads.get_targeting_criteria_platforms
Full name: x-ads.x_ads_get_targeting_criteria_platforms

Parameter	Type	Required	Description
`count`	string	no	optional
`q`	string	no	optional
`lang`	string	no	optional

get_targeting_criteria_tv_markets Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/tv_markets.

Lua path: app.integrations.x_ads.get_targeting_criteria_tv_markets
Full name: x-ads.x_ads_get_targeting_criteria_tv_markets

Parameter	Type	Required	Description
No parameters.

get_targeting_criteria_tv_shows Read

X Ads API operation: Campaign Management / Targeting Options targeting_criteria/tv_shows.

Lua path: app.integrations.x_ads.get_targeting_criteria_tv_shows
Full name: x-ads.x_ads_get_targeting_criteria_tv_shows

Parameter	Type	Required	Description
`locale`	string	yes	required
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional

get_accounts_account_id_targeting_suggestions Read

X Ads API operation: Campaign Management / Targeting Suggestions accounts/:account_id/targeting_suggestions.

Lua path: app.integrations.x_ads.get_accounts_account_id_targeting_suggestions
Full name: x-ads.x_ads_get_accounts_account_id_targeting_suggestions

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`suggestion_type`	string	yes	required
`targeting_values`	string	yes	required
`count`	string	no	optional

get_accounts_account_id_tax_settings Read

X Ads API operation: Campaign Management / Tax Settings accounts/:account_id/tax_settings.

Lua path: app.integrations.x_ads.get_accounts_account_id_tax_settings
Full name: x-ads.x_ads_get_accounts_account_id_tax_settings

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

put_accounts_account_id_tax_settings Write

X Ads API operation: Campaign Management / Tax Settings accounts/:account_id/tax_settings.

Lua path: app.integrations.x_ads.put_accounts_account_id_tax_settings
Full name: x-ads.x_ads_put_accounts_account_id_tax_settings

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`address_city`	string	no	optional
`address_country`	string	no	optional
`address_email`	string	no	optional
`address_first_name`	string	no	optional
`address_last_name`	string	no	optional
`address_name`	string	no	optional
`address_postal_code`	string	no	optional
`address_region`	string	no	optional
`address_street1`	string	no	optional
`address_street2`	string	no	optional
`bill_to`	string	no	optional
`business_relationship`	string	no	optional
`client_address_city`	string	no	optional
`client_address_country`	string	no	optional
`client_address_email`	string	no	optional
`client_address_first_name`	string	no	optional
`client_address_last_name`	string	no	optional
`client_address_name`	string	no	optional
`client_address_postal_code`	string	no	optional
`client_address_region`	string	no	optional
`client_address_street1`	string	no	optional
`client_address_street2`	string	no	optional
`invoice_jurisdiction`	string	no	optional
`tax_category`	string	no	optional
`tax_exemption_id`	string	no	optional
`tax_id`	string	no	optional

get_accounts_account_id_user_settings_user_id Read

X Ads API operation: Campaign Management / User Settings accounts/:account_id/user_settings/:user_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_user_settings_user_id
Full name: x-ads.x_ads_get_accounts_account_id_user_settings_user_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`user_id`	string	yes	required

put_accounts_account_id_user_settings_user_id Write

X Ads API operation: Campaign Management / User Settings accounts/:account_id/user_settings/:user_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_user_settings_user_id
Full name: x-ads.x_ads_put_accounts_account_id_user_settings_user_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`user_id`	string	yes	required
`notification_email`	string	no	optional
`contact_phone`	string	no	optional
`contact_phone_extension`	string	no	optional
`subscribed_email_types`	string	no	optional

get_advertiser_business_categories Read

X Ads API operation: Campaign Management / Advertiser Business Categories advertiser_business_categories.

Lua path: app.integrations.x_ads.get_advertiser_business_categories
Full name: x-ads.x_ads_get_advertiser_business_categories

Parameter	Type	Required	Description
No parameters.

post_accounts_account_id_audience_summary Write

X Ads API operation: Campaign Management / Audience Summary accounts/:account_id/audience_summary.

Lua path: app.integrations.x_ads.post_accounts_account_id_audience_summary
Full name: x-ads.x_ads_post_accounts_account_id_audience_summary

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`targeting_criteria`	string	yes	required

get_accounts_account_id_account_media Read

X Ads API operation: Creatives / Account Media accounts/:account_id/account_media.

Lua path: app.integrations.x_ads.get_accounts_account_id_account_media
Full name: x-ads.x_ads_get_accounts_account_id_account_media

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`account_media_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_account_media_account_media_id Read

X Ads API operation: Creatives / Account Media accounts/:account_id/account_media/:account_media_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_account_media_account_media_id
Full name: x-ads.x_ads_get_accounts_account_id_account_media_account_media_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

delete_accounts_account_id_account_media_account_media_id Write

X Ads API operation: Creatives / Account Media accounts/:account_id/account_media/:account_media_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_account_media_account_media_id
Full name: x-ads.x_ads_delete_accounts_account_id_account_media_account_media_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_all Read

X Ads API operation: Creatives / Cards Fetch accounts/:account_id/cards/all.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_all
Full name: x-ads.x_ads_get_accounts_account_id_cards_all

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_uris`	string	yes	required
`with_deleted`	string	no	optional

get_accounts_account_id_cards_all_card_id Read

X Ads API operation: Creatives / Cards Fetch accounts/:account_id/cards/all/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_all_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_all_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

get_accounts_account_id_tweets Read

X Ads API operation: Creatives / Tweets accounts/:account_id/tweets.

Lua path: app.integrations.x_ads.get_accounts_account_id_tweets
Full name: x-ads.x_ads_get_accounts_account_id_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`tweet_type`	string	yes	required
`count`	string	no	optional
`cursor`	string	no	optional
`timeline_type`	string	no	optional
`trim_user`	string	no	optional
`tweet_ids`	string	no	optional
`user_id`	string	no	optional

post_accounts_account_id_tweet Write

X Ads API operation: Creatives / Tweets accounts/:account_id/tweet.

Lua path: app.integrations.x_ads.post_accounts_account_id_tweet
Full name: x-ads.x_ads_post_accounts_account_id_tweet

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`as_user_id`	string	yes	required
`text`	string	no	sometimes required
`card_uri`	string	no	optional
`media_keys`	string	no	optional
`nullcast`	string	no	optional
`trim_user`	string	no	optional
`tweet_mode`	string	no	optional
`video_cta`	string	no	optional
`video_cta_value`	string	no	optional
`video_description`	string	no	optional
`video_title`	string	no	optional

get_accounts_account_id_draft_tweets Read

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets.

Lua path: app.integrations.x_ads.get_accounts_account_id_draft_tweets
Full name: x-ads.x_ads_get_accounts_account_id_draft_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`user_id`	string	no	optional

get_accounts_account_id_draft_tweets_draft_tweet_id Read

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets/:draft_tweet_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_draft_tweets_draft_tweet_id
Full name: x-ads.x_ads_get_accounts_account_id_draft_tweets_draft_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

post_accounts_account_id_draft_tweets Write

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets.

Lua path: app.integrations.x_ads.post_accounts_account_id_draft_tweets
Full name: x-ads.x_ads_post_accounts_account_id_draft_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`as_user_id`	string	yes	required
`text`	string	no	sometimes required
`card_uri`	string	no	optional
`media_keys`	string	no	optional
`nullcast`	string	no	optional

put_accounts_account_id_draft_tweets_draft_tweet_id Write

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets/:draft_tweet_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_draft_tweets_draft_tweet_id
Full name: x-ads.x_ads_put_accounts_account_id_draft_tweets_draft_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_uri`	string	no	optional
`media_keys`	string	no	optional
`nullcast`	string	no	optional
`text`	string	no	optional

delete_accounts_account_id_draft_tweets_draft_tweet_id Write

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets/:draft_tweet_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_draft_tweets_draft_tweet_id
Full name: x-ads.x_ads_delete_accounts_account_id_draft_tweets_draft_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

post_accounts_account_id_draft_tweets_preview_draft_tweet_id Write

X Ads API operation: Creatives / Draft Tweets accounts/:account_id/draft_tweets/preview/:draft_tweet_id.

Lua path: app.integrations.x_ads.post_accounts_account_id_draft_tweets_preview_draft_tweet_id
Full name: x-ads.x_ads_post_accounts_account_id_draft_tweets_preview_draft_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_scheduled_tweets Read

X Ads API operation: Creatives / Scheduled Tweets accounts/:account_id/scheduled_tweets.

Lua path: app.integrations.x_ads.get_accounts_account_id_scheduled_tweets
Full name: x-ads.x_ads_get_accounts_account_id_scheduled_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`user_id`	string	no	optional

get_accounts_account_id_scheduled_tweets_scheduled_tweet_id Read

X Ads API operation: Creatives / Scheduled Tweets accounts/:account_id/scheduled_tweets/:scheduled_tweet_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_scheduled_tweets_scheduled_tweet_id
Full name: x-ads.x_ads_get_accounts_account_id_scheduled_tweets_scheduled_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`scheduled_tweet_id`	string	yes	required

post_accounts_account_id_scheduled_tweets Write

X Ads API operation: Creatives / Scheduled Tweets accounts/:account_id/scheduled_tweets.

Lua path: app.integrations.x_ads.post_accounts_account_id_scheduled_tweets
Full name: x-ads.x_ads_post_accounts_account_id_scheduled_tweets

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`as_user_id`	string	yes	required
`scheduled_at`	string	yes	required
`text`	string	no	sometimes required
`card_uri`	string	no	optional
`media_keys`	string	no	optional
`nullcast`	string	no	optional

put_accounts_account_id_scheduled_tweets_scheduled_tweet_id Write

X Ads API operation: Creatives / Scheduled Tweets accounts/:account_id/scheduled_tweets/:scheduled_tweet_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_scheduled_tweets_scheduled_tweet_id
Full name: x-ads.x_ads_put_accounts_account_id_scheduled_tweets_scheduled_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`scheduled_tweet_id`	string	yes	required
`card_uri`	string	no	optional
`media_keys`	string	no	optional
`nullcast`	string	no	optional
`scheduled_at`	string	no	optional
`text`	string	no	optional

delete_accounts_account_id_scheduled_tweets_scheduled_tweet_id Write

X Ads API operation: Creatives / Scheduled Tweets accounts/:account_id/scheduled_tweets/:scheduled_tweet_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_scheduled_tweets_scheduled_tweet_id
Full name: x-ads.x_ads_delete_accounts_account_id_scheduled_tweets_scheduled_tweet_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`scheduled_tweet_id`	string	yes	required

get_accounts_account_id_cards_website Read

X Ads API operation: Creatives / Website Cards accounts/:account_id/cards/website.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_website
Full name: x-ads.x_ads_get_accounts_account_id_cards_website

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_website_card_id Read

X Ads API operation: Creatives / Website Cards accounts/:account_id/cards/website/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_website_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_website Write

X Ads API operation: Creatives / Website Cards accounts/:account_id/cards/website.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_website
Full name: x-ads.x_ads_post_accounts_account_id_cards_website

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	yes	required
`website_title`	string	yes	required
`website_url`	string	yes	required
`media_key`	string	no	sometimes required

put_accounts_account_id_cards_website_card_id Write

X Ads API operation: Creatives / Website Cards accounts/:account_id/cards/website/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_website_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`media_key`	string	no	optional
`name`	string	no	optional
`website_title`	string	no	optional
`website_url`	string	no	optional

delete_accounts_account_id_cards_website_card_id Write

X Ads API operation: Creatives / Website Cards accounts/:account_id/cards/website/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_website_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_video_website Read

X Ads API operation: Creatives / Video Website Cards accounts/:account_id/cards/video_website.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_website
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_website

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_video_website_card_id Read

X Ads API operation: Creatives / Video Website Cards accounts/:account_id/cards/video_website/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_website_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_video_website Write

X Ads API operation: Creatives / Video Website Cards accounts/:account_id/cards/video_website.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_video_website
Full name: x-ads.x_ads_post_accounts_account_id_cards_video_website

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	yes	required
`title`	string	yes	required
`media_key`	string	yes	required
`website_url`	string	yes	required

put_accounts_account_id_cards_video_website_card_id Write

X Ads API operation: Creatives / Video Website Cards accounts/:account_id/cards/video_website/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_video_website_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_video_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	no	optional
`title`	string	no	optional
`media_key`	string	no	optional
`website_url`	string	no	optional

delete_accounts_account_id_cards_video_website_card_id Write

X Ads API operation: Creatives / Video Website Cards accounts/:account_id/cards/video_website/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_video_website_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_video_website_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_image_app_download Read

X Ads API operation: Creatives / Image App Download Cards accounts/:account_id/cards/image_app_download.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_app_download
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_app_download

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_image_app_download_card_id Read

X Ads API operation: Creatives / Image App Download Cards accounts/:account_id/cards/image_app_download/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_app_download_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_image_app_download Write

X Ads API operation: Creatives / Image App Download Cards accounts/:account_id/cards/image_app_download.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_image_app_download
Full name: x-ads.x_ads_post_accounts_account_id_cards_image_app_download

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`name`	string	yes	required
`country_code`	string	yes	required
`ipad_app_id`	string	no	sometimes required
`iphone_app_id`	string	no	sometimes required
`googleplay_app_id`	string	no	sometimes required
`app_cta`	string	no	optional
`ipad_deep_link`	string	no	optional
`iphone_deep_link`	string	no	optional
`googleplay_deep_link`	string	no	optional
`media_key`	string	no	sometimes required

put_accounts_account_id_cards_image_app_download_card_id Write

X Ads API operation: Creatives / Image App Download Cards accounts/:account_id/cards/image_app_download/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_image_app_download_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_image_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`country_code`	string	no	optional
`app_cta`	string	no	optional
`ipad_app_id`	string	no	optional
`ipad_deep_link`	string	no	optional
`iphone_app_id`	string	no	optional
`iphone_deep_link`	string	no	optional
`googleplay_app_id`	string	no	optional
`googleplay_deep_link`	string	no	optional
`name`	string	no	optional
`media_key`	string	no	optional

delete_accounts_account_id_cards_image_app_download_card_id Write

X Ads API operation: Creatives / Image App Download Cards accounts/:account_id/cards/image_app_download/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_image_app_download_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_image_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_image_conversation Read

X Ads API operation: Creatives / Image Conversation Cards accounts/:account_id/cards/image_conversation.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_conversation
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_conversation

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_image_conversation_card_id Read

X Ads API operation: Creatives / Image Conversation Cards accounts/:account_id/cards/image_conversation/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_conversation_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_image_conversation Write

X Ads API operation: Creatives / Image Conversation Cards accounts/:account_id/cards/image_conversation.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_image_conversation
Full name: x-ads.x_ads_post_accounts_account_id_cards_image_conversation

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`first_cta`	string	yes	required
`first_cta_tweet`	string	yes	required
`name`	string	yes	required
`thank_you_text`	string	yes	required
`media_key`	string	no	sometimes required
`second_cta`	string	no	sometimes required
`second_cta_tweet`	string	no	sometimes required
`title`	string	no	sometimes required
`unlocked_image_media_key`	string	no	optional
`third_cta`	string	no	optional
`third_cta_tweet`	string	no	sometimes required
`fourth_cta`	string	no	optional
`fourth_cta_tweet`	string	no	sometimes required
`thank_you_url`	string	no	optional

put_accounts_account_id_cards_image_conversation_card_id Write

X Ads API operation: Creatives / Image Conversation Cards accounts/:account_id/cards/image_conversation/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_image_conversation_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_image_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`unlocked_image_media_key`	string	no	optional
`media_key`	string	no	optional
`first_cta`	string	no	optional
`first_cta_tweet`	string	no	optional
`second_cta`	string	no	optional
`second_cta_tweet`	string	no	optional
`third_cta`	string	no	optional
`third_cta_tweet`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_tweet`	string	no	optional
`name`	string	no	optional
`thank_you_text`	string	no	optional
`thank_you_url`	string	no	optional
`title`	string	no	optional

delete_accounts_account_id_cards_image_conversation_card_id Write

X Ads API operation: Creatives / Image Conversation Cards accounts/:account_id/cards/image_conversation/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_image_conversation_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_image_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_image_direct_message Read

X Ads API operation: Creatives / Image Direct Message Cards accounts/:account_id/cards/image_direct_message.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_direct_message
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_direct_message

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_image_direct_message_card_id Read

X Ads API operation: Creatives / Image Direct Message Cards accounts/:account_id/cards/image_direct_message/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_image_direct_message_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_image_direct_message_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_image_direct_message Write

X Ads API operation: Creatives / Image Direct Message Cards accounts/:account_id/cards/image_direct_message.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_image_direct_message
Full name: x-ads.x_ads_post_accounts_account_id_cards_image_direct_message

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`first_cta`	string	yes	required
`first_cta_welcome_message_id`	string	yes	required
`name`	string	yes	required
`recipient_user_id`	string	yes	required
`media_key`	string	no	sometimes required
`second_cta`	string	no	optional
`second_cta_welcome_message_id`	string	no	optional
`third_cta`	string	no	optional
`third_cta_welcome_message_id`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_welcome_message_id`	string	no	optional

put_accounts_account_id_cards_image_direct_message Write

X Ads API operation: Creatives / Image Direct Message Cards accounts/:account_id/cards/image_direct_message.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_image_direct_message
Full name: x-ads.x_ads_put_accounts_account_id_cards_image_direct_message

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_id`	string	yes	required
`first_cta`	string	no	optional
`first_cta_welcome_message_id`	string	no	optional
`media_key`	string	no	optional
`second_cta`	string	no	optional
`second_cta_welcome_message_id`	string	no	optional
`third_cta`	string	no	optional
`third_cta_welcome_message_id`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_welcome_message_id`	string	no	optional
`name`	string	no	optional

delete_accounts_account_id_cards_image_direct_message_card_id Write

X Ads API operation: Creatives / Image Direct Message Cards accounts/:account_id/cards/image_direct_message/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_image_direct_message_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_image_direct_message_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_video_app_download Read

X Ads API operation: Creatives / Video App Download Cards accounts/:account_id/cards/video_app_download.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_app_download
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_app_download

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_video_app_download_card_id Read

X Ads API operation: Creatives / Video App Download Cards accounts/:account_id/cards/video_app_download/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_app_download_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_video_app_download Write

X Ads API operation: Creatives / Video App Download Cards accounts/:account_id/cards/video_app_download.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_video_app_download
Full name: x-ads.x_ads_post_accounts_account_id_cards_video_app_download

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`country_code`	string	yes	required
`name`	string	yes	required
`media_key`	string	yes	required
`ipad_app_id`	string	no	sometimes required
`iphone_app_id`	string	no	sometimes required
`googleplay_app_id`	string	no	sometimes required
`app_cta`	string	no	optional
`ipad_deep_link`	string	no	optional
`iphone_deep_link`	string	no	optional
`googleplay_deep_link`	string	no	optional
`poster_media_key`	string	no	optional

put_accounts_account_id_cards_video_app_download_card_id Write

X Ads API operation: Creatives / Video App Download Cards accounts/:account_id/cards/video_app_download/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_video_app_download_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_video_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`country_code`	string	no	optional
`app_cta`	string	no	optional
`ipad_app_id`	string	no	optional
`ipad_deep_link`	string	no	optional
`iphone_app_id`	string	no	optional
`iphone_deep_link`	string	no	optional
`googleplay_app_id`	string	no	optional
`googleplay_deep_link`	string	no	optional
`poster_media_key`	string	no	optional
`name`	string	no	optional
`media_key`	string	no	optional

delete_accounts_account_id_cards_video_app_download_card_id Write

X Ads API operation: Creatives / Video App Download Cards accounts/:account_id/cards/video_app_download/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_video_app_download_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_video_app_download_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_video_conversation Read

X Ads API operation: Creatives / Video Conversation Cards accounts/:account_id/cards/video_conversation.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_conversation
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_conversation

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_video_conversation_card_id Read

X Ads API operation: Creatives / Video Conversation Cards accounts/:account_id/cards/video_conversation/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_conversation_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_video_conversation Write

X Ads API operation: Creatives / Video Conversation Cards accounts/:account_id/cards/video_conversation.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_video_conversation
Full name: x-ads.x_ads_post_accounts_account_id_cards_video_conversation

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`first_cta`	string	yes	required
`first_cta_tweet`	string	yes	required
`name`	string	yes	required
`thank_you_text`	string	yes	required
`media_key`	string	yes	required
`title`	string	no	sometimes required
`second_cta`	string	no	sometimes required
`second_cta_tweet`	string	no	sometimes required
`unlocked_image_media_key`	string	no	optional
`unlocked_video_media_key`	string	no	optional
`poster_media_key`	string	no	optional
`third_cta`	string	no	optional
`third_cta_tweet`	string	no	sometimes required
`fourth_cta`	string	no	optional
`fourth_cta_tweet`	string	no	sometimes required
`thank_you_url`	string	no	optional

put_accounts_account_id_cards_video_conversation_card_id Write

X Ads API operation: Creatives / Video Conversation Cards accounts/:account_id/cards/video_conversation/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_video_conversation_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_video_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`unlocked_image_media_key`	string	no	optional
`unlocked_video_media_key`	string	no	optional
`poster_media_key`	string	no	optional
`first_cta`	string	no	optional
`first_cta_tweet`	string	no	optional
`second_cta`	string	no	optional
`second_cta_tweet`	string	no	optional
`third_cta`	string	no	optional
`third_cta_tweet`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_tweet`	string	no	optional
`name`	string	no	optional
`thank_you_text`	string	no	optional
`thank_you_url`	string	no	optional
`title`	string	no	optional
`media_key`	string	no	optional

delete_accounts_account_id_cards_video_conversation_card_id Write

X Ads API operation: Creatives / Video Conversation Cards accounts/:account_id/cards/video_conversation/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_video_conversation_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_video_conversation_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_video_direct_message Read

X Ads API operation: Creatives / Video Direct Message Cards accounts/:account_id/cards/video_direct_message.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_direct_message
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_direct_message

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_video_direct_message_card_id Read

X Ads API operation: Creatives / Video Direct Message Cards accounts/:account_id/cards/video_direct_message/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_video_direct_message_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_video_direct_message_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_video_direct_message Write

X Ads API operation: Creatives / Video Direct Message Cards accounts/:account_id/cards/video_direct_message.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_video_direct_message
Full name: x-ads.x_ads_post_accounts_account_id_cards_video_direct_message

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`first_cta`	string	yes	required
`first_cta_welcome_message_id`	string	yes	required
`name`	string	yes	required
`recipient_user_id`	string	yes	required
`media_key`	string	yes	required
`poster_media_key`	string	no	optional
`second_cta`	string	no	optional
`second_cta_welcome_message_id`	string	no	optional
`third_cta`	string	no	optional
`third_cta_welcome_message_id`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_welcome_message_id`	string	no	optional

put_accounts_account_id_cards_video_direct_message_card_id Write

X Ads API operation: Creatives / Video Direct Message Cards accounts/:account_id/cards/video_direct_message/:card_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_cards_video_direct_message_card_id
Full name: x-ads.x_ads_put_accounts_account_id_cards_video_direct_message_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`poster_media_key`	string	no	optional
`first_cta`	string	no	optional
`first_cta_welcome_message_id`	string	no	optional
`second_cta`	string	no	optional
`second_cta_welcome_message_id`	string	no	optional
`third_cta`	string	no	optional
`third_cta_welcome_message_id`	string	no	optional
`fourth_cta`	string	no	optional
`fourth_cta_welcome_message_id`	string	no	optional
`name`	string	no	optional
`media_key`	string	no	optional

delete_accounts_account_id_cards_video_direct_message_card_id Write

X Ads API operation: Creatives / Video Direct Message Cards accounts/:account_id/cards/video_direct_message/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_video_direct_message_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_video_direct_message_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_media_library Read

X Ads API operation: Creatives / Media Library accounts/:account_id/media_library.

Lua path: app.integrations.x_ads.get_accounts_account_id_media_library
Full name: x-ads.x_ads_get_accounts_account_id_media_library

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`media_type`	string	no	optional
`q`	string	no	optional

get_accounts_account_id_media_library_media_key Read

X Ads API operation: Creatives / Media Library accounts/:account_id/media_library/:media_key.

Lua path: app.integrations.x_ads.get_accounts_account_id_media_library_media_key
Full name: x-ads.x_ads_get_accounts_account_id_media_library_media_key

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

post_accounts_account_id_media_library Write

X Ads API operation: Creatives / Media Library accounts/:account_id/media_library.

Lua path: app.integrations.x_ads.post_accounts_account_id_media_library
Full name: x-ads.x_ads_post_accounts_account_id_media_library

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`media_key`	string	no	sometimes required
`description`	string	no	optional
`file_name`	string	no	optional
`name`	string	no	optional
`poster_media_key`	string	no	optional
`title`	string	no	optional

put_accounts_account_id_media_library_media_key Write

X Ads API operation: Creatives / Media Library accounts/:account_id/media_library/:media_key.

Lua path: app.integrations.x_ads.put_accounts_account_id_media_library_media_key
Full name: x-ads.x_ads_put_accounts_account_id_media_library_media_key

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`description`	string	no	optional
`file_name`	string	no	optional
`name`	string	no	optional
`poster_media_key`	string	no	optional
`title`	string	no	optional

delete_accounts_account_id_media_library_media_key Write

X Ads API operation: Creatives / Media Library accounts/:account_id/media_library/:media_key.

Lua path: app.integrations.x_ads.delete_accounts_account_id_media_library_media_key
Full name: x-ads.x_ads_delete_accounts_account_id_media_library_media_key

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_cards_poll Read

X Ads API operation: Creatives / Poll Cards accounts/:account_id/cards/poll.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_poll
Full name: x-ads.x_ads_get_accounts_account_id_cards_poll

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`card_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`q`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_cards_poll_card_id Read

X Ads API operation: Creatives / Poll Cards accounts/:account_id/cards/poll/:card_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_cards_poll_card_id
Full name: x-ads.x_ads_get_accounts_account_id_cards_poll_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_cards_poll Write

X Ads API operation: Creatives / Poll Cards accounts/:account_id/cards/poll.

Lua path: app.integrations.x_ads.post_accounts_account_id_cards_poll
Full name: x-ads.x_ads_post_accounts_account_id_cards_poll

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`duration_in_minutes`	string	yes	required
`first_choice`	string	yes	required
`name`	string	yes	required
`second_choice`	string	yes	required
`fourth_choice`	string	no	optional
`media_key`	string	no	optional
`third_choice`	string	no	optional

delete_accounts_account_id_cards_poll_card_id Write

X Ads API operation: Creatives / Poll Cards accounts/:account_id/cards/poll/:card_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_cards_poll_card_id
Full name: x-ads.x_ads_delete_accounts_account_id_cards_poll_card_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_preroll_call_actions Read

X Ads API operation: Creatives / Preroll Call To Actions accounts/:account_id/preroll_call_to_actions.

Lua path: app.integrations.x_ads.get_accounts_account_id_preroll_call_actions
Full name: x-ads.x_ads_get_accounts_account_id_preroll_call_to_actions

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`line_item_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`preroll_call_to_action_ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_preroll_call_actions_preroll_call_action_id Read

X Ads API operation: Creatives / Preroll Call To Actions accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_preroll_call_actions_preroll_call_action_id
Full name: x-ads.x_ads_get_accounts_account_id_preroll_call_to_actions_preroll_call_to_action_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_preroll_call_actions Write

X Ads API operation: Creatives / Preroll Call To Actions accounts/:account_id/preroll_call_to_actions.

Lua path: app.integrations.x_ads.post_accounts_account_id_preroll_call_actions
Full name: x-ads.x_ads_post_accounts_account_id_preroll_call_to_actions

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`call_to_action`	string	yes	required
`call_to_action_url`	string	yes	required
`line_item_id`	string	yes	required

put_accounts_account_id_preroll_call_actions_preroll_call_action_id Write

X Ads API operation: Creatives / Preroll Call To Actions accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_preroll_call_actions_preroll_call_action_id
Full name: x-ads.x_ads_put_accounts_account_id_preroll_call_to_actions_preroll_call_to_action_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`call_to_action`	string	no	optional
`call_to_action_url`	string	no	optional

delete_accounts_account_id_preroll_call_actions_preroll_call_action_id Write

X Ads API operation: Creatives / Preroll Call To Actions accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_preroll_call_actions_preroll_call_action_id
Full name: x-ads.x_ads_delete_accounts_account_id_preroll_call_to_actions_preroll_call_to_action_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_tweet_previews Read

X Ads API operation: Creatives / Tweet Previews accounts/:account_id/tweet_previews.

Lua path: app.integrations.x_ads.get_accounts_account_id_tweet_previews
Full name: x-ads.x_ads_get_accounts_account_id_tweet_previews

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`tweet_ids`	string	yes	required
`tweet_type`	string	yes	required

get_accounts_account_id_app_event_tags Read

X Ads API operation: Measurement / App Event Tags accounts/:account_id/app_event_tags.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_event_tags
Full name: x-ads.x_ads_get_accounts_account_id_app_event_tags

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_event_tag_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_app_event_tags_app_event_tag_id Read

X Ads API operation: Measurement / App Event Tags accounts/:account_id/app_event_tags/:app_event_tag_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_event_tags_app_event_tag_id
Full name: x-ads.x_ads_get_accounts_account_id_app_event_tags_app_event_tag_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_app_event_tags Write

X Ads API operation: Measurement / App Event Tags accounts/:account_id/app_event_tags.

Lua path: app.integrations.x_ads.post_accounts_account_id_app_event_tags
Full name: x-ads.x_ads_post_accounts_account_id_app_event_tags

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_store_identifier`	string	yes	required
`conversion_type`	string	yes	required
`os_type`	string	yes	required
`provider_app_event_id`	string	yes	required
`provider_app_event_name`	string	yes	required
`deep_link_scheme`	string	no	optional
`post_engagement_attribution_window`	string	no	optional
`post_view_attribution_window`	string	no	optional
`retargeting_enabled`	string	no	optional

delete_accounts_account_id_app_event_tags_id Write

X Ads API operation: Measurement / App Event Tags accounts/:account_id/app_event_tags/:id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_app_event_tags_id
Full name: x-ads.x_ads_delete_accounts_account_id_app_event_tags_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_app_event_provider_configurations Read

X Ads API operation: Measurement / App Event Provider Configurations accounts/:account_id/app_event_provider_configurations.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_event_provider_configurations
Full name: x-ads.x_ads_get_accounts_account_id_app_event_provider_configurations

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`ids`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_app_event_provider_configurations_id Read

X Ads API operation: Measurement / App Event Provider Configurations accounts/:account_id/app_event_provider_configurations/:id.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_event_provider_configurations_id
Full name: x-ads.x_ads_get_accounts_account_id_app_event_provider_configurations_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_app_event_provider_configurations Write

X Ads API operation: Measurement / App Event Provider Configurations accounts/:account_id/app_event_provider_configurations.

Lua path: app.integrations.x_ads.post_accounts_account_id_app_event_provider_configurations
Full name: x-ads.x_ads_post_accounts_account_id_app_event_provider_configurations

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`provider_advertiser_id`	string	yes	required

delete_accounts_account_id_app_event_provider_configurations_id Write

X Ads API operation: Measurement / App Event Provider Configurations accounts/:account_id/app_event_provider_configurations/:id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_app_event_provider_configurations_id
Full name: x-ads.x_ads_delete_accounts_account_id_app_event_provider_configurations_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.

get_accounts_account_id_app_lists Read

X Ads API operation: Measurement / App Lists accounts/:account_id/app_lists.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_lists
Full name: x-ads.x_ads_get_accounts_account_id_app_lists

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_list_ids`	string	no	optional
`count`	string	no	optional
`cursor`	string	no	optional
`sort_by`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_app_lists_app_list_id Read

X Ads API operation: Measurement / App Lists accounts/:account_id/app_lists/:app_list_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_app_lists_app_list_id
Full name: x-ads.x_ads_get_accounts_account_id_app_lists_app_list_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_list_id`	string	yes	required
`with_deleted`	string	no	optional

post_accounts_account_id_app_lists Write

X Ads API operation: Measurement / App Lists accounts/:account_id/app_lists.

Lua path: app.integrations.x_ads.post_accounts_account_id_app_lists
Full name: x-ads.x_ads_post_accounts_account_id_app_lists

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_store_identifiers`	string	yes	required
`name`	string	yes	required

delete_accounts_account_id_app_lists_app_list_id Write

X Ads API operation: Measurement / App Lists accounts/:account_id/app_lists/:app_list_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_app_lists_app_list_id
Full name: x-ads.x_ads_delete_accounts_account_id_app_lists_app_list_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`app_list_id`	string	yes	required

get_conversion_attribution Read

X Ads API operation: Measurement / Conversion Attribution conversion_attribution.

Lua path: app.integrations.x_ads.get_conversion_attribution
Full name: x-ads.x_ads_get_conversion_attribution

Parameter	Type	Required	Description
`app_id`	string	yes	required
`conversion_time`	string	yes	required
`conversion_type`	string	yes	required
`hashed_device_id`	string	yes	required
`os_type`	string	yes	required
`click_window`	string	no	optional
`extra_device_ids`	string	no	optional
`non_twitter_engagement_time`	string	no	optional
`non_twitter_engagement_type`	string	no	optional
`view_through_window`	string	no	optional

post_conversion_event Write

X Ads API operation: Measurement / Conversion Event conversion_event.

Lua path: app.integrations.x_ads.post_conversion_event
Full name: x-ads.x_ads_post_conversion_event

Parameter	Type	Required	Description
`app_id`	string	yes	required
`conversion_time`	string	yes	required
`conversion_type`	string	yes	required
`hashed_device_id`	string	yes	required
`os_type`	string	yes	required
`click_window`	string	no	optional
`extra_device_ids`	string	no	optional
`non_twitter_engagement_time`	string	no	optional
`non_twitter_engagement_type`	string	no	optional
`view_through_window`	string	no	optional

get_accounts_account_id_web_event_tags Read

X Ads API operation: Measurement / Web Event Tags accounts/:account_id/web_event_tags.

Lua path: app.integrations.x_ads.get_accounts_account_id_web_event_tags
Full name: x-ads.x_ads_get_accounts_account_id_web_event_tags

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`count`	string	no	optional
`cursor`	string	no	optional
`sort_by`	string	no	optional
`web_event_tag_ids`	string	no	optional
`with_deleted`	string	no	optional
`with_total_count`	string	no	optional

get_accounts_account_id_web_event_tags_web_event_tag_id Read

X Ads API operation: Measurement / Web Event Tags accounts/:account_id/web_event_tags/:web_event_tag_id.

Lua path: app.integrations.x_ads.get_accounts_account_id_web_event_tags_web_event_tag_id
Full name: x-ads.x_ads_get_accounts_account_id_web_event_tags_web_event_tag_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`with_deleted`	string	no	optional

post_accounts_account_id_web_event_tags Write

X Ads API operation: Measurement / Web Event Tags accounts/:account_id/web_event_tags.

Lua path: app.integrations.x_ads.post_accounts_account_id_web_event_tags
Full name: x-ads.x_ads_post_accounts_account_id_web_event_tags

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`click_window`	string	yes	required
`name`	string	yes	required
`retargeting_enabled`	string	yes	required
`type`	string	yes	required
`view_through_window`	string	yes	required

put_accounts_account_id_web_event_tags_web_event_tag_id Write

X Ads API operation: Measurement / Web Event Tags accounts/:account_id/web_event_tags/:web_event_tag_id.

Lua path: app.integrations.x_ads.put_accounts_account_id_web_event_tags_web_event_tag_id
Full name: x-ads.x_ads_put_accounts_account_id_web_event_tags_web_event_tag_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.
`click_window`	string	no	optional
`name`	string	no	optional
`retargeting_enabled`	string	no	optional
`type`	string	no	optional
`view_through_window`	string	no	optional

delete_accounts_account_id_web_event_tags_web_event_tag_id Write

X Ads API operation: Measurement / Web Event Tags accounts/:account_id/web_event_tags/:web_event_tag_id.

Lua path: app.integrations.x_ads.delete_accounts_account_id_web_event_tags_web_event_tag_id
Full name: x-ads.x_ads_delete_accounts_account_id_web_event_tags_web_event_tag_id

Parameter	Type	Required	Description
`account_id`	string	yes	Account ID path parameter.