Measurement
App Event Provider Configurations
GET accounts/:account_id/app_event_provider_configurations¶
Retrieve details for some or all app event provider configurations (core configuration for Mobile Application Conversion Tracking) associated with the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/app_event_provider_configurations
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
count optional |
Specifies the number of records to try and retrieve per distinct request. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor optional |
Specifies a cursor to get the next page of results. See Pagination for more information. Type: string Example: |
ids optional |
Scope the response to just the desired configurations by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided. Type: string Example: |
sort_by optional |
Sorts by supported attribute in ascending or descending order. See Sorting for more information. Type: string Example: |
with_deleted optional |
Include deleted results in your request. Type: boolean Default: false Possible values: true , false |
with_total_count optional |
Include the Note: This parameter will be ignored if Note: Requests which include Type: boolean Default: false Possible values: true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n
Example Response¶
{
"data": [
{
"provider_name": "Answers powered by Fabric",
"id": "25n",
"account_id": "18ce54d4x5t",
"provider_advertiser_id": "54ac2766f0de9e1f7a00001a",
"created_at": "2016-12-08T07:49:58Z",
"provider_advertiser_identifier": "54ac2766f0de9e1f7a00001a",
"updated_at": "2017-05-12T21:37:15Z",
"deleted": false
}
],
"next_cursor": null,
"request": {
"params": {
"ids": [
"25n"
],
"account_id": "18ce54d4x5t"
}
}
}
GET accounts/:account_id/app_event_provider_configurations/:id¶
Retrieve a specific ID for event provider configurations (core configuration for Mobile Application Conversion Tracking) associated with the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/app_event_provider_configurations/:id
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
id required |
A reference to the app event provider configuration you are operating with in the request. Type: string Example: |
with_deleted optional |
Include deleted results in your request. Type: boolean Default: false Possible values: true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/app_event_provider_configurations/25n
Example Response¶
{
"data_type": "app_event_provider_configuration",
"data": {
"provider_name": "API McTestface",
"id": "25n",
"account_id": "18ce54d4x5t",
"provider_advertiser_id": "123",
"created_at": "2017-03-24T22:24:56Z",
"provider_advertiser_identifier": "123",
"updated_at": "2017-03-24T22:24:56Z",
"deleted": false
},
"request": {
"params": {
"id": "25n",
"account_id": "18ce54d4x5t"
}
}
}
POST accounts/:account_id/app_event_provider_configurations¶
Create a new app event provider configuration associated with the current account. Only one MACT provider can be associated with a particular ads account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/app_event_provider_configurations
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
provider_advertiser_id required |
The advertiser's identifier from the provider's site Type: string Example: |
Example Request¶
POST https://ads-api.twitter.com/4/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1
Example Response¶
{
"data": {
"provider_name": "InternalTestProvider",
"id": "e5g",
"account_id": "18ce54d4x5t",
"provider_advertiser_id": "client1",
"created_at": "2017-08-30T05:40:07Z",
"provider_advertiser_identifier": "client1",
"updated_at": "2017-09-06T06:39:03Z",
"deleted": false
},
"request": {
"params": {
"provider_advertiser_id": "client1",
"account_id": "18ce54d4x5t"
}
}
}
DELETE accounts/:account_id/app_event_provider_configurations/:id¶
Delete the specified app event provider configuration belonging to the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/app_event_provider_configurations/:id
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
id required |
A reference to the app event provider configuration you are operating with in the request. Type: string Example: |
Example Request¶
DELETE https://ads-api.twitter.com/4/accounts/18ce54d4x5t/app_event_provider_configurations/e5g
Example Response¶
{
"data": {
"provider_name": "InternalTestProvider",
"id": "e5g",
"account_id": "18ce54d4x5t",
"provider_advertiser_id": "client1",
"created_at": "2017-08-30T05:40:07Z",
"provider_advertiser_identifier": "client1",
"updated_at": "2017-08-30T05:40:26Z",
"deleted": true
},
"request": {
"params": {
"id": "e5g",
"account_id": "18ce54d4x5t"
}
}
}