blob: 773f26e9216f22da2734ff0e621fd0c91e840cab [file] [log] [blame]
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -07001<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="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.insightsdata.html">insightsdata</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Export insights data to a destination defined in the request body.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
91 <pre>Export insights data to a destination defined in the request body.
92
93Args:
94 parent: string, Required. The parent resource to export data from. (required)
95 body: object, The request body.
96 The object takes the form of:
97
98{ # The request to export insights.
99 &quot;bigQueryDestination&quot;: { # A BigQuery Table Reference. # Specified if sink is a BigQuery table.
100 &quot;dataset&quot;: &quot;A String&quot;, # Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.
101 &quot;projectId&quot;: &quot;A String&quot;, # A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.
102 &quot;table&quot;: &quot;A String&quot;, # The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.
103 },
104 &quot;filter&quot;: &quot;A String&quot;, # A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.
105 &quot;kmsKey&quot;: &quot;A String&quot;, # A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
106 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource to export data from.
107}
108
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 { # This resource represents a long-running operation that is the result of a network API call.
118 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
119 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
120 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
121 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
122 {
123 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
124 },
125 ],
126 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
127 },
128 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
129 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130 },
131 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
132 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
133 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
134 },
135}</pre>
136</div>
137
138</body></html>