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
|
<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_v1.html">Merchant API</a> . <a href="merchantapi_accounts_v1.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1.accounts.homepage.html">homepage</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#claim">claim(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details).</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="#getHomepage">getHomepage(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a store's homepage.</p>
<p class="toc_element">
<code><a href="#unclaim">unclaim(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unclaims a store's homepage. Executing this method requires admin access.</p>
<p class="toc_element">
<code><a href="#updateHomepage">updateHomepage(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a store's homepage. Executing this method requires admin access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="claim">claim(name, body=None, x__xgafv=None)</code>
<pre>Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details).
Args:
name: string, Required. The name of the homepage to claim. Format: `accounts/{account}/homepage` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the `ClaimHomepage` method.
"overwrite": True or False, # Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
"claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
"name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
"uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getHomepage">getHomepage(name, x__xgafv=None)</code>
<pre>Retrieves a store's homepage.
Args:
name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
"claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
"name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
"uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}</pre>
</div>
<div class="method">
<code class="details" id="unclaim">unclaim(name, body=None, x__xgafv=None)</code>
<pre>Unclaims a store's homepage. Executing this method requires admin access.
Args:
name: string, Required. The name of the homepage to unclaim. Format: `accounts/{account}/homepage` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the `UnclaimHomepage` method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
"claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
"name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
"uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}</pre>
</div>
<div class="method">
<code class="details" id="updateHomepage">updateHomepage(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a store's homepage. Executing this method requires admin access.
Args:
name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
body: object, The request body.
The object takes the form of:
{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
"claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
"name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
"uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}
updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
"claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
"name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
"uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}</pre>
</div>
</body></html>
|
