late-sdk 0.0.110 → 0.0.111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -0
- data/docs/AnalyticsApi.md +154 -0
- data/docs/GetGoogleBusinessPerformance200Response.md +28 -0
- data/docs/GetGoogleBusinessPerformance200ResponseDateRange.md +20 -0
- data/docs/GetGoogleBusinessPerformance200ResponseMetricsValue.md +20 -0
- data/docs/GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner.md +20 -0
- data/docs/GetGoogleBusinessPerformance400Response.md +20 -0
- data/docs/GetGoogleBusinessSearchKeywords200Response.md +28 -0
- data/docs/GetGoogleBusinessSearchKeywords200ResponseKeywordsInner.md +20 -0
- data/docs/GetGoogleBusinessSearchKeywords200ResponseMonthRange.md +20 -0
- data/docs/GetGoogleBusinessSearchKeywords400Response.md +18 -0
- data/lib/late-sdk/api/analytics_api.rb +153 -0
- data/lib/late-sdk/models/get_google_business_performance200_response.rb +195 -0
- data/lib/late-sdk/models/get_google_business_performance200_response_date_range.rb +156 -0
- data/lib/late-sdk/models/get_google_business_performance200_response_metrics_value.rb +159 -0
- data/lib/late-sdk/models/get_google_business_performance200_response_metrics_value_values_inner.rb +156 -0
- data/lib/late-sdk/models/get_google_business_performance400_response.rb +158 -0
- data/lib/late-sdk/models/get_google_business_search_keywords200_response.rb +194 -0
- data/lib/late-sdk/models/get_google_business_search_keywords200_response_keywords_inner.rb +156 -0
- data/lib/late-sdk/models/get_google_business_search_keywords200_response_month_range.rb +156 -0
- data/lib/late-sdk/models/get_google_business_search_keywords400_response.rb +147 -0
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +9 -0
- data/openapi.yaml +216 -0
- data/spec/api/analytics_api_spec.rb +29 -0
- data/spec/models/get_google_business_performance200_response_date_range_spec.rb +42 -0
- data/spec/models/get_google_business_performance200_response_metrics_value_spec.rb +42 -0
- data/spec/models/get_google_business_performance200_response_metrics_value_values_inner_spec.rb +42 -0
- data/spec/models/get_google_business_performance200_response_spec.rb +66 -0
- data/spec/models/get_google_business_performance400_response_spec.rb +42 -0
- data/spec/models/get_google_business_search_keywords200_response_keywords_inner_spec.rb +42 -0
- data/spec/models/get_google_business_search_keywords200_response_month_range_spec.rb +42 -0
- data/spec/models/get_google_business_search_keywords200_response_spec.rb +66 -0
- data/spec/models/get_google_business_search_keywords400_response_spec.rb +36 -0
- data/zernio-sdk-0.0.111.gem +0 -0
- metadata +39 -3
- data/zernio-sdk-0.0.110.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aee9ed8e893fedf45e4eadfc12f3faac5f9443b06da905cbc2089efab69a2273
|
|
4
|
+
data.tar.gz: eac0f429572b338933b0273bd2078f4bbad6f64f9ee6cc85ebdcf999bd04118f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 96a637bedcbbaff8909484fbc0c0b490ac774b61904809291ec667c3c0ed6245376e5feea3e011cb49de89e45feb55ce9bafddd8ad549e2abe552f8d3f951c23
|
|
7
|
+
data.tar.gz: 9660e5d02afd22ef9ddbac955f32a3672045d74303b05f3bca6674867f7c8ad8a16c0559dfed00ac9562d2515fcdb0df97e91b9ae4ddbe5ce9f6744e59da2ce0
|
data/README.md
CHANGED
|
@@ -110,6 +110,8 @@ Class | Method | HTTP request | Description
|
|
|
110
110
|
*Late::AnalyticsApi* | [**get_content_decay**](docs/AnalyticsApi.md#get_content_decay) | **GET** /v1/analytics/content-decay | Get content performance decay
|
|
111
111
|
*Late::AnalyticsApi* | [**get_daily_metrics**](docs/AnalyticsApi.md#get_daily_metrics) | **GET** /v1/analytics/daily-metrics | Get daily aggregated metrics
|
|
112
112
|
*Late::AnalyticsApi* | [**get_follower_stats**](docs/AnalyticsApi.md#get_follower_stats) | **GET** /v1/accounts/follower-stats | Get follower stats
|
|
113
|
+
*Late::AnalyticsApi* | [**get_google_business_performance**](docs/AnalyticsApi.md#get_google_business_performance) | **GET** /v1/analytics/googlebusiness/performance | Get Google Business Profile performance metrics
|
|
114
|
+
*Late::AnalyticsApi* | [**get_google_business_search_keywords**](docs/AnalyticsApi.md#get_google_business_search_keywords) | **GET** /v1/analytics/googlebusiness/search-keywords | Get Google Business Profile search keywords
|
|
113
115
|
*Late::AnalyticsApi* | [**get_instagram_account_insights**](docs/AnalyticsApi.md#get_instagram_account_insights) | **GET** /v1/analytics/instagram/account-insights | Get Instagram account-level insights
|
|
114
116
|
*Late::AnalyticsApi* | [**get_instagram_demographics**](docs/AnalyticsApi.md#get_instagram_demographics) | **GET** /v1/analytics/instagram/demographics | Get Instagram audience demographics
|
|
115
117
|
*Late::AnalyticsApi* | [**get_linked_in_aggregate_analytics**](docs/AnalyticsApi.md#get_linked_in_aggregate_analytics) | **GET** /v1/accounts/{accountId}/linkedin-aggregate-analytics | Get LinkedIn aggregate stats
|
|
@@ -559,10 +561,19 @@ Class | Method | HTTP request | Description
|
|
|
559
561
|
- [Late::GetGoogleBusinessLocationDetails200ResponseServiceItemsInnerPrice](docs/GetGoogleBusinessLocationDetails200ResponseServiceItemsInnerPrice.md)
|
|
560
562
|
- [Late::GetGoogleBusinessLocationDetails200ResponseServiceItemsInnerStructuredServiceItem](docs/GetGoogleBusinessLocationDetails200ResponseServiceItemsInnerStructuredServiceItem.md)
|
|
561
563
|
- [Late::GetGoogleBusinessLocationDetails200ResponseSpecialHours](docs/GetGoogleBusinessLocationDetails200ResponseSpecialHours.md)
|
|
564
|
+
- [Late::GetGoogleBusinessPerformance200Response](docs/GetGoogleBusinessPerformance200Response.md)
|
|
565
|
+
- [Late::GetGoogleBusinessPerformance200ResponseDateRange](docs/GetGoogleBusinessPerformance200ResponseDateRange.md)
|
|
566
|
+
- [Late::GetGoogleBusinessPerformance200ResponseMetricsValue](docs/GetGoogleBusinessPerformance200ResponseMetricsValue.md)
|
|
567
|
+
- [Late::GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner](docs/GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner.md)
|
|
568
|
+
- [Late::GetGoogleBusinessPerformance400Response](docs/GetGoogleBusinessPerformance400Response.md)
|
|
562
569
|
- [Late::GetGoogleBusinessReviews200Response](docs/GetGoogleBusinessReviews200Response.md)
|
|
563
570
|
- [Late::GetGoogleBusinessReviews200ResponseReviewsInner](docs/GetGoogleBusinessReviews200ResponseReviewsInner.md)
|
|
564
571
|
- [Late::GetGoogleBusinessReviews200ResponseReviewsInnerReviewReply](docs/GetGoogleBusinessReviews200ResponseReviewsInnerReviewReply.md)
|
|
565
572
|
- [Late::GetGoogleBusinessReviews200ResponseReviewsInnerReviewer](docs/GetGoogleBusinessReviews200ResponseReviewsInnerReviewer.md)
|
|
573
|
+
- [Late::GetGoogleBusinessSearchKeywords200Response](docs/GetGoogleBusinessSearchKeywords200Response.md)
|
|
574
|
+
- [Late::GetGoogleBusinessSearchKeywords200ResponseKeywordsInner](docs/GetGoogleBusinessSearchKeywords200ResponseKeywordsInner.md)
|
|
575
|
+
- [Late::GetGoogleBusinessSearchKeywords200ResponseMonthRange](docs/GetGoogleBusinessSearchKeywords200ResponseMonthRange.md)
|
|
576
|
+
- [Late::GetGoogleBusinessSearchKeywords400Response](docs/GetGoogleBusinessSearchKeywords400Response.md)
|
|
566
577
|
- [Late::GetInboxConversation200Response](docs/GetInboxConversation200Response.md)
|
|
567
578
|
- [Late::GetInboxConversation200ResponseData](docs/GetInboxConversation200ResponseData.md)
|
|
568
579
|
- [Late::GetInboxConversationMessages200Response](docs/GetInboxConversationMessages200Response.md)
|
data/docs/AnalyticsApi.md
CHANGED
|
@@ -9,6 +9,8 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
9
9
|
| [**get_content_decay**](AnalyticsApi.md#get_content_decay) | **GET** /v1/analytics/content-decay | Get content performance decay |
|
|
10
10
|
| [**get_daily_metrics**](AnalyticsApi.md#get_daily_metrics) | **GET** /v1/analytics/daily-metrics | Get daily aggregated metrics |
|
|
11
11
|
| [**get_follower_stats**](AnalyticsApi.md#get_follower_stats) | **GET** /v1/accounts/follower-stats | Get follower stats |
|
|
12
|
+
| [**get_google_business_performance**](AnalyticsApi.md#get_google_business_performance) | **GET** /v1/analytics/googlebusiness/performance | Get Google Business Profile performance metrics |
|
|
13
|
+
| [**get_google_business_search_keywords**](AnalyticsApi.md#get_google_business_search_keywords) | **GET** /v1/analytics/googlebusiness/search-keywords | Get Google Business Profile search keywords |
|
|
12
14
|
| [**get_instagram_account_insights**](AnalyticsApi.md#get_instagram_account_insights) | **GET** /v1/analytics/instagram/account-insights | Get Instagram account-level insights |
|
|
13
15
|
| [**get_instagram_demographics**](AnalyticsApi.md#get_instagram_demographics) | **GET** /v1/analytics/instagram/demographics | Get Instagram audience demographics |
|
|
14
16
|
| [**get_linked_in_aggregate_analytics**](AnalyticsApi.md#get_linked_in_aggregate_analytics) | **GET** /v1/accounts/{accountId}/linkedin-aggregate-analytics | Get LinkedIn aggregate stats |
|
|
@@ -421,6 +423,158 @@ end
|
|
|
421
423
|
- **Accept**: application/json
|
|
422
424
|
|
|
423
425
|
|
|
426
|
+
## get_google_business_performance
|
|
427
|
+
|
|
428
|
+
> <GetGoogleBusinessPerformance200Response> get_google_business_performance(account_id, opts)
|
|
429
|
+
|
|
430
|
+
Get Google Business Profile performance metrics
|
|
431
|
+
|
|
432
|
+
Returns daily performance metrics for a Google Business Profile location. Metrics include impressions (Maps/Search, desktop/mobile), website clicks, call clicks, direction requests, conversations, bookings, and food orders. Data may be delayed 2-3 days. Max 18 months of historical data. Requires the Analytics add-on.
|
|
433
|
+
|
|
434
|
+
### Examples
|
|
435
|
+
|
|
436
|
+
```ruby
|
|
437
|
+
require 'time'
|
|
438
|
+
require 'late-sdk'
|
|
439
|
+
# setup authorization
|
|
440
|
+
Late.configure do |config|
|
|
441
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
442
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
443
|
+
end
|
|
444
|
+
|
|
445
|
+
api_instance = Late::AnalyticsApi.new
|
|
446
|
+
account_id = 'account_id_example' # String | The Zernio SocialAccount ID for the Google Business Profile account.
|
|
447
|
+
opts = {
|
|
448
|
+
metrics: 'metrics_example', # String | Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
|
|
449
|
+
start_date: Date.parse('2013-10-20'), # Date | Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
450
|
+
end_date: Date.parse('2013-10-20') # Date | End date (YYYY-MM-DD). Defaults to today.
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
begin
|
|
454
|
+
# Get Google Business Profile performance metrics
|
|
455
|
+
result = api_instance.get_google_business_performance(account_id, opts)
|
|
456
|
+
p result
|
|
457
|
+
rescue Late::ApiError => e
|
|
458
|
+
puts "Error when calling AnalyticsApi->get_google_business_performance: #{e}"
|
|
459
|
+
end
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
#### Using the get_google_business_performance_with_http_info variant
|
|
463
|
+
|
|
464
|
+
This returns an Array which contains the response data, status code and headers.
|
|
465
|
+
|
|
466
|
+
> <Array(<GetGoogleBusinessPerformance200Response>, Integer, Hash)> get_google_business_performance_with_http_info(account_id, opts)
|
|
467
|
+
|
|
468
|
+
```ruby
|
|
469
|
+
begin
|
|
470
|
+
# Get Google Business Profile performance metrics
|
|
471
|
+
data, status_code, headers = api_instance.get_google_business_performance_with_http_info(account_id, opts)
|
|
472
|
+
p status_code # => 2xx
|
|
473
|
+
p headers # => { ... }
|
|
474
|
+
p data # => <GetGoogleBusinessPerformance200Response>
|
|
475
|
+
rescue Late::ApiError => e
|
|
476
|
+
puts "Error when calling AnalyticsApi->get_google_business_performance_with_http_info: #{e}"
|
|
477
|
+
end
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
### Parameters
|
|
481
|
+
|
|
482
|
+
| Name | Type | Description | Notes |
|
|
483
|
+
| ---- | ---- | ----------- | ----- |
|
|
484
|
+
| **account_id** | **String** | The Zernio SocialAccount ID for the Google Business Profile account. | |
|
|
485
|
+
| **metrics** | **String** | Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS | [optional] |
|
|
486
|
+
| **start_date** | **Date** | Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back. | [optional] |
|
|
487
|
+
| **end_date** | **Date** | End date (YYYY-MM-DD). Defaults to today. | [optional] |
|
|
488
|
+
|
|
489
|
+
### Return type
|
|
490
|
+
|
|
491
|
+
[**GetGoogleBusinessPerformance200Response**](GetGoogleBusinessPerformance200Response.md)
|
|
492
|
+
|
|
493
|
+
### Authorization
|
|
494
|
+
|
|
495
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
496
|
+
|
|
497
|
+
### HTTP request headers
|
|
498
|
+
|
|
499
|
+
- **Content-Type**: Not defined
|
|
500
|
+
- **Accept**: application/json
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
## get_google_business_search_keywords
|
|
504
|
+
|
|
505
|
+
> <GetGoogleBusinessSearchKeywords200Response> get_google_business_search_keywords(account_id, opts)
|
|
506
|
+
|
|
507
|
+
Get Google Business Profile search keywords
|
|
508
|
+
|
|
509
|
+
Returns search keywords that triggered impressions for a Google Business Profile location. Data is aggregated monthly. Keywords below a minimum impression threshold set by Google are excluded. Max 18 months of historical data. Requires the Analytics add-on.
|
|
510
|
+
|
|
511
|
+
### Examples
|
|
512
|
+
|
|
513
|
+
```ruby
|
|
514
|
+
require 'time'
|
|
515
|
+
require 'late-sdk'
|
|
516
|
+
# setup authorization
|
|
517
|
+
Late.configure do |config|
|
|
518
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
519
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
520
|
+
end
|
|
521
|
+
|
|
522
|
+
api_instance = Late::AnalyticsApi.new
|
|
523
|
+
account_id = 'account_id_example' # String | The Zernio SocialAccount ID for the Google Business Profile account.
|
|
524
|
+
opts = {
|
|
525
|
+
start_month: 'start_month_example', # String | Start month (YYYY-MM). Defaults to 3 months ago.
|
|
526
|
+
end_month: 'end_month_example' # String | End month (YYYY-MM). Defaults to current month.
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
begin
|
|
530
|
+
# Get Google Business Profile search keywords
|
|
531
|
+
result = api_instance.get_google_business_search_keywords(account_id, opts)
|
|
532
|
+
p result
|
|
533
|
+
rescue Late::ApiError => e
|
|
534
|
+
puts "Error when calling AnalyticsApi->get_google_business_search_keywords: #{e}"
|
|
535
|
+
end
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
#### Using the get_google_business_search_keywords_with_http_info variant
|
|
539
|
+
|
|
540
|
+
This returns an Array which contains the response data, status code and headers.
|
|
541
|
+
|
|
542
|
+
> <Array(<GetGoogleBusinessSearchKeywords200Response>, Integer, Hash)> get_google_business_search_keywords_with_http_info(account_id, opts)
|
|
543
|
+
|
|
544
|
+
```ruby
|
|
545
|
+
begin
|
|
546
|
+
# Get Google Business Profile search keywords
|
|
547
|
+
data, status_code, headers = api_instance.get_google_business_search_keywords_with_http_info(account_id, opts)
|
|
548
|
+
p status_code # => 2xx
|
|
549
|
+
p headers # => { ... }
|
|
550
|
+
p data # => <GetGoogleBusinessSearchKeywords200Response>
|
|
551
|
+
rescue Late::ApiError => e
|
|
552
|
+
puts "Error when calling AnalyticsApi->get_google_business_search_keywords_with_http_info: #{e}"
|
|
553
|
+
end
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
### Parameters
|
|
557
|
+
|
|
558
|
+
| Name | Type | Description | Notes |
|
|
559
|
+
| ---- | ---- | ----------- | ----- |
|
|
560
|
+
| **account_id** | **String** | The Zernio SocialAccount ID for the Google Business Profile account. | |
|
|
561
|
+
| **start_month** | **String** | Start month (YYYY-MM). Defaults to 3 months ago. | [optional] |
|
|
562
|
+
| **end_month** | **String** | End month (YYYY-MM). Defaults to current month. | [optional] |
|
|
563
|
+
|
|
564
|
+
### Return type
|
|
565
|
+
|
|
566
|
+
[**GetGoogleBusinessSearchKeywords200Response**](GetGoogleBusinessSearchKeywords200Response.md)
|
|
567
|
+
|
|
568
|
+
### Authorization
|
|
569
|
+
|
|
570
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
571
|
+
|
|
572
|
+
### HTTP request headers
|
|
573
|
+
|
|
574
|
+
- **Content-Type**: Not defined
|
|
575
|
+
- **Accept**: application/json
|
|
576
|
+
|
|
577
|
+
|
|
424
578
|
## get_instagram_account_insights
|
|
425
579
|
|
|
426
580
|
> <InstagramAccountInsightsResponse> get_instagram_account_insights(account_id, opts)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessPerformance200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **account_id** | **String** | | [optional] |
|
|
9
|
+
| **platform** | **String** | | [optional] |
|
|
10
|
+
| **date_range** | [**GetGoogleBusinessPerformance200ResponseDateRange**](GetGoogleBusinessPerformance200ResponseDateRange.md) | | [optional] |
|
|
11
|
+
| **metrics** | [**Hash<String, GetGoogleBusinessPerformance200ResponseMetricsValue>**](GetGoogleBusinessPerformance200ResponseMetricsValue.md) | Each key is a metric name containing total and daily values. | [optional] |
|
|
12
|
+
| **data_delay** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'late-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Late::GetGoogleBusinessPerformance200Response.new(
|
|
20
|
+
success: true,
|
|
21
|
+
account_id: null,
|
|
22
|
+
platform: googlebusiness,
|
|
23
|
+
date_range: null,
|
|
24
|
+
metrics: null,
|
|
25
|
+
data_delay: Data may be delayed 2-3 days
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessPerformance200ResponseDateRange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start_date** | **Date** | | [optional] |
|
|
8
|
+
| **end_date** | **Date** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessPerformance200ResponseDateRange.new(
|
|
16
|
+
start_date: 2026-03-01,
|
|
17
|
+
end_date: 2026-03-31
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessPerformance200ResponseMetricsValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | Sum of all daily values in the range | [optional] |
|
|
8
|
+
| **values** | [**Array<GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner>**](GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessPerformance200ResponseMetricsValue.new(
|
|
16
|
+
total: null,
|
|
17
|
+
values: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | | [optional] |
|
|
8
|
+
| **value** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessPerformance200ResponseMetricsValueValuesInner.new(
|
|
16
|
+
date: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessPerformance400Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | **String** | | [optional] |
|
|
8
|
+
| **valid_metrics** | **Array<String>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessPerformance400Response.new(
|
|
16
|
+
error: Invalid metrics: INVALID_METRIC,
|
|
17
|
+
valid_metrics: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessSearchKeywords200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **account_id** | **String** | | [optional] |
|
|
9
|
+
| **platform** | **String** | | [optional] |
|
|
10
|
+
| **month_range** | [**GetGoogleBusinessSearchKeywords200ResponseMonthRange**](GetGoogleBusinessSearchKeywords200ResponseMonthRange.md) | | [optional] |
|
|
11
|
+
| **keywords** | [**Array<GetGoogleBusinessSearchKeywords200ResponseKeywordsInner>**](GetGoogleBusinessSearchKeywords200ResponseKeywordsInner.md) | | [optional] |
|
|
12
|
+
| **note** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'late-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Late::GetGoogleBusinessSearchKeywords200Response.new(
|
|
20
|
+
success: true,
|
|
21
|
+
account_id: null,
|
|
22
|
+
platform: googlebusiness,
|
|
23
|
+
month_range: null,
|
|
24
|
+
keywords: null,
|
|
25
|
+
note: Keywords below a minimum impression threshold are excluded by Google
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessSearchKeywords200ResponseKeywordsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **keyword** | **String** | | [optional] |
|
|
8
|
+
| **impressions** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessSearchKeywords200ResponseKeywordsInner.new(
|
|
16
|
+
keyword: restaurant near me,
|
|
17
|
+
impressions: 245
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessSearchKeywords200ResponseMonthRange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start_month** | **String** | | [optional] |
|
|
8
|
+
| **end_month** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetGoogleBusinessSearchKeywords200ResponseMonthRange.new(
|
|
16
|
+
start_month: 2026-01,
|
|
17
|
+
end_month: 2026-03
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::GetGoogleBusinessSearchKeywords400Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::GetGoogleBusinessSearchKeywords400Response.new(
|
|
15
|
+
error: Invalid startMonth format. Use YYYY-MM.
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -428,6 +428,159 @@ module Late
|
|
|
428
428
|
return data, status_code, headers
|
|
429
429
|
end
|
|
430
430
|
|
|
431
|
+
# Get Google Business Profile performance metrics
|
|
432
|
+
# Returns daily performance metrics for a Google Business Profile location. Metrics include impressions (Maps/Search, desktop/mobile), website clicks, call clicks, direction requests, conversations, bookings, and food orders. Data may be delayed 2-3 days. Max 18 months of historical data. Requires the Analytics add-on.
|
|
433
|
+
# @param account_id [String] The Zernio SocialAccount ID for the Google Business Profile account.
|
|
434
|
+
# @param [Hash] opts the optional parameters
|
|
435
|
+
# @option opts [String] :metrics Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
|
|
436
|
+
# @option opts [Date] :start_date Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
437
|
+
# @option opts [Date] :end_date End date (YYYY-MM-DD). Defaults to today.
|
|
438
|
+
# @return [GetGoogleBusinessPerformance200Response]
|
|
439
|
+
def get_google_business_performance(account_id, opts = {})
|
|
440
|
+
data, _status_code, _headers = get_google_business_performance_with_http_info(account_id, opts)
|
|
441
|
+
data
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
# Get Google Business Profile performance metrics
|
|
445
|
+
# Returns daily performance metrics for a Google Business Profile location. Metrics include impressions (Maps/Search, desktop/mobile), website clicks, call clicks, direction requests, conversations, bookings, and food orders. Data may be delayed 2-3 days. Max 18 months of historical data. Requires the Analytics add-on.
|
|
446
|
+
# @param account_id [String] The Zernio SocialAccount ID for the Google Business Profile account.
|
|
447
|
+
# @param [Hash] opts the optional parameters
|
|
448
|
+
# @option opts [String] :metrics Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
|
|
449
|
+
# @option opts [Date] :start_date Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
450
|
+
# @option opts [Date] :end_date End date (YYYY-MM-DD). Defaults to today.
|
|
451
|
+
# @return [Array<(GetGoogleBusinessPerformance200Response, Integer, Hash)>] GetGoogleBusinessPerformance200Response data, response status code and response headers
|
|
452
|
+
def get_google_business_performance_with_http_info(account_id, opts = {})
|
|
453
|
+
if @api_client.config.debugging
|
|
454
|
+
@api_client.config.logger.debug 'Calling API: AnalyticsApi.get_google_business_performance ...'
|
|
455
|
+
end
|
|
456
|
+
# verify the required parameter 'account_id' is set
|
|
457
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
|
458
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_google_business_performance"
|
|
459
|
+
end
|
|
460
|
+
# resource path
|
|
461
|
+
local_var_path = '/v1/analytics/googlebusiness/performance'
|
|
462
|
+
|
|
463
|
+
# query parameters
|
|
464
|
+
query_params = opts[:query_params] || {}
|
|
465
|
+
query_params[:'accountId'] = account_id
|
|
466
|
+
query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
|
|
467
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
468
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
469
|
+
|
|
470
|
+
# header parameters
|
|
471
|
+
header_params = opts[:header_params] || {}
|
|
472
|
+
# HTTP header 'Accept' (if needed)
|
|
473
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
474
|
+
|
|
475
|
+
# form parameters
|
|
476
|
+
form_params = opts[:form_params] || {}
|
|
477
|
+
|
|
478
|
+
# http body (model)
|
|
479
|
+
post_body = opts[:debug_body]
|
|
480
|
+
|
|
481
|
+
# return_type
|
|
482
|
+
return_type = opts[:debug_return_type] || 'GetGoogleBusinessPerformance200Response'
|
|
483
|
+
|
|
484
|
+
# auth_names
|
|
485
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
486
|
+
|
|
487
|
+
new_options = opts.merge(
|
|
488
|
+
:operation => :"AnalyticsApi.get_google_business_performance",
|
|
489
|
+
:header_params => header_params,
|
|
490
|
+
:query_params => query_params,
|
|
491
|
+
:form_params => form_params,
|
|
492
|
+
:body => post_body,
|
|
493
|
+
:auth_names => auth_names,
|
|
494
|
+
:return_type => return_type
|
|
495
|
+
)
|
|
496
|
+
|
|
497
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
498
|
+
if @api_client.config.debugging
|
|
499
|
+
@api_client.config.logger.debug "API called: AnalyticsApi#get_google_business_performance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
500
|
+
end
|
|
501
|
+
return data, status_code, headers
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
# Get Google Business Profile search keywords
|
|
505
|
+
# Returns search keywords that triggered impressions for a Google Business Profile location. Data is aggregated monthly. Keywords below a minimum impression threshold set by Google are excluded. Max 18 months of historical data. Requires the Analytics add-on.
|
|
506
|
+
# @param account_id [String] The Zernio SocialAccount ID for the Google Business Profile account.
|
|
507
|
+
# @param [Hash] opts the optional parameters
|
|
508
|
+
# @option opts [String] :start_month Start month (YYYY-MM). Defaults to 3 months ago.
|
|
509
|
+
# @option opts [String] :end_month End month (YYYY-MM). Defaults to current month.
|
|
510
|
+
# @return [GetGoogleBusinessSearchKeywords200Response]
|
|
511
|
+
def get_google_business_search_keywords(account_id, opts = {})
|
|
512
|
+
data, _status_code, _headers = get_google_business_search_keywords_with_http_info(account_id, opts)
|
|
513
|
+
data
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# Get Google Business Profile search keywords
|
|
517
|
+
# Returns search keywords that triggered impressions for a Google Business Profile location. Data is aggregated monthly. Keywords below a minimum impression threshold set by Google are excluded. Max 18 months of historical data. Requires the Analytics add-on.
|
|
518
|
+
# @param account_id [String] The Zernio SocialAccount ID for the Google Business Profile account.
|
|
519
|
+
# @param [Hash] opts the optional parameters
|
|
520
|
+
# @option opts [String] :start_month Start month (YYYY-MM). Defaults to 3 months ago.
|
|
521
|
+
# @option opts [String] :end_month End month (YYYY-MM). Defaults to current month.
|
|
522
|
+
# @return [Array<(GetGoogleBusinessSearchKeywords200Response, Integer, Hash)>] GetGoogleBusinessSearchKeywords200Response data, response status code and response headers
|
|
523
|
+
def get_google_business_search_keywords_with_http_info(account_id, opts = {})
|
|
524
|
+
if @api_client.config.debugging
|
|
525
|
+
@api_client.config.logger.debug 'Calling API: AnalyticsApi.get_google_business_search_keywords ...'
|
|
526
|
+
end
|
|
527
|
+
# verify the required parameter 'account_id' is set
|
|
528
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
|
529
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_google_business_search_keywords"
|
|
530
|
+
end
|
|
531
|
+
pattern = Regexp.new(/^\d{4}-\d{2}$/)
|
|
532
|
+
if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern
|
|
533
|
+
fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling AnalyticsApi.get_google_business_search_keywords, must conform to the pattern #{pattern}."
|
|
534
|
+
end
|
|
535
|
+
|
|
536
|
+
pattern = Regexp.new(/^\d{4}-\d{2}$/)
|
|
537
|
+
if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern
|
|
538
|
+
fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling AnalyticsApi.get_google_business_search_keywords, must conform to the pattern #{pattern}."
|
|
539
|
+
end
|
|
540
|
+
|
|
541
|
+
# resource path
|
|
542
|
+
local_var_path = '/v1/analytics/googlebusiness/search-keywords'
|
|
543
|
+
|
|
544
|
+
# query parameters
|
|
545
|
+
query_params = opts[:query_params] || {}
|
|
546
|
+
query_params[:'accountId'] = account_id
|
|
547
|
+
query_params[:'startMonth'] = opts[:'start_month'] if !opts[:'start_month'].nil?
|
|
548
|
+
query_params[:'endMonth'] = opts[:'end_month'] if !opts[:'end_month'].nil?
|
|
549
|
+
|
|
550
|
+
# header parameters
|
|
551
|
+
header_params = opts[:header_params] || {}
|
|
552
|
+
# HTTP header 'Accept' (if needed)
|
|
553
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
554
|
+
|
|
555
|
+
# form parameters
|
|
556
|
+
form_params = opts[:form_params] || {}
|
|
557
|
+
|
|
558
|
+
# http body (model)
|
|
559
|
+
post_body = opts[:debug_body]
|
|
560
|
+
|
|
561
|
+
# return_type
|
|
562
|
+
return_type = opts[:debug_return_type] || 'GetGoogleBusinessSearchKeywords200Response'
|
|
563
|
+
|
|
564
|
+
# auth_names
|
|
565
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
566
|
+
|
|
567
|
+
new_options = opts.merge(
|
|
568
|
+
:operation => :"AnalyticsApi.get_google_business_search_keywords",
|
|
569
|
+
:header_params => header_params,
|
|
570
|
+
:query_params => query_params,
|
|
571
|
+
:form_params => form_params,
|
|
572
|
+
:body => post_body,
|
|
573
|
+
:auth_names => auth_names,
|
|
574
|
+
:return_type => return_type
|
|
575
|
+
)
|
|
576
|
+
|
|
577
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
578
|
+
if @api_client.config.debugging
|
|
579
|
+
@api_client.config.logger.debug "API called: AnalyticsApi#get_google_business_search_keywords\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
580
|
+
end
|
|
581
|
+
return data, status_code, headers
|
|
582
|
+
end
|
|
583
|
+
|
|
431
584
|
# Get Instagram account-level insights
|
|
432
585
|
# Returns account-level Instagram insights such as reach, views, accounts engaged, and total interactions. These metrics reflect the entire account's performance across all content surfaces (feed, stories, explore, profile), and are fundamentally different from post-level metrics. Data may be delayed up to 48 hours. Max 90 days, defaults to last 30 days. Requires the Analytics add-on.
|
|
433
586
|
# @param account_id [String] The Zernio SocialAccount ID for the Instagram account
|