# frozen_string_literal: true # Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! module Google module Analytics module Admin module V1alpha # The request for a Data Access Record Report. # @!attribute [rw] entity # @return [::String] # The Data Access Report is requested for this property. # For example if "123" is your GA4 property ID, then entity should be # "properties/123". # @!attribute [rw] dimensions # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>] # The dimensions requested and displayed in the response. Requests are # allowed up to 9 dimensions. # @!attribute [rw] metrics # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric>] # The metrics requested and displayed in the response. Requests are allowed # up to 10 metrics. # @!attribute [rw] date_ranges # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange>] # Date ranges of access records to read. If multiple date ranges are # requested, each response row will contain a zero based date range index. If # two date ranges overlap, the access records for the overlapping days is # included in the response rows for both date ranges. Requests are allowed up # to 2 date ranges. # @!attribute [rw] dimension_filter # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression] # Dimension filters allow you to restrict report response to specific # dimension values which match the filter. For example, filtering on access # records of a single user. To learn more, see [Fundamentals of Dimension # Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) # for examples. Metrics cannot be used in this filter. # @!attribute [rw] metric_filter # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression] # Metric filters allow you to restrict report response to specific metric # values which match the filter. Metric filters are applied after aggregating # the report's rows, similar to SQL having-clause. Dimensions cannot be used # in this filter. # @!attribute [rw] offset # @return [::Integer] # The row count of the start row. The first row is counted as row 0. If # offset is unspecified, it is treated as 0. If offset is zero, then this # method will return the first page of results with `limit` entries. # # To learn more about this pagination parameter, see # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). # @!attribute [rw] limit # @return [::Integer] # The number of rows to return. If unspecified, 10,000 rows are returned. The # API returns a maximum of 100,000 rows per request, no matter how many you # ask for. `limit` must be positive. # # The API may return fewer rows than the requested `limit`, if there aren't # as many remaining rows as the `limit`. For instance, there are fewer than # 300 possible values for the dimension `country`, so when reporting on only # `country`, you can't get more than 300 rows, even if you set `limit` to a # higher value. # # To learn more about this pagination parameter, see # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). # @!attribute [rw] time_zone # @return [::String] # This request's time zone if specified. If unspecified, the property's time # zone is used. The request's time zone is used to interpret the start & end # dates of the report. # # Formatted as strings from the IANA Time Zone database # (https://www.iana.org/time-zones); for example "America/New_York" or # "Asia/Tokyo". # @!attribute [rw] order_bys # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy>] # Specifies how rows are ordered in the response. # @!attribute [rw] return_entity_quota # @return [::Boolean] # Toggles whether to return the current state of this Analytics Property's # quota. Quota is returned in [AccessQuota](#AccessQuota). class RunAccessReportRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The customized Data Access Record Report response. # @!attribute [rw] dimension_headers # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimensionHeader>] # The header for a column in the report that corresponds to a specific # dimension. The number of DimensionHeaders and ordering of DimensionHeaders # matches the dimensions present in rows. # @!attribute [rw] metric_headers # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetricHeader>] # The header for a column in the report that corresponds to a specific # metric. The number of MetricHeaders and ordering of MetricHeaders matches # the metrics present in rows. # @!attribute [rw] rows # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessRow>] # Rows of dimension value combinations and metric values in the report. # @!attribute [rw] row_count # @return [::Integer] # The total number of rows in the query result. `rowCount` is independent of # the number of rows returned in the response, the `limit` request # parameter, and the `offset` request parameter. For example if a query # returns 175 rows and includes `limit` of 50 in the API request, the # response will contain `rowCount` of 175 but only 50 rows. # # To learn more about this pagination parameter, see # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). # @!attribute [rw] quota # @return [::Google::Analytics::Admin::V1alpha::AccessQuota] # The quota state for this Analytics property including this request. class RunAccessReportResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetAccount RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the account to lookup. # Format: accounts/\\{account} # Example: "accounts/100" class GetAccountRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListAccounts RPC. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. The service may return # fewer than this value, even if there are additional pages. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListAccounts` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListAccounts` must # match the call that provided the page token. # @!attribute [rw] show_deleted # @return [::Boolean] # Whether to include soft-deleted (ie: "trashed") Accounts in the # results. Accounts can be inspected to determine whether they are deleted or # not. class ListAccountsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListAccounts RPC. # @!attribute [rw] accounts # @return [::Array<::Google::Analytics::Admin::V1alpha::Account>] # Results that were accessible to the caller. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListAccountsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteAccount RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the Account to soft-delete. # Format: accounts/\\{account} # Example: "accounts/100" class DeleteAccountRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateAccount RPC. # @!attribute [rw] account # @return [::Google::Analytics::Admin::V1alpha::Account] # Required. The account to update. # The account's `name` field is used to identify the account. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateAccountRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ProvisionAccountTicket RPC. # @!attribute [rw] account # @return [::Google::Analytics::Admin::V1alpha::Account] # The account to create. # @!attribute [rw] redirect_uri # @return [::String] # Redirect URI where the user will be sent after accepting Terms of Service. # Must be configured in Developers Console as a Redirect URI class ProvisionAccountTicketRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ProvisionAccountTicket RPC. # @!attribute [rw] account_ticket_id # @return [::String] # The param to be passed in the ToS link. class ProvisionAccountTicketResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetProperty RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the property to lookup. # Format: properties/\\{property_id} # Example: "properties/1000" class GetPropertyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListProperties RPC. # @!attribute [rw] filter # @return [::String] # Required. An expression for filtering the results of the request. # Fields eligible for filtering are: # `parent:`(The resource name of the parent account/property) or # `ancestor:`(The resource name of the parent account) or # `firebase_project:`(The id or number of the linked firebase project). # Some examples of filters: # # ``` # | Filter | Description | # |-----------------------------|-------------------------------------------| # | parent:accounts/123 | The account with account id: 123. | # | parent:properties/123 | The property with property id: 123. | # | ancestor:accounts/123 | The account with account id: 123. | # | firebase_project:project-id | The firebase project with id: project-id. | # | firebase_project:123 | The firebase project with number: 123. | # ``` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. The service may return # fewer than this value, even if there are additional pages. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListProperties` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListProperties` must # match the call that provided the page token. # @!attribute [rw] show_deleted # @return [::Boolean] # Whether to include soft-deleted (ie: "trashed") Properties in the # results. Properties can be inspected to determine whether they are deleted # or not. class ListPropertiesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListProperties RPC. # @!attribute [rw] properties # @return [::Array<::Google::Analytics::Admin::V1alpha::Property>] # Results that matched the filter criteria and were accessible to the caller. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListPropertiesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateProperty RPC. # @!attribute [rw] property # @return [::Google::Analytics::Admin::V1alpha::Property] # Required. The property to update. # The property's `name` field is used to identify the property to be # updated. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdatePropertyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateProperty RPC. # @!attribute [rw] property # @return [::Google::Analytics::Admin::V1alpha::Property] # Required. The property to create. # Note: the supplied property must specify its parent. class CreatePropertyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteProperty RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the Property to soft-delete. # Format: properties/\\{property_id} # Example: "properties/1000" class DeletePropertyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetUserLink RPC. # @!attribute [rw] name # @return [::String] # Required. Example format: accounts/1234/userLinks/5678 class GetUserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for BatchGetUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. The account or property that all user links in the request are # for. The parent of all provided values for the 'names' field must match # this field. # Example format: accounts/1234 # @!attribute [rw] names # @return [::Array<::String>] # Required. The names of the user links to retrieve. # A maximum of 1000 user links can be retrieved in a batch. # Format: accounts/\\{accountId}/userLinks/\\{userLinkId} class BatchGetUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for BatchGetUserLinks RPC. # @!attribute [rw] user_links # @return [::Array<::Google::Analytics::Admin::V1alpha::UserLink>] # The requested user links. class BatchGetUserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: accounts/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of user links to return. # The service may return fewer than this value. # If unspecified, at most 200 user links will be returned. # The maximum value is 500; values above 500 will be coerced to 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListUserLinks` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListUserLinks` must # match the call that provided the page token. class ListUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListUserLinks RPC. # @!attribute [rw] user_links # @return [::Array<::Google::Analytics::Admin::V1alpha::UserLink>] # List of UserLinks. These will be ordered stably, but in an arbitrary order. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListUserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for AuditUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: accounts/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of user links to return. # The service may return fewer than this value. # If unspecified, at most 1000 user links will be returned. # The maximum value is 5000; values above 5000 will be coerced to 5000. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `AuditUserLinks` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `AuditUserLinks` must # match the call that provided the page token. class AuditUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for AuditUserLinks RPC. # @!attribute [rw] user_links # @return [::Array<::Google::Analytics::Admin::V1alpha::AuditUserLink>] # List of AuditUserLinks. These will be ordered stably, but in an arbitrary # order. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class AuditUserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateUserLink RPC. # # Users can have multiple email addresses associated with their Google # account, and one of these email addresses is the "primary" email address. # Any of the email addresses associated with a Google account may be used # for a new UserLink, but the returned UserLink will always contain the # "primary" email address. As a result, the input and output email address # for this request may differ. # @!attribute [rw] parent # @return [::String] # Required. Example format: accounts/1234 # @!attribute [rw] notify_new_user # @return [::Boolean] # Optional. If set, then email the new user notifying them that they've been # granted permissions to the resource. # @!attribute [rw] user_link # @return [::Google::Analytics::Admin::V1alpha::UserLink] # Required. The user link to create. class CreateUserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for BatchCreateUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. The account or property that all user links in the request are # for. This field is required. The parent field in the CreateUserLinkRequest # messages must either be empty or match this field. # Example format: accounts/1234 # @!attribute [rw] notify_new_users # @return [::Boolean] # Optional. If set, then email the new users notifying them that they've been # granted permissions to the resource. Regardless of whether this is set or # not, notify_new_user field inside each individual request is ignored. # @!attribute [rw] requests # @return [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest>] # Required. The requests specifying the user links to create. # A maximum of 1000 user links can be created in a batch. class BatchCreateUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for BatchCreateUserLinks RPC. # @!attribute [rw] user_links # @return [::Array<::Google::Analytics::Admin::V1alpha::UserLink>] # The user links created. class BatchCreateUserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateUserLink RPC. # @!attribute [rw] user_link # @return [::Google::Analytics::Admin::V1alpha::UserLink] # Required. The user link to update. class UpdateUserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for BatchUpdateUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. The account or property that all user links in the request are # for. The parent field in the UpdateUserLinkRequest messages must either be # empty or match this field. # Example format: accounts/1234 # @!attribute [rw] requests # @return [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest>] # Required. The requests specifying the user links to update. # A maximum of 1000 user links can be updated in a batch. class BatchUpdateUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for BatchUpdateUserLinks RPC. # @!attribute [rw] user_links # @return [::Array<::Google::Analytics::Admin::V1alpha::UserLink>] # The user links updated. class BatchUpdateUserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteUserLink RPC. # @!attribute [rw] name # @return [::String] # Required. Example format: accounts/1234/userLinks/5678 class DeleteUserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for BatchDeleteUserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. The account or property that all user links in the request are # for. The parent of all values for user link names to delete must match this # field. # Example format: accounts/1234 # @!attribute [rw] requests # @return [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest>] # Required. The requests specifying the user links to update. # A maximum of 1000 user links can be updated in a batch. class BatchDeleteUserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateFirebaseLink RPC # @!attribute [rw] parent # @return [::String] # Required. Format: properties/\\{property_id} # Example: properties/1234 # @!attribute [rw] firebase_link # @return [::Google::Analytics::Admin::V1alpha::FirebaseLink] # Required. The Firebase link to create. class CreateFirebaseLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteFirebaseLink RPC # @!attribute [rw] name # @return [::String] # Required. Format: properties/\\{property_id}/firebaseLinks/\\{firebase_link_id} # Example: properties/1234/firebaseLinks/5678 class DeleteFirebaseLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListFirebaseLinks RPC # @!attribute [rw] parent # @return [::String] # Required. Format: properties/\\{property_id} # Example: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. The service may return # fewer than this value, even if there are additional pages. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListFirebaseLinks` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListFirebaseLinks` must # match the call that provided the page token. class ListFirebaseLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListFirebaseLinks RPC # @!attribute [rw] firebase_links # @return [::Array<::Google::Analytics::Admin::V1alpha::FirebaseLink>] # List of FirebaseLinks. This will have at most one value. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # Currently, Google Analytics supports only one FirebaseLink per property, # so this will never be populated. class ListFirebaseLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetGlobalSiteTag RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the site tag to lookup. # Note that site tags are singletons and do not have unique IDs. # Format: properties/\\{property_id}/dataStreams/\\{stream_id}/globalSiteTag # Example: "properties/123/dataStreams/456/globalSiteTag" class GetGlobalSiteTagRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateGoogleAdsLink RPC # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] google_ads_link # @return [::Google::Analytics::Admin::V1alpha::GoogleAdsLink] # Required. The GoogleAdsLink to create. class CreateGoogleAdsLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateGoogleAdsLink RPC # @!attribute [rw] google_ads_link # @return [::Google::Analytics::Admin::V1alpha::GoogleAdsLink] # The GoogleAdsLink to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateGoogleAdsLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteGoogleAdsLink RPC. # @!attribute [rw] name # @return [::String] # Required. Example format: properties/1234/googleAdsLinks/5678 class DeleteGoogleAdsLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListGoogleAdsLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListGoogleAdsLinks` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListGoogleAdsLinks` must # match the call that provided the page token. class ListGoogleAdsLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListGoogleAdsLinks RPC. # @!attribute [rw] google_ads_links # @return [::Array<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>] # List of GoogleAdsLinks. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListGoogleAdsLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetDataSharingSettings RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the settings to lookup. # Format: accounts/\\{account}/dataSharingSettings # Example: "accounts/1000/dataSharingSettings" class GetDataSharingSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListAccountSummaries RPC. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of AccountSummary resources to return. The service may # return fewer than this value, even if there are additional pages. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListAccountSummaries` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListAccountSummaries` # must match the call that provided the page token. class ListAccountSummariesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListAccountSummaries RPC. # @!attribute [rw] account_summaries # @return [::Array<::Google::Analytics::Admin::V1alpha::AccountSummary>] # Account summaries of all accounts the caller has access to. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListAccountSummariesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for AcknowledgeUserDataCollection RPC. # @!attribute [rw] property # @return [::String] # Required. The property for which to acknowledge user data collection. # @!attribute [rw] acknowledgement # @return [::String] # Required. An acknowledgement that the caller of this method understands the # terms of user data collection. # # This field must contain the exact value: # "I acknowledge that I have the necessary privacy disclosures and rights # from my end users for the collection and processing of their data, # including the association of such data with the visitation information # Google Analytics collects from my site and/or app property." class AcknowledgeUserDataCollectionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for AcknowledgeUserDataCollection RPC. class AcknowledgeUserDataCollectionResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for SearchChangeHistoryEvents RPC. # @!attribute [rw] account # @return [::String] # Required. The account resource for which to return change history # resources. # @!attribute [rw] property # @return [::String] # Optional. Resource name for a child property. If set, only return changes # made to this property or its child resources. # @!attribute [rw] resource_type # @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>] # Optional. If set, only return changes if they are for a resource that # matches at least one of these types. # @!attribute [rw] action # @return [::Array<::Google::Analytics::Admin::V1alpha::ActionType>] # Optional. If set, only return changes that match one or more of these types # of actions. # @!attribute [rw] actor_email # @return [::Array<::String>] # Optional. If set, only return changes if they are made by a user in this # list. # @!attribute [rw] earliest_change_time # @return [::Google::Protobuf::Timestamp] # Optional. If set, only return changes made after this time (inclusive). # @!attribute [rw] latest_change_time # @return [::Google::Protobuf::Timestamp] # Optional. If set, only return changes made before this time (inclusive). # @!attribute [rw] page_size # @return [::Integer] # Optional. The maximum number of ChangeHistoryEvent items to return. # The service may return fewer than this value, even if there are additional # pages. If unspecified, at most 50 items will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # Optional. A page token, received from a previous # `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent # page. When paginating, all other parameters provided to # `SearchChangeHistoryEvents` must match the call that provided the page # token. class SearchChangeHistoryEventsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for SearchAccounts RPC. # @!attribute [rw] change_history_events # @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>] # Results that were accessible to the caller. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class SearchChangeHistoryEventsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetMeasurementProtocolSecret RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the measurement protocol secret to lookup. # Format: # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret} class GetMeasurementProtocolSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateMeasurementProtocolSecret RPC # @!attribute [rw] parent # @return [::String] # Required. The parent resource where this secret will be created. # Format: properties/\\{property}/dataStreams/\\{dataStream} # @!attribute [rw] measurement_protocol_secret # @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret] # Required. The measurement protocol secret to create. class CreateMeasurementProtocolSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteMeasurementProtocolSecret RPC # @!attribute [rw] name # @return [::String] # Required. The name of the MeasurementProtocolSecret to delete. # Format: # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret} class DeleteMeasurementProtocolSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateMeasurementProtocolSecret RPC # @!attribute [rw] measurement_protocol_secret # @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret] # Required. The measurement protocol secret to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The list of fields to be updated. Omitted fields will not be updated. class UpdateMeasurementProtocolSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListMeasurementProtocolSecret RPC # @!attribute [rw] parent # @return [::String] # Required. The resource name of the parent stream. # Format: # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 10 resources will be returned. # The maximum value is 10. Higher values will be coerced to the maximum. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListMeasurementProtocolSecrets` # call. Provide this to retrieve the subsequent page. When paginating, all # other parameters provided to `ListMeasurementProtocolSecrets` must match # the call that provided the page token. class ListMeasurementProtocolSecretsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListMeasurementProtocolSecret RPC # @!attribute [rw] measurement_protocol_secrets # @return [::Array<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>] # A list of secrets for the parent stream specified in the request. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListMeasurementProtocolSecretsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetGoogleSignalsSettings RPC # @!attribute [rw] name # @return [::String] # Required. The name of the google signals settings to retrieve. # Format: properties/\\{property}/googleSignalsSettings class GetGoogleSignalsSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateGoogleSignalsSettings RPC # @!attribute [rw] google_signals_settings # @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings] # Required. The settings to update. # The `name` field is used to identify the settings to be updated. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateGoogleSignalsSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateConversionEvent RPC # @!attribute [rw] conversion_event # @return [::Google::Analytics::Admin::V1alpha::ConversionEvent] # Required. The conversion event to create. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the parent property where this conversion # event will be created. Format: properties/123 class CreateConversionEventRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetConversionEvent RPC # @!attribute [rw] name # @return [::String] # Required. The resource name of the conversion event to retrieve. # Format: properties/\\{property}/conversionEvents/\\{conversion_event} # Example: "properties/123/conversionEvents/456" class GetConversionEventRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteConversionEvent RPC # @!attribute [rw] name # @return [::String] # Required. The resource name of the conversion event to delete. # Format: properties/\\{property}/conversionEvents/\\{conversion_event} # Example: "properties/123/conversionEvents/456" class DeleteConversionEventRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListConversionEvents RPC # @!attribute [rw] parent # @return [::String] # Required. The resource name of the parent property. # Example: 'properties/123' # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListConversionEvents` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListConversionEvents` # must match the call that provided the page token. class ListConversionEventsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListConversionEvents RPC. # @!attribute [rw] conversion_events # @return [::Array<::Google::Analytics::Admin::V1alpha::ConversionEvent>] # The requested conversion events # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListConversionEventsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetDisplayVideo360AdvertiserLink RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLink to get. # Example format: properties/1234/displayVideo360AdvertiserLink/5678 class GetDisplayVideo360AdvertiserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListDisplayVideo360AdvertiserLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListDisplayVideo360AdvertiserLinks` # call. Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListDisplayVideo360AdvertiserLinks` must match the call that provided the # page token. class ListDisplayVideo360AdvertiserLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListDisplayVideo360AdvertiserLinks RPC. # @!attribute [rw] display_video_360_advertiser_links # @return [::Array<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>] # List of DisplayVideo360AdvertiserLinks. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListDisplayVideo360AdvertiserLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateDisplayVideo360AdvertiserLink RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] display_video_360_advertiser_link # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink] # Required. The DisplayVideo360AdvertiserLink to create. class CreateDisplayVideo360AdvertiserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteDisplayVideo360AdvertiserLink RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLink to delete. # Example format: properties/1234/displayVideo360AdvertiserLinks/5678 class DeleteDisplayVideo360AdvertiserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateDisplayVideo360AdvertiserLink RPC. # @!attribute [rw] display_video_360_advertiser_link # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink] # The DisplayVideo360AdvertiserLink to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Omitted fields will not be # updated. To replace the entire entity, use one path with the string "*" to # match all fields. class UpdateDisplayVideo360AdvertiserLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 class GetDisplayVideo360AdvertiserLinkProposalRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListDisplayVideo360AdvertiserLinkProposals RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous # `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve # the subsequent page. # # When paginating, all other parameters provided to # `ListDisplayVideo360AdvertiserLinkProposals` must match the call that # provided the page token. class ListDisplayVideo360AdvertiserLinkProposalsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListDisplayVideo360AdvertiserLinkProposals RPC. # @!attribute [rw] display_video_360_advertiser_link_proposals # @return [::Array<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>] # List of DisplayVideo360AdvertiserLinkProposals. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListDisplayVideo360AdvertiserLinkProposalsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] display_video_360_advertiser_link_proposal # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal] # Required. The DisplayVideo360AdvertiserLinkProposal to create. class CreateDisplayVideo360AdvertiserLinkProposalRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 class DeleteDisplayVideo360AdvertiserLinkProposalRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 class ApproveDisplayVideo360AdvertiserLinkProposalRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] display_video_360_advertiser_link # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink] # The DisplayVideo360AdvertiserLink created as a result of approving the # proposal. class ApproveDisplayVideo360AdvertiserLinkProposalResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 class CancelDisplayVideo360AdvertiserLinkProposalRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetSearchAds360Link RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the SearchAds360Link to get. # Example format: properties/1234/SearchAds360Link/5678 class GetSearchAds360LinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListSearchAds360Links RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListSearchAds360Links` # call. Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListSearchAds360Links` must match the call that provided the # page token. class ListSearchAds360LinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListSearchAds360Links RPC. # @!attribute [rw] search_ads_360_links # @return [::Array<::Google::Analytics::Admin::V1alpha::SearchAds360Link>] # List of SearchAds360Links. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListSearchAds360LinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateSearchAds360Link RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] search_ads_360_link # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link] # Required. The SearchAds360Link to create. class CreateSearchAds360LinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteSearchAds360Link RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the SearchAds360Link to delete. # Example format: properties/1234/SearchAds360Links/5678 class DeleteSearchAds360LinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateSearchAds360Link RPC. # @!attribute [rw] search_ads_360_link # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link] # The SearchAds360Link to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Omitted fields will not be # updated. To replace the entire entity, use one path with the string "*" to # match all fields. class UpdateSearchAds360LinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateCustomDimension RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] custom_dimension # @return [::Google::Analytics::Admin::V1alpha::CustomDimension] # Required. The CustomDimension to create. class CreateCustomDimensionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateCustomDimension RPC. # @!attribute [rw] custom_dimension # @return [::Google::Analytics::Admin::V1alpha::CustomDimension] # The CustomDimension to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Omitted fields will not be # updated. To replace the entire entity, use one path with the string "*" to # match all fields. class UpdateCustomDimensionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListCustomDimensions RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListCustomDimensions` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListCustomDimensions` # must match the call that provided the page token. class ListCustomDimensionsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListCustomDimensions RPC. # @!attribute [rw] custom_dimensions # @return [::Array<::Google::Analytics::Admin::V1alpha::CustomDimension>] # List of CustomDimensions. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListCustomDimensionsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ArchiveCustomDimension RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the CustomDimension to archive. # Example format: properties/1234/customDimensions/5678 class ArchiveCustomDimensionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetCustomDimension RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the CustomDimension to get. # Example format: properties/1234/customDimensions/5678 class GetCustomDimensionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateCustomMetric RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] custom_metric # @return [::Google::Analytics::Admin::V1alpha::CustomMetric] # Required. The CustomMetric to create. class CreateCustomMetricRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateCustomMetric RPC. # @!attribute [rw] custom_metric # @return [::Google::Analytics::Admin::V1alpha::CustomMetric] # The CustomMetric to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Omitted fields will not be # updated. To replace the entire entity, use one path with the string "*" to # match all fields. class UpdateCustomMetricRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListCustomMetrics RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListCustomMetrics` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListCustomMetrics` must # match the call that provided the page token. class ListCustomMetricsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListCustomMetrics RPC. # @!attribute [rw] custom_metrics # @return [::Array<::Google::Analytics::Admin::V1alpha::CustomMetric>] # List of CustomMetrics. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListCustomMetricsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ArchiveCustomMetric RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the CustomMetric to archive. # Example format: properties/1234/customMetrics/5678 class ArchiveCustomMetricRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetCustomMetric RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the CustomMetric to get. # Example format: properties/1234/customMetrics/5678 class GetCustomMetricRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetDataRetentionSettings RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the settings to lookup. # Format: # properties/\\{property}/dataRetentionSettings # Example: "properties/1000/dataRetentionSettings" class GetDataRetentionSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateDataRetentionSettings RPC. # @!attribute [rw] data_retention_settings # @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings] # Required. The settings to update. # The `name` field is used to identify the settings to be updated. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateDataRetentionSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateDataStream RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] data_stream # @return [::Google::Analytics::Admin::V1alpha::DataStream] # Required. The DataStream to create. class CreateDataStreamRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for DeleteDataStream RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DataStream to delete. # Example format: properties/1234/dataStreams/5678 class DeleteDataStreamRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateDataStream RPC. # @!attribute [rw] data_stream # @return [::Google::Analytics::Admin::V1alpha::DataStream] # The DataStream to update # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Omitted fields will not be # updated. To replace the entire entity, use one path with the string "*" to # match all fields. class UpdateDataStreamRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListDataStreams RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListDataStreams` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListDataStreams` must # match the call that provided the page token. class ListDataStreamsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListDataStreams RPC. # @!attribute [rw] data_streams # @return [::Array<::Google::Analytics::Admin::V1alpha::DataStream>] # List of DataStreams. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListDataStreamsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetDataStream RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the DataStream to get. # Example format: properties/1234/dataStreams/5678 class GetDataStreamRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetAudience RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the Audience to get. # Example format: properties/1234/audiences/5678 class GetAudienceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListAudiences RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. # If unspecified, at most 50 resources will be returned. # The maximum value is 200 (higher values will be coerced to the maximum). # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListAudiences` call. Provide this # to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListAudiences` must # match the call that provided the page token. class ListAudiencesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListAudiences RPC. # @!attribute [rw] audiences # @return [::Array<::Google::Analytics::Admin::V1alpha::Audience>] # List of Audiences. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListAudiencesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateAudience RPC. # @!attribute [rw] parent # @return [::String] # Required. Example format: properties/1234 # @!attribute [rw] audience # @return [::Google::Analytics::Admin::V1alpha::Audience] # Required. The audience to create. class CreateAudienceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateAudience RPC. # @!attribute [rw] audience # @return [::Google::Analytics::Admin::V1alpha::Audience] # Required. The audience to update. # The audience's `name` field is used to identify the audience to be updated. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateAudienceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ArchiveAudience RPC. # @!attribute [rw] name # @return [::String] # Required. Example format: properties/1234/audiences/5678 class ArchiveAudienceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetAttributionSettings RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the attribution settings to retrieve. # Format: properties/\\{property}/attributionSettings class GetAttributionSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateAttributionSettings RPC # @!attribute [rw] attribution_settings # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings] # Required. The attribution settings to update. # The `name` field is used to identify the settings to be updated. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. The list of fields to be updated. Field names must be in snake # case (e.g., "field_to_update"). Omitted fields will not be updated. To # replace the entire entity, use one path with the string "*" to match all # fields. class UpdateAttributionSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request for setting the opt out status for the automated GA4 setup process. # @!attribute [rw] property # @return [::String] # 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 # @!attribute [rw] opt_out # @return [::Boolean] # The status to set. class SetAutomatedGa4ConfigurationOptOutRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for setting the opt out status for the automated GA4 setup # process. class SetAutomatedGa4ConfigurationOptOutResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request for fetching the opt out status for the automated GA4 setup process. # @!attribute [rw] property # @return [::String] # 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 class FetchAutomatedGa4ConfigurationOptOutRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for fetching the opt out status for the automated GA4 setup # process. # @!attribute [rw] opt_out # @return [::Boolean] # The opt out status for the UA property. class FetchAutomatedGa4ConfigurationOptOutResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetBigQueryLink RPC. # @!attribute [rw] name # @return [::String] # Required. The name of the BigQuery link to lookup. # Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id} # Example: properties/123/bigQueryLinks/456 class GetBigQueryLinkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for ListBigQueryLinks RPC. # @!attribute [rw] parent # @return [::String] # Required. The name of the property to list BigQuery links under. # Format: properties/\\{property_id} # Example: properties/1234 # @!attribute [rw] page_size # @return [::Integer] # The maximum number of resources to return. The service may return # fewer than this value, even if there are additional pages. # If unspecified, at most 50 resources will be returned. # The maximum value is 200; (higher values will be coerced to the maximum) # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListBigQueryLinks` call. # Provide this to retrieve the subsequent page. # When paginating, all other parameters provided to `ListBigQueryLinks` must # match the call that provided the page token. class ListBigQueryLinksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for ListBigQueryLinks RPC # @!attribute [rw] bigquery_links # @return [::Array<::Google::Analytics::Admin::V1alpha::BigQueryLink>] # List of BigQueryLinks. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListBigQueryLinksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end