late-sdk 0.0.1169 → 0.0.1170
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -0
- data/docs/AssignTrackingTagUser200Response.md +22 -0
- data/docs/AssignTrackingTagUserRequest.md +20 -0
- data/docs/ListTrackingTagPartners200Response.md +20 -0
- data/docs/ListTrackingTagUsers200Response.md +20 -0
- data/docs/RemoveTrackingTagUser200Response.md +22 -0
- data/docs/TrackingTagPartner.md +20 -0
- data/docs/TrackingTagUser.md +22 -0
- data/docs/TrackingTagsApi.md +292 -0
- data/lib/zernio-sdk/api/tracking_tags_api.rb +293 -0
- data/lib/zernio-sdk/models/assign_tracking_tag_user200_response.rb +167 -0
- data/lib/zernio-sdk/models/assign_tracking_tag_user_request.rb +221 -0
- data/lib/zernio-sdk/models/list_tracking_tag_partners200_response.rb +158 -0
- data/lib/zernio-sdk/models/list_tracking_tag_users200_response.rb +158 -0
- data/lib/zernio-sdk/models/remove_tracking_tag_user200_response.rb +165 -0
- data/lib/zernio-sdk/models/tracking_tag_partner.rb +175 -0
- data/lib/zernio-sdk/models/tracking_tag_user.rb +204 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +7 -0
- data/openapi.yaml +1 -1
- data/spec/api/tracking_tags_api_spec.rb +54 -0
- data/spec/models/assign_tracking_tag_user200_response_spec.rb +48 -0
- data/spec/models/assign_tracking_tag_user_request_spec.rb +42 -0
- data/spec/models/list_tracking_tag_partners200_response_spec.rb +42 -0
- data/spec/models/list_tracking_tag_users200_response_spec.rb +42 -0
- data/spec/models/remove_tracking_tag_user200_response_spec.rb +48 -0
- data/spec/models/tracking_tag_partner_spec.rb +42 -0
- data/spec/models/tracking_tag_user_spec.rb +48 -0
- data/zernio-sdk-0.0.1170.gem +0 -0
- metadata +30 -2
- data/zernio-sdk-0.0.1169.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 97368a4b3d9d75639a9758d022c40f52b8fe0a9e281c2201143c2250f9b30c7e
|
|
4
|
+
data.tar.gz: 4080adb07de9e76b34220a8e552eba359a26909fae53ba1f8b544ffe8bcc17b4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ea7b435a05d4ad0b76e87ada592883771cd03a697bf2e7de11f99b8545abd0c88164f5c66911e47c390ccf06d76649b933ca6ae99b6141086fb449fbafbbc661
|
|
7
|
+
data.tar.gz: '09cc9ac17d35bcbf7b9921914bb74fb302f7eb24dc9b99215956b4841be12b023844bed8d0ec551d654975dbf2911f2d4b1a17a695195a0ad6a679a171bbf056'
|
data/README.md
CHANGED
|
@@ -756,6 +756,7 @@ Class | Method | HTTP request | Description
|
|
|
756
756
|
*Zernio::SlackApi* | [**list_slack_members**](docs/SlackApi.md#list_slack_members) | **GET** /v1/accounts/{accountId}/slack-members | List Slack workspace members
|
|
757
757
|
*Zernio::ToolsApi* | [**download_tik_tok_video**](docs/ToolsApi.md#download_tik_tok_video) | **GET** /v1/tools/tiktok/download | Download a TikTok video
|
|
758
758
|
*Zernio::TrackingTagsApi* | [**add_tracking_tag_shared_account**](docs/TrackingTagsApi.md#add_tracking_tag_shared_account) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | Share with an ad account
|
|
759
|
+
*Zernio::TrackingTagsApi* | [**assign_tracking_tag_user**](docs/TrackingTagsApi.md#assign_tracking_tag_user) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/users | Assign a user to a tag
|
|
759
760
|
*Zernio::TrackingTagsApi* | [**create_tracking_tag**](docs/TrackingTagsApi.md#create_tracking_tag) | **POST** /v1/accounts/{accountId}/tracking-tags | Create a tracking tag
|
|
760
761
|
*Zernio::TrackingTagsApi* | [**create_tracking_tag_event**](docs/TrackingTagsApi.md#create_tracking_tag_event) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/events | Create a conversion event
|
|
761
762
|
*Zernio::TrackingTagsApi* | [**delete_tracking_tag_event**](docs/TrackingTagsApi.md#delete_tracking_tag_event) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/events/{eventId} | Delete a conversion event
|
|
@@ -766,10 +767,13 @@ Class | Method | HTTP request | Description
|
|
|
766
767
|
*Zernio::TrackingTagsApi* | [**get_tracking_tag_store_install**](docs/TrackingTagsApi.md#get_tracking_tag_store_install) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Get store install status
|
|
767
768
|
*Zernio::TrackingTagsApi* | [**install_tracking_tag_on_store**](docs/TrackingTagsApi.md#install_tracking_tag_on_store) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Install on a Shopify store or WordPress site
|
|
768
769
|
*Zernio::TrackingTagsApi* | [**list_tracking_tag_events**](docs/TrackingTagsApi.md#list_tracking_tag_events) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/events | List conversion events
|
|
770
|
+
*Zernio::TrackingTagsApi* | [**list_tracking_tag_partners**](docs/TrackingTagsApi.md#list_tracking_tag_partners) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/partners | List partner businesses of a tag
|
|
769
771
|
*Zernio::TrackingTagsApi* | [**list_tracking_tag_shared_accounts**](docs/TrackingTagsApi.md#list_tracking_tag_shared_accounts) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | List accounts it is shared with
|
|
772
|
+
*Zernio::TrackingTagsApi* | [**list_tracking_tag_users**](docs/TrackingTagsApi.md#list_tracking_tag_users) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/users | List tag users
|
|
770
773
|
*Zernio::TrackingTagsApi* | [**list_tracking_tags**](docs/TrackingTagsApi.md#list_tracking_tags) | **GET** /v1/accounts/{accountId}/tracking-tags | List tracking tags
|
|
771
774
|
*Zernio::TrackingTagsApi* | [**remove_tracking_tag_from_store**](docs/TrackingTagsApi.md#remove_tracking_tag_from_store) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Remove from a Shopify store or WordPress site
|
|
772
775
|
*Zernio::TrackingTagsApi* | [**remove_tracking_tag_shared_account**](docs/TrackingTagsApi.md#remove_tracking_tag_shared_account) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | Stop sharing with an account
|
|
776
|
+
*Zernio::TrackingTagsApi* | [**remove_tracking_tag_user**](docs/TrackingTagsApi.md#remove_tracking_tag_user) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/users/{userId} | Remove a user from a tag
|
|
773
777
|
*Zernio::TrackingTagsApi* | [**update_ad_tracking_tags**](docs/TrackingTagsApi.md#update_ad_tracking_tags) | **PATCH** /v1/ads/{adId}/tracking-tags | Set ad tracking tags
|
|
774
778
|
*Zernio::TrackingTagsApi* | [**update_tracking_tag**](docs/TrackingTagsApi.md#update_tracking_tag) | **PATCH** /v1/accounts/{accountId}/tracking-tags/{tagId} | Update a tracking tag
|
|
775
779
|
*Zernio::TrackingTagsApi* | [**update_tracking_tag_event**](docs/TrackingTagsApi.md#update_tracking_tag_event) | **PATCH** /v1/accounts/{accountId}/tracking-tags/{tagId}/events/{eventId} | Update a conversion event
|
|
@@ -1043,6 +1047,8 @@ Class | Method | HTTP request | Description
|
|
|
1043
1047
|
- [Zernio::AssignPageUser201Response](docs/AssignPageUser201Response.md)
|
|
1044
1048
|
- [Zernio::AssignPageUser201ResponseUser](docs/AssignPageUser201ResponseUser.md)
|
|
1045
1049
|
- [Zernio::AssignPageUserRequest](docs/AssignPageUserRequest.md)
|
|
1050
|
+
- [Zernio::AssignTrackingTagUser200Response](docs/AssignTrackingTagUser200Response.md)
|
|
1051
|
+
- [Zernio::AssignTrackingTagUserRequest](docs/AssignTrackingTagUserRequest.md)
|
|
1046
1052
|
- [Zernio::AttachAdGroupAssets201Response](docs/AttachAdGroupAssets201Response.md)
|
|
1047
1053
|
- [Zernio::AttachAdLabel200Response](docs/AttachAdLabel200Response.md)
|
|
1048
1054
|
- [Zernio::AttachBrandedCallingNumbersRequest](docs/AttachBrandedCallingNumbersRequest.md)
|
|
@@ -2359,7 +2365,9 @@ Class | Method | HTTP request | Description
|
|
|
2359
2365
|
- [Zernio::ListTikTokCommercialMusic200ResponseTracksInner](docs/ListTikTokCommercialMusic200ResponseTracksInner.md)
|
|
2360
2366
|
- [Zernio::ListTikTokCommercialMusic200ResponseTracksInnerClip](docs/ListTikTokCommercialMusic200ResponseTracksInnerClip.md)
|
|
2361
2367
|
- [Zernio::ListTrackingTagEvents200Response](docs/ListTrackingTagEvents200Response.md)
|
|
2368
|
+
- [Zernio::ListTrackingTagPartners200Response](docs/ListTrackingTagPartners200Response.md)
|
|
2362
2369
|
- [Zernio::ListTrackingTagSharedAccounts200Response](docs/ListTrackingTagSharedAccounts200Response.md)
|
|
2370
|
+
- [Zernio::ListTrackingTagUsers200Response](docs/ListTrackingTagUsers200Response.md)
|
|
2363
2371
|
- [Zernio::ListTrackingTags200Response](docs/ListTrackingTags200Response.md)
|
|
2364
2372
|
- [Zernio::ListUsers200Response](docs/ListUsers200Response.md)
|
|
2365
2373
|
- [Zernio::ListUsers200ResponseUsersInner](docs/ListUsers200ResponseUsersInner.md)
|
|
@@ -2608,6 +2616,7 @@ Class | Method | HTTP request | Description
|
|
|
2608
2616
|
- [Zernio::RemovePageUser200Response](docs/RemovePageUser200Response.md)
|
|
2609
2617
|
- [Zernio::RemoveTrackingTagFromStore200Response](docs/RemoveTrackingTagFromStore200Response.md)
|
|
2610
2618
|
- [Zernio::RemoveTrackingTagFromStore200ResponseInstall](docs/RemoveTrackingTagFromStore200ResponseInstall.md)
|
|
2619
|
+
- [Zernio::RemoveTrackingTagUser200Response](docs/RemoveTrackingTagUser200Response.md)
|
|
2611
2620
|
- [Zernio::RemoveWhatsAppGroupParticipantsRequest](docs/RemoveWhatsAppGroupParticipantsRequest.md)
|
|
2612
2621
|
- [Zernio::ReplaceAdAudienceCompanies200Response](docs/ReplaceAdAudienceCompanies200Response.md)
|
|
2613
2622
|
- [Zernio::ReplaceAdAudienceCompaniesRequest](docs/ReplaceAdAudienceCompaniesRequest.md)
|
|
@@ -2886,6 +2895,8 @@ Class | Method | HTTP request | Description
|
|
|
2886
2895
|
- [Zernio::TrackingTagEvent](docs/TrackingTagEvent.md)
|
|
2887
2896
|
- [Zernio::TrackingTagEventInput](docs/TrackingTagEventInput.md)
|
|
2888
2897
|
- [Zernio::TrackingTagInstallBlockedReason](docs/TrackingTagInstallBlockedReason.md)
|
|
2898
|
+
- [Zernio::TrackingTagPartner](docs/TrackingTagPartner.md)
|
|
2899
|
+
- [Zernio::TrackingTagUser](docs/TrackingTagUser.md)
|
|
2889
2900
|
- [Zernio::TransferVoiceCall200Response](docs/TransferVoiceCall200Response.md)
|
|
2890
2901
|
- [Zernio::TransferVoiceCallRequest](docs/TransferVoiceCallRequest.md)
|
|
2891
2902
|
- [Zernio::TriggerWorkflow200Response](docs/TriggerWorkflow200Response.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::AssignTrackingTagUser200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **platform** | **String** | | [optional] |
|
|
8
|
+
| **user_id** | **String** | | [optional] |
|
|
9
|
+
| **tasks** | **Array<String>** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::AssignTrackingTagUser200Response.new(
|
|
17
|
+
platform: null,
|
|
18
|
+
user_id: null,
|
|
19
|
+
tasks: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::AssignTrackingTagUserRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **String** | | |
|
|
8
|
+
| **tasks** | **Array<String>** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::AssignTrackingTagUserRequest.new(
|
|
16
|
+
user_id: null,
|
|
17
|
+
tasks: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListTrackingTagPartners200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **platform** | **String** | | [optional] |
|
|
8
|
+
| **partners** | [**Array<TrackingTagPartner>**](TrackingTagPartner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListTrackingTagPartners200Response.new(
|
|
16
|
+
platform: null,
|
|
17
|
+
partners: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListTrackingTagUsers200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **platform** | **String** | | [optional] |
|
|
8
|
+
| **users** | [**Array<TrackingTagUser>**](TrackingTagUser.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListTrackingTagUsers200Response.new(
|
|
16
|
+
platform: null,
|
|
17
|
+
users: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::RemoveTrackingTagUser200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **platform** | **String** | | [optional] |
|
|
8
|
+
| **user_id** | **String** | | [optional] |
|
|
9
|
+
| **removed** | **Boolean** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::RemoveTrackingTagUser200Response.new(
|
|
17
|
+
platform: null,
|
|
18
|
+
user_id: null,
|
|
19
|
+
removed: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::TrackingTagPartner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Partner business id. | |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::TrackingTagPartner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::TrackingTagUser
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Business-scoped user id (as listed by GET /v1/ads/businesses/users). | |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **tasks** | **Array<String>** | Platform permission names (Meta: `AA_ANALYZE`, `ADVERTISE`, `ANALYZE`, `EDIT`, `UPLOAD`). | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::TrackingTagUser.new(
|
|
17
|
+
id: null,
|
|
18
|
+
name: null,
|
|
19
|
+
tasks: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/TrackingTagsApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**add_tracking_tag_shared_account**](TrackingTagsApi.md#add_tracking_tag_shared_account) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | Share with an ad account |
|
|
8
|
+
| [**assign_tracking_tag_user**](TrackingTagsApi.md#assign_tracking_tag_user) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/users | Assign a user to a tag |
|
|
8
9
|
| [**create_tracking_tag**](TrackingTagsApi.md#create_tracking_tag) | **POST** /v1/accounts/{accountId}/tracking-tags | Create a tracking tag |
|
|
9
10
|
| [**create_tracking_tag_event**](TrackingTagsApi.md#create_tracking_tag_event) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/events | Create a conversion event |
|
|
10
11
|
| [**delete_tracking_tag_event**](TrackingTagsApi.md#delete_tracking_tag_event) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/events/{eventId} | Delete a conversion event |
|
|
@@ -15,10 +16,13 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
15
16
|
| [**get_tracking_tag_store_install**](TrackingTagsApi.md#get_tracking_tag_store_install) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Get store install status |
|
|
16
17
|
| [**install_tracking_tag_on_store**](TrackingTagsApi.md#install_tracking_tag_on_store) | **POST** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Install on a Shopify store or WordPress site |
|
|
17
18
|
| [**list_tracking_tag_events**](TrackingTagsApi.md#list_tracking_tag_events) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/events | List conversion events |
|
|
19
|
+
| [**list_tracking_tag_partners**](TrackingTagsApi.md#list_tracking_tag_partners) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/partners | List partner businesses of a tag |
|
|
18
20
|
| [**list_tracking_tag_shared_accounts**](TrackingTagsApi.md#list_tracking_tag_shared_accounts) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | List accounts it is shared with |
|
|
21
|
+
| [**list_tracking_tag_users**](TrackingTagsApi.md#list_tracking_tag_users) | **GET** /v1/accounts/{accountId}/tracking-tags/{tagId}/users | List tag users |
|
|
19
22
|
| [**list_tracking_tags**](TrackingTagsApi.md#list_tracking_tags) | **GET** /v1/accounts/{accountId}/tracking-tags | List tracking tags |
|
|
20
23
|
| [**remove_tracking_tag_from_store**](TrackingTagsApi.md#remove_tracking_tag_from_store) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/install | Remove from a Shopify store or WordPress site |
|
|
21
24
|
| [**remove_tracking_tag_shared_account**](TrackingTagsApi.md#remove_tracking_tag_shared_account) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts | Stop sharing with an account |
|
|
25
|
+
| [**remove_tracking_tag_user**](TrackingTagsApi.md#remove_tracking_tag_user) | **DELETE** /v1/accounts/{accountId}/tracking-tags/{tagId}/users/{userId} | Remove a user from a tag |
|
|
22
26
|
| [**update_ad_tracking_tags**](TrackingTagsApi.md#update_ad_tracking_tags) | **PATCH** /v1/ads/{adId}/tracking-tags | Set ad tracking tags |
|
|
23
27
|
| [**update_tracking_tag**](TrackingTagsApi.md#update_tracking_tag) | **PATCH** /v1/accounts/{accountId}/tracking-tags/{tagId} | Update a tracking tag |
|
|
24
28
|
| [**update_tracking_tag_event**](TrackingTagsApi.md#update_tracking_tag_event) | **PATCH** /v1/accounts/{accountId}/tracking-tags/{tagId}/events/{eventId} | Update a conversion event |
|
|
@@ -97,6 +101,79 @@ end
|
|
|
97
101
|
- **Accept**: application/json
|
|
98
102
|
|
|
99
103
|
|
|
104
|
+
## assign_tracking_tag_user
|
|
105
|
+
|
|
106
|
+
> <AssignTrackingTagUser200Response> assign_tracking_tag_user(account_id, tag_id, assign_tracking_tag_user_request)
|
|
107
|
+
|
|
108
|
+
Assign a user to a tag
|
|
109
|
+
|
|
110
|
+
Gives a user of the owning business access to the tag. Assigning an already assigned user replaces their task set. Meta: `tasks` are `AA_ANALYZE`, `ADVERTISE`, `ANALYZE`, `EDIT`, `UPLOAD`; `userId` is the business-scoped id from `GET /v1/ads/businesses/users`. A pixel on a personal ad account answers 400. Needs `business_management` like the list.
|
|
111
|
+
|
|
112
|
+
### Examples
|
|
113
|
+
|
|
114
|
+
```ruby
|
|
115
|
+
require 'time'
|
|
116
|
+
require 'zernio-sdk'
|
|
117
|
+
# setup authorization
|
|
118
|
+
Zernio.configure do |config|
|
|
119
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
120
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
api_instance = Zernio::TrackingTagsApi.new
|
|
124
|
+
account_id = 'account_id_example' # String |
|
|
125
|
+
tag_id = 'tag_id_example' # String | Tag id (`TrackingTag.id`).
|
|
126
|
+
assign_tracking_tag_user_request = Zernio::AssignTrackingTagUserRequest.new({user_id: 'user_id_example', tasks: ['tasks_example']}) # AssignTrackingTagUserRequest |
|
|
127
|
+
|
|
128
|
+
begin
|
|
129
|
+
# Assign a user to a tag
|
|
130
|
+
result = api_instance.assign_tracking_tag_user(account_id, tag_id, assign_tracking_tag_user_request)
|
|
131
|
+
p result
|
|
132
|
+
rescue Zernio::ApiError => e
|
|
133
|
+
puts "Error when calling TrackingTagsApi->assign_tracking_tag_user: #{e}"
|
|
134
|
+
end
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
#### Using the assign_tracking_tag_user_with_http_info variant
|
|
138
|
+
|
|
139
|
+
This returns an Array which contains the response data, status code and headers.
|
|
140
|
+
|
|
141
|
+
> <Array(<AssignTrackingTagUser200Response>, Integer, Hash)> assign_tracking_tag_user_with_http_info(account_id, tag_id, assign_tracking_tag_user_request)
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
begin
|
|
145
|
+
# Assign a user to a tag
|
|
146
|
+
data, status_code, headers = api_instance.assign_tracking_tag_user_with_http_info(account_id, tag_id, assign_tracking_tag_user_request)
|
|
147
|
+
p status_code # => 2xx
|
|
148
|
+
p headers # => { ... }
|
|
149
|
+
p data # => <AssignTrackingTagUser200Response>
|
|
150
|
+
rescue Zernio::ApiError => e
|
|
151
|
+
puts "Error when calling TrackingTagsApi->assign_tracking_tag_user_with_http_info: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
| Name | Type | Description | Notes |
|
|
158
|
+
| ---- | ---- | ----------- | ----- |
|
|
159
|
+
| **account_id** | **String** | | |
|
|
160
|
+
| **tag_id** | **String** | Tag id (`TrackingTag.id`). | |
|
|
161
|
+
| **assign_tracking_tag_user_request** | [**AssignTrackingTagUserRequest**](AssignTrackingTagUserRequest.md) | | |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**AssignTrackingTagUser200Response**](AssignTrackingTagUser200Response.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: application/json
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
100
177
|
## create_tracking_tag
|
|
101
178
|
|
|
102
179
|
> <CreateTrackingTag201Response> create_tracking_tag(account_id, create_tracking_tag_request)
|
|
@@ -839,6 +916,77 @@ end
|
|
|
839
916
|
- **Accept**: application/json
|
|
840
917
|
|
|
841
918
|
|
|
919
|
+
## list_tracking_tag_partners
|
|
920
|
+
|
|
921
|
+
> <ListTrackingTagPartners200Response> list_tracking_tag_partners(account_id, tag_id)
|
|
922
|
+
|
|
923
|
+
List partner businesses of a tag
|
|
924
|
+
|
|
925
|
+
Other businesses the tag is shared with. Read-only. Platforms without partner sharing answer 501. Meta: the pixel's shared agencies. Sharing a pixel with a new partner is not available: `/{pixel}/agencies` answers \"(#3) Application does not have the capability to make this API call\" for our app.
|
|
926
|
+
|
|
927
|
+
### Examples
|
|
928
|
+
|
|
929
|
+
```ruby
|
|
930
|
+
require 'time'
|
|
931
|
+
require 'zernio-sdk'
|
|
932
|
+
# setup authorization
|
|
933
|
+
Zernio.configure do |config|
|
|
934
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
935
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
936
|
+
end
|
|
937
|
+
|
|
938
|
+
api_instance = Zernio::TrackingTagsApi.new
|
|
939
|
+
account_id = 'account_id_example' # String |
|
|
940
|
+
tag_id = 'tag_id_example' # String | Tag id (`TrackingTag.id`).
|
|
941
|
+
|
|
942
|
+
begin
|
|
943
|
+
# List partner businesses of a tag
|
|
944
|
+
result = api_instance.list_tracking_tag_partners(account_id, tag_id)
|
|
945
|
+
p result
|
|
946
|
+
rescue Zernio::ApiError => e
|
|
947
|
+
puts "Error when calling TrackingTagsApi->list_tracking_tag_partners: #{e}"
|
|
948
|
+
end
|
|
949
|
+
```
|
|
950
|
+
|
|
951
|
+
#### Using the list_tracking_tag_partners_with_http_info variant
|
|
952
|
+
|
|
953
|
+
This returns an Array which contains the response data, status code and headers.
|
|
954
|
+
|
|
955
|
+
> <Array(<ListTrackingTagPartners200Response>, Integer, Hash)> list_tracking_tag_partners_with_http_info(account_id, tag_id)
|
|
956
|
+
|
|
957
|
+
```ruby
|
|
958
|
+
begin
|
|
959
|
+
# List partner businesses of a tag
|
|
960
|
+
data, status_code, headers = api_instance.list_tracking_tag_partners_with_http_info(account_id, tag_id)
|
|
961
|
+
p status_code # => 2xx
|
|
962
|
+
p headers # => { ... }
|
|
963
|
+
p data # => <ListTrackingTagPartners200Response>
|
|
964
|
+
rescue Zernio::ApiError => e
|
|
965
|
+
puts "Error when calling TrackingTagsApi->list_tracking_tag_partners_with_http_info: #{e}"
|
|
966
|
+
end
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
### Parameters
|
|
970
|
+
|
|
971
|
+
| Name | Type | Description | Notes |
|
|
972
|
+
| ---- | ---- | ----------- | ----- |
|
|
973
|
+
| **account_id** | **String** | | |
|
|
974
|
+
| **tag_id** | **String** | Tag id (`TrackingTag.id`). | |
|
|
975
|
+
|
|
976
|
+
### Return type
|
|
977
|
+
|
|
978
|
+
[**ListTrackingTagPartners200Response**](ListTrackingTagPartners200Response.md)
|
|
979
|
+
|
|
980
|
+
### Authorization
|
|
981
|
+
|
|
982
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
983
|
+
|
|
984
|
+
### HTTP request headers
|
|
985
|
+
|
|
986
|
+
- **Content-Type**: Not defined
|
|
987
|
+
- **Accept**: application/json
|
|
988
|
+
|
|
989
|
+
|
|
842
990
|
## list_tracking_tag_shared_accounts
|
|
843
991
|
|
|
844
992
|
> <ListTrackingTagSharedAccounts200Response> list_tracking_tag_shared_accounts(account_id, tag_id)
|
|
@@ -910,6 +1058,77 @@ end
|
|
|
910
1058
|
- **Accept**: application/json
|
|
911
1059
|
|
|
912
1060
|
|
|
1061
|
+
## list_tracking_tag_users
|
|
1062
|
+
|
|
1063
|
+
> <ListTrackingTagUsers200Response> list_tracking_tag_users(account_id, tag_id)
|
|
1064
|
+
|
|
1065
|
+
List tag users
|
|
1066
|
+
|
|
1067
|
+
People and system users of the owning business with access to the tag. Platforms without tag user assignment answer 501. Meta: the pixel's assigned users in its owning Business Manager. A pixel on a personal ad account has no business and returns an empty list. Needs the `business_management` permission on the connecting Meta user (an admin of the owning business); without it the call answers 403 asking to reconnect.
|
|
1068
|
+
|
|
1069
|
+
### Examples
|
|
1070
|
+
|
|
1071
|
+
```ruby
|
|
1072
|
+
require 'time'
|
|
1073
|
+
require 'zernio-sdk'
|
|
1074
|
+
# setup authorization
|
|
1075
|
+
Zernio.configure do |config|
|
|
1076
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1077
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1078
|
+
end
|
|
1079
|
+
|
|
1080
|
+
api_instance = Zernio::TrackingTagsApi.new
|
|
1081
|
+
account_id = 'account_id_example' # String |
|
|
1082
|
+
tag_id = 'tag_id_example' # String | Tag id (`TrackingTag.id`).
|
|
1083
|
+
|
|
1084
|
+
begin
|
|
1085
|
+
# List tag users
|
|
1086
|
+
result = api_instance.list_tracking_tag_users(account_id, tag_id)
|
|
1087
|
+
p result
|
|
1088
|
+
rescue Zernio::ApiError => e
|
|
1089
|
+
puts "Error when calling TrackingTagsApi->list_tracking_tag_users: #{e}"
|
|
1090
|
+
end
|
|
1091
|
+
```
|
|
1092
|
+
|
|
1093
|
+
#### Using the list_tracking_tag_users_with_http_info variant
|
|
1094
|
+
|
|
1095
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1096
|
+
|
|
1097
|
+
> <Array(<ListTrackingTagUsers200Response>, Integer, Hash)> list_tracking_tag_users_with_http_info(account_id, tag_id)
|
|
1098
|
+
|
|
1099
|
+
```ruby
|
|
1100
|
+
begin
|
|
1101
|
+
# List tag users
|
|
1102
|
+
data, status_code, headers = api_instance.list_tracking_tag_users_with_http_info(account_id, tag_id)
|
|
1103
|
+
p status_code # => 2xx
|
|
1104
|
+
p headers # => { ... }
|
|
1105
|
+
p data # => <ListTrackingTagUsers200Response>
|
|
1106
|
+
rescue Zernio::ApiError => e
|
|
1107
|
+
puts "Error when calling TrackingTagsApi->list_tracking_tag_users_with_http_info: #{e}"
|
|
1108
|
+
end
|
|
1109
|
+
```
|
|
1110
|
+
|
|
1111
|
+
### Parameters
|
|
1112
|
+
|
|
1113
|
+
| Name | Type | Description | Notes |
|
|
1114
|
+
| ---- | ---- | ----------- | ----- |
|
|
1115
|
+
| **account_id** | **String** | | |
|
|
1116
|
+
| **tag_id** | **String** | Tag id (`TrackingTag.id`). | |
|
|
1117
|
+
|
|
1118
|
+
### Return type
|
|
1119
|
+
|
|
1120
|
+
[**ListTrackingTagUsers200Response**](ListTrackingTagUsers200Response.md)
|
|
1121
|
+
|
|
1122
|
+
### Authorization
|
|
1123
|
+
|
|
1124
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1125
|
+
|
|
1126
|
+
### HTTP request headers
|
|
1127
|
+
|
|
1128
|
+
- **Content-Type**: Not defined
|
|
1129
|
+
- **Accept**: application/json
|
|
1130
|
+
|
|
1131
|
+
|
|
913
1132
|
## list_tracking_tags
|
|
914
1133
|
|
|
915
1134
|
> <ListTrackingTags200Response> list_tracking_tags(account_id, opts)
|
|
@@ -1134,6 +1353,79 @@ nil (empty response body)
|
|
|
1134
1353
|
- **Accept**: application/json
|
|
1135
1354
|
|
|
1136
1355
|
|
|
1356
|
+
## remove_tracking_tag_user
|
|
1357
|
+
|
|
1358
|
+
> <RemoveTrackingTagUser200Response> remove_tracking_tag_user(account_id, tag_id, user_id)
|
|
1359
|
+
|
|
1360
|
+
Remove a user from a tag
|
|
1361
|
+
|
|
1362
|
+
Removes a user's access to the tag, on platforms whose API allows it. Meta answers 501: the Business SDK has no delete on the pixel's assigned users, `DELETE /{pixel}/assigned_users` answers \"Unsupported delete request\" (code 100, subcode 33) and re-assigning with no tasks is refused. Remove the user in Business Settings.
|
|
1363
|
+
|
|
1364
|
+
### Examples
|
|
1365
|
+
|
|
1366
|
+
```ruby
|
|
1367
|
+
require 'time'
|
|
1368
|
+
require 'zernio-sdk'
|
|
1369
|
+
# setup authorization
|
|
1370
|
+
Zernio.configure do |config|
|
|
1371
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1372
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1373
|
+
end
|
|
1374
|
+
|
|
1375
|
+
api_instance = Zernio::TrackingTagsApi.new
|
|
1376
|
+
account_id = 'account_id_example' # String |
|
|
1377
|
+
tag_id = 'tag_id_example' # String |
|
|
1378
|
+
user_id = 'user_id_example' # String | User id (`TrackingTagUser.id`).
|
|
1379
|
+
|
|
1380
|
+
begin
|
|
1381
|
+
# Remove a user from a tag
|
|
1382
|
+
result = api_instance.remove_tracking_tag_user(account_id, tag_id, user_id)
|
|
1383
|
+
p result
|
|
1384
|
+
rescue Zernio::ApiError => e
|
|
1385
|
+
puts "Error when calling TrackingTagsApi->remove_tracking_tag_user: #{e}"
|
|
1386
|
+
end
|
|
1387
|
+
```
|
|
1388
|
+
|
|
1389
|
+
#### Using the remove_tracking_tag_user_with_http_info variant
|
|
1390
|
+
|
|
1391
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1392
|
+
|
|
1393
|
+
> <Array(<RemoveTrackingTagUser200Response>, Integer, Hash)> remove_tracking_tag_user_with_http_info(account_id, tag_id, user_id)
|
|
1394
|
+
|
|
1395
|
+
```ruby
|
|
1396
|
+
begin
|
|
1397
|
+
# Remove a user from a tag
|
|
1398
|
+
data, status_code, headers = api_instance.remove_tracking_tag_user_with_http_info(account_id, tag_id, user_id)
|
|
1399
|
+
p status_code # => 2xx
|
|
1400
|
+
p headers # => { ... }
|
|
1401
|
+
p data # => <RemoveTrackingTagUser200Response>
|
|
1402
|
+
rescue Zernio::ApiError => e
|
|
1403
|
+
puts "Error when calling TrackingTagsApi->remove_tracking_tag_user_with_http_info: #{e}"
|
|
1404
|
+
end
|
|
1405
|
+
```
|
|
1406
|
+
|
|
1407
|
+
### Parameters
|
|
1408
|
+
|
|
1409
|
+
| Name | Type | Description | Notes |
|
|
1410
|
+
| ---- | ---- | ----------- | ----- |
|
|
1411
|
+
| **account_id** | **String** | | |
|
|
1412
|
+
| **tag_id** | **String** | | |
|
|
1413
|
+
| **user_id** | **String** | User id (`TrackingTagUser.id`). | |
|
|
1414
|
+
|
|
1415
|
+
### Return type
|
|
1416
|
+
|
|
1417
|
+
[**RemoveTrackingTagUser200Response**](RemoveTrackingTagUser200Response.md)
|
|
1418
|
+
|
|
1419
|
+
### Authorization
|
|
1420
|
+
|
|
1421
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1422
|
+
|
|
1423
|
+
### HTTP request headers
|
|
1424
|
+
|
|
1425
|
+
- **Content-Type**: Not defined
|
|
1426
|
+
- **Accept**: application/json
|
|
1427
|
+
|
|
1428
|
+
|
|
1137
1429
|
## update_ad_tracking_tags
|
|
1138
1430
|
|
|
1139
1431
|
> <UpdateAdTrackingTags200Response> update_ad_tracking_tags(ad_id, update_ad_tracking_tags_request)
|