package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> customMetricId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.CustomMetric.t * GapiConversation.Session.t

Get a custom metric to which the user has access.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter etag

    Optional ETag.

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID for the custom metric to retrieve.

  • parameter webPropertyId

    Web property ID for the custom metric to retrieve.

  • parameter customMetricId

    The ID of the custom metric to retrieve.

val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> GapiAnalyticsV3Model.CustomMetric.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.CustomMetric.t * GapiConversation.Session.t

Create a new custom metric.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID for the custom metric to create.

  • parameter webPropertyId

    Web property ID for the custom dimension to create.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?max_results:int -> ?start_index:int -> accountId:string -> webPropertyId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.CustomMetrics.t * GapiConversation.Session.t

Lists custom metrics to which the user has access.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter max_results

    The maximum number of custom metrics to include in this response.

  • parameter start_index

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • parameter accountId

    Account ID for the custom metrics to retrieve.

  • parameter webPropertyId

    Web property ID for the custom metrics to retrieve.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?ignoreCustomDataSourceLinks:bool -> accountId:string -> webPropertyId:string -> customMetricId:string -> GapiAnalyticsV3Model.CustomMetric.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.CustomMetric.t * GapiConversation.Session.t

Updates an existing custom metric. This method supports patch semantics.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter ignoreCustomDataSourceLinks

    Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

  • parameter accountId

    Account ID for the custom metric to update.

  • parameter webPropertyId

    Web property ID for the custom metric to update.

  • parameter customMetricId

    Custom metric ID for the custom metric to update.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?ignoreCustomDataSourceLinks:bool -> accountId:string -> webPropertyId:string -> customMetricId:string -> GapiAnalyticsV3Model.CustomMetric.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.CustomMetric.t * GapiConversation.Session.t

Updates an existing custom metric.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter ignoreCustomDataSourceLinks

    Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

  • parameter accountId

    Account ID for the custom metric to update.

  • parameter webPropertyId

    Web property ID for the custom metric to update.

  • parameter customMetricId

    Custom metric ID for the custom metric to update.