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="safebrowsing_v4.html">Google Safe Browsing API</a> . <a href="safebrowsing_v4.threatListUpdates.html">threatListUpdates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#fetch">fetch(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Fetches the most recent threat list updates. A client can request updates</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="fetch">fetch(body, x__xgafv=None)</code>
83  <pre>Fetches the most recent threat list updates. A client can request updates
84for multiple lists at once.
85
86Args:
87  body: object, The request body. (required)
88    The object takes the form of:
89
90{ # Describes a Safe Browsing API update request. Clients can request updates for
91      # multiple lists in a single request.
92      # NOTE: Field index 2 is unused.
93      # NEXT: 5
94    "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
95      "clientVersion": "A String", # The version of the client implementation.
96      "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
97          # of the Safe Browsing API.
98    },
99    "listUpdateRequests": [ # The requested threat list updates.
100      { # A single list update request.
101        "threatType": "A String", # The type of threat posed by entries present in the list.
102        "state": "A String", # The current state of the client for the requested list (the encrypted
103            # client state that was received from the last successful list update).
104        "threatEntryType": "A String", # The types of entries present in the list.
105        "platformType": "A String", # The type of platform at risk by entries present in the list.
106        "constraints": { # The constraints for this update. # The constraints associated with this request.
107          "maxDatabaseEntries": 42, # Sets the maximum number of entries that the client is willing to have
108              # in the local database. This should be a power of 2 between 2**10 and
109              # 2**20. If zero, no database size limit is set.
110          "region": "A String", # Requests the list for a specific geographic location. If not set the
111              # server may pick that value based on the user's IP address. Expects ISO
112              # 3166-1 alpha-2 format.
113          "supportedCompressions": [ # The compression types supported by the client.
114            "A String",
115          ],
116          "maxUpdateEntries": 42, # The maximum size in number of entries. The update will not contain more
117              # entries than this value.  This should be a power of 2 between 2**10 and
118              # 2**20.  If zero, no update size limit is set.
119        },
120      },
121    ],
122  }
123
124  x__xgafv: string, V1 error format.
125    Allowed values
126      1 - v1 error format
127      2 - v2 error format
128
129Returns:
130  An object of the form:
131
132    {
133    "listUpdateResponses": [ # The list updates requested by the clients.
134      { # An update to an individual list.
135        "responseType": "A String", # The type of response. This may indicate that an action is required by the
136            # client when the response is received.
137        "threatType": "A String", # The threat type for which data is returned.
138        "removals": [ # A set of entries to remove from a local threat type's list. In practice,
139            # this field is empty or contains exactly one ThreatEntrySet.
140          { # A set of threats that should be added or removed from a client's local
141              # database.
142            "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded 4-byte prefixes of SHA256-formatted entries, using a
143                # Golomb-Rice encoding. The hashes are converted to uint32, sorted in
144                # ascending order, then delta encoded and stored as encoded_data.
145                # compressed removal indices.
146              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
147                  # is missing (that is, zero) if `num_entries` is zero.
148              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
149                  # single integer was encoded, this will be zero and the single value will be
150                  # stored in `first_value`.
151              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
152              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
153                  # integer was encoded, that single integer's value.
154            },
155            "compressionType": "A String", # The compression type for the entries in this set.
156            "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
157              "indices": [ # The indices to remove from a lexicographically-sorted local list.
158                42,
159              ],
160            },
161            "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a
162                # Golomb-Rice encoding. Used for sending compressed removal indices. The
163                # removal indices (uint32) are sorted in ascending order, then delta encoded
164                # and stored as encoded_data.
165                # compressed removal indices.
166              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
167                  # is missing (that is, zero) if `num_entries` is zero.
168              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
169                  # single integer was encoded, this will be zero and the single value will be
170                  # stored in `first_value`.
171              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
172              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
173                  # integer was encoded, that single integer's value.
174            },
175            "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.
176                # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
177                # bytes, but some hashes are lengthened if they collide with the hash of a
178                # popular URL.
179                #
180                # Used for sending ThreatEntrySet to clients that do not support compression,
181                # or when sending non-4-byte hashes to clients that do support compression.
182              "prefixSize": 42, # The number of bytes for each prefix encoded below.  This field can be
183                  # anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
184              "rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are
185                  # sorted in lexicographic order. For JSON API users, hashes are
186                  # base64-encoded.
187            },
188          },
189        ],
190        "newClientState": "A String", # The new client state, in encrypted format. Opaque to clients.
191        "checksum": { # The expected state of a client's local database. # The expected SHA256 hash of the client state; that is, of the sorted list
192            # of all hashes present in the database after applying the provided update.
193            # If the client state doesn't match the expected state, the client must
194            # disregard this update and retry later.
195          "sha256": "A String", # The SHA256 hash of the client state; that is, of the sorted list of all
196              # hashes present in the database.
197        },
198        "threatEntryType": "A String", # The format of the threats.
199        "additions": [ # A set of entries to add to a local threat type's list. Repeated to allow
200            # for a combination of compressed and raw data to be sent in a single
201            # response.
202          { # A set of threats that should be added or removed from a client's local
203              # database.
204            "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded 4-byte prefixes of SHA256-formatted entries, using a
205                # Golomb-Rice encoding. The hashes are converted to uint32, sorted in
206                # ascending order, then delta encoded and stored as encoded_data.
207                # compressed removal indices.
208              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
209                  # is missing (that is, zero) if `num_entries` is zero.
210              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
211                  # single integer was encoded, this will be zero and the single value will be
212                  # stored in `first_value`.
213              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
214              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
215                  # integer was encoded, that single integer's value.
216            },
217            "compressionType": "A String", # The compression type for the entries in this set.
218            "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
219              "indices": [ # The indices to remove from a lexicographically-sorted local list.
220                42,
221              ],
222            },
223            "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a
224                # Golomb-Rice encoding. Used for sending compressed removal indices. The
225                # removal indices (uint32) are sorted in ascending order, then delta encoded
226                # and stored as encoded_data.
227                # compressed removal indices.
228              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
229                  # is missing (that is, zero) if `num_entries` is zero.
230              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
231                  # single integer was encoded, this will be zero and the single value will be
232                  # stored in `first_value`.
233              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
234              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
235                  # integer was encoded, that single integer's value.
236            },
237            "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.
238                # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
239                # bytes, but some hashes are lengthened if they collide with the hash of a
240                # popular URL.
241                #
242                # Used for sending ThreatEntrySet to clients that do not support compression,
243                # or when sending non-4-byte hashes to clients that do support compression.
244              "prefixSize": 42, # The number of bytes for each prefix encoded below.  This field can be
245                  # anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
246              "rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are
247                  # sorted in lexicographic order. For JSON API users, hashes are
248                  # base64-encoded.
249            },
250          },
251        ],
252        "platformType": "A String", # The platform type for which data is returned.
253      },
254    ],
255    "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any update
256        # request. If this field is not set clients may update as soon as they want.
257  }</pre>
258</div>
259
260</body></html>