From 1277148ed4bb16c03802a6d11bb15ab138bf6c19 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Dec 2022 07:07:38 +0000 Subject: [PATCH] feat(analyticsadmin): update the api #### analyticsadmin:v1alpha The following keys were added: - resources.properties.resources.bigQueryLinks.methods.get (Total Keys: 11) - resources.properties.resources.bigQueryLinks.methods.list (Total Keys: 16) - schemas.GoogleAnalyticsAdminV1alphaBigQueryLink (Total Keys: 15) - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.bigqueryLink.$ref (Total Keys: 1) - schemas.GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse (Total Keys: 5) --- docs/dyn/analyticsadmin_v1alpha.accounts.html | 28 + ...dmin_v1alpha.properties.bigQueryLinks.html | 176 ++ ...dmin_v1alpha.properties.firebaseLinks.html | 2 +- .../analyticsadmin_v1alpha.properties.html | 5 + ...nalyticsadmin_v1beta.accountSummaries.html | 141 + docs/dyn/analyticsadmin_v1beta.accounts.html | 514 ++++ docs/dyn/analyticsadmin_v1beta.html | 121 + ...in_v1beta.properties.conversionEvents.html | 220 ++ ...in_v1beta.properties.customDimensions.html | 270 ++ ...admin_v1beta.properties.customMetrics.html | 288 ++ ...csadmin_v1beta.properties.dataStreams.html | 341 +++ ...ataStreams.measurementProtocolSecrets.html | 246 ++ ...admin_v1beta.properties.firebaseLinks.html | 188 ++ ...dmin_v1beta.properties.googleAdsLinks.html | 242 ++ .../dyn/analyticsadmin_v1beta.properties.html | 435 +++ .../documents/analyticsadmin.v1alpha.json | 141 +- .../documents/analyticsadmin.v1beta.json | 2692 +++++++++++++++++ 17 files changed, 6047 insertions(+), 3 deletions(-) create mode 100644 docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html create mode 100644 docs/dyn/analyticsadmin_v1beta.accountSummaries.html create mode 100644 docs/dyn/analyticsadmin_v1beta.accounts.html create mode 100644 docs/dyn/analyticsadmin_v1beta.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.html create mode 100644 googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 2c61932e574..bcae5ea0bf1 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -354,6 +354,20 @@

Method Details

"otherConversionEventLookbackWindow": "A String", # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. "reportingAttributionModel": "A String", # Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. }, + "bigqueryLink": { # A link between a GA4 Property and BigQuery project. # A snapshot of a BigQuery link resource in change history. + "createTime": "A String", # Output only. Time when the link was created. + "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project. + "excludedEvents": [ # The list of event names that will be excluded from exports. + "A String", + ], + "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000'] + "A String", + ], + "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. + "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' + "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. + }, "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history. "createTime": "A String", # Output only. Time when this conversion event was created in the property. "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property. @@ -525,6 +539,20 @@

Method Details

"otherConversionEventLookbackWindow": "A String", # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. "reportingAttributionModel": "A String", # Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. }, + "bigqueryLink": { # A link between a GA4 Property and BigQuery project. # A snapshot of a BigQuery link resource in change history. + "createTime": "A String", # Output only. Time when the link was created. + "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project. + "excludedEvents": [ # The list of event names that will be excluded from exports. + "A String", + ], + "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000'] + "A String", + ], + "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. + "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' + "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. + }, "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history. "createTime": "A String", # Output only. Time when this conversion event was created in the property. "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html new file mode 100644 index 00000000000..c4f7bd1bc78 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html @@ -0,0 +1,176 @@ + + + +

Google Analytics Admin API . properties . bigQueryLinks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Lookup for a single BigQuery Link.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists BigQuery Links on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single BigQuery Link.
+
+Args:
+  name: string, Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A link between a GA4 Property and BigQuery project.
+  "createTime": "A String", # Output only. Time when the link was created.
+  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
+  "excludedEvents": [ # The list of event names that will be excluded from exports.
+    "A String",
+  ],
+  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
+    "A String",
+  ],
+  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
+  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
+  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists BigQuery Links on a property.
+
+Args:
+  parent: string, Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234 (required)
+  pageSize: 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)
+  pageToken: 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.
+  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 ListBigQueryLinks RPC
+  "bigqueryLinks": [ # List of BigQueryLinks.
+    { # A link between a GA4 Property and BigQuery project.
+      "createTime": "A String", # Output only. Time when the link was created.
+      "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
+      "excludedEvents": [ # The list of event names that will be excluded from exports.
+        "A String",
+      ],
+      "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
+        "A String",
+      ],
+      "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
+      "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
+      "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+      "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html index 7a6caab6a39..ceb2fd7c37c 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html @@ -150,7 +150,7 @@

Method Details

Args: parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required) pageSize: 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) - pageToken: string, A page token, received from a previous `ListFirebaseLinks` 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. + pageToken: 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index 6df0abbec7c..0bc7a684e68 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -79,6 +79,11 @@

Instance Methods

Returns the audiences Resource.

+

+ bigQueryLinks() +

+

Returns the bigQueryLinks Resource.

+

conversionEvents()

diff --git a/docs/dyn/analyticsadmin_v1beta.accountSummaries.html b/docs/dyn/analyticsadmin_v1beta.accountSummaries.html new file mode 100644 index 00000000000..d3969a00017 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.accountSummaries.html @@ -0,0 +1,141 @@ + + + +

Google Analytics Admin API . accountSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(pageSize=None, pageToken=None, x__xgafv=None)

+

Returns summaries of all accounts accessible by the caller.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ list(pageSize=None, pageToken=None, x__xgafv=None) + 
Returns summaries of all accounts accessible by the caller.
+
+Args:
+  pageSize: 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)
+  pageToken: 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.
+  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 ListAccountSummaries RPC.
+  "accountSummaries": [ # Account summaries of all accounts the caller has access to.
+    { # A virtual resource representing an overview of an account and all its child GA4 properties.
+      "account": "A String", # Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"
+      "displayName": "A String", # Display name for the account referred to in this account summary.
+      "name": "A String", # Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"
+      "propertySummaries": [ # List of summaries for child accounts of this account.
+        { # A virtual resource representing metadata for a GA4 property.
+          "displayName": "A String", # Display name for the property referred to in this property summary.
+          "parent": "A String", # Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200"
+          "property": "A String", # Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"
+          "propertyType": "A String", # The property's property type.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html new file mode 100644 index 00000000000..0a268cc6a68 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.accounts.html @@ -0,0 +1,514 @@ + + + +

Google Analytics Admin API . accounts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

+

+ get(name, x__xgafv=None)

+

Lookup for a single Account.

+

+ getDataSharingSettings(name, x__xgafv=None)

+

Get data sharing settings on an account. Data sharing settings are singletons.

+

+ list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

+

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates an account.

+

+ provisionAccountTicket(body=None, x__xgafv=None)

+

Requests a ticket for creating an account.

+

+ searchChangeHistoryEvents(account, body=None, x__xgafv=None)

+

Searches through all changes to an account or its children given the specified set of filters.

+

+ searchChangeHistoryEvents_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
+
+Args:
+  name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single Account.
+
+Args:
+  name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics account.
+  "createTime": "A String", # Output only. Time when this account was originally created.
+  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+  "displayName": "A String", # Required. Human-readable display name for this account.
+  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+}
+
+ +
+ getDataSharingSettings(name, x__xgafv=None) + 
Get data sharing settings on an account. Data sharing settings are singletons.
+
+Args:
+  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing data sharing settings of a Google Analytics account.
+  "name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
+  "sharingWithGoogleAnySalesEnabled": True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
+  "sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
+  "sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services.
+  "sharingWithGoogleSupportEnabled": True or False, # Allows Google support to access the data in order to help troubleshoot issues.
+  "sharingWithOthersEnabled": True or False, # Allows Google to share the data anonymously in aggregate form with others.
+}
+
+ +
+ list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) + 
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
+
+Args:
+  pageSize: 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)
+  pageToken: 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.
+  showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Request message for ListAccounts RPC.
+  "accounts": [ # Results that were accessible to the caller.
+    { # A resource message representing a Google Analytics account.
+      "createTime": "A String", # Output only. Time when this account was originally created.
+      "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+      "displayName": "A String", # Required. Human-readable display name for this account.
+      "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+      "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+      "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates an account.
+
+Args:
+  name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource message representing a Google Analytics account.
+  "createTime": "A String", # Output only. Time when this account was originally created.
+  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+  "displayName": "A String", # Required. Human-readable display name for this account.
+  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics account.
+  "createTime": "A String", # Output only. Time when this account was originally created.
+  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+  "displayName": "A String", # Required. Human-readable display name for this account.
+  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+}
+
+ +
+ provisionAccountTicket(body=None, x__xgafv=None) + 
Requests a ticket for creating an account.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ProvisionAccountTicket RPC.
+  "account": { # A resource message representing a Google Analytics account. # The account to create.
+    "createTime": "A String", # Output only. Time when this account was originally created.
+    "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+    "displayName": "A String", # Required. Human-readable display name for this account.
+    "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+    "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+    "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+  },
+  "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI
+}
+
+  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 ProvisionAccountTicket RPC.
+  "accountTicketId": "A String", # The param to be passed in the ToS link.
+}
+
+ +
+ searchChangeHistoryEvents(account, body=None, x__xgafv=None) + 
Searches through all changes to an account or its children given the specified set of filters.
+
+Args:
+  account: string, Required. The account resource for which to return change history resources. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SearchChangeHistoryEvents RPC.
+  "action": [ # Optional. If set, only return changes that match one or more of these types of actions.
+    "A String",
+  ],
+  "actorEmail": [ # Optional. If set, only return changes if they are made by a user in this list.
+    "A String",
+  ],
+  "earliestChangeTime": "A String", # Optional. If set, only return changes made after this time (inclusive).
+  "latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
+  "pageSize": 42, # 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).
+  "pageToken": "A 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.
+  "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.
+  "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
+    "A String",
+  ],
+}
+
+  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 SearchAccounts RPC.
+  "changeHistoryEvents": [ # Results that were accessible to the caller.
+    { # A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
+      "actorType": "A String", # The type of actor that made this change.
+      "changeTime": "A String", # Time when change was made.
+      "changes": [ # A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
+        { # A description of a change to a single Google Analytics resource.
+          "action": "A String", # The type of action that changed this resource.
+          "resource": "A String", # Resource name of the resource whose changes are described by this entry.
+          "resourceAfterChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
+            "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
+              "createTime": "A String", # Output only. Time when this account was originally created.
+              "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+              "displayName": "A String", # Required. Human-readable display name for this account.
+              "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+              "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+              "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+            },
+            "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
+              "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+              "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+              "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+              "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+              "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+            },
+            "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
+              "eventDataRetention": "A String", # The length of time that event-level data is retained.
+              "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+              "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+            },
+            "dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
+              "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+                "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+                "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+              },
+              "createTime": "A String", # Output only. Time when this stream was originally created.
+              "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+              "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+                "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+                "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+              },
+              "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+              "type": "A String", # Required. Immutable. The type of this DataStream resource.
+              "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+              "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+                "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+                "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+                "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+              },
+            },
+            "firebaseLink": { # A link between a GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
+              "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
+              "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
+              "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+            },
+            "googleAdsLink": { # A link between a GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
+              "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+              "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+              "createTime": "A String", # Output only. Time when this link was originally created.
+              "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+              "customerId": "A String", # Immutable. Google Ads customer ID.
+              "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+              "updateTime": "A String", # Output only. Time when this link was last updated.
+            },
+            "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
+              "displayName": "A String", # Required. Human-readable display name for this secret.
+              "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+              "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+            },
+            "property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.
+              "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+              "createTime": "A String", # Output only. Time when the entity was originally created.
+              "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+              "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+              "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+              "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+              "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+              "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+              "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+              "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+              "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+              "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+              "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+            },
+          },
+          "resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
+            "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
+              "createTime": "A String", # Output only. Time when this account was originally created.
+              "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
+              "displayName": "A String", # Required. Human-readable display name for this account.
+              "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
+              "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
+              "updateTime": "A String", # Output only. Time when account payload fields were last updated.
+            },
+            "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
+              "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+              "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+              "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+              "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+              "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+            },
+            "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
+              "eventDataRetention": "A String", # The length of time that event-level data is retained.
+              "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+              "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+            },
+            "dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
+              "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+                "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+                "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+              },
+              "createTime": "A String", # Output only. Time when this stream was originally created.
+              "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+              "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+                "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+                "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+              },
+              "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+              "type": "A String", # Required. Immutable. The type of this DataStream resource.
+              "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+              "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+                "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+                "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+                "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+              },
+            },
+            "firebaseLink": { # A link between a GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
+              "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
+              "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
+              "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+            },
+            "googleAdsLink": { # A link between a GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
+              "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+              "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+              "createTime": "A String", # Output only. Time when this link was originally created.
+              "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+              "customerId": "A String", # Immutable. Google Ads customer ID.
+              "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+              "updateTime": "A String", # Output only. Time when this link was last updated.
+            },
+            "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
+              "displayName": "A String", # Required. Human-readable display name for this secret.
+              "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+              "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+            },
+            "property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.
+              "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+              "createTime": "A String", # Output only. Time when the entity was originally created.
+              "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+              "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+              "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+              "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+              "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+              "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+              "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+              "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+              "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+              "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+              "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+            },
+          },
+        },
+      ],
+      "changesFiltered": True or False, # If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.
+      "id": "A String", # ID of this change history event. This ID is unique across Google Analytics.
+      "userActorEmail": "A String", # Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ searchChangeHistoryEvents_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.html b/docs/dyn/analyticsadmin_v1beta.html new file mode 100644 index 00000000000..75246f47a14 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.html @@ -0,0 +1,121 @@ + + + +

Google Analytics Admin API

+

Instance Methods

+

+ accountSummaries() +

+

Returns the accountSummaries Resource.

+ +

+ accounts() +

+

Returns the accounts Resource.

+ +

+ properties() +

+

Returns the properties Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ new_batch_http_request() + 
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html new file mode 100644 index 00000000000..7d839cbf40e --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html @@ -0,0 +1,220 @@ + + + +

Google Analytics Admin API . properties . conversionEvents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a conversion event with the specified attributes.

+

+ delete(name, x__xgafv=None)

+

Deletes a conversion event in a property.

+

+ get(name, x__xgafv=None)

+

Retrieve a single conversion event.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a conversion event with the specified attributes.
+
+Args:
+  parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A conversion event in a Google Analytics property.
+  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+  "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+  "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A conversion event in a Google Analytics property.
+  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+  "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+  "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a conversion event in a property.
+
+Args:
+  name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Retrieve a single conversion event.
+
+Args:
+  name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A conversion event in a Google Analytics property.
+  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+  "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+  "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+
+Args:
+  parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
+  pageSize: 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)
+  pageToken: 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.
+  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 ListConversionEvents RPC.
+  "conversionEvents": [ # The requested conversion events
+    { # A conversion event in a Google Analytics property.
+      "createTime": "A String", # Output only. Time when this conversion event was created in the property.
+      "custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
+      "deletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+      "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
+      "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html b/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html new file mode 100644 index 00000000000..42f07f34a4c --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.customDimensions.html @@ -0,0 +1,270 @@ + + + +

Google Analytics Admin API . properties . customDimensions

+

Instance Methods

+

+ archive(name, body=None, x__xgafv=None)

+

Archives a CustomDimension on a property.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a CustomDimension.

+

+ get(name, x__xgafv=None)

+

Lookup for a single CustomDimension.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists CustomDimensions on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a CustomDimension on a property.

+

Method Details

+
+ archive(name, body=None, x__xgafv=None) + 
Archives a CustomDimension on a property.
+
+Args:
+  name: string, Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ArchiveCustomDimension RPC.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a CustomDimension.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A definition for a CustomDimension.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+  "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+  "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+  "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a CustomDimension.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+  "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+  "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+  "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single CustomDimension.
+
+Args:
+  name: string, Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a CustomDimension.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+  "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+  "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+  "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists CustomDimensions on a property.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  pageSize: 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).
+  pageToken: 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.
+  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 ListCustomDimensions RPC.
+  "customDimensions": [ # List of CustomDimensions.
+    { # A definition for a CustomDimension.
+      "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+      "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+      "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+      "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+      "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+      "scope": "A String", # Required. Immutable. The scope of this dimension.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a CustomDimension on a property.
+
+Args:
+  name: string, Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A definition for a CustomDimension.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+  "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+  "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+  "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a CustomDimension.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
+  "displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
+  "parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
+  "scope": "A String", # Required. Immutable. The scope of this dimension.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html b/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html new file mode 100644 index 00000000000..54450c66414 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.customMetrics.html @@ -0,0 +1,288 @@ + + + +

Google Analytics Admin API . properties . customMetrics

+

Instance Methods

+

+ archive(name, body=None, x__xgafv=None)

+

Archives a CustomMetric on a property.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a CustomMetric.

+

+ get(name, x__xgafv=None)

+

Lookup for a single CustomMetric.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists CustomMetrics on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a CustomMetric on a property.

+

Method Details

+
+ archive(name, body=None, x__xgafv=None) + 
Archives a CustomMetric on a property.
+
+Args:
+  name: string, Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ArchiveCustomMetric RPC.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a CustomMetric.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A definition for a custom metric.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "measurementUnit": "A String", # Required. The type for the custom metric's value.
+  "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+  "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+  "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+    "A String",
+  ],
+  "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a custom metric.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "measurementUnit": "A String", # Required. The type for the custom metric's value.
+  "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+  "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+  "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+    "A String",
+  ],
+  "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single CustomMetric.
+
+Args:
+  name: string, Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a custom metric.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "measurementUnit": "A String", # Required. The type for the custom metric's value.
+  "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+  "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+  "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+    "A String",
+  ],
+  "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists CustomMetrics on a property.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  pageSize: 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).
+  pageToken: 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.
+  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 ListCustomMetrics RPC.
+  "customMetrics": [ # List of CustomMetrics.
+    { # A definition for a custom metric.
+      "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+      "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+      "measurementUnit": "A String", # Required. The type for the custom metric's value.
+      "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+      "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+      "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+        "A String",
+      ],
+      "scope": "A String", # Required. Immutable. The scope of this custom metric.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a CustomMetric on a property.
+
+Args:
+  name: string, Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A definition for a custom metric.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "measurementUnit": "A String", # Required. The type for the custom metric's value.
+  "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+  "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+  "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+    "A String",
+  ],
+  "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A definition for a custom metric.
+  "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
+  "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
+  "measurementUnit": "A String", # Required. The type for the custom metric's value.
+  "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
+  "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
+  "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
+    "A String",
+  ],
+  "scope": "A String", # Required. Immutable. The scope of this custom metric.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html new file mode 100644 index 00000000000..15695b9286a --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html @@ -0,0 +1,341 @@ + + + +

Google Analytics Admin API . properties . dataStreams

+

Instance Methods

+

+ measurementProtocolSecrets() +

+

Returns the measurementProtocolSecrets Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a DataStream.

+

+ delete(name, x__xgafv=None)

+

Deletes a DataStream on a property.

+

+ get(name, x__xgafv=None)

+

Lookup for a single DataStream.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists DataStreams on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a DataStream on a property.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a DataStream.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource message representing a data stream.
+  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+  },
+  "createTime": "A String", # Output only. Time when this stream was originally created.
+  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+  },
+  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+  "type": "A String", # Required. Immutable. The type of this DataStream resource.
+  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+    "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+    "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a data stream.
+  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+  },
+  "createTime": "A String", # Output only. Time when this stream was originally created.
+  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+  },
+  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+  "type": "A String", # Required. Immutable. The type of this DataStream resource.
+  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+    "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+    "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a DataStream on a property.
+
+Args:
+  name: string, Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single DataStream.
+
+Args:
+  name: string, Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a data stream.
+  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+  },
+  "createTime": "A String", # Output only. Time when this stream was originally created.
+  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+  },
+  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+  "type": "A String", # Required. Immutable. The type of this DataStream resource.
+  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+    "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+    "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists DataStreams on a property.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  pageSize: 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).
+  pageToken: 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.
+  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 ListDataStreams RPC.
+  "dataStreams": [ # List of DataStreams.
+    { # A resource message representing a data stream.
+      "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+        "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+        "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+      },
+      "createTime": "A String", # Output only. Time when this stream was originally created.
+      "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+      "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+        "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+        "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+      },
+      "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+      "type": "A String", # Required. Immutable. The type of this DataStream resource.
+      "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+      "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+        "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+        "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+        "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+      },
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a DataStream on a property.
+
+Args:
+  name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource message representing a data stream.
+  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+  },
+  "createTime": "A String", # Output only. Time when this stream was originally created.
+  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+  },
+  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+  "type": "A String", # Required. Immutable. The type of this DataStream resource.
+  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+    "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+    "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+  },
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a data stream.
+  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
+    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
+    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
+  },
+  "createTime": "A String", # Output only. Time when this stream was originally created.
+  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
+  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
+    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
+  },
+  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
+  "type": "A String", # Required. Immutable. The type of this DataStream resource.
+  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
+  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
+    "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
+    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
+    "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html new file mode 100644 index 00000000000..c3364391498 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.measurementProtocolSecrets.html @@ -0,0 +1,246 @@ + + + +

Google Analytics Admin API . properties . dataStreams . measurementProtocolSecrets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a measurement protocol secret.

+

+ delete(name, x__xgafv=None)

+

Deletes target MeasurementProtocolSecret.

+

+ get(name, x__xgafv=None)

+

Lookup for a single "GA4" MeasurementProtocolSecret.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns child MeasurementProtocolSecrets under the specified parent Property.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a measurement protocol secret.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a measurement protocol secret.
+
+Args:
+  parent: string, Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A secret value used for sending hits to Measurement Protocol.
+  "displayName": "A String", # Required. Human-readable display name for this secret.
+  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret value used for sending hits to Measurement Protocol.
+  "displayName": "A String", # Required. Human-readable display name for this secret.
+  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes target MeasurementProtocolSecret.
+
+Args:
+  name: string, Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single "GA4" MeasurementProtocolSecret.
+
+Args:
+  name: string, Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret value used for sending hits to Measurement Protocol.
+  "displayName": "A String", # Required. Human-readable display name for this secret.
+  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Returns child MeasurementProtocolSecrets under the specified parent Property.
+
+Args:
+  parent: string, Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets (required)
+  pageSize: 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.
+  pageToken: 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.
+  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 ListMeasurementProtocolSecret RPC
+  "measurementProtocolSecrets": [ # A list of secrets for the parent stream specified in the request.
+    { # A secret value used for sending hits to Measurement Protocol.
+      "displayName": "A String", # Required. Human-readable display name for this secret.
+      "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+      "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a measurement protocol secret.
+
+Args:
+  name: string, Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A secret value used for sending hits to Measurement Protocol.
+  "displayName": "A String", # Required. Human-readable display name for this secret.
+  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+  updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret value used for sending hits to Measurement Protocol.
+  "displayName": "A String", # Required. Human-readable display name for this secret.
+  "name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
+  "secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html new file mode 100644 index 00000000000..939d87d0477 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html @@ -0,0 +1,188 @@ + + + +

Google Analytics Admin API . properties . firebaseLinks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

+

+ delete(name, x__xgafv=None)

+

Deletes a FirebaseLink on a property

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
+
+Args:
+  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A link between a GA4 property and a Firebase project.
+  "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
+  "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
+  "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A link between a GA4 property and a Firebase project.
+  "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
+  "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
+  "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a FirebaseLink on a property
+
+Args:
+  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
+
+Args:
+  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  pageSize: 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)
+  pageToken: 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.
+  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 ListFirebaseLinks RPC
+  "firebaseLinks": [ # List of FirebaseLinks. This will have at most one value.
+    { # A link between a GA4 property and a Firebase project.
+      "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
+      "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
+      "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html new file mode 100644 index 00000000000..ef0f4d72d51 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.googleAdsLinks.html @@ -0,0 +1,242 @@ + + + +

Google Analytics Admin API . properties . googleAdsLinks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a GoogleAdsLink.

+

+ delete(name, x__xgafv=None)

+

Deletes a GoogleAdsLink on a property

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists GoogleAdsLinks on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a GoogleAdsLink on a property

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a GoogleAdsLink.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A link between a GA4 property and a Google Ads account.
+  "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+  "createTime": "A String", # Output only. Time when this link was originally created.
+  "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+  "customerId": "A String", # Immutable. Google Ads customer ID.
+  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+  "updateTime": "A String", # Output only. Time when this link was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A link between a GA4 property and a Google Ads account.
+  "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+  "createTime": "A String", # Output only. Time when this link was originally created.
+  "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+  "customerId": "A String", # Immutable. Google Ads customer ID.
+  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+  "updateTime": "A String", # Output only. Time when this link was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a GoogleAdsLink on a property
+
+Args:
+  name: string, Required. Example format: properties/1234/googleAdsLinks/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists GoogleAdsLinks on a property.
+
+Args:
+  parent: string, Required. Example format: properties/1234 (required)
+  pageSize: 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).
+  pageToken: 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.
+  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 ListGoogleAdsLinks RPC.
+  "googleAdsLinks": [ # List of GoogleAdsLinks.
+    { # A link between a GA4 property and a Google Ads account.
+      "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+      "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+      "createTime": "A String", # Output only. Time when this link was originally created.
+      "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+      "customerId": "A String", # Immutable. Google Ads customer ID.
+      "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+      "updateTime": "A String", # Output only. Time when this link was last updated.
+    },
+  ],
+  "nextPageToken": "A 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.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a GoogleAdsLink on a property
+
+Args:
+  name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A link between a GA4 property and a Google Ads account.
+  "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+  "createTime": "A String", # Output only. Time when this link was originally created.
+  "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+  "customerId": "A String", # Immutable. Google Ads customer ID.
+  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+  "updateTime": "A String", # Output only. Time when this link was last updated.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A link between a GA4 property and a Google Ads account.
+  "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
+  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
+  "createTime": "A String", # Output only. Time when this link was originally created.
+  "creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
+  "customerId": "A String", # Immutable. Google Ads customer ID.
+  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
+  "updateTime": "A String", # Output only. Time when this link was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.html b/docs/dyn/analyticsadmin_v1beta.properties.html new file mode 100644 index 00000000000..8e8b1fe9a0b --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.html @@ -0,0 +1,435 @@ + + + +

Google Analytics Admin API . properties

+

Instance Methods

+

+ conversionEvents() +

+

Returns the conversionEvents Resource.

+ +

+ customDimensions() +

+

Returns the customDimensions Resource.

+ +

+ customMetrics() +

+

Returns the customMetrics Resource.

+ +

+ dataStreams() +

+

Returns the dataStreams Resource.

+ +

+ firebaseLinks() +

+

Returns the firebaseLinks Resource.

+ +

+ googleAdsLinks() +

+

Returns the googleAdsLinks Resource.

+ +

+ acknowledgeUserDataCollection(property, body=None, x__xgafv=None)

+

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.

+

+ close()

+

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates an "GA4" property with the specified location and attributes.

+

+ delete(name, x__xgafv=None)

+

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.

+

+ get(name, x__xgafv=None)

+

Lookup for a single "GA4" Property.

+

+ getDataRetentionSettings(name, x__xgafv=None)

+

Returns the singleton data retention settings for this property.

+

+ list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

+

Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a property.

+

+ updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the singleton data retention settings for this property.

+

Method Details

+
+ acknowledgeUserDataCollection(property, body=None, x__xgafv=None) + 
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
+
+Args:
+  property: string, Required. The property for which to acknowledge user data collection. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AcknowledgeUserDataCollection RPC.
+  "acknowledgement": "A 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."
+}
+
+  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 AcknowledgeUserDataCollection RPC.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ create(body=None, x__xgafv=None) + 
Creates an "GA4" property with the specified location and attributes.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+ +
+ get(name, x__xgafv=None) + 
Lookup for a single "GA4" Property.
+
+Args:
+  name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+ +
+ getDataRetentionSettings(name, x__xgafv=None) + 
Returns the singleton data retention settings for this property.
+
+Args:
+  name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings values for data retention. This is a singleton resource.
+  "eventDataRetention": "A String", # The length of time that event-level data is retained.
+  "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+  "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+}
+
+ +
+ list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) + 
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
+
+Args:
+  filter: 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. | ```
+  pageSize: 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)
+  pageToken: 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.
+  showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
+  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 ListProperties RPC.
+  "nextPageToken": "A 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.
+  "properties": [ # Results that matched the filter criteria and were accessible to the caller.
+    { # A resource message representing a Google Analytics GA4 property.
+      "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+      "createTime": "A String", # Output only. Time when the entity was originally created.
+      "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+      "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+      "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+      "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+      "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+      "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+      "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+      "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+      "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+      "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+      "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a property.
+
+Args:
+  name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource message representing a Google Analytics GA4 property.
+  "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
+  "createTime": "A String", # Output only. Time when the entity was originally created.
+  "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
+  "deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
+  "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
+  "expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
+  "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
+  "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
+  "parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
+  "propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+  "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
+  "timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
+  "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
+}
+
+ +
+ updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the singleton data retention settings for this property.
+
+Args:
+  name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Settings values for data retention. This is a singleton resource.
+  "eventDataRetention": "A String", # The length of time that event-level data is retained.
+  "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+  "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+}
+
+  updateMask: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings values for data retention. This is a singleton resource.
+  "eventDataRetention": "A String", # The length of time that event-level data is retained.
+  "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
+  "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index b8ec54b4228..271a39b3c28 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -1179,6 +1179,73 @@ } } }, + "bigQueryLinks": { + "methods": { + "get": { + "description": "Lookup for a single BigQuery Link.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.bigQueryLinks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456", + "location": "path", + "pattern": "^properties/[^/]+/bigQueryLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists BigQuery Links on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks", + "httpMethod": "GET", + "id": "analyticsadmin.properties.bigQueryLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/bigQueryLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, "conversionEvents": { "methods": { "create": { @@ -2350,7 +2417,7 @@ "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous `ListFirebaseLinks` 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.", + "description": "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.", "location": "query", "type": "string" }, @@ -2956,7 +3023,7 @@ } } }, - "revision": "20221116", + "revision": "20221205", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -4070,6 +4137,54 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaBigQueryLink": { + "description": "A link between a GA4 Property and BigQuery project.", + "id": "GoogleAnalyticsAdminV1alphaBigQueryLink", + "properties": { + "createTime": { + "description": "Output only. Time when the link was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dailyExportEnabled": { + "description": "If set true, enables daily data export to the linked Google Cloud project.", + "type": "boolean" + }, + "excludedEvents": { + "description": "The list of event names that will be excluded from exports.", + "items": { + "type": "string" + }, + "type": "array" + }, + "exportStreams": { + "description": "The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']", + "items": { + "type": "string" + }, + "type": "array" + }, + "includeAdvertisingId": { + "description": "If set true, exported data will include advertising identifiers for mobile app streams.", + "type": "boolean" + }, + "name": { + "description": "Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'", + "readOnly": true, + "type": "string" + }, + "project": { + "description": "Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'", + "type": "string" + }, + "streamingExportEnabled": { + "description": "If set true, enables streaming export to the linked Google Cloud project.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest": { "description": "Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.", "id": "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest", @@ -4123,6 +4238,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaAttributionSettings", "description": "A snapshot of AttributionSettings resource in change history." }, + "bigqueryLink": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink", + "description": "A snapshot of a BigQuery link resource in change history." + }, "conversionEvent": { "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent", "description": "A snapshot of a ConversionEvent resource in change history." @@ -5036,6 +5155,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse": { + "description": "Response message for ListBigQueryLinks RPC", + "id": "GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse", + "properties": { + "bigqueryLinks": { + "description": "List of BigQueryLinks.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListConversionEventsResponse": { "description": "Response message for ListConversionEvents RPC.", "id": "GoogleAnalyticsAdminV1alphaListConversionEventsResponse", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json new file mode 100644 index 00000000000..f4c2e136c26 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -0,0 +1,2692 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/analytics.edit": { + "description": "Edit Google Analytics management entities" + }, + "https://www.googleapis.com/auth/analytics.readonly": { + "description": "See and download your Google Analytics data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://analyticsadmin.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Google Analytics Admin", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "analyticsadmin:v1beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://analyticsadmin.mtls.googleapis.com/", + "name": "analyticsadmin", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accountSummaries": { + "methods": { + "list": { + "description": "Returns summaries of all accounts accessible by the caller.", + "flatPath": "v1beta/accountSummaries", + "httpMethod": "GET", + "id": "analyticsadmin.accountSummaries.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/accountSummaries", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListAccountSummariesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, + "accounts": { + "methods": { + "delete": { + "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", + "flatPath": "v1beta/accounts/{accountsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.accounts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single Account.", + "flatPath": "v1beta/accounts/{accountsId}", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "getDataSharingSettings": { + "description": "Get data sharing settings on an account. Data sharing settings are singletons.", + "flatPath": "v1beta/accounts/{accountsId}/dataSharingSettings", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.getDataSharingSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "location": "path", + "pattern": "^accounts/[^/]+/dataSharingSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataSharingSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found.", + "flatPath": "v1beta/accounts", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "showDeleted": { + "description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/accounts", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an account.", + "flatPath": "v1beta/accounts/{accountsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.accounts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaAccount" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "provisionAccountTicket": { + "description": "Requests a ticket for creating an account.", + "flatPath": "v1beta/accounts:provisionAccountTicket", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.provisionAccountTicket", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta/accounts:provisionAccountTicket", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "searchChangeHistoryEvents": { + "description": "Searches through all changes to an account or its children given the specified set of filters.", + "flatPath": "v1beta/accounts/{accountsId}:searchChangeHistoryEvents", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.searchChangeHistoryEvents", + "parameterOrder": [ + "account" + ], + "parameters": { + "account": { + "description": "Required. The account resource for which to return change history resources.", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+account}:searchChangeHistoryEvents", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "properties": { + "methods": { + "acknowledgeUserDataCollection": { + "description": "Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.", + "flatPath": "v1beta/properties/{propertiesId}:acknowledgeUserDataCollection", + "httpMethod": "POST", + "id": "analyticsadmin.properties.acknowledgeUserDataCollection", + "parameterOrder": [ + "property" + ], + "parameters": { + "property": { + "description": "Required. The property for which to acknowledge user data collection.", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+property}:acknowledgeUserDataCollection", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "create": { + "description": "Creates an \"GA4\" property with the specified location and attributes.", + "flatPath": "v1beta/properties", + "httpMethod": "POST", + "id": "analyticsadmin.properties.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta/properties", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "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.", + "flatPath": "v1beta/properties/{propertiesId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" Property.", + "flatPath": "v1beta/properties/{propertiesId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "getDataRetentionSettings": { + "description": "Returns the singleton data retention settings for this property.", + "flatPath": "v1beta/properties/{propertiesId}/dataRetentionSettings", + "httpMethod": "GET", + "id": "analyticsadmin.properties.getDataRetentionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"", + "location": "path", + "pattern": "^properties/[^/]+/dataRetentionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child Properties under the specified parent Account. Only \"GA4\" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.", + "flatPath": "v1beta/properties", + "httpMethod": "GET", + "id": "analyticsadmin.properties.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "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. | ```", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "showDeleted": { + "description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/properties", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListPropertiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a property.", + "flatPath": "v1beta/properties/{propertiesId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "updateDataRetentionSettings": { + "description": "Updates the singleton data retention settings for this property.", + "flatPath": "v1beta/properties/{propertiesId}/dataRetentionSettings", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.updateDataRetentionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", + "location": "path", + "pattern": "^properties/[^/]+/dataRetentionSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + }, + "resources": { + "conversionEvents": { + "methods": { + "create": { + "description": "Creates a conversion event with the specified attributes.", + "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", + "httpMethod": "POST", + "id": "analyticsadmin.properties.conversionEvents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the parent property where this conversion event will be created. Format: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/conversionEvents", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a conversion event in a property.", + "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.conversionEvents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"", + "location": "path", + "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Retrieve a single conversion event.", + "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.conversionEvents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"", + "location": "path", + "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", + "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", + "httpMethod": "GET", + "id": "analyticsadmin.properties.conversionEvents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent property. Example: 'properties/123'", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/conversionEvents", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListConversionEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, + "customDimensions": { + "methods": { + "archive": { + "description": "Archives a CustomDimension on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive", + "httpMethod": "POST", + "id": "analyticsadmin.properties.customDimensions.archive", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678", + "location": "path", + "pattern": "^properties/[^/]+/customDimensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:archive", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "create": { + "description": "Creates a CustomDimension.", + "flatPath": "v1beta/properties/{propertiesId}/customDimensions", + "httpMethod": "POST", + "id": "analyticsadmin.properties.customDimensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/customDimensions", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single CustomDimension.", + "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.customDimensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678", + "location": "path", + "pattern": "^properties/[^/]+/customDimensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists CustomDimensions on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customDimensions", + "httpMethod": "GET", + "id": "analyticsadmin.properties.customDimensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/customDimensions", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a CustomDimension on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.customDimensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", + "location": "path", + "pattern": "^properties/[^/]+/customDimensions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "customMetrics": { + "methods": { + "archive": { + "description": "Archives a CustomMetric on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive", + "httpMethod": "POST", + "id": "analyticsadmin.properties.customMetrics.archive", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678", + "location": "path", + "pattern": "^properties/[^/]+/customMetrics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:archive", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "create": { + "description": "Creates a CustomMetric.", + "flatPath": "v1beta/properties/{propertiesId}/customMetrics", + "httpMethod": "POST", + "id": "analyticsadmin.properties.customMetrics.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/customMetrics", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single CustomMetric.", + "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.customMetrics.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678", + "location": "path", + "pattern": "^properties/[^/]+/customMetrics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists CustomMetrics on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customMetrics", + "httpMethod": "GET", + "id": "analyticsadmin.properties.customMetrics.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/customMetrics", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListCustomMetricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a CustomMetric on a property.", + "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.customMetrics.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", + "location": "path", + "pattern": "^properties/[^/]+/customMetrics/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "dataStreams": { + "methods": { + "create": { + "description": "Creates a DataStream.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams", + "httpMethod": "POST", + "id": "analyticsadmin.properties.dataStreams.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/dataStreams", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a DataStream on a property.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.dataStreams.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single DataStream.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists DataStreams on a property.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/dataStreams", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListDataStreamsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a DataStream on a property.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.dataStreams.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + }, + "resources": { + "measurementProtocolSecrets": { + "methods": { + "create": { + "description": "Creates a measurement protocol secret.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets", + "httpMethod": "POST", + "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/measurementProtocolSecrets", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes target MeasurementProtocolSecret.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/measurementProtocolSecrets", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a measurement protocol secret.", + "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. Omitted fields will not be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } + } + }, + "firebaseLinks": { + "methods": { + "create": { + "description": "Creates a FirebaseLink. Properties can have at most one FirebaseLink.", + "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks", + "httpMethod": "POST", + "id": "analyticsadmin.properties.firebaseLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Format: properties/{property_id} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/firebaseLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a FirebaseLink on a property", + "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.firebaseLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "list": { + "description": "Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.", + "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks", + "httpMethod": "GET", + "id": "analyticsadmin.properties.firebaseLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: properties/{property_id} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/firebaseLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, + "googleAdsLinks": { + "methods": { + "create": { + "description": "Creates a GoogleAdsLink.", + "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks", + "httpMethod": "POST", + "id": "analyticsadmin.properties.googleAdsLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/googleAdsLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a GoogleAdsLink on a property", + "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.googleAdsLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: properties/1234/googleAdsLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "list": { + "description": "Lists GoogleAdsLinks on a property.", + "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks", + "httpMethod": "GET", + "id": "analyticsadmin.properties.googleAdsLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/googleAdsLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a GoogleAdsLink on a property", + "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.googleAdsLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", + "location": "path", + "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } + } + } + }, + "revision": "20221205", + "rootUrl": "https://analyticsadmin.googleapis.com/", + "schemas": { + "GoogleAnalyticsAdminV1betaAccount": { + "description": "A resource message representing a Google Analytics account.", + "id": "GoogleAnalyticsAdminV1betaAccount", + "properties": { + "createTime": { + "description": "Output only. Time when this account was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleted": { + "description": "Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.", + "readOnly": true, + "type": "boolean" + }, + "displayName": { + "description": "Required. Human-readable display name for this account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Country of business. Must be a Unicode CLDR region code.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when account payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaAccountSummary": { + "description": "A virtual resource representing an overview of an account and all its child GA4 properties.", + "id": "GoogleAnalyticsAdminV1betaAccountSummary", + "properties": { + "account": { + "description": "Resource name of account referred to by this account summary Format: accounts/{account_id} Example: \"accounts/1000\"", + "type": "string" + }, + "displayName": { + "description": "Display name for the account referred to in this account summary.", + "type": "string" + }, + "name": { + "description": "Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", + "type": "string" + }, + "propertySummaries": { + "description": "List of summaries for child accounts of this account.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaPropertySummary" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest": { + "description": "Request message for AcknowledgeUserDataCollection RPC.", + "id": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest", + "properties": { + "acknowledgement": { + "description": "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.\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse": { + "description": "Response message for AcknowledgeUserDataCollection RPC.", + "id": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse", + "properties": {}, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest": { + "description": "Request message for ArchiveCustomDimension RPC.", + "id": "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest", + "properties": {}, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest": { + "description": "Request message for ArchiveCustomMetric RPC.", + "id": "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest", + "properties": {}, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaChangeHistoryChange": { + "description": "A description of a change to a single Google Analytics resource.", + "id": "GoogleAnalyticsAdminV1betaChangeHistoryChange", + "properties": { + "action": { + "description": "The type of action that changed this resource.", + "enum": [ + "ACTION_TYPE_UNSPECIFIED", + "CREATED", + "UPDATED", + "DELETED" + ], + "enumDescriptions": [ + "Action type unknown or not specified.", + "Resource was created in this change.", + "Resource was updated in this change.", + "Resource was deleted in this change." + ], + "type": "string" + }, + "resource": { + "description": "Resource name of the resource whose changes are described by this entry.", + "type": "string" + }, + "resourceAfterChange": { + "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", + "description": "Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing." + }, + "resourceBeforeChange": { + "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", + "description": "Resource contents from before the change was made. If this resource was created in this change, this field will be missing." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource": { + "description": "A snapshot of a resource as before or after the result of a change in change history.", + "id": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", + "properties": { + "account": { + "$ref": "GoogleAnalyticsAdminV1betaAccount", + "description": "A snapshot of an Account resource in change history." + }, + "conversionEvent": { + "$ref": "GoogleAnalyticsAdminV1betaConversionEvent", + "description": "A snapshot of a ConversionEvent resource in change history." + }, + "dataRetentionSettings": { + "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings", + "description": "A snapshot of a data retention settings resource in change history." + }, + "dataStream": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream", + "description": "A snapshot of a DataStream resource in change history." + }, + "firebaseLink": { + "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink", + "description": "A snapshot of a FirebaseLink resource in change history." + }, + "googleAdsLink": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink", + "description": "A snapshot of a GoogleAdsLink resource in change history." + }, + "measurementProtocolSecret": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret", + "description": "A snapshot of a MeasurementProtocolSecret resource in change history." + }, + "property": { + "$ref": "GoogleAnalyticsAdminV1betaProperty", + "description": "A snapshot of a Property resource in change history." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaChangeHistoryEvent": { + "description": "A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.", + "id": "GoogleAnalyticsAdminV1betaChangeHistoryEvent", + "properties": { + "actorType": { + "description": "The type of actor that made this change.", + "enum": [ + "ACTOR_TYPE_UNSPECIFIED", + "USER", + "SYSTEM", + "SUPPORT" + ], + "enumDescriptions": [ + "Unknown or unspecified actor type.", + "Changes made by the user specified in actor_email.", + "Changes made by the Google Analytics system.", + "Changes made by Google Analytics support team staff." + ], + "type": "string" + }, + "changeTime": { + "description": "Time when change was made.", + "format": "google-datetime", + "type": "string" + }, + "changes": { + "description": "A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChange" + }, + "type": "array" + }, + "changesFiltered": { + "description": "If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.", + "type": "boolean" + }, + "id": { + "description": "ID of this change history event. This ID is unique across Google Analytics.", + "type": "string" + }, + "userActorEmail": { + "description": "Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaConversionEvent": { + "description": "A conversion event in a Google Analytics property.", + "id": "GoogleAnalyticsAdminV1betaConversionEvent", + "properties": { + "createTime": { + "description": "Output only. Time when this conversion event was created in the property.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "custom": { + "description": "Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.", + "readOnly": true, + "type": "boolean" + }, + "deletable": { + "description": "Output only. If set, this event can currently be deleted via DeleteConversionEvent.", + "readOnly": true, + "type": "boolean" + }, + "eventName": { + "description": "Immutable. The event name for this conversion event. Examples: 'click', 'purchase'", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaCustomDimension": { + "description": "A definition for a CustomDimension.", + "id": "GoogleAnalyticsAdminV1betaCustomDimension", + "properties": { + "description": { + "description": "Optional. Description for this custom dimension. Max length of 150 characters.", + "type": "string" + }, + "disallowAdsPersonalization": { + "description": "Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.", + "type": "boolean" + }, + "displayName": { + "description": "Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", + "readOnly": true, + "type": "string" + }, + "parameterName": { + "description": "Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.", + "type": "string" + }, + "scope": { + "description": "Required. Immutable. The scope of this dimension.", + "enum": [ + "DIMENSION_SCOPE_UNSPECIFIED", + "EVENT", + "USER" + ], + "enumDescriptions": [ + "Scope unknown or not specified.", + "Dimension scoped to an event.", + "Dimension scoped to a user." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaCustomMetric": { + "description": "A definition for a custom metric.", + "id": "GoogleAnalyticsAdminV1betaCustomMetric", + "properties": { + "description": { + "description": "Optional. Description for this custom dimension. Max length of 150 characters.", + "type": "string" + }, + "displayName": { + "description": "Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.", + "type": "string" + }, + "measurementUnit": { + "description": "Required. The type for the custom metric's value.", + "enum": [ + "MEASUREMENT_UNIT_UNSPECIFIED", + "STANDARD", + "CURRENCY", + "FEET", + "METERS", + "KILOMETERS", + "MILES", + "MILLISECONDS", + "SECONDS", + "MINUTES", + "HOURS" + ], + "enumDescriptions": [ + "MeasurementUnit unspecified or missing.", + "This metric uses default units.", + "This metric measures a currency.", + "This metric measures feet.", + "This metric measures meters.", + "This metric measures kilometers.", + "This metric measures miles.", + "This metric measures milliseconds.", + "This metric measures seconds.", + "This metric measures minutes.", + "This metric measures hours." + ], + "type": "string" + }, + "name": { + "description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", + "readOnly": true, + "type": "string" + }, + "parameterName": { + "description": "Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.", + "type": "string" + }, + "restrictedMetricType": { + "description": "Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.", + "items": { + "enum": [ + "RESTRICTED_METRIC_TYPE_UNSPECIFIED", + "COST_DATA", + "REVENUE_DATA" + ], + "enumDescriptions": [ + "Type unknown or unspecified.", + "Metric reports cost data.", + "Metric reports revenue data." + ], + "type": "string" + }, + "type": "array" + }, + "scope": { + "description": "Required. Immutable. The scope of this custom metric.", + "enum": [ + "METRIC_SCOPE_UNSPECIFIED", + "EVENT" + ], + "enumDescriptions": [ + "Scope unknown or not specified.", + "Metric scoped to an event." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataRetentionSettings": { + "description": "Settings values for data retention. This is a singleton resource.", + "id": "GoogleAnalyticsAdminV1betaDataRetentionSettings", + "properties": { + "eventDataRetention": { + "description": "The length of time that event-level data is retained.", + "enum": [ + "RETENTION_DURATION_UNSPECIFIED", + "TWO_MONTHS", + "FOURTEEN_MONTHS", + "TWENTY_SIX_MONTHS", + "THIRTY_EIGHT_MONTHS", + "FIFTY_MONTHS" + ], + "enumDescriptions": [ + "Data retention time duration is not specified.", + "The data retention time duration is 2 months.", + "The data retention time duration is 14 months.", + "The data retention time duration is 26 months. Available to 360 properties only.", + "The data retention time duration is 38 months. Available to 360 properties only.", + "The data retention time duration is 50 months. Available to 360 properties only." + ], + "type": "string" + }, + "name": { + "description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", + "readOnly": true, + "type": "string" + }, + "resetUserDataOnNewActivity": { + "description": "If true, reset the retention period for the user identifier with every event from that user.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataSharingSettings": { + "description": "A resource message representing data sharing settings of a Google Analytics account.", + "id": "GoogleAnalyticsAdminV1betaDataSharingSettings", + "properties": { + "name": { + "description": "Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "readOnly": true, + "type": "string" + }, + "sharingWithGoogleAnySalesEnabled": { + "description": "Allows any of Google sales to access the data in order to suggest configuration changes to improve results.", + "type": "boolean" + }, + "sharingWithGoogleAssignedSalesEnabled": { + "description": "Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.", + "type": "boolean" + }, + "sharingWithGoogleProductsEnabled": { + "description": "Allows Google to use the data to improve other Google products or services.", + "type": "boolean" + }, + "sharingWithGoogleSupportEnabled": { + "description": "Allows Google support to access the data in order to help troubleshoot issues.", + "type": "boolean" + }, + "sharingWithOthersEnabled": { + "description": "Allows Google to share the data anonymously in aggregate form with others.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataStream": { + "description": "A resource message representing a data stream.", + "id": "GoogleAnalyticsAdminV1betaDataStream", + "properties": { + "androidAppStreamData": { + "$ref": "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData", + "description": "Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM." + }, + "createTime": { + "description": "Output only. Time when this stream was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.", + "type": "string" + }, + "iosAppStreamData": { + "$ref": "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData", + "description": "Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM." + }, + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Required. Immutable. The type of this DataStream resource.", + "enum": [ + "DATA_STREAM_TYPE_UNSPECIFIED", + "WEB_DATA_STREAM", + "ANDROID_APP_DATA_STREAM", + "IOS_APP_DATA_STREAM" + ], + "enumDescriptions": [ + "Type unknown or not specified.", + "Web data stream.", + "Android app data stream.", + "iOS app data stream." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when stream payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "webStreamData": { + "$ref": "GoogleAnalyticsAdminV1betaDataStreamWebStreamData", + "description": "Data specific to web streams. Must be populated if type is WEB_DATA_STREAM." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData": { + "description": "Data specific to Android app streams.", + "id": "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData", + "properties": { + "firebaseAppId": { + "description": "Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.", + "readOnly": true, + "type": "string" + }, + "packageName": { + "description": "Immutable. The package name for the app being measured. Example: \"com.example.myandroidapp\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData": { + "description": "Data specific to iOS app streams.", + "id": "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData", + "properties": { + "bundleId": { + "description": "Required. Immutable. The Apple App Store Bundle ID for the app Example: \"com.example.myiosapp\"", + "type": "string" + }, + "firebaseAppId": { + "description": "Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaDataStreamWebStreamData": { + "description": "Data specific to web streams.", + "id": "GoogleAnalyticsAdminV1betaDataStreamWebStreamData", + "properties": { + "defaultUri": { + "description": "Immutable. Domain name of the web app being measured, or empty. Example: \"http://www.google.com\", \"https://www.google.com\"", + "type": "string" + }, + "firebaseAppId": { + "description": "Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.", + "readOnly": true, + "type": "string" + }, + "measurementId": { + "description": "Output only. Analytics \"Measurement ID\", without the \"G-\" prefix. Example: \"G-1A2BCD345E\" would just be \"1A2BCD345E\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaFirebaseLink": { + "description": "A link between a GA4 property and a Firebase project.", + "id": "GoogleAnalyticsAdminV1betaFirebaseLink", + "properties": { + "createTime": { + "description": "Output only. Time when this FirebaseLink was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Example format: properties/1234/firebaseLinks/5678", + "readOnly": true, + "type": "string" + }, + "project": { + "description": "Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaGoogleAdsLink": { + "description": "A link between a GA4 property and a Google Ads account.", + "id": "GoogleAnalyticsAdminV1betaGoogleAdsLink", + "properties": { + "adsPersonalizationEnabled": { + "description": "Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.", + "type": "boolean" + }, + "canManageClients": { + "description": "Output only. If true, this link is for a Google Ads manager account.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. Time when this link was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creatorEmailAddress": { + "description": "Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.", + "readOnly": true, + "type": "string" + }, + "customerId": { + "description": "Immutable. Google Ads customer ID.", + "type": "string" + }, + "name": { + "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when this link was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListAccountSummariesResponse": { + "description": "Response message for ListAccountSummaries RPC.", + "id": "GoogleAnalyticsAdminV1betaListAccountSummariesResponse", + "properties": { + "accountSummaries": { + "description": "Account summaries of all accounts the caller has access to.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaAccountSummary" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListAccountsResponse": { + "description": "Request message for ListAccounts RPC.", + "id": "GoogleAnalyticsAdminV1betaListAccountsResponse", + "properties": { + "accounts": { + "description": "Results that were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaAccount" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListConversionEventsResponse": { + "description": "Response message for ListConversionEvents RPC.", + "id": "GoogleAnalyticsAdminV1betaListConversionEventsResponse", + "properties": { + "conversionEvents": { + "description": "The requested conversion events", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse": { + "description": "Response message for ListCustomDimensions RPC.", + "id": "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse", + "properties": { + "customDimensions": { + "description": "List of CustomDimensions.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListCustomMetricsResponse": { + "description": "Response message for ListCustomMetrics RPC.", + "id": "GoogleAnalyticsAdminV1betaListCustomMetricsResponse", + "properties": { + "customMetrics": { + "description": "List of CustomMetrics.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListDataStreamsResponse": { + "description": "Response message for ListDataStreams RPC.", + "id": "GoogleAnalyticsAdminV1betaListDataStreamsResponse", + "properties": { + "dataStreams": { + "description": "List of DataStreams.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaDataStream" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse": { + "description": "Response message for ListFirebaseLinks RPC", + "id": "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse", + "properties": { + "firebaseLinks": { + "description": "List of FirebaseLinks. This will have at most one value.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" + }, + "type": "array" + }, + "nextPageToken": { + "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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse": { + "description": "Response message for ListGoogleAdsLinks RPC.", + "id": "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse", + "properties": { + "googleAdsLinks": { + "description": "List of GoogleAdsLinks.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse": { + "description": "Response message for ListMeasurementProtocolSecret RPC", + "id": "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse", + "properties": { + "measurementProtocolSecrets": { + "description": "A list of secrets for the parent stream specified in the request.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaListPropertiesResponse": { + "description": "Response message for ListProperties RPC.", + "id": "GoogleAnalyticsAdminV1betaListPropertiesResponse", + "properties": { + "nextPageToken": { + "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.", + "type": "string" + }, + "properties": { + "description": "Results that matched the filter criteria and were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret": { + "description": "A secret value used for sending hits to Measurement Protocol.", + "id": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret", + "properties": { + "displayName": { + "description": "Required. Human-readable display name for this secret.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", + "readOnly": true, + "type": "string" + }, + "secretValue": { + "description": "Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaProperty": { + "description": "A resource message representing a Google Analytics GA4 property.", + "id": "GoogleAnalyticsAdminV1betaProperty", + "properties": { + "account": { + "description": "Immutable. The resource name of the parent account Format: accounts/{account_id} Example: \"accounts/123\"", + "type": "string" + }, + "createTime": { + "description": "Output only. Time when the entity was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "currencyCode": { + "description": "The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: \"USD\", \"EUR\", \"JPY\"", + "type": "string" + }, + "deleteTime": { + "description": "Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.", + "type": "string" + }, + "expireTime": { + "description": "Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "industryCategory": { + "description": "Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK", + "enum": [ + "INDUSTRY_CATEGORY_UNSPECIFIED", + "AUTOMOTIVE", + "BUSINESS_AND_INDUSTRIAL_MARKETS", + "FINANCE", + "HEALTHCARE", + "TECHNOLOGY", + "TRAVEL", + "OTHER", + "ARTS_AND_ENTERTAINMENT", + "BEAUTY_AND_FITNESS", + "BOOKS_AND_LITERATURE", + "FOOD_AND_DRINK", + "GAMES", + "HOBBIES_AND_LEISURE", + "HOME_AND_GARDEN", + "INTERNET_AND_TELECOM", + "LAW_AND_GOVERNMENT", + "NEWS", + "ONLINE_COMMUNITIES", + "PEOPLE_AND_SOCIETY", + "PETS_AND_ANIMALS", + "REAL_ESTATE", + "REFERENCE", + "SCIENCE", + "SPORTS", + "JOBS_AND_EDUCATION", + "SHOPPING" + ], + "enumDescriptions": [ + "Industry category unspecified", + "Automotive", + "Business and industrial markets", + "Finance", + "Healthcare", + "Technology", + "Travel", + "Other", + "Arts and entertainment", + "Beauty and fitness", + "Books and literature", + "Food and drink", + "Games", + "Hobbies and leisure", + "Home and garden", + "Internet and telecom", + "Law and government", + "News", + "Online communities", + "People and society", + "Pets and animals", + "Real estate", + "Reference", + "Science", + "Sports", + "Jobs and education", + "Shopping" + ], + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", + "readOnly": true, + "type": "string" + }, + "parent": { + "description": "Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\", \"properties/101\"", + "type": "string" + }, + "propertyType": { + "description": "Immutable. The property type for this Property resource. When creating a property, if the type is \"PROPERTY_TYPE_UNSPECIFIED\", then \"ORDINARY_PROPERTY\" will be implied. \"SUBPROPERTY\" and \"ROLLUP_PROPERTY\" types cannot yet be created via Google Analytics Admin API.", + "enum": [ + "PROPERTY_TYPE_UNSPECIFIED", + "PROPERTY_TYPE_ORDINARY", + "PROPERTY_TYPE_SUBPROPERTY", + "PROPERTY_TYPE_ROLLUP" + ], + "enumDescriptions": [ + "Unknown or unspecified property type", + "Ordinary GA4 property", + "GA4 subproperty", + "GA4 rollup property" + ], + "type": "string" + }, + "serviceLevel": { + "description": "Output only. The Google Analytics service level that applies to this property.", + "enum": [ + "SERVICE_LEVEL_UNSPECIFIED", + "GOOGLE_ANALYTICS_STANDARD", + "GOOGLE_ANALYTICS_360" + ], + "enumDescriptions": [ + "Service level not specified or invalid.", + "The standard version of Google Analytics.", + "The paid, premium version of Google Analytics." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: \"America/Los_Angeles\"", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when entity payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaPropertySummary": { + "description": "A virtual resource representing metadata for a GA4 property.", + "id": "GoogleAnalyticsAdminV1betaPropertySummary", + "properties": { + "displayName": { + "description": "Display name for the property referred to in this property summary.", + "type": "string" + }, + "parent": { + "description": "Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\", \"properties/200\"", + "type": "string" + }, + "property": { + "description": "Resource name of property referred to by this property summary Format: properties/{property_id} Example: \"properties/1000\"", + "type": "string" + }, + "propertyType": { + "description": "The property's property type.", + "enum": [ + "PROPERTY_TYPE_UNSPECIFIED", + "PROPERTY_TYPE_ORDINARY", + "PROPERTY_TYPE_SUBPROPERTY", + "PROPERTY_TYPE_ROLLUP" + ], + "enumDescriptions": [ + "Unknown or unspecified property type", + "Ordinary GA4 property", + "GA4 subproperty", + "GA4 rollup property" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest": { + "description": "Request message for ProvisionAccountTicket RPC.", + "id": "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest", + "properties": { + "account": { + "$ref": "GoogleAnalyticsAdminV1betaAccount", + "description": "The account to create." + }, + "redirectUri": { + "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse": { + "description": "Response message for ProvisionAccountTicket RPC.", + "id": "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse", + "properties": { + "accountTicketId": { + "description": "The param to be passed in the ToS link.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest": { + "description": "Request message for SearchChangeHistoryEvents RPC.", + "id": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest", + "properties": { + "action": { + "description": "Optional. If set, only return changes that match one or more of these types of actions.", + "items": { + "enum": [ + "ACTION_TYPE_UNSPECIFIED", + "CREATED", + "UPDATED", + "DELETED" + ], + "enumDescriptions": [ + "Action type unknown or not specified.", + "Resource was created in this change.", + "Resource was updated in this change.", + "Resource was deleted in this change." + ], + "type": "string" + }, + "type": "array" + }, + "actorEmail": { + "description": "Optional. If set, only return changes if they are made by a user in this list.", + "items": { + "type": "string" + }, + "type": "array" + }, + "earliestChangeTime": { + "description": "Optional. If set, only return changes made after this time (inclusive).", + "format": "google-datetime", + "type": "string" + }, + "latestChangeTime": { + "description": "Optional. If set, only return changes made before this time (inclusive).", + "format": "google-datetime", + "type": "string" + }, + "pageSize": { + "description": "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).", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "type": "string" + }, + "property": { + "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.", + "type": "string" + }, + "resourceType": { + "description": "Optional. If set, only return changes if they are for a resource that matches at least one of these types.", + "items": { + "enum": [ + "CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED", + "ACCOUNT", + "PROPERTY", + "FIREBASE_LINK", + "GOOGLE_ADS_LINK", + "GOOGLE_SIGNALS_SETTINGS", + "CONVERSION_EVENT", + "MEASUREMENT_PROTOCOL_SECRET", + "DATA_RETENTION_SETTINGS", + "DISPLAY_VIDEO_360_ADVERTISER_LINK", + "DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL", + "SEARCH_ADS_360_LINK", + "DATA_STREAM", + "ATTRIBUTION_SETTINGS", + "EXPANDED_DATA_SET", + "CHANNEL_GROUP" + ], + "enumDescriptions": [ + "Resource type unknown or not specified.", + "Account resource", + "Property resource", + "FirebaseLink resource", + "GoogleAdsLink resource", + "GoogleSignalsSettings resource", + "ConversionEvent resource", + "MeasurementProtocolSecret resource", + "DataRetentionSettings resource", + "DisplayVideo360AdvertiserLink resource", + "DisplayVideo360AdvertiserLinkProposal resource", + "SearchAds360Link resource", + "DataStream resource", + "AttributionSettings resource", + "ExpandedDataSet resource", + "ChannelGroup resource" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse": { + "description": "Response message for SearchAccounts RPC.", + "id": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse", + "properties": { + "changeHistoryEvents": { + "description": "Results that were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryEvent" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); }", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Analytics Admin API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file