zernio-sdk 0.0.1124 → 0.0.1125
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 +17 -1
- data/docs/AdAccountsApi.md +383 -17
- data/docs/AttachAdLabel200Response.md +24 -0
- data/docs/CreateAdLabel201Response.md +22 -0
- data/docs/CreateAdLabelRequest.md +28 -0
- data/docs/DetachAdLabel200Response.md +24 -0
- data/docs/GoogleAdLabel.md +28 -0
- data/docs/GoogleAdLabelAssignments.md +30 -0
- data/docs/ListAdLabels200Response.md +8 -4
- data/docs/ListAdLabels200ResponseDataInner.md +49 -0
- data/docs/ListAdLabels200ResponsePaging.md +18 -0
- data/docs/RemoveAdLabel200Response.md +22 -0
- data/docs/UpdateAdLabel200Response.md +20 -0
- data/docs/UpdateAdLabelRequest.md +28 -0
- data/lib/zernio-sdk/api/ad_accounts_api.rb +424 -19
- data/lib/zernio-sdk/models/attach_ad_label200_response.rb +176 -0
- data/lib/zernio-sdk/models/create_ad_label201_response.rb +167 -0
- data/lib/zernio-sdk/models/create_ad_label_request.rb +331 -0
- data/lib/zernio-sdk/models/detach_ad_label200_response.rb +176 -0
- data/lib/zernio-sdk/models/google_ad_label.rb +231 -0
- data/lib/zernio-sdk/models/google_ad_label_assignments.rb +352 -0
- data/lib/zernio-sdk/models/list_ad_labels200_response.rb +27 -5
- data/lib/zernio-sdk/models/list_ad_labels200_response_data_inner.rb +104 -0
- data/lib/zernio-sdk/models/list_ad_labels200_response_paging.rb +149 -0
- data/lib/zernio-sdk/models/remove_ad_label200_response.rb +166 -0
- data/lib/zernio-sdk/models/update_ad_label200_response.rb +156 -0
- data/lib/zernio-sdk/models/update_ad_label_request.rb +323 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +11 -0
- data/openapi.yaml +1 -1
- data/spec/api/ad_accounts_api_spec.rb +74 -7
- data/spec/models/attach_ad_label200_response_spec.rb +54 -0
- data/spec/models/create_ad_label201_response_spec.rb +48 -0
- data/spec/models/create_ad_label_request_spec.rb +66 -0
- data/spec/models/detach_ad_label200_response_spec.rb +54 -0
- data/spec/models/google_ad_label_assignments_spec.rb +72 -0
- data/spec/models/google_ad_label_spec.rb +70 -0
- data/spec/models/list_ad_labels200_response_data_inner_spec.rb +32 -0
- data/spec/models/list_ad_labels200_response_paging_spec.rb +36 -0
- data/spec/models/list_ad_labels200_response_spec.rb +12 -0
- data/spec/models/remove_ad_label200_response_spec.rb +48 -0
- data/spec/models/update_ad_label200_response_spec.rb +42 -0
- data/spec/models/update_ad_label_request_spec.rb +66 -0
- metadata +45 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 25791087d3a5b3977956b38a244b3a6a91e261a1fc1a718d4176c0bca721f8cb
|
|
4
|
+
data.tar.gz: 945e068f26582ec721511c4fe7ef924d6bc15bd4e083000dec842816de2e797b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '0385ab3dd5d19a1b1e0c7119a6c1423b9112fe467bec44a9f9dac53a8808af636b25543d7b20e64a6831ec5621ac26558a16c6c0f18ec4ee00305079aa8d0fb0'
|
|
7
|
+
data.tar.gz: 80f0cac9706e94af534f61a76ea9aeb67e76a5581ae2a5e6bc9f6c63489931606aaf121011711f120260f6a91af0c468fdb70cfd88ddf7de71e2d5bf17dcbf5f
|
data/README.md
CHANGED
|
@@ -115,7 +115,9 @@ Class | Method | HTTP request | Description
|
|
|
115
115
|
*Zernio::AdAccountsApi* | [**add_account_callouts**](docs/AdAccountsApi.md#add_account_callouts) | **POST** /v1/ads/accounts/callouts | Add account callouts
|
|
116
116
|
*Zernio::AdAccountsApi* | [**add_account_sitelinks**](docs/AdAccountsApi.md#add_account_sitelinks) | **POST** /v1/ads/accounts/sitelinks | Add account sitelinks
|
|
117
117
|
*Zernio::AdAccountsApi* | [**add_account_structured_snippets**](docs/AdAccountsApi.md#add_account_structured_snippets) | **POST** /v1/ads/accounts/structured-snippets | Add account snippets
|
|
118
|
+
*Zernio::AdAccountsApi* | [**attach_ad_label**](docs/AdAccountsApi.md#attach_ad_label) | **POST** /v1/ads/labels/{labelId}/assignments | Attach a Google Ads label
|
|
118
119
|
*Zernio::AdAccountsApi* | [**create_ad_account**](docs/AdAccountsApi.md#create_ad_account) | **POST** /v1/ads/accounts | Create Meta ad account
|
|
120
|
+
*Zernio::AdAccountsApi* | [**create_ad_label**](docs/AdAccountsApi.md#create_ad_label) | **POST** /v1/ads/labels | Create a Google Ads label
|
|
119
121
|
*Zernio::AdAccountsApi* | [**create_ad_negative_keyword_list**](docs/AdAccountsApi.md#create_ad_negative_keyword_list) | **POST** /v1/ads/accounts/negative-keyword-lists | Create a negative keyword list
|
|
120
122
|
*Zernio::AdAccountsApi* | [**create_custom_conversion**](docs/AdAccountsApi.md#create_custom_conversion) | **POST** /v1/accounts/{accountId}/custom-conversions | Create custom conversion
|
|
121
123
|
*Zernio::AdAccountsApi* | [**create_high_demand_period**](docs/AdAccountsApi.md#create_high_demand_period) | **POST** /v1/ads/high-demand-periods | Schedule a budget increase
|
|
@@ -123,6 +125,7 @@ Class | Method | HTTP request | Description
|
|
|
123
125
|
*Zernio::AdAccountsApi* | [**delete_ad_comment**](docs/AdAccountsApi.md#delete_ad_comment) | **DELETE** /v1/ads/{adId}/comments/{commentId} | Delete an ad comment
|
|
124
126
|
*Zernio::AdAccountsApi* | [**delete_ad_negative_keyword_list**](docs/AdAccountsApi.md#delete_ad_negative_keyword_list) | **DELETE** /v1/ads/accounts/negative-keyword-lists/{listId} | Delete a negative keyword list
|
|
125
127
|
*Zernio::AdAccountsApi* | [**delete_value_rule_set**](docs/AdAccountsApi.md#delete_value_rule_set) | **DELETE** /v1/ads/value-rule-sets/{valueRuleSetId} | Delete a value rule set
|
|
128
|
+
*Zernio::AdAccountsApi* | [**detach_ad_label**](docs/AdAccountsApi.md#detach_ad_label) | **DELETE** /v1/ads/labels/{labelId}/assignments | Detach a Google Ads label
|
|
126
129
|
*Zernio::AdAccountsApi* | [**get_ad_account_finance**](docs/AdAccountsApi.md#get_ad_account_finance) | **GET** /v1/ads/accounts/finance | Ad account finances
|
|
127
130
|
*Zernio::AdAccountsApi* | [**get_ad_comments**](docs/AdAccountsApi.md#get_ad_comments) | **GET** /v1/ads/{adId}/comments | List comments on an ad
|
|
128
131
|
*Zernio::AdAccountsApi* | [**get_ad_negative_keyword_list**](docs/AdAccountsApi.md#get_ad_negative_keyword_list) | **GET** /v1/ads/accounts/negative-keyword-lists/{listId} | Get a negative keyword list
|
|
@@ -136,7 +139,7 @@ Class | Method | HTTP request | Description
|
|
|
136
139
|
*Zernio::AdAccountsApi* | [**list_account_sitelinks**](docs/AdAccountsApi.md#list_account_sitelinks) | **GET** /v1/ads/accounts/sitelinks | List account sitelinks
|
|
137
140
|
*Zernio::AdAccountsApi* | [**list_account_structured_snippets**](docs/AdAccountsApi.md#list_account_structured_snippets) | **GET** /v1/ads/accounts/structured-snippets | List account snippets
|
|
138
141
|
*Zernio::AdAccountsApi* | [**list_ad_accounts**](docs/AdAccountsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts
|
|
139
|
-
*Zernio::AdAccountsApi* | [**list_ad_labels**](docs/AdAccountsApi.md#list_ad_labels) | **GET** /v1/ads/labels |
|
|
142
|
+
*Zernio::AdAccountsApi* | [**list_ad_labels**](docs/AdAccountsApi.md#list_ad_labels) | **GET** /v1/ads/labels | List ad labels
|
|
140
143
|
*Zernio::AdAccountsApi* | [**list_ad_negative_keyword_lists**](docs/AdAccountsApi.md#list_ad_negative_keyword_lists) | **GET** /v1/ads/accounts/negative-keyword-lists | List negative keyword lists
|
|
141
144
|
*Zernio::AdAccountsApi* | [**list_ad_studies**](docs/AdAccountsApi.md#list_ad_studies) | **GET** /v1/ads/studies | A/B tests and lift studies
|
|
142
145
|
*Zernio::AdAccountsApi* | [**list_ads_business_centers**](docs/AdAccountsApi.md#list_ads_business_centers) | **GET** /v1/ads/business-centers | List TikTok Business Centers
|
|
@@ -151,12 +154,14 @@ Class | Method | HTTP request | Description
|
|
|
151
154
|
*Zernio::AdAccountsApi* | [**remove_account_callout**](docs/AdAccountsApi.md#remove_account_callout) | **DELETE** /v1/ads/accounts/callouts | Remove account callout
|
|
152
155
|
*Zernio::AdAccountsApi* | [**remove_account_sitelink**](docs/AdAccountsApi.md#remove_account_sitelink) | **DELETE** /v1/ads/accounts/sitelinks | Remove account sitelink
|
|
153
156
|
*Zernio::AdAccountsApi* | [**remove_account_structured_snippet**](docs/AdAccountsApi.md#remove_account_structured_snippet) | **DELETE** /v1/ads/accounts/structured-snippets | Remove account snippet
|
|
157
|
+
*Zernio::AdAccountsApi* | [**remove_ad_label**](docs/AdAccountsApi.md#remove_ad_label) | **DELETE** /v1/ads/labels/{labelId} | Remove a Google Ads label
|
|
154
158
|
*Zernio::AdAccountsApi* | [**replace_ad_negative_keyword_list_keywords**](docs/AdAccountsApi.md#replace_ad_negative_keyword_list_keywords) | **PUT** /v1/ads/accounts/negative-keyword-lists/{listId}/keywords | Replace negative list keywords
|
|
155
159
|
*Zernio::AdAccountsApi* | [**reply_to_ad_comment**](docs/AdAccountsApi.md#reply_to_ad_comment) | **POST** /v1/ads/{adId}/comments/{commentId}/reply | Reply to an ad comment
|
|
156
160
|
*Zernio::AdAccountsApi* | [**update_account_callouts**](docs/AdAccountsApi.md#update_account_callouts) | **PUT** /v1/ads/accounts/callouts | Update account callouts
|
|
157
161
|
*Zernio::AdAccountsApi* | [**update_account_sitelinks**](docs/AdAccountsApi.md#update_account_sitelinks) | **PUT** /v1/ads/accounts/sitelinks | Update account sitelinks
|
|
158
162
|
*Zernio::AdAccountsApi* | [**update_account_structured_snippets**](docs/AdAccountsApi.md#update_account_structured_snippets) | **PUT** /v1/ads/accounts/structured-snippets | Update account snippets
|
|
159
163
|
*Zernio::AdAccountsApi* | [**update_ad_account**](docs/AdAccountsApi.md#update_ad_account) | **PATCH** /v1/ads/accounts | Update ad account settings
|
|
164
|
+
*Zernio::AdAccountsApi* | [**update_ad_label**](docs/AdAccountsApi.md#update_ad_label) | **PATCH** /v1/ads/labels/{labelId} | Update a Google Ads label
|
|
160
165
|
*Zernio::AdAccountsApi* | [**update_ad_negative_keyword_list**](docs/AdAccountsApi.md#update_ad_negative_keyword_list) | **PUT** /v1/ads/accounts/negative-keyword-lists/{listId} | Rename a negative keyword list
|
|
161
166
|
*Zernio::AdAccountsApi* | [**update_value_rule_set**](docs/AdAccountsApi.md#update_value_rule_set) | **PUT** /v1/ads/value-rule-sets/{valueRuleSetId} | Replace a value rule set
|
|
162
167
|
*Zernio::AdAudiencesApi* | [**add_users_to_ad_audience**](docs/AdAudiencesApi.md#add_users_to_ad_audience) | **POST** /v1/ads/audiences/{audienceId}/users | Add users to audience
|
|
@@ -965,6 +970,7 @@ Class | Method | HTTP request | Description
|
|
|
965
970
|
- [Zernio::AssignGoogleBusinessLocation200ResponseAccount](docs/AssignGoogleBusinessLocation200ResponseAccount.md)
|
|
966
971
|
- [Zernio::AssignGoogleBusinessLocationRequest](docs/AssignGoogleBusinessLocationRequest.md)
|
|
967
972
|
- [Zernio::AttachAdGroupAssets201Response](docs/AttachAdGroupAssets201Response.md)
|
|
973
|
+
- [Zernio::AttachAdLabel200Response](docs/AttachAdLabel200Response.md)
|
|
968
974
|
- [Zernio::AttachCampaignAssets201Response](docs/AttachCampaignAssets201Response.md)
|
|
969
975
|
- [Zernio::AttachCampaignAssetsRequest](docs/AttachCampaignAssetsRequest.md)
|
|
970
976
|
- [Zernio::AttachNumberToSipTrunk200Response](docs/AttachNumberToSipTrunk200Response.md)
|
|
@@ -1150,6 +1156,8 @@ Class | Method | HTTP request | Description
|
|
|
1150
1156
|
- [Zernio::CreateAdInsightsReportRequest](docs/CreateAdInsightsReportRequest.md)
|
|
1151
1157
|
- [Zernio::CreateAdInsightsReportRequestFilteringInner](docs/CreateAdInsightsReportRequestFilteringInner.md)
|
|
1152
1158
|
- [Zernio::CreateAdInsightsReportRequestTimeIncrement](docs/CreateAdInsightsReportRequestTimeIncrement.md)
|
|
1159
|
+
- [Zernio::CreateAdLabel201Response](docs/CreateAdLabel201Response.md)
|
|
1160
|
+
- [Zernio::CreateAdLabelRequest](docs/CreateAdLabelRequest.md)
|
|
1153
1161
|
- [Zernio::CreateAdNegativeKeywordList201Response](docs/CreateAdNegativeKeywordList201Response.md)
|
|
1154
1162
|
- [Zernio::CreateAdNegativeKeywordListRequest](docs/CreateAdNegativeKeywordListRequest.md)
|
|
1155
1163
|
- [Zernio::CreateAdSet201Response](docs/CreateAdSet201Response.md)
|
|
@@ -1382,6 +1390,7 @@ Class | Method | HTTP request | Description
|
|
|
1382
1390
|
- [Zernio::DeleteWhatsAppTemplate200Response](docs/DeleteWhatsAppTemplate200Response.md)
|
|
1383
1391
|
- [Zernio::DeleteWhatsAppTemplateById200Response](docs/DeleteWhatsAppTemplateById200Response.md)
|
|
1384
1392
|
- [Zernio::DeleteWhatsappBusinessUsernameRequest](docs/DeleteWhatsappBusinessUsernameRequest.md)
|
|
1393
|
+
- [Zernio::DetachAdLabel200Response](docs/DetachAdLabel200Response.md)
|
|
1385
1394
|
- [Zernio::DetachNumberFromSipTrunk200Response](docs/DetachNumberFromSipTrunk200Response.md)
|
|
1386
1395
|
- [Zernio::DialVoiceWebCall200Response](docs/DialVoiceWebCall200Response.md)
|
|
1387
1396
|
- [Zernio::DialVoiceWebCallRequest](docs/DialVoiceWebCallRequest.md)
|
|
@@ -1854,6 +1863,8 @@ Class | Method | HTTP request | Description
|
|
|
1854
1863
|
- [Zernio::GetYoutubeCaptions200ResponseCuesInner](docs/GetYoutubeCaptions200ResponseCuesInner.md)
|
|
1855
1864
|
- [Zernio::GetYoutubePlaylists200Response](docs/GetYoutubePlaylists200Response.md)
|
|
1856
1865
|
- [Zernio::GetYoutubePlaylists200ResponsePlaylistsInner](docs/GetYoutubePlaylists200ResponsePlaylistsInner.md)
|
|
1866
|
+
- [Zernio::GoogleAdLabel](docs/GoogleAdLabel.md)
|
|
1867
|
+
- [Zernio::GoogleAdLabelAssignments](docs/GoogleAdLabelAssignments.md)
|
|
1857
1868
|
- [Zernio::GoogleAssetGroupAssetLink](docs/GoogleAssetGroupAssetLink.md)
|
|
1858
1869
|
- [Zernio::GoogleAssetGroupAssetUnlink](docs/GoogleAssetGroupAssetUnlink.md)
|
|
1859
1870
|
- [Zernio::GoogleAssetUpdate](docs/GoogleAssetUpdate.md)
|
|
@@ -2000,6 +2011,8 @@ Class | Method | HTTP request | Description
|
|
|
2000
2011
|
- [Zernio::ListAdImages200Response](docs/ListAdImages200Response.md)
|
|
2001
2012
|
- [Zernio::ListAdKeywords200Response](docs/ListAdKeywords200Response.md)
|
|
2002
2013
|
- [Zernio::ListAdLabels200Response](docs/ListAdLabels200Response.md)
|
|
2014
|
+
- [Zernio::ListAdLabels200ResponseDataInner](docs/ListAdLabels200ResponseDataInner.md)
|
|
2015
|
+
- [Zernio::ListAdLabels200ResponsePaging](docs/ListAdLabels200ResponsePaging.md)
|
|
2003
2016
|
- [Zernio::ListAdNegativeKeywordLists200Response](docs/ListAdNegativeKeywordLists200Response.md)
|
|
2004
2017
|
- [Zernio::ListAdSets200Response](docs/ListAdSets200Response.md)
|
|
2005
2018
|
- [Zernio::ListAdSets200ResponseAdSetsInner](docs/ListAdSets200ResponseAdSetsInner.md)
|
|
@@ -2367,6 +2380,7 @@ Class | Method | HTTP request | Description
|
|
|
2367
2380
|
- [Zernio::RemoveAccountCalloutRequest](docs/RemoveAccountCalloutRequest.md)
|
|
2368
2381
|
- [Zernio::RemoveAdGroupAssetsRequest](docs/RemoveAdGroupAssetsRequest.md)
|
|
2369
2382
|
- [Zernio::RemoveAdKeyword200Response](docs/RemoveAdKeyword200Response.md)
|
|
2383
|
+
- [Zernio::RemoveAdLabel200Response](docs/RemoveAdLabel200Response.md)
|
|
2370
2384
|
- [Zernio::RemoveBookmark200Response](docs/RemoveBookmark200Response.md)
|
|
2371
2385
|
- [Zernio::RemoveCampaignAssets200Response](docs/RemoveCampaignAssets200Response.md)
|
|
2372
2386
|
- [Zernio::RemoveCampaignAssetsRequest](docs/RemoveCampaignAssetsRequest.md)
|
|
@@ -2690,6 +2704,8 @@ Class | Method | HTTP request | Description
|
|
|
2690
2704
|
- [Zernio::UpdateAdCreativeRequest](docs/UpdateAdCreativeRequest.md)
|
|
2691
2705
|
- [Zernio::UpdateAdKeyword200Response](docs/UpdateAdKeyword200Response.md)
|
|
2692
2706
|
- [Zernio::UpdateAdKeywordRequest](docs/UpdateAdKeywordRequest.md)
|
|
2707
|
+
- [Zernio::UpdateAdLabel200Response](docs/UpdateAdLabel200Response.md)
|
|
2708
|
+
- [Zernio::UpdateAdLabelRequest](docs/UpdateAdLabelRequest.md)
|
|
2693
2709
|
- [Zernio::UpdateAdNegativeKeywordList200Response](docs/UpdateAdNegativeKeywordList200Response.md)
|
|
2694
2710
|
- [Zernio::UpdateAdNegativeKeywordListRequest](docs/UpdateAdNegativeKeywordListRequest.md)
|
|
2695
2711
|
- [Zernio::UpdateAdRequest](docs/UpdateAdRequest.md)
|
data/docs/AdAccountsApi.md
CHANGED
|
@@ -7,7 +7,9 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
7
7
|
| [**add_account_callouts**](AdAccountsApi.md#add_account_callouts) | **POST** /v1/ads/accounts/callouts | Add account callouts |
|
|
8
8
|
| [**add_account_sitelinks**](AdAccountsApi.md#add_account_sitelinks) | **POST** /v1/ads/accounts/sitelinks | Add account sitelinks |
|
|
9
9
|
| [**add_account_structured_snippets**](AdAccountsApi.md#add_account_structured_snippets) | **POST** /v1/ads/accounts/structured-snippets | Add account snippets |
|
|
10
|
+
| [**attach_ad_label**](AdAccountsApi.md#attach_ad_label) | **POST** /v1/ads/labels/{labelId}/assignments | Attach a Google Ads label |
|
|
10
11
|
| [**create_ad_account**](AdAccountsApi.md#create_ad_account) | **POST** /v1/ads/accounts | Create Meta ad account |
|
|
12
|
+
| [**create_ad_label**](AdAccountsApi.md#create_ad_label) | **POST** /v1/ads/labels | Create a Google Ads label |
|
|
11
13
|
| [**create_ad_negative_keyword_list**](AdAccountsApi.md#create_ad_negative_keyword_list) | **POST** /v1/ads/accounts/negative-keyword-lists | Create a negative keyword list |
|
|
12
14
|
| [**create_custom_conversion**](AdAccountsApi.md#create_custom_conversion) | **POST** /v1/accounts/{accountId}/custom-conversions | Create custom conversion |
|
|
13
15
|
| [**create_high_demand_period**](AdAccountsApi.md#create_high_demand_period) | **POST** /v1/ads/high-demand-periods | Schedule a budget increase |
|
|
@@ -15,6 +17,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
15
17
|
| [**delete_ad_comment**](AdAccountsApi.md#delete_ad_comment) | **DELETE** /v1/ads/{adId}/comments/{commentId} | Delete an ad comment |
|
|
16
18
|
| [**delete_ad_negative_keyword_list**](AdAccountsApi.md#delete_ad_negative_keyword_list) | **DELETE** /v1/ads/accounts/negative-keyword-lists/{listId} | Delete a negative keyword list |
|
|
17
19
|
| [**delete_value_rule_set**](AdAccountsApi.md#delete_value_rule_set) | **DELETE** /v1/ads/value-rule-sets/{valueRuleSetId} | Delete a value rule set |
|
|
20
|
+
| [**detach_ad_label**](AdAccountsApi.md#detach_ad_label) | **DELETE** /v1/ads/labels/{labelId}/assignments | Detach a Google Ads label |
|
|
18
21
|
| [**get_ad_account_finance**](AdAccountsApi.md#get_ad_account_finance) | **GET** /v1/ads/accounts/finance | Ad account finances |
|
|
19
22
|
| [**get_ad_comments**](AdAccountsApi.md#get_ad_comments) | **GET** /v1/ads/{adId}/comments | List comments on an ad |
|
|
20
23
|
| [**get_ad_negative_keyword_list**](AdAccountsApi.md#get_ad_negative_keyword_list) | **GET** /v1/ads/accounts/negative-keyword-lists/{listId} | Get a negative keyword list |
|
|
@@ -28,7 +31,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
28
31
|
| [**list_account_sitelinks**](AdAccountsApi.md#list_account_sitelinks) | **GET** /v1/ads/accounts/sitelinks | List account sitelinks |
|
|
29
32
|
| [**list_account_structured_snippets**](AdAccountsApi.md#list_account_structured_snippets) | **GET** /v1/ads/accounts/structured-snippets | List account snippets |
|
|
30
33
|
| [**list_ad_accounts**](AdAccountsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts |
|
|
31
|
-
| [**list_ad_labels**](AdAccountsApi.md#list_ad_labels) | **GET** /v1/ads/labels |
|
|
34
|
+
| [**list_ad_labels**](AdAccountsApi.md#list_ad_labels) | **GET** /v1/ads/labels | List ad labels |
|
|
32
35
|
| [**list_ad_negative_keyword_lists**](AdAccountsApi.md#list_ad_negative_keyword_lists) | **GET** /v1/ads/accounts/negative-keyword-lists | List negative keyword lists |
|
|
33
36
|
| [**list_ad_studies**](AdAccountsApi.md#list_ad_studies) | **GET** /v1/ads/studies | A/B tests and lift studies |
|
|
34
37
|
| [**list_ads_business_centers**](AdAccountsApi.md#list_ads_business_centers) | **GET** /v1/ads/business-centers | List TikTok Business Centers |
|
|
@@ -43,12 +46,14 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
43
46
|
| [**remove_account_callout**](AdAccountsApi.md#remove_account_callout) | **DELETE** /v1/ads/accounts/callouts | Remove account callout |
|
|
44
47
|
| [**remove_account_sitelink**](AdAccountsApi.md#remove_account_sitelink) | **DELETE** /v1/ads/accounts/sitelinks | Remove account sitelink |
|
|
45
48
|
| [**remove_account_structured_snippet**](AdAccountsApi.md#remove_account_structured_snippet) | **DELETE** /v1/ads/accounts/structured-snippets | Remove account snippet |
|
|
49
|
+
| [**remove_ad_label**](AdAccountsApi.md#remove_ad_label) | **DELETE** /v1/ads/labels/{labelId} | Remove a Google Ads label |
|
|
46
50
|
| [**replace_ad_negative_keyword_list_keywords**](AdAccountsApi.md#replace_ad_negative_keyword_list_keywords) | **PUT** /v1/ads/accounts/negative-keyword-lists/{listId}/keywords | Replace negative list keywords |
|
|
47
51
|
| [**reply_to_ad_comment**](AdAccountsApi.md#reply_to_ad_comment) | **POST** /v1/ads/{adId}/comments/{commentId}/reply | Reply to an ad comment |
|
|
48
52
|
| [**update_account_callouts**](AdAccountsApi.md#update_account_callouts) | **PUT** /v1/ads/accounts/callouts | Update account callouts |
|
|
49
53
|
| [**update_account_sitelinks**](AdAccountsApi.md#update_account_sitelinks) | **PUT** /v1/ads/accounts/sitelinks | Update account sitelinks |
|
|
50
54
|
| [**update_account_structured_snippets**](AdAccountsApi.md#update_account_structured_snippets) | **PUT** /v1/ads/accounts/structured-snippets | Update account snippets |
|
|
51
55
|
| [**update_ad_account**](AdAccountsApi.md#update_ad_account) | **PATCH** /v1/ads/accounts | Update ad account settings |
|
|
56
|
+
| [**update_ad_label**](AdAccountsApi.md#update_ad_label) | **PATCH** /v1/ads/labels/{labelId} | Update a Google Ads label |
|
|
52
57
|
| [**update_ad_negative_keyword_list**](AdAccountsApi.md#update_ad_negative_keyword_list) | **PUT** /v1/ads/accounts/negative-keyword-lists/{listId} | Rename a negative keyword list |
|
|
53
58
|
| [**update_value_rule_set**](AdAccountsApi.md#update_value_rule_set) | **PUT** /v1/ads/value-rule-sets/{valueRuleSetId} | Replace a value rule set |
|
|
54
59
|
|
|
@@ -260,6 +265,77 @@ end
|
|
|
260
265
|
- **Accept**: application/json
|
|
261
266
|
|
|
262
267
|
|
|
268
|
+
## attach_ad_label
|
|
269
|
+
|
|
270
|
+
> <AttachAdLabel200Response> attach_ad_label(label_id, google_ad_label_assignments)
|
|
271
|
+
|
|
272
|
+
Attach a Google Ads label
|
|
273
|
+
|
|
274
|
+
Attaches the label to campaigns, ad groups, ads and keywords (Google CampaignLabel, AdGroupLabel, AdGroupAdLabel and AdGroupCriterionLabel) in one mutate. Idempotent: a target that already carries the label is counted in `unchanged` instead of failing the call. All ids are Google's own: ads and keywords use the composite id Google puts in their resource names, `{adGroupId}~{adId}` and `{adGroupId}~{criterionId}` (the keyword form is the tail of `resourceName` on `GET /v1/ads/keywords`).
|
|
275
|
+
|
|
276
|
+
### Examples
|
|
277
|
+
|
|
278
|
+
```ruby
|
|
279
|
+
require 'time'
|
|
280
|
+
require 'zernio-sdk'
|
|
281
|
+
# setup authorization
|
|
282
|
+
Zernio.configure do |config|
|
|
283
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
284
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = Zernio::AdAccountsApi.new
|
|
288
|
+
label_id = 'label_id_example' # String | Google label id
|
|
289
|
+
google_ad_label_assignments = Zernio::GoogleAdLabelAssignments.new({account_id: 'account_id_example'}) # GoogleAdLabelAssignments |
|
|
290
|
+
|
|
291
|
+
begin
|
|
292
|
+
# Attach a Google Ads label
|
|
293
|
+
result = api_instance.attach_ad_label(label_id, google_ad_label_assignments)
|
|
294
|
+
p result
|
|
295
|
+
rescue Zernio::ApiError => e
|
|
296
|
+
puts "Error when calling AdAccountsApi->attach_ad_label: #{e}"
|
|
297
|
+
end
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
#### Using the attach_ad_label_with_http_info variant
|
|
301
|
+
|
|
302
|
+
This returns an Array which contains the response data, status code and headers.
|
|
303
|
+
|
|
304
|
+
> <Array(<AttachAdLabel200Response>, Integer, Hash)> attach_ad_label_with_http_info(label_id, google_ad_label_assignments)
|
|
305
|
+
|
|
306
|
+
```ruby
|
|
307
|
+
begin
|
|
308
|
+
# Attach a Google Ads label
|
|
309
|
+
data, status_code, headers = api_instance.attach_ad_label_with_http_info(label_id, google_ad_label_assignments)
|
|
310
|
+
p status_code # => 2xx
|
|
311
|
+
p headers # => { ... }
|
|
312
|
+
p data # => <AttachAdLabel200Response>
|
|
313
|
+
rescue Zernio::ApiError => e
|
|
314
|
+
puts "Error when calling AdAccountsApi->attach_ad_label_with_http_info: #{e}"
|
|
315
|
+
end
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
| Name | Type | Description | Notes |
|
|
321
|
+
| ---- | ---- | ----------- | ----- |
|
|
322
|
+
| **label_id** | **String** | Google label id | |
|
|
323
|
+
| **google_ad_label_assignments** | [**GoogleAdLabelAssignments**](GoogleAdLabelAssignments.md) | | |
|
|
324
|
+
|
|
325
|
+
### Return type
|
|
326
|
+
|
|
327
|
+
[**AttachAdLabel200Response**](AttachAdLabel200Response.md)
|
|
328
|
+
|
|
329
|
+
### Authorization
|
|
330
|
+
|
|
331
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
332
|
+
|
|
333
|
+
### HTTP request headers
|
|
334
|
+
|
|
335
|
+
- **Content-Type**: application/json
|
|
336
|
+
- **Accept**: application/json
|
|
337
|
+
|
|
338
|
+
|
|
263
339
|
## create_ad_account
|
|
264
340
|
|
|
265
341
|
> <CreateAdAccount201Response> create_ad_account(create_ad_account_request)
|
|
@@ -329,6 +405,75 @@ end
|
|
|
329
405
|
- **Accept**: application/json
|
|
330
406
|
|
|
331
407
|
|
|
408
|
+
## create_ad_label
|
|
409
|
+
|
|
410
|
+
> <CreateAdLabel201Response> create_ad_label(create_ad_label_request)
|
|
411
|
+
|
|
412
|
+
Create a Google Ads label
|
|
413
|
+
|
|
414
|
+
Creates a label on a Google Ads customer. Attach it to campaigns, ad groups, ads and keywords with `POST /v1/ads/labels/{labelId}/assignments`. Label names are unique per customer; a duplicate is a 400.
|
|
415
|
+
|
|
416
|
+
### Examples
|
|
417
|
+
|
|
418
|
+
```ruby
|
|
419
|
+
require 'time'
|
|
420
|
+
require 'zernio-sdk'
|
|
421
|
+
# setup authorization
|
|
422
|
+
Zernio.configure do |config|
|
|
423
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
424
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
api_instance = Zernio::AdAccountsApi.new
|
|
428
|
+
create_ad_label_request = Zernio::CreateAdLabelRequest.new({account_id: 'account_id_example', name: 'name_example'}) # CreateAdLabelRequest |
|
|
429
|
+
|
|
430
|
+
begin
|
|
431
|
+
# Create a Google Ads label
|
|
432
|
+
result = api_instance.create_ad_label(create_ad_label_request)
|
|
433
|
+
p result
|
|
434
|
+
rescue Zernio::ApiError => e
|
|
435
|
+
puts "Error when calling AdAccountsApi->create_ad_label: #{e}"
|
|
436
|
+
end
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
#### Using the create_ad_label_with_http_info variant
|
|
440
|
+
|
|
441
|
+
This returns an Array which contains the response data, status code and headers.
|
|
442
|
+
|
|
443
|
+
> <Array(<CreateAdLabel201Response>, Integer, Hash)> create_ad_label_with_http_info(create_ad_label_request)
|
|
444
|
+
|
|
445
|
+
```ruby
|
|
446
|
+
begin
|
|
447
|
+
# Create a Google Ads label
|
|
448
|
+
data, status_code, headers = api_instance.create_ad_label_with_http_info(create_ad_label_request)
|
|
449
|
+
p status_code # => 2xx
|
|
450
|
+
p headers # => { ... }
|
|
451
|
+
p data # => <CreateAdLabel201Response>
|
|
452
|
+
rescue Zernio::ApiError => e
|
|
453
|
+
puts "Error when calling AdAccountsApi->create_ad_label_with_http_info: #{e}"
|
|
454
|
+
end
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### Parameters
|
|
458
|
+
|
|
459
|
+
| Name | Type | Description | Notes |
|
|
460
|
+
| ---- | ---- | ----------- | ----- |
|
|
461
|
+
| **create_ad_label_request** | [**CreateAdLabelRequest**](CreateAdLabelRequest.md) | | |
|
|
462
|
+
|
|
463
|
+
### Return type
|
|
464
|
+
|
|
465
|
+
[**CreateAdLabel201Response**](CreateAdLabel201Response.md)
|
|
466
|
+
|
|
467
|
+
### Authorization
|
|
468
|
+
|
|
469
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
470
|
+
|
|
471
|
+
### HTTP request headers
|
|
472
|
+
|
|
473
|
+
- **Content-Type**: application/json
|
|
474
|
+
- **Accept**: application/json
|
|
475
|
+
|
|
476
|
+
|
|
332
477
|
## create_ad_negative_keyword_list
|
|
333
478
|
|
|
334
479
|
> <CreateAdNegativeKeywordList201Response> create_ad_negative_keyword_list(create_ad_negative_keyword_list_request)
|
|
@@ -834,6 +979,77 @@ end
|
|
|
834
979
|
- **Accept**: application/json
|
|
835
980
|
|
|
836
981
|
|
|
982
|
+
## detach_ad_label
|
|
983
|
+
|
|
984
|
+
> <DetachAdLabel200Response> detach_ad_label(label_id, google_ad_label_assignments)
|
|
985
|
+
|
|
986
|
+
Detach a Google Ads label
|
|
987
|
+
|
|
988
|
+
Removes the label from the given targets. Idempotent; a target without the label is counted in `unchanged`.
|
|
989
|
+
|
|
990
|
+
### Examples
|
|
991
|
+
|
|
992
|
+
```ruby
|
|
993
|
+
require 'time'
|
|
994
|
+
require 'zernio-sdk'
|
|
995
|
+
# setup authorization
|
|
996
|
+
Zernio.configure do |config|
|
|
997
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
998
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
999
|
+
end
|
|
1000
|
+
|
|
1001
|
+
api_instance = Zernio::AdAccountsApi.new
|
|
1002
|
+
label_id = 'label_id_example' # String | Google label id
|
|
1003
|
+
google_ad_label_assignments = Zernio::GoogleAdLabelAssignments.new({account_id: 'account_id_example'}) # GoogleAdLabelAssignments |
|
|
1004
|
+
|
|
1005
|
+
begin
|
|
1006
|
+
# Detach a Google Ads label
|
|
1007
|
+
result = api_instance.detach_ad_label(label_id, google_ad_label_assignments)
|
|
1008
|
+
p result
|
|
1009
|
+
rescue Zernio::ApiError => e
|
|
1010
|
+
puts "Error when calling AdAccountsApi->detach_ad_label: #{e}"
|
|
1011
|
+
end
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
#### Using the detach_ad_label_with_http_info variant
|
|
1015
|
+
|
|
1016
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1017
|
+
|
|
1018
|
+
> <Array(<DetachAdLabel200Response>, Integer, Hash)> detach_ad_label_with_http_info(label_id, google_ad_label_assignments)
|
|
1019
|
+
|
|
1020
|
+
```ruby
|
|
1021
|
+
begin
|
|
1022
|
+
# Detach a Google Ads label
|
|
1023
|
+
data, status_code, headers = api_instance.detach_ad_label_with_http_info(label_id, google_ad_label_assignments)
|
|
1024
|
+
p status_code # => 2xx
|
|
1025
|
+
p headers # => { ... }
|
|
1026
|
+
p data # => <DetachAdLabel200Response>
|
|
1027
|
+
rescue Zernio::ApiError => e
|
|
1028
|
+
puts "Error when calling AdAccountsApi->detach_ad_label_with_http_info: #{e}"
|
|
1029
|
+
end
|
|
1030
|
+
```
|
|
1031
|
+
|
|
1032
|
+
### Parameters
|
|
1033
|
+
|
|
1034
|
+
| Name | Type | Description | Notes |
|
|
1035
|
+
| ---- | ---- | ----------- | ----- |
|
|
1036
|
+
| **label_id** | **String** | Google label id | |
|
|
1037
|
+
| **google_ad_label_assignments** | [**GoogleAdLabelAssignments**](GoogleAdLabelAssignments.md) | | |
|
|
1038
|
+
|
|
1039
|
+
### Return type
|
|
1040
|
+
|
|
1041
|
+
[**DetachAdLabel200Response**](DetachAdLabel200Response.md)
|
|
1042
|
+
|
|
1043
|
+
### Authorization
|
|
1044
|
+
|
|
1045
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1046
|
+
|
|
1047
|
+
### HTTP request headers
|
|
1048
|
+
|
|
1049
|
+
- **Content-Type**: application/json
|
|
1050
|
+
- **Accept**: application/json
|
|
1051
|
+
|
|
1052
|
+
|
|
837
1053
|
## get_ad_account_finance
|
|
838
1054
|
|
|
839
1055
|
> <GetAdAccountFinance200Response> get_ad_account_finance(account_id, ad_account_id)
|
|
@@ -1815,11 +2031,11 @@ end
|
|
|
1815
2031
|
|
|
1816
2032
|
## list_ad_labels
|
|
1817
2033
|
|
|
1818
|
-
> <ListAdLabels200Response> list_ad_labels(account_id,
|
|
2034
|
+
> <ListAdLabels200Response> list_ad_labels(account_id, opts)
|
|
1819
2035
|
|
|
1820
|
-
|
|
2036
|
+
List ad labels
|
|
1821
2037
|
|
|
1822
|
-
Lists the ad account
|
|
2038
|
+
Lists the organizational labels on an ad account. - **Meta**: pass `adAccountId=act_<n>`. Rows are Meta's `/act_X/adlabels` returned verbatim (id, name, created/updated time), paginated with `limit` / `after`. - **Google Ads**: pass the numeric customer id as `adAccountId` (optional when the connection has a single customer). Returns every non-removed label as a `GoogleAdLabel` in one page (`paging.after` is always null). Reads are cached for 10 minutes; when the shared Google quota is exhausted the last successful result is served with `stale: true`.
|
|
1823
2039
|
|
|
1824
2040
|
### Examples
|
|
1825
2041
|
|
|
@@ -1833,16 +2049,17 @@ Zernio.configure do |config|
|
|
|
1833
2049
|
end
|
|
1834
2050
|
|
|
1835
2051
|
api_instance = Zernio::AdAccountsApi.new
|
|
1836
|
-
account_id = 'account_id_example' # String | Zernio SocialAccount id
|
|
1837
|
-
ad_account_id = 'ad_account_id_example' # String | Meta ad account id (act_<n>).
|
|
2052
|
+
account_id = 'account_id_example' # String | Zernio SocialAccount id. For Meta, the posting or ads variant used to resolve the token.
|
|
1838
2053
|
opts = {
|
|
1839
|
-
|
|
1840
|
-
|
|
2054
|
+
ad_account_id: 'ad_account_id_example', # String | Meta ad account id (act_<n>), or the Google Ads customer id (digits only).
|
|
2055
|
+
customer_id: 'customer_id_example', # String | Google only. Alias of adAccountId, kept for existing callers.
|
|
2056
|
+
limit: 56, # Integer | Meta only. Rows per page.
|
|
2057
|
+
after: 'after_example' # String | Meta only. Cursor from paging.after of the previous page.
|
|
1841
2058
|
}
|
|
1842
2059
|
|
|
1843
2060
|
begin
|
|
1844
|
-
#
|
|
1845
|
-
result = api_instance.list_ad_labels(account_id,
|
|
2061
|
+
# List ad labels
|
|
2062
|
+
result = api_instance.list_ad_labels(account_id, opts)
|
|
1846
2063
|
p result
|
|
1847
2064
|
rescue Zernio::ApiError => e
|
|
1848
2065
|
puts "Error when calling AdAccountsApi->list_ad_labels: #{e}"
|
|
@@ -1853,12 +2070,12 @@ end
|
|
|
1853
2070
|
|
|
1854
2071
|
This returns an Array which contains the response data, status code and headers.
|
|
1855
2072
|
|
|
1856
|
-
> <Array(<ListAdLabels200Response>, Integer, Hash)> list_ad_labels_with_http_info(account_id,
|
|
2073
|
+
> <Array(<ListAdLabels200Response>, Integer, Hash)> list_ad_labels_with_http_info(account_id, opts)
|
|
1857
2074
|
|
|
1858
2075
|
```ruby
|
|
1859
2076
|
begin
|
|
1860
|
-
#
|
|
1861
|
-
data, status_code, headers = api_instance.list_ad_labels_with_http_info(account_id,
|
|
2077
|
+
# List ad labels
|
|
2078
|
+
data, status_code, headers = api_instance.list_ad_labels_with_http_info(account_id, opts)
|
|
1862
2079
|
p status_code # => 2xx
|
|
1863
2080
|
p headers # => { ... }
|
|
1864
2081
|
p data # => <ListAdLabels200Response>
|
|
@@ -1871,10 +2088,11 @@ end
|
|
|
1871
2088
|
|
|
1872
2089
|
| Name | Type | Description | Notes |
|
|
1873
2090
|
| ---- | ---- | ----------- | ----- |
|
|
1874
|
-
| **account_id** | **String** | Zernio SocialAccount id
|
|
1875
|
-
| **ad_account_id** | **String** | Meta ad account id (act_<n>). |
|
|
1876
|
-
| **
|
|
1877
|
-
| **
|
|
2091
|
+
| **account_id** | **String** | Zernio SocialAccount id. For Meta, the posting or ads variant used to resolve the token. | |
|
|
2092
|
+
| **ad_account_id** | **String** | Meta ad account id (act_<n>), or the Google Ads customer id (digits only). | [optional] |
|
|
2093
|
+
| **customer_id** | **String** | Google only. Alias of adAccountId, kept for existing callers. | [optional] |
|
|
2094
|
+
| **limit** | **Integer** | Meta only. Rows per page. | [optional][default to 25] |
|
|
2095
|
+
| **after** | **String** | Meta only. Cursor from paging.after of the previous page. | [optional] |
|
|
1878
2096
|
|
|
1879
2097
|
### Return type
|
|
1880
2098
|
|
|
@@ -2922,6 +3140,83 @@ end
|
|
|
2922
3140
|
- **Accept**: application/json
|
|
2923
3141
|
|
|
2924
3142
|
|
|
3143
|
+
## remove_ad_label
|
|
3144
|
+
|
|
3145
|
+
> <RemoveAdLabel200Response> remove_ad_label(label_id, account_id, opts)
|
|
3146
|
+
|
|
3147
|
+
Remove a Google Ads label
|
|
3148
|
+
|
|
3149
|
+
Removes the label. Google drops it from every campaign, ad group, ad and keyword it was attached to.
|
|
3150
|
+
|
|
3151
|
+
### Examples
|
|
3152
|
+
|
|
3153
|
+
```ruby
|
|
3154
|
+
require 'time'
|
|
3155
|
+
require 'zernio-sdk'
|
|
3156
|
+
# setup authorization
|
|
3157
|
+
Zernio.configure do |config|
|
|
3158
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
3159
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3160
|
+
end
|
|
3161
|
+
|
|
3162
|
+
api_instance = Zernio::AdAccountsApi.new
|
|
3163
|
+
label_id = 'label_id_example' # String | Google label id
|
|
3164
|
+
account_id = 'account_id_example' # String | Zernio SocialAccount id (Google Ads)
|
|
3165
|
+
opts = {
|
|
3166
|
+
ad_account_id: 'ad_account_id_example', # String | Google customer id. Required when the connection has multiple customers.
|
|
3167
|
+
customer_id: 'customer_id_example' # String | Alias of adAccountId
|
|
3168
|
+
}
|
|
3169
|
+
|
|
3170
|
+
begin
|
|
3171
|
+
# Remove a Google Ads label
|
|
3172
|
+
result = api_instance.remove_ad_label(label_id, account_id, opts)
|
|
3173
|
+
p result
|
|
3174
|
+
rescue Zernio::ApiError => e
|
|
3175
|
+
puts "Error when calling AdAccountsApi->remove_ad_label: #{e}"
|
|
3176
|
+
end
|
|
3177
|
+
```
|
|
3178
|
+
|
|
3179
|
+
#### Using the remove_ad_label_with_http_info variant
|
|
3180
|
+
|
|
3181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3182
|
+
|
|
3183
|
+
> <Array(<RemoveAdLabel200Response>, Integer, Hash)> remove_ad_label_with_http_info(label_id, account_id, opts)
|
|
3184
|
+
|
|
3185
|
+
```ruby
|
|
3186
|
+
begin
|
|
3187
|
+
# Remove a Google Ads label
|
|
3188
|
+
data, status_code, headers = api_instance.remove_ad_label_with_http_info(label_id, account_id, opts)
|
|
3189
|
+
p status_code # => 2xx
|
|
3190
|
+
p headers # => { ... }
|
|
3191
|
+
p data # => <RemoveAdLabel200Response>
|
|
3192
|
+
rescue Zernio::ApiError => e
|
|
3193
|
+
puts "Error when calling AdAccountsApi->remove_ad_label_with_http_info: #{e}"
|
|
3194
|
+
end
|
|
3195
|
+
```
|
|
3196
|
+
|
|
3197
|
+
### Parameters
|
|
3198
|
+
|
|
3199
|
+
| Name | Type | Description | Notes |
|
|
3200
|
+
| ---- | ---- | ----------- | ----- |
|
|
3201
|
+
| **label_id** | **String** | Google label id | |
|
|
3202
|
+
| **account_id** | **String** | Zernio SocialAccount id (Google Ads) | |
|
|
3203
|
+
| **ad_account_id** | **String** | Google customer id. Required when the connection has multiple customers. | [optional] |
|
|
3204
|
+
| **customer_id** | **String** | Alias of adAccountId | [optional] |
|
|
3205
|
+
|
|
3206
|
+
### Return type
|
|
3207
|
+
|
|
3208
|
+
[**RemoveAdLabel200Response**](RemoveAdLabel200Response.md)
|
|
3209
|
+
|
|
3210
|
+
### Authorization
|
|
3211
|
+
|
|
3212
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3213
|
+
|
|
3214
|
+
### HTTP request headers
|
|
3215
|
+
|
|
3216
|
+
- **Content-Type**: Not defined
|
|
3217
|
+
- **Accept**: application/json
|
|
3218
|
+
|
|
3219
|
+
|
|
2925
3220
|
## replace_ad_negative_keyword_list_keywords
|
|
2926
3221
|
|
|
2927
3222
|
> <ReplaceAdNegativeKeywordListKeywords200Response> replace_ad_negative_keyword_list_keywords(list_id, replace_ad_negative_keyword_list_keywords_request)
|
|
@@ -3348,6 +3643,77 @@ end
|
|
|
3348
3643
|
- **Accept**: application/json
|
|
3349
3644
|
|
|
3350
3645
|
|
|
3646
|
+
## update_ad_label
|
|
3647
|
+
|
|
3648
|
+
> <UpdateAdLabel200Response> update_ad_label(label_id, update_ad_label_request)
|
|
3649
|
+
|
|
3650
|
+
Update a Google Ads label
|
|
3651
|
+
|
|
3652
|
+
Changes the name, color or description of a label. Only the fields sent are written.
|
|
3653
|
+
|
|
3654
|
+
### Examples
|
|
3655
|
+
|
|
3656
|
+
```ruby
|
|
3657
|
+
require 'time'
|
|
3658
|
+
require 'zernio-sdk'
|
|
3659
|
+
# setup authorization
|
|
3660
|
+
Zernio.configure do |config|
|
|
3661
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
3662
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3663
|
+
end
|
|
3664
|
+
|
|
3665
|
+
api_instance = Zernio::AdAccountsApi.new
|
|
3666
|
+
label_id = 'label_id_example' # String | Google label id
|
|
3667
|
+
update_ad_label_request = Zernio::UpdateAdLabelRequest.new({account_id: 'account_id_example'}) # UpdateAdLabelRequest |
|
|
3668
|
+
|
|
3669
|
+
begin
|
|
3670
|
+
# Update a Google Ads label
|
|
3671
|
+
result = api_instance.update_ad_label(label_id, update_ad_label_request)
|
|
3672
|
+
p result
|
|
3673
|
+
rescue Zernio::ApiError => e
|
|
3674
|
+
puts "Error when calling AdAccountsApi->update_ad_label: #{e}"
|
|
3675
|
+
end
|
|
3676
|
+
```
|
|
3677
|
+
|
|
3678
|
+
#### Using the update_ad_label_with_http_info variant
|
|
3679
|
+
|
|
3680
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3681
|
+
|
|
3682
|
+
> <Array(<UpdateAdLabel200Response>, Integer, Hash)> update_ad_label_with_http_info(label_id, update_ad_label_request)
|
|
3683
|
+
|
|
3684
|
+
```ruby
|
|
3685
|
+
begin
|
|
3686
|
+
# Update a Google Ads label
|
|
3687
|
+
data, status_code, headers = api_instance.update_ad_label_with_http_info(label_id, update_ad_label_request)
|
|
3688
|
+
p status_code # => 2xx
|
|
3689
|
+
p headers # => { ... }
|
|
3690
|
+
p data # => <UpdateAdLabel200Response>
|
|
3691
|
+
rescue Zernio::ApiError => e
|
|
3692
|
+
puts "Error when calling AdAccountsApi->update_ad_label_with_http_info: #{e}"
|
|
3693
|
+
end
|
|
3694
|
+
```
|
|
3695
|
+
|
|
3696
|
+
### Parameters
|
|
3697
|
+
|
|
3698
|
+
| Name | Type | Description | Notes |
|
|
3699
|
+
| ---- | ---- | ----------- | ----- |
|
|
3700
|
+
| **label_id** | **String** | Google label id | |
|
|
3701
|
+
| **update_ad_label_request** | [**UpdateAdLabelRequest**](UpdateAdLabelRequest.md) | | |
|
|
3702
|
+
|
|
3703
|
+
### Return type
|
|
3704
|
+
|
|
3705
|
+
[**UpdateAdLabel200Response**](UpdateAdLabel200Response.md)
|
|
3706
|
+
|
|
3707
|
+
### Authorization
|
|
3708
|
+
|
|
3709
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3710
|
+
|
|
3711
|
+
### HTTP request headers
|
|
3712
|
+
|
|
3713
|
+
- **Content-Type**: application/json
|
|
3714
|
+
- **Accept**: application/json
|
|
3715
|
+
|
|
3716
|
+
|
|
3351
3717
|
## update_ad_negative_keyword_list
|
|
3352
3718
|
|
|
3353
3719
|
> <UpdateAdNegativeKeywordList200Response> update_ad_negative_keyword_list(list_id, update_ad_negative_keyword_list_request)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zernio::AttachAdLabel200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer_id** | **String** | | [optional] |
|
|
8
|
+
| **label_id** | **String** | | [optional] |
|
|
9
|
+
| **attached** | **Integer** | Links created by this call | [optional] |
|
|
10
|
+
| **unchanged** | **Integer** | Targets that already carried the label | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zernio-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Zernio::AttachAdLabel200Response.new(
|
|
18
|
+
customer_id: null,
|
|
19
|
+
label_id: null,
|
|
20
|
+
attached: null,
|
|
21
|
+
unchanged: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::CreateAdLabel201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer_id** | **String** | | [optional] |
|
|
8
|
+
| **id** | **String** | Google label id | [optional] |
|
|
9
|
+
| **resource_name** | **String** | customers/{customerId}/labels/{id} | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::CreateAdLabel201Response.new(
|
|
17
|
+
customer_id: null,
|
|
18
|
+
id: null,
|
|
19
|
+
resource_name: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|