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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<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="merchantapi_accounts_v1beta.html">Merchant API</a> . <a href="merchantapi_accounts_v1beta.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1beta.accounts.programs.html">programs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="merchantapi_accounts_v1beta.accounts.programs.checkoutSettings.html">checkoutSettings()</a></code>
</p>
<p class="firstline">Returns the checkoutSettings Resource.</p>
<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="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Disable participation in the specified program for the account.</p>
<p class="toc_element">
<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enable participation in the specified program for the account.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified program for the account.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves all programs for the 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="disable">disable(name, body=None, x__xgafv=None)</code>
<pre>Disable participation in the specified program for the account.
Args:
name: string, Required. The name of the program for which to disable participation for the given account. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the DisableProgram method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
"activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a Merchant Center help page describing the program.
"name": "A String", # Identifier. The resource name of the program. Format: `accounts/{account}/programs/{program}`
"state": "A String", # Output only. The participation state of the account in the program.
"unmetRequirements": [ # Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
{ # Defines a requirement specified for participation in the program.
"affectedRegionCodes": [ # Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a help page describing the requirement.
"title": "A String", # Output only. Name of the requirement.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
<pre>Enable participation in the specified program for the account.
Args:
name: string, Required. The name of the program for which to enable participation for the given account. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the EnableProgram method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
"activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a Merchant Center help page describing the program.
"name": "A String", # Identifier. The resource name of the program. Format: `accounts/{account}/programs/{program}`
"state": "A String", # Output only. The participation state of the account in the program.
"unmetRequirements": [ # Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
{ # Defines a requirement specified for participation in the program.
"affectedRegionCodes": [ # Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a help page describing the requirement.
"title": "A String", # Output only. Name of the requirement.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the specified program for the account.
Args:
name: string, Required. The name of the program to retrieve. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
"activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a Merchant Center help page describing the program.
"name": "A String", # Identifier. The resource name of the program. Format: `accounts/{account}/programs/{program}`
"state": "A String", # Output only. The participation state of the account in the program.
"unmetRequirements": [ # Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
{ # Defines a requirement specified for participation in the program.
"affectedRegionCodes": [ # Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a help page describing the requirement.
"title": "A String", # Output only. Name of the requirement.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves all programs for the account.
Args:
parent: string, Required. The name of the account for which to retrieve all programs. Format: `accounts/{account}` (required)
pageSize: integer, Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A continuation token, received from a previous `ListPrograms` call. Provide this to retrieve the next page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListPrograms method.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"programs": [ # The programs for the given account.
{ # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
"activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a Merchant Center help page describing the program.
"name": "A String", # Identifier. The resource name of the program. Format: `accounts/{account}/programs/{program}`
"state": "A String", # Output only. The participation state of the account in the program.
"unmetRequirements": [ # Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.
{ # Defines a requirement specified for participation in the program.
"affectedRegionCodes": [ # Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally.
"A String",
],
"documentationUri": "A String", # Output only. The URL of a help page describing the requirement.
"title": "A String", # Output only. Name of the requirement.
},
],
},
],
}</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>
|
