late-sdk 0.0.1044 → 0.0.1045
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/docs/AdAccountsApi.md +16 -2
- data/docs/AdCampaignsApi.md +12 -4
- data/docs/AdInsightsApi.md +17 -9
- data/docs/AddAccountCalloutsRequest.md +3 -1
- data/docs/AddAccountSitelinksRequest.md +3 -1
- data/docs/AddAccountStructuredSnippetsRequest.md +3 -1
- data/docs/AttachCampaignAssetsRequest.md +3 -1
- data/docs/ConversionsApi.md +5 -3
- data/docs/CreateAdNegativeKeywordListRequest.md +3 -1
- data/docs/CreateAdSetRequest.md +3 -1
- data/docs/CreateBidStrategyRequest.md +3 -1
- data/docs/CreateConversionActionRequest.md +3 -1
- data/docs/GenerateKeywordHistoricalMetricsRequest.md +3 -1
- data/docs/GenerateKeywordIdeasRequest.md +3 -1
- data/docs/RemoveAccountCalloutRequest.md +3 -1
- data/docs/RemoveAdGroupAssetsRequest.md +3 -1
- data/docs/RemoveCampaignAssetsRequest.md +3 -1
- data/docs/ReplaceAdNegativeKeywordListKeywordsRequest.md +3 -1
- data/docs/UpdateAccountCalloutsRequest.md +3 -1
- data/docs/UpdateAccountSitelinksRequest.md +3 -1
- data/docs/UpdateAccountStructuredSnippetsRequest.md +3 -1
- data/docs/UpdateAdNegativeKeywordListRequest.md +3 -1
- data/docs/UpdateBidStrategyRequest.md +3 -1
- data/docs/UpdateCampaignAssetsRequest.md +3 -1
- data/lib/zernio-sdk/api/ad_accounts_api.rb +53 -2
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +26 -4
- data/lib/zernio-sdk/api/ad_insights_api.rb +22 -10
- data/lib/zernio-sdk/api/conversions_api.rb +7 -4
- data/lib/zernio-sdk/models/add_account_callouts_request.rb +33 -2
- data/lib/zernio-sdk/models/add_account_sitelinks_request.rb +33 -2
- data/lib/zernio-sdk/models/add_account_structured_snippets_request.rb +33 -2
- data/lib/zernio-sdk/models/attach_campaign_assets_request.rb +33 -2
- data/lib/zernio-sdk/models/create_ad_negative_keyword_list_request.rb +33 -2
- data/lib/zernio-sdk/models/create_ad_set_request.rb +12 -2
- data/lib/zernio-sdk/models/create_bid_strategy_request.rb +12 -2
- data/lib/zernio-sdk/models/create_conversion_action_request.rb +12 -2
- data/lib/zernio-sdk/models/generate_keyword_historical_metrics_request.rb +12 -2
- data/lib/zernio-sdk/models/generate_keyword_ideas_request.rb +12 -2
- data/lib/zernio-sdk/models/remove_account_callout_request.rb +33 -2
- data/lib/zernio-sdk/models/remove_ad_group_assets_request.rb +33 -2
- data/lib/zernio-sdk/models/remove_campaign_assets_request.rb +33 -2
- data/lib/zernio-sdk/models/replace_ad_negative_keyword_list_keywords_request.rb +33 -2
- data/lib/zernio-sdk/models/update_account_callouts_request.rb +33 -2
- data/lib/zernio-sdk/models/update_account_sitelinks_request.rb +33 -2
- data/lib/zernio-sdk/models/update_account_structured_snippets_request.rb +33 -2
- data/lib/zernio-sdk/models/update_ad_negative_keyword_list_request.rb +33 -2
- data/lib/zernio-sdk/models/update_bid_strategy_request.rb +12 -2
- data/lib/zernio-sdk/models/update_campaign_assets_request.rb +33 -2
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +1 -1
- data/spec/api/ad_accounts_api_spec.rb +8 -1
- data/spec/api/ad_campaigns_api_spec.rb +6 -2
- data/spec/api/ad_insights_api_spec.rb +9 -5
- data/spec/api/conversions_api_spec.rb +3 -2
- data/spec/models/add_account_callouts_request_spec.rb +6 -0
- data/spec/models/add_account_sitelinks_request_spec.rb +6 -0
- data/spec/models/add_account_structured_snippets_request_spec.rb +6 -0
- data/spec/models/attach_campaign_assets_request_spec.rb +6 -0
- data/spec/models/create_ad_negative_keyword_list_request_spec.rb +6 -0
- data/spec/models/create_ad_set_request_spec.rb +6 -0
- data/spec/models/create_bid_strategy_request_spec.rb +6 -0
- data/spec/models/create_conversion_action_request_spec.rb +6 -0
- data/spec/models/generate_keyword_historical_metrics_request_spec.rb +6 -0
- data/spec/models/generate_keyword_ideas_request_spec.rb +6 -0
- data/spec/models/remove_account_callout_request_spec.rb +6 -0
- data/spec/models/remove_ad_group_assets_request_spec.rb +6 -0
- data/spec/models/remove_campaign_assets_request_spec.rb +6 -0
- data/spec/models/replace_ad_negative_keyword_list_keywords_request_spec.rb +6 -0
- data/spec/models/update_account_callouts_request_spec.rb +6 -0
- data/spec/models/update_account_sitelinks_request_spec.rb +6 -0
- data/spec/models/update_account_structured_snippets_request_spec.rb +6 -0
- data/spec/models/update_ad_negative_keyword_list_request_spec.rb +6 -0
- data/spec/models/update_bid_strategy_request_spec.rb +6 -0
- data/spec/models/update_campaign_assets_request_spec.rb +6 -0
- data/zernio-sdk-0.0.1045.gem +0 -0
- metadata +2152 -2152
- data/zernio-sdk-0.0.1044.gem +0 -0
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **account_id** | **String** | Zernio Google Ads connection id. | |
|
|
8
|
-
| **
|
|
8
|
+
| **ad_account_id** | **String** | Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple customers. | [optional] |
|
|
9
|
+
| **customer_id** | **String** | Alias of adAccountId, kept for existing callers | [optional] |
|
|
9
10
|
| **updates** | [**Array<UpdateAccountStructuredSnippetsRequestUpdatesInner>**](UpdateAccountStructuredSnippetsRequestUpdatesInner.md) | | |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
@@ -15,6 +16,7 @@ require 'zernio-sdk'
|
|
|
15
16
|
|
|
16
17
|
instance = Zernio::UpdateAccountStructuredSnippetsRequest.new(
|
|
17
18
|
account_id: null,
|
|
19
|
+
ad_account_id: null,
|
|
18
20
|
customer_id: null,
|
|
19
21
|
updates: null
|
|
20
22
|
)
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **account_id** | **String** | Zernio SocialAccount id. | |
|
|
8
|
-
| **
|
|
8
|
+
| **ad_account_id** | **String** | Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple customers. | [optional] |
|
|
9
|
+
| **customer_id** | **String** | Alias of adAccountId, kept for existing callers | [optional] |
|
|
9
10
|
| **platform** | **String** | Optional courtesy field. The resolved account or campaign determines support; other platforms return 501. | [optional] |
|
|
10
11
|
| **name** | **String** | Nonempty list name, trimmed before use. | |
|
|
11
12
|
|
|
@@ -16,6 +17,7 @@ require 'zernio-sdk'
|
|
|
16
17
|
|
|
17
18
|
instance = Zernio::UpdateAdNegativeKeywordListRequest.new(
|
|
18
19
|
account_id: null,
|
|
20
|
+
ad_account_id: null,
|
|
19
21
|
customer_id: null,
|
|
20
22
|
platform: null,
|
|
21
23
|
name: null
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **account_id** | **String** | Google ads SocialAccount id. | |
|
|
8
|
-
| **
|
|
8
|
+
| **ad_account_id** | **String** | Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer. | [optional] |
|
|
9
|
+
| **customer_id** | **String** | Alias of adAccountId, kept for existing callers | [optional] |
|
|
9
10
|
| **name** | **String** | | [optional] |
|
|
10
11
|
| **type** | **String** | | [optional] |
|
|
11
12
|
| **target_cpa** | **Float** | | [optional] |
|
|
@@ -18,6 +19,7 @@ require 'zernio-sdk'
|
|
|
18
19
|
|
|
19
20
|
instance = Zernio::UpdateBidStrategyRequest.new(
|
|
20
21
|
account_id: null,
|
|
22
|
+
ad_account_id: null,
|
|
21
23
|
customer_id: null,
|
|
22
24
|
name: null,
|
|
23
25
|
type: null,
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **account_id** | **String** | Zernio Google Ads connection id. | |
|
|
8
|
-
| **
|
|
8
|
+
| **ad_account_id** | **String** | Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple customers. | [optional] |
|
|
9
|
+
| **customer_id** | **String** | Alias of adAccountId, kept for existing callers | [optional] |
|
|
9
10
|
| **updates** | [**Array<GoogleAssetUpdate>**](GoogleAssetUpdate.md) | | |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
@@ -15,6 +16,7 @@ require 'zernio-sdk'
|
|
|
15
16
|
|
|
16
17
|
instance = Zernio::UpdateCampaignAssetsRequest.new(
|
|
17
18
|
account_id: null,
|
|
19
|
+
ad_account_id: null,
|
|
18
20
|
customer_id: null,
|
|
19
21
|
updates: null
|
|
20
22
|
)
|
|
@@ -654,6 +654,7 @@ module Zernio
|
|
|
654
654
|
# @param list_id [String]
|
|
655
655
|
# @param account_id [String]
|
|
656
656
|
# @param [Hash] opts the optional parameters
|
|
657
|
+
# @option opts [String] :ad_account_id
|
|
657
658
|
# @option opts [String] :customer_id
|
|
658
659
|
# @option opts [String] :platform
|
|
659
660
|
# @return [DeleteAdNegativeKeywordList200Response]
|
|
@@ -667,6 +668,7 @@ module Zernio
|
|
|
667
668
|
# @param list_id [String]
|
|
668
669
|
# @param account_id [String]
|
|
669
670
|
# @param [Hash] opts the optional parameters
|
|
671
|
+
# @option opts [String] :ad_account_id
|
|
670
672
|
# @option opts [String] :customer_id
|
|
671
673
|
# @option opts [String] :platform
|
|
672
674
|
# @return [Array<(DeleteAdNegativeKeywordList200Response, Integer, Hash)>] DeleteAdNegativeKeywordList200Response data, response status code and response headers
|
|
@@ -692,6 +694,11 @@ module Zernio
|
|
|
692
694
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.delete_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
693
695
|
end
|
|
694
696
|
|
|
697
|
+
pattern = Regexp.new(/^\d+$/)
|
|
698
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
699
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.delete_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
700
|
+
end
|
|
701
|
+
|
|
695
702
|
pattern = Regexp.new(/^\d+$/)
|
|
696
703
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
697
704
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.delete_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
@@ -707,6 +714,7 @@ module Zernio
|
|
|
707
714
|
# query parameters
|
|
708
715
|
query_params = opts[:query_params] || {}
|
|
709
716
|
query_params[:'accountId'] = account_id
|
|
717
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
710
718
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
711
719
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
712
720
|
|
|
@@ -980,6 +988,7 @@ module Zernio
|
|
|
980
988
|
# @param list_id [String]
|
|
981
989
|
# @param account_id [String]
|
|
982
990
|
# @param [Hash] opts the optional parameters
|
|
991
|
+
# @option opts [String] :ad_account_id
|
|
983
992
|
# @option opts [String] :customer_id
|
|
984
993
|
# @option opts [String] :platform
|
|
985
994
|
# @return [GetAdNegativeKeywordList200Response]
|
|
@@ -993,6 +1002,7 @@ module Zernio
|
|
|
993
1002
|
# @param list_id [String]
|
|
994
1003
|
# @param account_id [String]
|
|
995
1004
|
# @param [Hash] opts the optional parameters
|
|
1005
|
+
# @option opts [String] :ad_account_id
|
|
996
1006
|
# @option opts [String] :customer_id
|
|
997
1007
|
# @option opts [String] :platform
|
|
998
1008
|
# @return [Array<(GetAdNegativeKeywordList200Response, Integer, Hash)>] GetAdNegativeKeywordList200Response data, response status code and response headers
|
|
@@ -1018,6 +1028,11 @@ module Zernio
|
|
|
1018
1028
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.get_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
1019
1029
|
end
|
|
1020
1030
|
|
|
1031
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1032
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
1033
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.get_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
1034
|
+
end
|
|
1035
|
+
|
|
1021
1036
|
pattern = Regexp.new(/^\d+$/)
|
|
1022
1037
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1023
1038
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.get_ad_negative_keyword_list, must conform to the pattern #{pattern}."
|
|
@@ -1033,6 +1048,7 @@ module Zernio
|
|
|
1033
1048
|
# query parameters
|
|
1034
1049
|
query_params = opts[:query_params] || {}
|
|
1035
1050
|
query_params[:'accountId'] = account_id
|
|
1051
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1036
1052
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1037
1053
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
1038
1054
|
|
|
@@ -1559,6 +1575,7 @@ module Zernio
|
|
|
1559
1575
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included. Preserves Google RMF C.75 account-level callouts.
|
|
1560
1576
|
# @param account_id [String]
|
|
1561
1577
|
# @param [Hash] opts the optional parameters
|
|
1578
|
+
# @option opts [String] :ad_account_id
|
|
1562
1579
|
# @option opts [String] :customer_id
|
|
1563
1580
|
# @return [ListAccountCallouts200Response]
|
|
1564
1581
|
def list_account_callouts(account_id, opts = {})
|
|
@@ -1570,6 +1587,7 @@ module Zernio
|
|
|
1570
1587
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included. Preserves Google RMF C.75 account-level callouts.
|
|
1571
1588
|
# @param account_id [String]
|
|
1572
1589
|
# @param [Hash] opts the optional parameters
|
|
1590
|
+
# @option opts [String] :ad_account_id
|
|
1573
1591
|
# @option opts [String] :customer_id
|
|
1574
1592
|
# @return [Array<(ListAccountCallouts200Response, Integer, Hash)>] ListAccountCallouts200Response data, response status code and response headers
|
|
1575
1593
|
def list_account_callouts_with_http_info(account_id, opts = {})
|
|
@@ -1585,6 +1603,11 @@ module Zernio
|
|
|
1585
1603
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.list_account_callouts, must conform to the pattern #{pattern}."
|
|
1586
1604
|
end
|
|
1587
1605
|
|
|
1606
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1607
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
1608
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.list_account_callouts, must conform to the pattern #{pattern}."
|
|
1609
|
+
end
|
|
1610
|
+
|
|
1588
1611
|
pattern = Regexp.new(/^\d+$/)
|
|
1589
1612
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1590
1613
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.list_account_callouts, must conform to the pattern #{pattern}."
|
|
@@ -1596,6 +1619,7 @@ module Zernio
|
|
|
1596
1619
|
# query parameters
|
|
1597
1620
|
query_params = opts[:query_params] || {}
|
|
1598
1621
|
query_params[:'accountId'] = account_id
|
|
1622
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1599
1623
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1600
1624
|
|
|
1601
1625
|
# header parameters
|
|
@@ -1636,6 +1660,7 @@ module Zernio
|
|
|
1636
1660
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included.
|
|
1637
1661
|
# @param account_id [String]
|
|
1638
1662
|
# @param [Hash] opts the optional parameters
|
|
1663
|
+
# @option opts [String] :ad_account_id
|
|
1639
1664
|
# @option opts [String] :customer_id
|
|
1640
1665
|
# @return [ListAccountSitelinks200Response]
|
|
1641
1666
|
def list_account_sitelinks(account_id, opts = {})
|
|
@@ -1647,6 +1672,7 @@ module Zernio
|
|
|
1647
1672
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included.
|
|
1648
1673
|
# @param account_id [String]
|
|
1649
1674
|
# @param [Hash] opts the optional parameters
|
|
1675
|
+
# @option opts [String] :ad_account_id
|
|
1650
1676
|
# @option opts [String] :customer_id
|
|
1651
1677
|
# @return [Array<(ListAccountSitelinks200Response, Integer, Hash)>] ListAccountSitelinks200Response data, response status code and response headers
|
|
1652
1678
|
def list_account_sitelinks_with_http_info(account_id, opts = {})
|
|
@@ -1662,6 +1688,11 @@ module Zernio
|
|
|
1662
1688
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.list_account_sitelinks, must conform to the pattern #{pattern}."
|
|
1663
1689
|
end
|
|
1664
1690
|
|
|
1691
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1692
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
1693
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.list_account_sitelinks, must conform to the pattern #{pattern}."
|
|
1694
|
+
end
|
|
1695
|
+
|
|
1665
1696
|
pattern = Regexp.new(/^\d+$/)
|
|
1666
1697
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1667
1698
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.list_account_sitelinks, must conform to the pattern #{pattern}."
|
|
@@ -1673,6 +1704,7 @@ module Zernio
|
|
|
1673
1704
|
# query parameters
|
|
1674
1705
|
query_params = opts[:query_params] || {}
|
|
1675
1706
|
query_params[:'accountId'] = account_id
|
|
1707
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1676
1708
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1677
1709
|
|
|
1678
1710
|
# header parameters
|
|
@@ -1713,6 +1745,7 @@ module Zernio
|
|
|
1713
1745
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included.
|
|
1714
1746
|
# @param account_id [String]
|
|
1715
1747
|
# @param [Hash] opts the optional parameters
|
|
1748
|
+
# @option opts [String] :ad_account_id
|
|
1716
1749
|
# @option opts [String] :customer_id
|
|
1717
1750
|
# @return [ListAccountStructuredSnippets200Response]
|
|
1718
1751
|
def list_account_structured_snippets(account_id, opts = {})
|
|
@@ -1724,6 +1757,7 @@ module Zernio
|
|
|
1724
1757
|
# Lists directly attached Google assets. Fresh reads are cached for 10 minutes; exhausted quota may return the last successful read with stale=true. Inherited assets are not included.
|
|
1725
1758
|
# @param account_id [String]
|
|
1726
1759
|
# @param [Hash] opts the optional parameters
|
|
1760
|
+
# @option opts [String] :ad_account_id
|
|
1727
1761
|
# @option opts [String] :customer_id
|
|
1728
1762
|
# @return [Array<(ListAccountStructuredSnippets200Response, Integer, Hash)>] ListAccountStructuredSnippets200Response data, response status code and response headers
|
|
1729
1763
|
def list_account_structured_snippets_with_http_info(account_id, opts = {})
|
|
@@ -1739,6 +1773,11 @@ module Zernio
|
|
|
1739
1773
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.list_account_structured_snippets, must conform to the pattern #{pattern}."
|
|
1740
1774
|
end
|
|
1741
1775
|
|
|
1776
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1777
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
1778
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.list_account_structured_snippets, must conform to the pattern #{pattern}."
|
|
1779
|
+
end
|
|
1780
|
+
|
|
1742
1781
|
pattern = Regexp.new(/^\d+$/)
|
|
1743
1782
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1744
1783
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.list_account_structured_snippets, must conform to the pattern #{pattern}."
|
|
@@ -1750,6 +1789,7 @@ module Zernio
|
|
|
1750
1789
|
# query parameters
|
|
1751
1790
|
query_params = opts[:query_params] || {}
|
|
1752
1791
|
query_params[:'accountId'] = account_id
|
|
1792
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1753
1793
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1754
1794
|
|
|
1755
1795
|
# header parameters
|
|
@@ -1953,6 +1993,7 @@ module Zernio
|
|
|
1953
1993
|
# Google Ads shared negative keyword lists (shared_set type NEGATIVE_KEYWORDS). Reads are cached for 10 minutes; quota exhaustion may return the last successful result for up to 7 days with stale=true. Customer selection is limited to this connection and its account scope.
|
|
1954
1994
|
# @param account_id [String]
|
|
1955
1995
|
# @param [Hash] opts the optional parameters
|
|
1996
|
+
# @option opts [String] :ad_account_id
|
|
1956
1997
|
# @option opts [String] :customer_id
|
|
1957
1998
|
# @option opts [String] :platform
|
|
1958
1999
|
# @return [ListAdNegativeKeywordLists200Response]
|
|
@@ -1965,6 +2006,7 @@ module Zernio
|
|
|
1965
2006
|
# Google Ads shared negative keyword lists (shared_set type NEGATIVE_KEYWORDS). Reads are cached for 10 minutes; quota exhaustion may return the last successful result for up to 7 days with stale=true. Customer selection is limited to this connection and its account scope.
|
|
1966
2007
|
# @param account_id [String]
|
|
1967
2008
|
# @param [Hash] opts the optional parameters
|
|
2009
|
+
# @option opts [String] :ad_account_id
|
|
1968
2010
|
# @option opts [String] :customer_id
|
|
1969
2011
|
# @option opts [String] :platform
|
|
1970
2012
|
# @return [Array<(ListAdNegativeKeywordLists200Response, Integer, Hash)>] ListAdNegativeKeywordLists200Response data, response status code and response headers
|
|
@@ -1981,6 +2023,11 @@ module Zernio
|
|
|
1981
2023
|
fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.list_ad_negative_keyword_lists, must conform to the pattern #{pattern}."
|
|
1982
2024
|
end
|
|
1983
2025
|
|
|
2026
|
+
pattern = Regexp.new(/^\d+$/)
|
|
2027
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
2028
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdAccountsApi.list_ad_negative_keyword_lists, must conform to the pattern #{pattern}."
|
|
2029
|
+
end
|
|
2030
|
+
|
|
1984
2031
|
pattern = Regexp.new(/^\d+$/)
|
|
1985
2032
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1986
2033
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdAccountsApi.list_ad_negative_keyword_lists, must conform to the pattern #{pattern}."
|
|
@@ -1996,6 +2043,7 @@ module Zernio
|
|
|
1996
2043
|
# query parameters
|
|
1997
2044
|
query_params = opts[:query_params] || {}
|
|
1998
2045
|
query_params[:'accountId'] = account_id
|
|
2046
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1999
2047
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
2000
2048
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
2001
2049
|
|
|
@@ -2662,7 +2710,8 @@ module Zernio
|
|
|
2662
2710
|
# Lists pixels and their supported optimization events for a connected TikTok Ads account. The advertiser defaults to the first advertiser on the connection. Reconnect if Pixel Management permission has not been granted.
|
|
2663
2711
|
# @param account_id [String] Zernio SocialAccount ID.
|
|
2664
2712
|
# @param [Hash] opts the optional parameters
|
|
2665
|
-
# @option opts [String] :
|
|
2713
|
+
# @option opts [String] :ad_account_id Platform ad account ID (TikTok advertiser id, digits only). Defaults to the first advertiser on the connection.
|
|
2714
|
+
# @option opts [String] :advertiser_id Alias of adAccountId, kept for existing callers
|
|
2666
2715
|
# @option opts [String] :code Filter by a Pixel Code.
|
|
2667
2716
|
# @return [ListTikTokAdPixels200Response]
|
|
2668
2717
|
def list_tik_tok_ad_pixels(account_id, opts = {})
|
|
@@ -2674,7 +2723,8 @@ module Zernio
|
|
|
2674
2723
|
# Lists pixels and their supported optimization events for a connected TikTok Ads account. The advertiser defaults to the first advertiser on the connection. Reconnect if Pixel Management permission has not been granted.
|
|
2675
2724
|
# @param account_id [String] Zernio SocialAccount ID.
|
|
2676
2725
|
# @param [Hash] opts the optional parameters
|
|
2677
|
-
# @option opts [String] :
|
|
2726
|
+
# @option opts [String] :ad_account_id Platform ad account ID (TikTok advertiser id, digits only). Defaults to the first advertiser on the connection.
|
|
2727
|
+
# @option opts [String] :advertiser_id Alias of adAccountId, kept for existing callers
|
|
2678
2728
|
# @option opts [String] :code Filter by a Pixel Code.
|
|
2679
2729
|
# @return [Array<(ListTikTokAdPixels200Response, Integer, Hash)>] ListTikTokAdPixels200Response data, response status code and response headers
|
|
2680
2730
|
def list_tik_tok_ad_pixels_with_http_info(account_id, opts = {})
|
|
@@ -2696,6 +2746,7 @@ module Zernio
|
|
|
2696
2746
|
# query parameters
|
|
2697
2747
|
query_params = opts[:query_params] || {}
|
|
2698
2748
|
query_params[:'accountId'] = account_id
|
|
2749
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
2699
2750
|
query_params[:'advertiserId'] = opts[:'advertiser_id'] if !opts[:'advertiser_id'].nil?
|
|
2700
2751
|
query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
|
|
2701
2752
|
|
|
@@ -1649,7 +1649,8 @@ module Zernio
|
|
|
1649
1649
|
# @param account_id [String] Zernio Google Ads SocialAccount id: resolves the customer id + refresh token.
|
|
1650
1650
|
# @param platform [String] Required: campaign IDs are not globally unique. Only \"google\" is supported today.
|
|
1651
1651
|
# @param [Hash] opts the optional parameters
|
|
1652
|
-
# @option opts [String] :
|
|
1652
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple Google Ads accounts; optional (and inferred) when it has only one.
|
|
1653
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
1653
1654
|
# @return [GetCampaignBidding200Response]
|
|
1654
1655
|
def get_campaign_bidding(campaign_id, account_id, platform, opts = {})
|
|
1655
1656
|
data, _status_code, _headers = get_campaign_bidding_with_http_info(campaign_id, account_id, platform, opts)
|
|
@@ -1662,7 +1663,8 @@ module Zernio
|
|
|
1662
1663
|
# @param account_id [String] Zernio Google Ads SocialAccount id: resolves the customer id + refresh token.
|
|
1663
1664
|
# @param platform [String] Required: campaign IDs are not globally unique. Only \"google\" is supported today.
|
|
1664
1665
|
# @param [Hash] opts the optional parameters
|
|
1665
|
-
# @option opts [String] :
|
|
1666
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Required when the connection has multiple Google Ads accounts; optional (and inferred) when it has only one.
|
|
1667
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
1666
1668
|
# @return [Array<(GetCampaignBidding200Response, Integer, Hash)>] GetCampaignBidding200Response data, response status code and response headers
|
|
1667
1669
|
def get_campaign_bidding_with_http_info(campaign_id, account_id, platform, opts = {})
|
|
1668
1670
|
if @api_client.config.debugging
|
|
@@ -1692,6 +1694,7 @@ module Zernio
|
|
|
1692
1694
|
query_params = opts[:query_params] || {}
|
|
1693
1695
|
query_params[:'accountId'] = account_id
|
|
1694
1696
|
query_params[:'platform'] = platform
|
|
1697
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1695
1698
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1696
1699
|
|
|
1697
1700
|
# header parameters
|
|
@@ -1926,6 +1929,7 @@ module Zernio
|
|
|
1926
1929
|
# @param ad_set_id [String] Numeric Google platform id.
|
|
1927
1930
|
# @param account_id [String]
|
|
1928
1931
|
# @param [Hash] opts the optional parameters
|
|
1932
|
+
# @option opts [String] :ad_account_id
|
|
1929
1933
|
# @option opts [String] :customer_id
|
|
1930
1934
|
# @return [ListAdGroupAssets200Response]
|
|
1931
1935
|
def list_ad_group_assets(ad_set_id, account_id, opts = {})
|
|
@@ -1938,6 +1942,7 @@ module Zernio
|
|
|
1938
1942
|
# @param ad_set_id [String] Numeric Google platform id.
|
|
1939
1943
|
# @param account_id [String]
|
|
1940
1944
|
# @param [Hash] opts the optional parameters
|
|
1945
|
+
# @option opts [String] :ad_account_id
|
|
1941
1946
|
# @option opts [String] :customer_id
|
|
1942
1947
|
# @return [Array<(ListAdGroupAssets200Response, Integer, Hash)>] ListAdGroupAssets200Response data, response status code and response headers
|
|
1943
1948
|
def list_ad_group_assets_with_http_info(ad_set_id, account_id, opts = {})
|
|
@@ -1962,6 +1967,11 @@ module Zernio
|
|
|
1962
1967
|
fail ArgumentError, "invalid value for 'account_id' when calling AdCampaignsApi.list_ad_group_assets, must conform to the pattern #{pattern}."
|
|
1963
1968
|
end
|
|
1964
1969
|
|
|
1970
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1971
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
1972
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdCampaignsApi.list_ad_group_assets, must conform to the pattern #{pattern}."
|
|
1973
|
+
end
|
|
1974
|
+
|
|
1965
1975
|
pattern = Regexp.new(/^\d+$/)
|
|
1966
1976
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
1967
1977
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdCampaignsApi.list_ad_group_assets, must conform to the pattern #{pattern}."
|
|
@@ -1973,6 +1983,7 @@ module Zernio
|
|
|
1973
1983
|
# query parameters
|
|
1974
1984
|
query_params = opts[:query_params] || {}
|
|
1975
1985
|
query_params[:'accountId'] = account_id
|
|
1986
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1976
1987
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
1977
1988
|
|
|
1978
1989
|
# header parameters
|
|
@@ -2322,7 +2333,8 @@ module Zernio
|
|
|
2322
2333
|
# Bidding strategy report: type, status, campaign count, clicks, cost, cost per conversion, impressions, average CPC and conversions over the date range (default last 30 days). Reads Google's `bidding_strategy` resource, cached for the quota window. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
2323
2334
|
# @param account_id [String] Google ads SocialAccount id.
|
|
2324
2335
|
# @param [Hash] opts the optional parameters
|
|
2325
|
-
# @option opts [String] :
|
|
2336
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
2337
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
2326
2338
|
# @option opts [Date] :from_date Defaults to 30 days ago.
|
|
2327
2339
|
# @option opts [Date] :to_date Defaults to today.
|
|
2328
2340
|
# @return [ListBidStrategies200Response]
|
|
@@ -2335,7 +2347,8 @@ module Zernio
|
|
|
2335
2347
|
# Bidding strategy report: type, status, campaign count, clicks, cost, cost per conversion, impressions, average CPC and conversions over the date range (default last 30 days). Reads Google's `bidding_strategy` resource, cached for the quota window. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
2336
2348
|
# @param account_id [String] Google ads SocialAccount id.
|
|
2337
2349
|
# @param [Hash] opts the optional parameters
|
|
2338
|
-
# @option opts [String] :
|
|
2350
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
2351
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
2339
2352
|
# @option opts [Date] :from_date Defaults to 30 days ago.
|
|
2340
2353
|
# @option opts [Date] :to_date Defaults to today.
|
|
2341
2354
|
# @return [Array<(ListBidStrategies200Response, Integer, Hash)>] ListBidStrategies200Response data, response status code and response headers
|
|
@@ -2353,6 +2366,7 @@ module Zernio
|
|
|
2353
2366
|
# query parameters
|
|
2354
2367
|
query_params = opts[:query_params] || {}
|
|
2355
2368
|
query_params[:'accountId'] = account_id
|
|
2369
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
2356
2370
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
2357
2371
|
query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
2358
2372
|
query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
@@ -2396,6 +2410,7 @@ module Zernio
|
|
|
2396
2410
|
# @param campaign_id [String] Numeric Google platform id.
|
|
2397
2411
|
# @param account_id [String]
|
|
2398
2412
|
# @param [Hash] opts the optional parameters
|
|
2413
|
+
# @option opts [String] :ad_account_id
|
|
2399
2414
|
# @option opts [String] :customer_id
|
|
2400
2415
|
# @return [ListCampaignAssets200Response]
|
|
2401
2416
|
def list_campaign_assets(campaign_id, account_id, opts = {})
|
|
@@ -2408,6 +2423,7 @@ module Zernio
|
|
|
2408
2423
|
# @param campaign_id [String] Numeric Google platform id.
|
|
2409
2424
|
# @param account_id [String]
|
|
2410
2425
|
# @param [Hash] opts the optional parameters
|
|
2426
|
+
# @option opts [String] :ad_account_id
|
|
2411
2427
|
# @option opts [String] :customer_id
|
|
2412
2428
|
# @return [Array<(ListCampaignAssets200Response, Integer, Hash)>] ListCampaignAssets200Response data, response status code and response headers
|
|
2413
2429
|
def list_campaign_assets_with_http_info(campaign_id, account_id, opts = {})
|
|
@@ -2432,6 +2448,11 @@ module Zernio
|
|
|
2432
2448
|
fail ArgumentError, "invalid value for 'account_id' when calling AdCampaignsApi.list_campaign_assets, must conform to the pattern #{pattern}."
|
|
2433
2449
|
end
|
|
2434
2450
|
|
|
2451
|
+
pattern = Regexp.new(/^\d+$/)
|
|
2452
|
+
if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
|
|
2453
|
+
fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdCampaignsApi.list_campaign_assets, must conform to the pattern #{pattern}."
|
|
2454
|
+
end
|
|
2455
|
+
|
|
2435
2456
|
pattern = Regexp.new(/^\d+$/)
|
|
2436
2457
|
if @api_client.config.client_side_validation && !opts[:'customer_id'].nil? && opts[:'customer_id'] !~ pattern
|
|
2437
2458
|
fail ArgumentError, "invalid value for 'opts[:\"customer_id\"]' when calling AdCampaignsApi.list_campaign_assets, must conform to the pattern #{pattern}."
|
|
@@ -2443,6 +2464,7 @@ module Zernio
|
|
|
2443
2464
|
# query parameters
|
|
2444
2465
|
query_params = opts[:query_params] || {}
|
|
2445
2466
|
query_params[:'accountId'] = account_id
|
|
2467
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
2446
2468
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
2447
2469
|
|
|
2448
2470
|
# header parameters
|
|
@@ -383,7 +383,8 @@ module Zernio
|
|
|
383
383
|
# The actual search queries that triggered your ads, with matched-keyword status and spend metrics, the raw material for wasted-spend analysis and negative-keyword lists. Reads Google's `search_term_view`, cached for the quota window; defaults to the last 30 days. Rows are ordered by cost, descending. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
384
384
|
# @param account_id [String] Google ads SocialAccount id.
|
|
385
385
|
# @param [Hash] opts the optional parameters
|
|
386
|
-
# @option opts [String] :
|
|
386
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
387
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
387
388
|
# @option opts [Date] :from_date Defaults to 30 days ago.
|
|
388
389
|
# @option opts [Date] :to_date Defaults to today.
|
|
389
390
|
# @option opts [String] :campaign_id Numeric Google campaign id filter.
|
|
@@ -400,7 +401,8 @@ module Zernio
|
|
|
400
401
|
# The actual search queries that triggered your ads, with matched-keyword status and spend metrics, the raw material for wasted-spend analysis and negative-keyword lists. Reads Google's `search_term_view`, cached for the quota window; defaults to the last 30 days. Rows are ordered by cost, descending. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
401
402
|
# @param account_id [String] Google ads SocialAccount id.
|
|
402
403
|
# @param [Hash] opts the optional parameters
|
|
403
|
-
# @option opts [String] :
|
|
404
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
405
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
404
406
|
# @option opts [Date] :from_date Defaults to 30 days ago.
|
|
405
407
|
# @option opts [Date] :to_date Defaults to today.
|
|
406
408
|
# @option opts [String] :campaign_id Numeric Google campaign id filter.
|
|
@@ -422,6 +424,7 @@ module Zernio
|
|
|
422
424
|
# query parameters
|
|
423
425
|
query_params = opts[:query_params] || {}
|
|
424
426
|
query_params[:'accountId'] = account_id
|
|
427
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
425
428
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
426
429
|
query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
427
430
|
query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
@@ -544,7 +547,8 @@ module Zernio
|
|
|
544
547
|
# @param lead_id [String] Numeric lead id from /v1/ads/local-services/leads.
|
|
545
548
|
# @param account_id [String] Google ads SocialAccount id.
|
|
546
549
|
# @param [Hash] opts the optional parameters
|
|
547
|
-
# @option opts [String] :
|
|
550
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
551
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
548
552
|
# @option opts [String] :page_token Cursor from paging.nextPageToken of the previous page.
|
|
549
553
|
# @return [ListLocalServicesLeadConversations200Response]
|
|
550
554
|
def list_local_services_lead_conversations(lead_id, account_id, opts = {})
|
|
@@ -557,7 +561,8 @@ module Zernio
|
|
|
557
561
|
# @param lead_id [String] Numeric lead id from /v1/ads/local-services/leads.
|
|
558
562
|
# @param account_id [String] Google ads SocialAccount id.
|
|
559
563
|
# @param [Hash] opts the optional parameters
|
|
560
|
-
# @option opts [String] :
|
|
564
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
565
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
561
566
|
# @option opts [String] :page_token Cursor from paging.nextPageToken of the previous page.
|
|
562
567
|
# @return [Array<(ListLocalServicesLeadConversations200Response, Integer, Hash)>] ListLocalServicesLeadConversations200Response data, response status code and response headers
|
|
563
568
|
def list_local_services_lead_conversations_with_http_info(lead_id, account_id, opts = {})
|
|
@@ -578,6 +583,7 @@ module Zernio
|
|
|
578
583
|
# query parameters
|
|
579
584
|
query_params = opts[:query_params] || {}
|
|
580
585
|
query_params[:'accountId'] = account_id
|
|
586
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
581
587
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
582
588
|
query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
|
|
583
589
|
|
|
@@ -619,7 +625,8 @@ module Zernio
|
|
|
619
625
|
# Leads generated by Local Services Ads (phone calls, messages, bookings), read live from Google's `local_services_lead` resource, newest first. No persistence: Google is the source of truth and lead/credit statuses keep changing server-side. Google never returns healthcare-category leads, and `WIPED_OUT` leads arrive with contact erased (`contact` is null). Draws on the shared Google Ads operations budget.
|
|
620
626
|
# @param account_id [String] Google ads SocialAccount id.
|
|
621
627
|
# @param [Hash] opts the optional parameters
|
|
622
|
-
# @option opts [String] :
|
|
628
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
629
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
623
630
|
# @option opts [Date] :from_date Leads created at/after this day.
|
|
624
631
|
# @option opts [Date] :to_date Leads created at/before this day.
|
|
625
632
|
# @option opts [String] :lead_type
|
|
@@ -636,7 +643,8 @@ module Zernio
|
|
|
636
643
|
# Leads generated by Local Services Ads (phone calls, messages, bookings), read live from Google's `local_services_lead` resource, newest first. No persistence: Google is the source of truth and lead/credit statuses keep changing server-side. Google never returns healthcare-category leads, and `WIPED_OUT` leads arrive with contact erased (`contact` is null). Draws on the shared Google Ads operations budget.
|
|
637
644
|
# @param account_id [String] Google ads SocialAccount id.
|
|
638
645
|
# @param [Hash] opts the optional parameters
|
|
639
|
-
# @option opts [String] :
|
|
646
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Defaults to the account's connected customer.
|
|
647
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
640
648
|
# @option opts [Date] :from_date Leads created at/after this day.
|
|
641
649
|
# @option opts [Date] :to_date Leads created at/before this day.
|
|
642
650
|
# @option opts [String] :lead_type
|
|
@@ -662,6 +670,7 @@ module Zernio
|
|
|
662
670
|
# query parameters
|
|
663
671
|
query_params = opts[:query_params] || {}
|
|
664
672
|
query_params[:'accountId'] = account_id
|
|
673
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
665
674
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
666
675
|
query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
667
676
|
query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
|
|
@@ -705,12 +714,13 @@ module Zernio
|
|
|
705
714
|
end
|
|
706
715
|
|
|
707
716
|
# Flexible live insights query
|
|
708
|
-
# Live, flexible insights query. The account's platform picks the contract: **Meta (facebook/instagram)**: forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node; `level` sets row granularity. Semantic validation is Meta's: an unknown field or invalid breakdown combination returns a 400 carrying Meta's message. For long ranges or agency-scale accounts prefer the async variant (POST /v1/ads/insights/reports). **Google Ads (googleads)**: raw GAQL passthrough. Send any read-only GAQL SELECT via `query` (campaign/keyword/search-term/geo/demographic/asset/shopping resources, `change_event`, any `segments.*`) and rows come back verbatim (camelCase, counters as strings). Results are paged at a fixed 10,000 rows; follow `paging.nextPageToken` with `pageToken`. `customerId` is only needed when the connection has several Google Ads accounts. Semantic validation is Google's: an invalid query returns a 400 carrying Google's message (note: selecting `segments.date` requires a finite date filter).
|
|
717
|
+
# Live, flexible insights query. The account's platform picks the contract: **Meta (facebook/instagram)**: forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node; `level` sets row granularity. Semantic validation is Meta's: an unknown field or invalid breakdown combination returns a 400 carrying Meta's message. For long ranges or agency-scale accounts prefer the async variant (POST /v1/ads/insights/reports). **Google Ads (googleads)**: raw GAQL passthrough. Send any read-only GAQL SELECT via `query` (campaign/keyword/search-term/geo/demographic/asset/shopping resources, `change_event`, any `segments.*`) and rows come back verbatim (camelCase, counters as strings). Results are paged at a fixed 10,000 rows; follow `paging.nextPageToken` with `pageToken`. `adAccountId` (alias `customerId`) is only needed when the connection has several Google Ads accounts. Semantic validation is Google's: an invalid query returns a 400 carrying Google's message (note: selecting `segments.date` requires a finite date filter).
|
|
709
718
|
# @param account_id [String] Zernio SocialAccount id (posting or ads variant); its platform selects the Meta or Google contract.
|
|
710
719
|
# @param [Hash] opts the optional parameters
|
|
711
720
|
# @option opts [String] :object_id Meta only (required there): insights node (act_<n>, campaign id, ad set id or ad id).
|
|
712
721
|
# @option opts [String] :query Google only (required there): the GAQL SELECT statement to run.
|
|
713
|
-
# @option opts [String] :
|
|
722
|
+
# @option opts [String] :ad_account_id Google only: platform ad account ID (Google customer ID, digits only) when the connection has several Google Ads accounts.
|
|
723
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
714
724
|
# @option opts [String] :page_token Google only: cursor from paging.nextPageToken of the previous page.
|
|
715
725
|
# @option opts [String] :level Row granularity
|
|
716
726
|
# @option opts [String] :fields Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set.
|
|
@@ -733,12 +743,13 @@ module Zernio
|
|
|
733
743
|
end
|
|
734
744
|
|
|
735
745
|
# Flexible live insights query
|
|
736
|
-
# Live, flexible insights query. The account's platform picks the contract: **Meta (facebook/instagram)**: forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node; `level` sets row granularity. Semantic validation is Meta's: an unknown field or invalid breakdown combination returns a 400 carrying Meta's message. For long ranges or agency-scale accounts prefer the async variant (POST /v1/ads/insights/reports). **Google Ads (googleads)**: raw GAQL passthrough. Send any read-only GAQL SELECT via `query` (campaign/keyword/search-term/geo/demographic/asset/shopping resources, `change_event`, any `segments.*`) and rows come back verbatim (camelCase, counters as strings). Results are paged at a fixed 10,000 rows; follow `paging.nextPageToken` with `pageToken`. `customerId` is only needed when the connection has several Google Ads accounts. Semantic validation is Google's: an invalid query returns a 400 carrying Google's message (note: selecting `segments.date` requires a finite date filter).
|
|
746
|
+
# Live, flexible insights query. The account's platform picks the contract: **Meta (facebook/instagram)**: forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node; `level` sets row granularity. Semantic validation is Meta's: an unknown field or invalid breakdown combination returns a 400 carrying Meta's message. For long ranges or agency-scale accounts prefer the async variant (POST /v1/ads/insights/reports). **Google Ads (googleads)**: raw GAQL passthrough. Send any read-only GAQL SELECT via `query` (campaign/keyword/search-term/geo/demographic/asset/shopping resources, `change_event`, any `segments.*`) and rows come back verbatim (camelCase, counters as strings). Results are paged at a fixed 10,000 rows; follow `paging.nextPageToken` with `pageToken`. `adAccountId` (alias `customerId`) is only needed when the connection has several Google Ads accounts. Semantic validation is Google's: an invalid query returns a 400 carrying Google's message (note: selecting `segments.date` requires a finite date filter).
|
|
737
747
|
# @param account_id [String] Zernio SocialAccount id (posting or ads variant); its platform selects the Meta or Google contract.
|
|
738
748
|
# @param [Hash] opts the optional parameters
|
|
739
749
|
# @option opts [String] :object_id Meta only (required there): insights node (act_<n>, campaign id, ad set id or ad id).
|
|
740
750
|
# @option opts [String] :query Google only (required there): the GAQL SELECT statement to run.
|
|
741
|
-
# @option opts [String] :
|
|
751
|
+
# @option opts [String] :ad_account_id Google only: platform ad account ID (Google customer ID, digits only) when the connection has several Google Ads accounts.
|
|
752
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
742
753
|
# @option opts [String] :page_token Google only: cursor from paging.nextPageToken of the previous page.
|
|
743
754
|
# @option opts [String] :level Row granularity
|
|
744
755
|
# @option opts [String] :fields Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set.
|
|
@@ -787,6 +798,7 @@ module Zernio
|
|
|
787
798
|
query_params[:'accountId'] = account_id
|
|
788
799
|
query_params[:'objectId'] = opts[:'object_id'] if !opts[:'object_id'].nil?
|
|
789
800
|
query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
|
|
801
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
790
802
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
791
803
|
query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
|
|
792
804
|
query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
|
|
@@ -632,10 +632,11 @@ module Zernio
|
|
|
632
632
|
end
|
|
633
633
|
|
|
634
634
|
# List conversion actions
|
|
635
|
-
# Lists Google Ads conversion actions on the resolved customer, all types by default. Each action's `tagSnippets` (global site tag + event snippet) is included when Google has them for that action's type, e.g. `WEBPAGE`. Google-only; other platforms return `501`. Requires the Ads add-on. `customerId` is optional: when omitted, it is resolved from the connection's accessible Google Ads customers, and the call fails with `400` when more than one is accessible (pass `
|
|
635
|
+
# Lists Google Ads conversion actions on the resolved customer, all types by default. Each action's `tagSnippets` (global site tag + event snippet) is included when Google has them for that action's type, e.g. `WEBPAGE`. Google-only; other platforms return `501`. Requires the Ads add-on. `adAccountId` (alias `customerId`) is optional: when omitted, it is resolved from the connection's accessible Google Ads customers, and the call fails with `400` when more than one is accessible (pass `adAccountId` to disambiguate). The list itself is cached for the quota window (1 hour fresh, up to 7 days last-good; the cache key does not vary on `type`). The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
636
636
|
# @param account_id [String] SocialAccount _id (must be a googleads account).
|
|
637
637
|
# @param [Hash] opts the optional parameters
|
|
638
|
-
# @option opts [String] :
|
|
638
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Resolved automatically when the connection has exactly one accessible customer.
|
|
639
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
639
640
|
# @option opts [String] :type Filter by Google's ConversionActionType enum (e.g. WEBPAGE, UPLOAD_CLICKS).
|
|
640
641
|
# @return [ListConversionActions200Response]
|
|
641
642
|
def list_conversion_actions(account_id, opts = {})
|
|
@@ -644,10 +645,11 @@ module Zernio
|
|
|
644
645
|
end
|
|
645
646
|
|
|
646
647
|
# List conversion actions
|
|
647
|
-
# Lists Google Ads conversion actions on the resolved customer, all types by default. Each action's `tagSnippets` (global site tag + event snippet) is included when Google has them for that action's type, e.g. `WEBPAGE`. Google-only; other platforms return `501`. Requires the Ads add-on. `customerId` is optional: when omitted, it is resolved from the connection's accessible Google Ads customers, and the call fails with `400` when more than one is accessible (pass `
|
|
648
|
+
# Lists Google Ads conversion actions on the resolved customer, all types by default. Each action's `tagSnippets` (global site tag + event snippet) is included when Google has them for that action's type, e.g. `WEBPAGE`. Google-only; other platforms return `501`. Requires the Ads add-on. `adAccountId` (alias `customerId`) is optional: when omitted, it is resolved from the connection's accessible Google Ads customers, and the call fails with `400` when more than one is accessible (pass `adAccountId` to disambiguate). The list itself is cached for the quota window (1 hour fresh, up to 7 days last-good; the cache key does not vary on `type`). The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
|
|
648
649
|
# @param account_id [String] SocialAccount _id (must be a googleads account).
|
|
649
650
|
# @param [Hash] opts the optional parameters
|
|
650
|
-
# @option opts [String] :
|
|
651
|
+
# @option opts [String] :ad_account_id Platform ad account ID (Google customer ID, digits only). Resolved automatically when the connection has exactly one accessible customer.
|
|
652
|
+
# @option opts [String] :customer_id Alias of adAccountId, kept for existing callers
|
|
651
653
|
# @option opts [String] :type Filter by Google's ConversionActionType enum (e.g. WEBPAGE, UPLOAD_CLICKS).
|
|
652
654
|
# @return [Array<(ListConversionActions200Response, Integer, Hash)>] ListConversionActions200Response data, response status code and response headers
|
|
653
655
|
def list_conversion_actions_with_http_info(account_id, opts = {})
|
|
@@ -664,6 +666,7 @@ module Zernio
|
|
|
664
666
|
# query parameters
|
|
665
667
|
query_params = opts[:query_params] || {}
|
|
666
668
|
query_params[:'accountId'] = account_id
|
|
669
|
+
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
667
670
|
query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
|
|
668
671
|
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
669
672
|
|