Method: properties.updateDataRetentionSettings
このプロパティのシングルトン データ保持設定を更新します。
HTTP リクエスト
PATCH https://analyticsadmin.googleapis.com/v1alpha/{dataRetentionSettings.name=properties/*/dataRetentionSettings}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
dataRetentionSettings.name |
string
出力専用。この DataRetentionSetting リソースのリソース名。形式: properties/{property}/dataRetentionSettings
|
クエリ パラメータ
パラメータ |
updateMask |
string (FieldMask format)
必須。更新するフィールドのリスト。フィールド名はスネークケースにする必要があります(例:"field_to_update")。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。 完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo" 。
|
リクエストの本文
リクエストの本文には DataRetentionSettings
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には DataRetentionSettings
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/analytics.edit
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-01-14 UTC。
[null,null,["最終更新日 2025-01-14 UTC。"],[[["This endpoint updates the data retention settings for a Google Analytics 4 property using an HTTP PATCH request."],["It requires specifying the `dataRetentionSettings.name` as a path parameter to identify the property's settings."],["An `updateMask` query parameter is required to indicate which fields should be updated within the data retention settings."],["The request body should contain the updated `DataRetentionSettings` object, and a successful response will return the updated settings."],["Users need the `https://www.googleapis.com/auth/analytics.edit` OAuth scope to authorize this request."]]],["This document details updating data retention settings for a property using a `PATCH` request to the specified URL. The resource path is defined by `dataRetentionSettings.name`, and the request requires a `updateMask` query parameter specifying fields to update. The request body contains `DataRetentionSettings`, and a successful response also returns `DataRetentionSettings`. This operation requires authorization with the `https://www.googleapis.com/auth/analytics.edit` scope. Additionally, it indicates that there are HTTP requests, path, query, request, and response bodies, and offers a 'try it!' feature.\n"]]