|
98 | 98 | "resources": {
|
99 | 99 | "locations": {
|
100 | 100 | "methods": {
|
| 101 | + "fetchMultiDailyMetricsTimeSeries": { |
| 102 | + "description": " Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`", |
| 103 | + "flatPath": "v1/locations/{locationsId}:fetchMultiDailyMetricsTimeSeries", |
| 104 | + "httpMethod": "GET", |
| 105 | + "id": "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries", |
| 106 | + "parameterOrder": [ |
| 107 | + "location" |
| 108 | + ], |
| 109 | + "parameters": { |
| 110 | + "dailyMetrics": { |
| 111 | + "description": "Required. The metrics to retrieve time series for.", |
| 112 | + "enum": [ |
| 113 | + "DAILY_METRIC_UNKNOWN", |
| 114 | + "BUSINESS_IMPRESSIONS_DESKTOP_MAPS", |
| 115 | + "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH", |
| 116 | + "BUSINESS_IMPRESSIONS_MOBILE_MAPS", |
| 117 | + "BUSINESS_IMPRESSIONS_MOBILE_SEARCH", |
| 118 | + "BUSINESS_CONVERSATIONS", |
| 119 | + "BUSINESS_DIRECTION_REQUESTS", |
| 120 | + "CALL_CLICKS", |
| 121 | + "WEBSITE_CLICKS", |
| 122 | + "BUSINESS_BOOKINGS", |
| 123 | + "BUSINESS_FOOD_ORDERS", |
| 124 | + "BUSINESS_FOOD_MENU_CLICKS" |
| 125 | + ], |
| 126 | + "enumDescriptions": [ |
| 127 | + "Represents the default unknown value.", |
| 128 | + "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 129 | + "Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 130 | + "Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 131 | + "Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 132 | + "The number of message conversations received on the business profile.", |
| 133 | + "The number of times a direction request was requested to the business location.", |
| 134 | + "The number of times the business profile call button was clicked.", |
| 135 | + "The number of times the business profile website was clicked.", |
| 136 | + "The number of bookings received from the business profile.", |
| 137 | + "The number of food orders received from the business profile.", |
| 138 | + "The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1." |
| 139 | + ], |
| 140 | + "location": "query", |
| 141 | + "repeated": true, |
| 142 | + "type": "string" |
| 143 | + }, |
| 144 | + "dailyRange.endDate.day": { |
| 145 | + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", |
| 146 | + "format": "int32", |
| 147 | + "location": "query", |
| 148 | + "type": "integer" |
| 149 | + }, |
| 150 | + "dailyRange.endDate.month": { |
| 151 | + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| 152 | + "format": "int32", |
| 153 | + "location": "query", |
| 154 | + "type": "integer" |
| 155 | + }, |
| 156 | + "dailyRange.endDate.year": { |
| 157 | + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| 158 | + "format": "int32", |
| 159 | + "location": "query", |
| 160 | + "type": "integer" |
| 161 | + }, |
| 162 | + "dailyRange.startDate.day": { |
| 163 | + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", |
| 164 | + "format": "int32", |
| 165 | + "location": "query", |
| 166 | + "type": "integer" |
| 167 | + }, |
| 168 | + "dailyRange.startDate.month": { |
| 169 | + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| 170 | + "format": "int32", |
| 171 | + "location": "query", |
| 172 | + "type": "integer" |
| 173 | + }, |
| 174 | + "dailyRange.startDate.year": { |
| 175 | + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| 176 | + "format": "int32", |
| 177 | + "location": "query", |
| 178 | + "type": "integer" |
| 179 | + }, |
| 180 | + "location": { |
| 181 | + "description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.", |
| 182 | + "location": "path", |
| 183 | + "pattern": "^locations/[^/]+$", |
| 184 | + "required": true, |
| 185 | + "type": "string" |
| 186 | + } |
| 187 | + }, |
| 188 | + "path": "v1/{+location}:fetchMultiDailyMetricsTimeSeries", |
| 189 | + "response": { |
| 190 | + "$ref": "FetchMultiDailyMetricsTimeSeriesResponse" |
| 191 | + } |
| 192 | + }, |
101 | 193 | "getDailyMetricsTimeSeries": {
|
102 | 194 | "description": " Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`",
|
103 | 195 | "flatPath": "v1/locations/{locationsId}:getDailyMetricsTimeSeries",
|
|
325 | 417 | }
|
326 | 418 | }
|
327 | 419 | },
|
328 |
| - "revision": "20230306", |
| 420 | + "revision": "20230312", |
329 | 421 | "rootUrl": "https://businessprofileperformance.googleapis.com/",
|
330 | 422 | "schemas": {
|
| 423 | + "DailyMetricTimeSeries": { |
| 424 | + "description": "Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple.", |
| 425 | + "id": "DailyMetricTimeSeries", |
| 426 | + "properties": { |
| 427 | + "dailyMetric": { |
| 428 | + "description": "The DailyMetric that the TimeSeries represents.", |
| 429 | + "enum": [ |
| 430 | + "DAILY_METRIC_UNKNOWN", |
| 431 | + "BUSINESS_IMPRESSIONS_DESKTOP_MAPS", |
| 432 | + "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH", |
| 433 | + "BUSINESS_IMPRESSIONS_MOBILE_MAPS", |
| 434 | + "BUSINESS_IMPRESSIONS_MOBILE_SEARCH", |
| 435 | + "BUSINESS_CONVERSATIONS", |
| 436 | + "BUSINESS_DIRECTION_REQUESTS", |
| 437 | + "CALL_CLICKS", |
| 438 | + "WEBSITE_CLICKS", |
| 439 | + "BUSINESS_BOOKINGS", |
| 440 | + "BUSINESS_FOOD_ORDERS", |
| 441 | + "BUSINESS_FOOD_MENU_CLICKS" |
| 442 | + ], |
| 443 | + "enumDescriptions": [ |
| 444 | + "Represents the default unknown value.", |
| 445 | + "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 446 | + "Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 447 | + "Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 448 | + "Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", |
| 449 | + "The number of message conversations received on the business profile.", |
| 450 | + "The number of times a direction request was requested to the business location.", |
| 451 | + "The number of times the business profile call button was clicked.", |
| 452 | + "The number of times the business profile website was clicked.", |
| 453 | + "The number of bookings received from the business profile.", |
| 454 | + "The number of food orders received from the business profile.", |
| 455 | + "The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1." |
| 456 | + ], |
| 457 | + "type": "string" |
| 458 | + }, |
| 459 | + "dailySubEntityType": { |
| 460 | + "$ref": "DailySubEntityType", |
| 461 | + "description": "The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist." |
| 462 | + }, |
| 463 | + "timeSeries": { |
| 464 | + "$ref": "TimeSeries", |
| 465 | + "description": "List of datapoints where each datapoint is a date-value pair." |
| 466 | + } |
| 467 | + }, |
| 468 | + "type": "object" |
| 469 | + }, |
| 470 | + "DailySubEntityType": { |
| 471 | + "description": "Represents all possible subentity types that are associated with DailyMetrics.", |
| 472 | + "id": "DailySubEntityType", |
| 473 | + "properties": { |
| 474 | + "dayOfWeek": { |
| 475 | + "description": "Represents the day of the week. Eg: MONDAY.", |
| 476 | + "enum": [ |
| 477 | + "DAY_OF_WEEK_UNSPECIFIED", |
| 478 | + "MONDAY", |
| 479 | + "TUESDAY", |
| 480 | + "WEDNESDAY", |
| 481 | + "THURSDAY", |
| 482 | + "FRIDAY", |
| 483 | + "SATURDAY", |
| 484 | + "SUNDAY" |
| 485 | + ], |
| 486 | + "enumDescriptions": [ |
| 487 | + "The day of the week is unspecified.", |
| 488 | + "Monday", |
| 489 | + "Tuesday", |
| 490 | + "Wednesday", |
| 491 | + "Thursday", |
| 492 | + "Friday", |
| 493 | + "Saturday", |
| 494 | + "Sunday" |
| 495 | + ], |
| 496 | + "type": "string" |
| 497 | + }, |
| 498 | + "timeOfDay": { |
| 499 | + "$ref": "TimeOfDay", |
| 500 | + "description": "Represents the time of the day in 24 hour format. Eg: 13:34:20" |
| 501 | + } |
| 502 | + }, |
| 503 | + "type": "object" |
| 504 | + }, |
331 | 505 | "Date": {
|
332 | 506 | "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
|
333 | 507 | "id": "Date",
|
|
366 | 540 | },
|
367 | 541 | "type": "object"
|
368 | 542 | },
|
| 543 | + "FetchMultiDailyMetricsTimeSeriesResponse": { |
| 544 | + "description": "Represents the response for FetchMultiDailyMetricsTimeSeries.", |
| 545 | + "id": "FetchMultiDailyMetricsTimeSeriesResponse", |
| 546 | + "properties": { |
| 547 | + "multiDailyMetricTimeSeries": { |
| 548 | + "description": "DailyMetrics and their corresponding time series.", |
| 549 | + "items": { |
| 550 | + "$ref": "MultiDailyMetricTimeSeries" |
| 551 | + }, |
| 552 | + "type": "array" |
| 553 | + } |
| 554 | + }, |
| 555 | + "type": "object" |
| 556 | + }, |
369 | 557 | "GetDailyMetricsTimeSeriesResponse": {
|
370 | 558 | "description": "Represents the response for GetDailyMetricsTimeSeries.",
|
371 | 559 | "id": "GetDailyMetricsTimeSeriesResponse",
|
|
413 | 601 | },
|
414 | 602 | "type": "object"
|
415 | 603 | },
|
| 604 | + "MultiDailyMetricTimeSeries": { |
| 605 | + "description": "Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.", |
| 606 | + "id": "MultiDailyMetricTimeSeries", |
| 607 | + "properties": { |
| 608 | + "dailyMetricTimeSeries": { |
| 609 | + "description": "List of DailyMetric-TimeSeries pairs.", |
| 610 | + "items": { |
| 611 | + "$ref": "DailyMetricTimeSeries" |
| 612 | + }, |
| 613 | + "type": "array" |
| 614 | + } |
| 615 | + }, |
| 616 | + "type": "object" |
| 617 | + }, |
416 | 618 | "SearchKeywordCount": {
|
417 | 619 | "description": "Represents a single search keyword and its value.",
|
418 | 620 | "id": "SearchKeywordCount",
|
|
428 | 630 | },
|
429 | 631 | "type": "object"
|
430 | 632 | },
|
| 633 | + "TimeOfDay": { |
| 634 | + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", |
| 635 | + "id": "TimeOfDay", |
| 636 | + "properties": { |
| 637 | + "hours": { |
| 638 | + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", |
| 639 | + "format": "int32", |
| 640 | + "type": "integer" |
| 641 | + }, |
| 642 | + "minutes": { |
| 643 | + "description": "Minutes of hour of day. Must be from 0 to 59.", |
| 644 | + "format": "int32", |
| 645 | + "type": "integer" |
| 646 | + }, |
| 647 | + "nanos": { |
| 648 | + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", |
| 649 | + "format": "int32", |
| 650 | + "type": "integer" |
| 651 | + }, |
| 652 | + "seconds": { |
| 653 | + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", |
| 654 | + "format": "int32", |
| 655 | + "type": "integer" |
| 656 | + } |
| 657 | + }, |
| 658 | + "type": "object" |
| 659 | + }, |
431 | 660 | "TimeSeries": {
|
432 | 661 | "description": "Represents a timeseries.",
|
433 | 662 | "id": "TimeSeries",
|
|
0 commit comments