Noizu.Google.Api.AnalyticsAdmin.DataStreams (Noizu Google v0.2.3)

Copy Markdown View Source

Google Analytics Admin API — Data Streams (GA4).

REST: properties/{property}/dataStreams

Docs: https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties.dataStreams

Summary

Functions

POST properties/{property}/dataStreams — create a data stream.

GET properties/{property}/dataStreams/{dataStream} — get a stream.

GET properties/{property}/dataStreams — list streams for a property.

PATCH a data stream. Optional :update_mask.

Types

opts()

@type opts() :: keyword() | map()

result()

@type result() :: {:ok, term()} | {:error, Noizu.Google.Error.t()}

Functions

create(property, body, opts \\ [])

@spec create(String.t(), map(), opts()) :: result()

POST properties/{property}/dataStreams — create a data stream.

Body example (web stream):

%{
  type: "WEB_DATA_STREAM",
  displayName: "example.com",
  webStreamData: %{
    defaultUri: "https://example.com"
  }
}

delete(property, stream_id, opts \\ [])

@spec delete(String.t(), String.t(), opts()) :: result()

DELETE a data stream.

get(property, stream_id, opts \\ [])

@spec get(String.t(), String.t(), opts()) :: result()

GET properties/{property}/dataStreams/{dataStream} — get a stream.

Prefer get(property, stream_id, opts). Full resource names are accepted as property when they already contain /dataStreams/.

list(property, opts \\ [])

@spec list(String.t(), opts()) :: result()

GET properties/{property}/dataStreams — list streams for a property.

patch(property, stream_id, body, opts \\ [])

@spec patch(String.t(), String.t(), map(), opts()) :: result()

PATCH a data stream. Optional :update_mask.