Skip to content

Commit

Permalink
feat(analyticsadmin): update the api
Browse files Browse the repository at this point in the history
#### analyticsadmin:v1alpha

The following keys were added:
- resources.properties.methods.fetchAutomatedGa4ConfigurationOptOut (Total Keys: 8)
- resources.properties.methods.setAutomatedGa4ConfigurationOptOut (Total Keys: 8)
- schemas.GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest (Total Keys: 3)
- schemas.GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse (Total Keys: 3)
- schemas.GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest (Total Keys: 4)
- schemas.GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Feb 1, 2023
1 parent 0642248 commit 9d6b0eb
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 2 deletions.
56 changes: 56 additions & 0 deletions docs/dyn/analyticsadmin_v1alpha.properties.html
Expand Up @@ -146,6 +146,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.</p>
<p class="toc_element">
<code><a href="#fetchAutomatedGa4ConfigurationOptOut">fetchAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lookup for a single "GA4" Property.</p>
Expand All @@ -170,6 +173,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#runAccessReport">runAccessReport(entity, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).</p>
<p class="toc_element">
<code><a href="#setAutomatedGa4ConfigurationOptOut">setAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.</p>
<p class="toc_element">
<code><a href="#updateAttributionSettings">updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates attribution settings on a property.</p>
Expand Down Expand Up @@ -290,6 +296,31 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="fetchAutomatedGa4ConfigurationOptOut">fetchAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)</code>
<pre>Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Args:
body: object, The request body.
The object takes the form of:

{ # Request for fetching the opt out status for the automated GA4 setup process.
&quot;property&quot;: &quot;A String&quot;, # Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
}

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 fetching the opt out status for the automated GA4 setup process.
&quot;optOut&quot;: True or False, # The opt out status for the UA property.
}</pre>
</div>

<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Lookup for a single &quot;GA4&quot; Property.
Expand Down Expand Up @@ -680,6 +711,31 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="setAutomatedGa4ConfigurationOptOut">setAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)</code>
<pre>Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Args:
body: object, The request body.
The object takes the form of:

{ # Request for setting the opt out status for the automated GA4 setup process.
&quot;optOut&quot;: True or False, # The status to set.
&quot;property&quot;: &quot;A String&quot;, # Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
}

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 setting the opt out status for the automated GA4 setup process.
}</pre>
</div>

<div class="method">
<code class="details" id="updateAttributionSettings">updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates attribution settings on a property.
Expand Down
Expand Up @@ -713,6 +713,25 @@
"https://www.googleapis.com/auth/analytics.edit"
]
},
"fetchAutomatedGa4ConfigurationOptOut": {
"description": "Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.",
"flatPath": "v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut",
"httpMethod": "POST",
"id": "analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"get": {
"description": "Lookup for a single \"GA4\" Property.",
"flatPath": "v1alpha/properties/{propertiesId}",
Expand Down Expand Up @@ -918,6 +937,24 @@
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"setAutomatedGa4ConfigurationOptOut": {
"description": "Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.",
"flatPath": "v1alpha/properties:setAutomatedGa4ConfigurationOptOut",
"httpMethod": "POST",
"id": "analyticsadmin.properties.setAutomatedGa4ConfigurationOptOut",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha/properties:setAutomatedGa4ConfigurationOptOut",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"updateAttributionSettings": {
"description": "Updates attribution settings on a property.",
"flatPath": "v1alpha/properties/{propertiesId}/attributionSettings",
Expand Down Expand Up @@ -3023,7 +3060,7 @@
}
}
},
"revision": "20230129",
"revision": "20230131",
"rootUrl": "https://analyticsadmin.googleapis.com/",
"schemas": {
"GoogleAnalyticsAdminV1alphaAccessBetweenFilter": {
Expand Down Expand Up @@ -4930,6 +4967,28 @@
},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest": {
"description": "Request for fetching the opt out status for the automated GA4 setup process.",
"id": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest",
"properties": {
"property": {
"description": "Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234",
"type": "string"
}
},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse": {
"description": "Response message for fetching the opt out status for the automated GA4 setup process.",
"id": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse",
"properties": {
"optOut": {
"description": "The opt out status for the UA property.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaFirebaseLink": {
"description": "A link between a GA4 property and a Firebase project.",
"id": "GoogleAnalyticsAdminV1alphaFirebaseLink",
Expand Down Expand Up @@ -5893,6 +5952,27 @@
},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest": {
"description": "Request for setting the opt out status for the automated GA4 setup process.",
"id": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest",
"properties": {
"optOut": {
"description": "The status to set.",
"type": "boolean"
},
"property": {
"description": "Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234",
"type": "string"
}
},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse": {
"description": "Response message for setting the opt out status for the automated GA4 setup process.",
"id": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse",
"properties": {},
"type": "object"
},
"GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest": {
"description": "Request message for UpdateUserLink RPC.",
"id": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest",
Expand Down
Expand Up @@ -1536,7 +1536,7 @@
}
}
},
"revision": "20230129",
"revision": "20230131",
"rootUrl": "https://analyticsadmin.googleapis.com/",
"schemas": {
"GoogleAnalyticsAdminV1betaAccount": {
Expand Down

0 comments on commit 9d6b0eb

Please sign in to comment.