Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / cloudsearch_v1.stats.session.searchapplications.html
blob: 4f86ad4b3c121577b8b5b3cab6ce03265f246af6 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.stats.html">stats</a> . <a href="cloudsearch_v1.stats.session.html">session</a> . <a href="cloudsearch_v1.stats.session.searchapplications.html">searchapplications</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]81 <code><a href="#get">get(name, fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user account to execute.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]88
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]89<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]90 <code class="details" id="get">get(name, fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user account to execute.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92
93Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 name: string, The resource id of the search application session stats, in the following format: searchapplications/{application_id} (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]95 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]96 fromDate_month: integer, Month of date. Must be from 1 to 12.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]97 fromDate_year: integer, Year of date. Must be from 1 to 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]98 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
99 toDate_month: integer, Month of date. Must be from 1 to 12.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]100 toDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]110 &quot;stats&quot;: [
111 {
112 &quot;date&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
113 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
114 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
115 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]117 &quot;searchSessionsCount&quot;: &quot;A String&quot;, # The count of search sessions on the day
118 },
119 ],
120}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121</div>
122
123</body></html>