blob: b559ff56027ac09fde8d1aac585cb85101d236c3 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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="books_v1.html">Books API</a> . <a href="books_v1.notification.html">notification</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070078 <code><a href="#get">get(notification_id, locale=None, source=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080079<p class="firstline">Returns notification details for a given notification id.</p>
80<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -070082 <code class="details" id="get">get(notification_id, locale=None, source=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083 <pre>Returns notification details for a given notification id.
84
85Args:
86 notification_id: string, String to identify the notification. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -070087 locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: &#x27;en_US&#x27;. Used for generating notification title and body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080088 source: string, String to identify the originator of this request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080089
90Returns:
91 An object of the form:
92
93 {
Bu Sun Kim65020912020-05-20 12:08:20 -070094 &quot;body&quot;: &quot;A String&quot;,
95 &quot;crmExperimentIds&quot;: [ # The list of crm experiment ids.
96 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070097 ],
Bu Sun Kim65020912020-05-20 12:08:20 -070098 &quot;doc_id&quot;: &quot;A String&quot;,
99 &quot;doc_type&quot;: &quot;A String&quot;,
100 &quot;dont_show_notification&quot;: True or False,
101 &quot;iconUrl&quot;: &quot;A String&quot;,
102 &quot;is_document_mature&quot;: True or False,
103 &quot;kind&quot;: &quot;books#notification&quot;, # Resource type.
104 &quot;notificationGroup&quot;: &quot;A String&quot;,
105 &quot;notification_type&quot;: &quot;A String&quot;,
106 &quot;pcampaign_id&quot;: &quot;A String&quot;,
107 &quot;reason&quot;: &quot;A String&quot;,
108 &quot;show_notification_settings_action&quot;: True or False,
109 &quot;targetUrl&quot;: &quot;A String&quot;,
110 &quot;timeToExpireMs&quot;: &quot;A String&quot;,
111 &quot;title&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800112 }</pre>
113</div>
114
115</body></html>