File: marketingplatformadmin_v1alpha.organizations.analyticsAccountLinks.html

package info (click to toggle)
python-googleapi 2.188.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 573,720 kB
  • sloc: python: 11,217; javascript: 249; sh: 114; makefile: 59
file content (220 lines) | stat: -rw-r--r-- 10,955 bytes parent folder | download | duplicates (2)
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
<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="marketingplatformadmin_v1alpha.html">Google Marketing Platform Admin API</a> . <a href="marketingplatformadmin_v1alpha.organizations.html">organizations</a> . <a href="marketingplatformadmin_v1alpha.organizations.analyticsAccountLinks.html">analyticsAccountLinks</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.</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>
<p class="toc_element">
  <code><a href="#setPropertyServiceLevel">setPropertyServiceLevel(analyticsAccountLink, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the service level for an Analytics property.</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="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.

Args:
  parent: string, Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
  &quot;analyticsAccount&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. The human-readable name for the Analytics account.
  &quot;linkVerificationState&quot;: &quot;A String&quot;, # Output only. The verification state of the link between the Analytics account and the parent organization.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: &quot;organizations/xyz/analyticsAccountLinks/1234&quot;
}

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

Returns:
  An object of the form:

    { # A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
  &quot;analyticsAccount&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. The human-readable name for the Analytics account.
  &quot;linkVerificationState&quot;: &quot;A String&quot;, # Output only. The verification state of the link between the Analytics account and the parent organization.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: &quot;organizations/xyz/analyticsAccountLinks/1234&quot;
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.

Args:
  name: string, Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} (required)
  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>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.

Args:
  parent: string, Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id} (required)
  pageSize: integer, Optional. The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnalyticsAccountLinks` must match the call that provided the page token.
  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 ListAnalyticsAccountLinks RPC.
  &quot;analyticsAccountLinks&quot;: [ # Analytics account links in this organization.
    { # A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
      &quot;analyticsAccount&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The human-readable name for the Analytics account.
      &quot;linkVerificationState&quot;: &quot;A String&quot;, # Output only. The verification state of the link between the Analytics account and the parent organization.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: &quot;organizations/xyz/analyticsAccountLinks/1234&quot;
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="setPropertyServiceLevel">setPropertyServiceLevel(analyticsAccountLink, body=None, x__xgafv=None)</code>
  <pre>Updates the service level for an Analytics property.

Args:
  analyticsAccountLink: string, Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SetPropertyServiceLevel RPC.
  &quot;analyticsProperty&quot;: &quot;A String&quot;, # Required. The Analytics property to change the ServiceLevel setting. This field is the name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}
  &quot;serviceLevel&quot;: &quot;A String&quot;, # Required. The service level to set for this property.
}

  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 SetPropertyServiceLevel RPC.
}</pre>
</div>

</body></html>