1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.settlementreports.html">settlementreports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, settlementId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a settlement report from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of settlement reports from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, settlementId, x__xgafv=None)</code>
<pre>Retrieves a settlement report from your Merchant Center account.
Args:
merchantId: string, The Merchant Center account of the settlement report. (required)
settlementId: string, The Google-provided ID of the settlement. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settlement reports detail order-level and item-level credits and debits between you and Google.
"endDate": "A String", # The end date on which all transactions are included in the report, in ISO 8601 format.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementReport`"
"previousBalance": { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"settlementId": "A String", # The ID of the settlement report.
"startDate": "A String", # The start date on which all transactions are included in the report, in ISO 8601 format.
"transferAmount": { # The money due to the merchant.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"transferDate": "A String", # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
"transferIds": [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)</code>
<pre>Retrieves a list of settlement reports from your Merchant Center account.
Args:
merchantId: string, The Merchant Center account to list settlements for. (required)
maxResults: integer, The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.
pageToken: string, The token returned by the previous request.
transferEndDate: string, Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.
transferStartDate: string, Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementreportsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of returns.
"resources": [
{ # Settlement reports detail order-level and item-level credits and debits between you and Google.
"endDate": "A String", # The end date on which all transactions are included in the report, in ISO 8601 format.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementReport`"
"previousBalance": { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"settlementId": "A String", # The ID of the settlement report.
"startDate": "A String", # The start date on which all transactions are included in the report, in ISO 8601 format.
"transferAmount": { # The money due to the merchant.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"transferDate": "A String", # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
"transferIds": [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
