package gapi-ocaml

  1. Overview
  2. Docs
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 -> profileId:string -> goalId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Goal.t * GapiConversation.Session.t

Gets a goal 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 goal for.

  • parameter webPropertyId

    Web property ID to retrieve the goal for.

  • parameter profileId

    View (Profile) ID to retrieve the goal for.

  • parameter goalId

    Goal ID to retrieve the goal for.

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

Create a new goal.

  • 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 goal for.

  • parameter webPropertyId

    Web property ID to create the goal for.

  • parameter profileId

    View (Profile) ID to create the goal for.

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

Lists goals 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 goals to include in this response.

  • parameter start_index

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

  • parameter accountId

    Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.

  • parameter webPropertyId

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

  • parameter profileId

    View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.

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

Updates an existing goal. 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 update the goal.

  • parameter webPropertyId

    Web property ID to update the goal.

  • parameter profileId

    View (Profile) ID to update the goal.

  • parameter goalId

    Index of the goal to be updated.

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

Updates an existing goal.

  • 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 update the goal.

  • parameter webPropertyId

    Web property ID to update the goal.

  • parameter profileId

    View (Profile) ID to update the goal.

  • parameter goalId

    Index of the goal to be updated.