File: merchantapi_accounts_v1beta.accounts.developerRegistration.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (170 lines) | stat: -rw-r--r-- 6,409 bytes parent folder | download
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
<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.developerRegistration.html">developerRegistration</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="#getDeveloperRegistration">getDeveloperRegistration(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a developer registration for a merchant.</p>
<p class="toc_element">
  <code><a href="#registerGcp">registerGcp(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.</p>
<p class="toc_element">
  <code><a href="#unregisterGcp">unregisterGcp(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.</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="getDeveloperRegistration">getDeveloperRegistration(name, x__xgafv=None)</code>
  <pre>Retrieves a developer registration for a merchant.

Args:
  name: string, Required. The `name` (ID) of the developer registration. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a developer registration owned by a Merchant account.
  &quot;gcpIds&quot;: [ # Output only. The GCP ids attached to this developer registration
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The `name` (ID) of the developer registration. Generated by the Content API upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
}</pre>
</div>

<div class="method">
    <code class="details" id="registerGcp">registerGcp(name, body=None, x__xgafv=None)</code>
  <pre>Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an &quot;API developer&quot; and add the &quot;developer_email&quot; as a contact with &quot;API notifications&quot; email preference on.

Args:
  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the RegisterGCP method.
  &quot;developerEmail&quot;: &quot;A String&quot;, # Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have &quot;API developer&quot; access type and the email preference corresponding to that user will be updated to have the new &quot;API notifications&quot; preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new &quot;API notifications&quot; preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can&#x27;t receive emails.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a developer registration owned by a Merchant account.
  &quot;gcpIds&quot;: [ # Output only. The GCP ids attached to this developer registration
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The `name` (ID) of the developer registration. Generated by the Content API upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
}</pre>
</div>

<div class="method">
    <code class="details" id="unregisterGcp">unregisterGcp(name, body=None, x__xgafv=None)</code>
  <pre>Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

Args:
  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the UnregisterGCP method.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

</body></html>