package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes a view (profile).

  • 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 to delete the view (profile) for.

  • parameter webPropertyId

    Web property ID to delete the view (profile) for.

  • parameter profileId

    ID of the view (profile) to be deleted.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Profile.t * GapiConversation.Session.t

Gets a view (profile) 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 to retrieve the view (profile) for.

  • parameter webPropertyId

    Web property ID to retrieve the view (profile) for.

  • parameter profileId

    View (Profile) ID to retrieve the view (profile) for.

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

Create a new view (profile).

  • 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 to create the view (profile) for.

  • parameter webPropertyId

    Web property ID to create the view (profile) for.

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

Lists views (profiles) 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 views (profiles) 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 view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.

  • parameter webPropertyId

    Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> GapiAnalyticsV3Model.Profile.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Profile.t * GapiConversation.Session.t

Updates an existing view (profile). 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 accountId

    Account ID to which the view (profile) belongs

  • parameter webPropertyId

    Web property ID to which the view (profile) belongs

  • parameter profileId

    ID of the view (profile) to be updated.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> GapiAnalyticsV3Model.Profile.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Profile.t * GapiConversation.Session.t

Updates an existing view (profile).

  • 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 to which the view (profile) belongs

  • parameter webPropertyId

    Web property ID to which the view (profile) belongs

  • parameter profileId

    ID of the view (profile) to be updated.