1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read": {
6 "description": "View your Google Analytics product account data in GMP home"
7 },
8 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update": {
9 "description": "Manage your Google Analytics product account data in GMP home"
10 }
11 }
12 }
13 },
14 "basePath": "",
15 "baseUrl": "https://marketingplatformadmin.googleapis.com/",
16 "batchPath": "batch",
17 "canonicalName": "Google Marketing Platform Admin API",
18 "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties.",
19 "discoveryVersion": "v1",
20 "documentationLink": "https://developers.google.com/analytics/devguides/config/gmp/v1",
21 "fullyEncodeReservedExpansion": true,
22 "icons": {
23 "x16": "http://www.google.com/images/icons/product/search-16.gif",
24 "x32": "http://www.google.com/images/icons/product/search-32.gif"
25 },
26 "id": "marketingplatformadmin:v1alpha",
27 "kind": "discovery#restDescription",
28 "mtlsRootUrl": "https://marketingplatformadmin.mtls.googleapis.com/",
29 "name": "marketingplatformadmin",
30 "ownerDomain": "google.com",
31 "ownerName": "Google",
32 "parameters": {
33 "$.xgafv": {
34 "description": "V1 error format.",
35 "enum": [
36 "1",
37 "2"
38 ],
39 "enumDescriptions": [
40 "v1 error format",
41 "v2 error format"
42 ],
43 "location": "query",
44 "type": "string"
45 },
46 "access_token": {
47 "description": "OAuth access token.",
48 "location": "query",
49 "type": "string"
50 },
51 "alt": {
52 "default": "json",
53 "description": "Data format for response.",
54 "enum": [
55 "json",
56 "media",
57 "proto"
58 ],
59 "enumDescriptions": [
60 "Responses with Content-Type of application/json",
61 "Media download with context-dependent Content-Type",
62 "Responses with Content-Type of application/x-protobuf"
63 ],
64 "location": "query",
65 "type": "string"
66 },
67 "callback": {
68 "description": "JSONP",
69 "location": "query",
70 "type": "string"
71 },
72 "fields": {
73 "description": "Selector specifying which fields to include in a partial response.",
74 "location": "query",
75 "type": "string"
76 },
77 "key": {
78 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
79 "location": "query",
80 "type": "string"
81 },
82 "oauth_token": {
83 "description": "OAuth 2.0 token for the current user.",
84 "location": "query",
85 "type": "string"
86 },
87 "prettyPrint": {
88 "default": "true",
89 "description": "Returns response with indentations and line breaks.",
90 "location": "query",
91 "type": "boolean"
92 },
93 "quotaUser": {
94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
95 "location": "query",
96 "type": "string"
97 },
98 "uploadType": {
99 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
100 "location": "query",
101 "type": "string"
102 },
103 "upload_protocol": {
104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
105 "location": "query",
106 "type": "string"
107 }
108 },
109 "protocol": "rest",
110 "resources": {
111 "organizations": {
112 "methods": {
113 "get": {
114 "description": "Lookup for a single organization.",
115 "flatPath": "v1alpha/organizations/{organizationsId}",
116 "httpMethod": "GET",
117 "id": "marketingplatformadmin.organizations.get",
118 "parameterOrder": [
119 "name"
120 ],
121 "parameters": {
122 "name": {
123 "description": "Required. The name of the Organization to retrieve. Format: organizations/{org_id}",
124 "location": "path",
125 "pattern": "^organizations/[^/]+$",
126 "required": true,
127 "type": "string"
128 }
129 },
130 "path": "v1alpha/{+name}",
131 "response": {
132 "$ref": "Organization"
133 },
134 "scopes": [
135 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read",
136 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
137 ]
138 }
139 },
140 "resources": {
141 "analyticsAccountLinks": {
142 "methods": {
143 "create": {
144 "description": "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.",
145 "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks",
146 "httpMethod": "POST",
147 "id": "marketingplatformadmin.organizations.analyticsAccountLinks.create",
148 "parameterOrder": [
149 "parent"
150 ],
151 "parameters": {
152 "parent": {
153 "description": "Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id}",
154 "location": "path",
155 "pattern": "^organizations/[^/]+$",
156 "required": true,
157 "type": "string"
158 }
159 },
160 "path": "v1alpha/{+parent}/analyticsAccountLinks",
161 "request": {
162 "$ref": "AnalyticsAccountLink"
163 },
164 "response": {
165 "$ref": "AnalyticsAccountLink"
166 },
167 "scopes": [
168 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
169 ]
170 },
171 "delete": {
172 "description": "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.",
173 "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}",
174 "httpMethod": "DELETE",
175 "id": "marketingplatformadmin.organizations.analyticsAccountLinks.delete",
176 "parameterOrder": [
177 "name"
178 ],
179 "parameters": {
180 "name": {
181 "description": "Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}",
182 "location": "path",
183 "pattern": "^organizations/[^/]+/analyticsAccountLinks/[^/]+$",
184 "required": true,
185 "type": "string"
186 }
187 },
188 "path": "v1alpha/{+name}",
189 "response": {
190 "$ref": "Empty"
191 },
192 "scopes": [
193 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
194 ]
195 },
196 "list": {
197 "description": "Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.",
198 "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks",
199 "httpMethod": "GET",
200 "id": "marketingplatformadmin.organizations.analyticsAccountLinks.list",
201 "parameterOrder": [
202 "parent"
203 ],
204 "parameters": {
205 "pageSize": {
206 "description": "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.",
207 "format": "int32",
208 "location": "query",
209 "type": "integer"
210 },
211 "pageToken": {
212 "description": "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.",
213 "location": "query",
214 "type": "string"
215 },
216 "parent": {
217 "description": "Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id}",
218 "location": "path",
219 "pattern": "^organizations/[^/]+$",
220 "required": true,
221 "type": "string"
222 }
223 },
224 "path": "v1alpha/{+parent}/analyticsAccountLinks",
225 "response": {
226 "$ref": "ListAnalyticsAccountLinksResponse"
227 },
228 "scopes": [
229 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read",
230 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
231 ]
232 },
233 "setPropertyServiceLevel": {
234 "description": "Updates the service level for an Analytics property.",
235 "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}:setPropertyServiceLevel",
236 "httpMethod": "POST",
237 "id": "marketingplatformadmin.organizations.analyticsAccountLinks.setPropertyServiceLevel",
238 "parameterOrder": [
239 "analyticsAccountLink"
240 ],
241 "parameters": {
242 "analyticsAccountLink": {
243 "description": "Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}",
244 "location": "path",
245 "pattern": "^organizations/[^/]+/analyticsAccountLinks/[^/]+$",
246 "required": true,
247 "type": "string"
248 }
249 },
250 "path": "v1alpha/{+analyticsAccountLink}:setPropertyServiceLevel",
251 "request": {
252 "$ref": "SetPropertyServiceLevelRequest"
253 },
254 "response": {
255 "$ref": "SetPropertyServiceLevelResponse"
256 },
257 "scopes": [
258 "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
259 ]
260 }
261 }
262 }
263 }
264 }
265 },
266 "revision": "20240410",
267 "rootUrl": "https://marketingplatformadmin.googleapis.com/",
268 "schemas": {
269 "AnalyticsAccountLink": {
270 "description": "A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.",
271 "id": "AnalyticsAccountLink",
272 "properties": {
273 "analyticsAccount": {
274 "description": "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}",
275 "type": "string"
276 },
277 "displayName": {
278 "description": "Output only. The human-readable name for the Analytics account.",
279 "readOnly": true,
280 "type": "string"
281 },
282 "linkVerificationState": {
283 "description": "Output only. The verification state of the link between the Analytics account and the parent organization.",
284 "enum": [
285 "LINK_VERIFICATION_STATE_UNSPECIFIED",
286 "LINK_VERIFICATION_STATE_VERIFIED",
287 "LINK_VERIFICATION_STATE_NOT_VERIFIED"
288 ],
289 "enumDescriptions": [
290 "The link state is unknown.",
291 "The link is established.",
292 "The link is requested, but hasn't been approved by the product account admin."
293 ],
294 "readOnly": true,
295 "type": "string"
296 },
297 "name": {
298 "description": "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: \"organizations/xyz/analyticsAccountLinks/1234\"",
299 "type": "string"
300 }
301 },
302 "type": "object"
303 },
304 "Empty": {
305 "description": "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); }",
306 "id": "Empty",
307 "properties": {},
308 "type": "object"
309 },
310 "ListAnalyticsAccountLinksResponse": {
311 "description": "Response message for ListAnalyticsAccountLinks RPC.",
312 "id": "ListAnalyticsAccountLinksResponse",
313 "properties": {
314 "analyticsAccountLinks": {
315 "description": "Analytics account links in this organization.",
316 "items": {
317 "$ref": "AnalyticsAccountLink"
318 },
319 "type": "array"
320 },
321 "nextPageToken": {
322 "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
323 "type": "string"
324 }
325 },
326 "type": "object"
327 },
328 "Organization": {
329 "description": "A resource message representing a Google Marketing Platform organization.",
330 "id": "Organization",
331 "properties": {
332 "displayName": {
333 "description": "The human-readable name for the organization.",
334 "type": "string"
335 },
336 "name": {
337 "description": "Identifier. The resource name of the GMP organization. Format: organizations/{org_id}",
338 "type": "string"
339 }
340 },
341 "type": "object"
342 },
343 "SetPropertyServiceLevelRequest": {
344 "description": "Request message for SetPropertyServiceLevel RPC.",
345 "id": "SetPropertyServiceLevelRequest",
346 "properties": {
347 "analyticsProperty": {
348 "description": "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}",
349 "type": "string"
350 },
351 "serviceLevel": {
352 "description": "Required. The service level to set for this property.",
353 "enum": [
354 "ANALYTICS_SERVICE_LEVEL_UNSPECIFIED",
355 "ANALYTICS_SERVICE_LEVEL_STANDARD",
356 "ANALYTICS_SERVICE_LEVEL_360"
357 ],
358 "enumDescriptions": [
359 "Service level unspecified.",
360 "The standard version of Google Analytics.",
361 "The premium version of Google Analytics."
362 ],
363 "type": "string"
364 }
365 },
366 "type": "object"
367 },
368 "SetPropertyServiceLevelResponse": {
369 "description": "Response message for SetPropertyServiceLevel RPC.",
370 "id": "SetPropertyServiceLevelResponse",
371 "properties": {},
372 "type": "object"
373 }
374 },
375 "servicePath": "",
376 "title": "Google Marketing Platform Admin API",
377 "version": "v1alpha",
378 "version_module": true
379}View as plain text