GoogleApi.DisplayVideo.V3.Api.FloodlightGroups (google_api_display_video v0.39.0)

API calls for all endpoints tagged FloodlightGroups.

Summary

Functions

displayvideo_floodlight_groups_floodlight_activities_get(connection, floodlight_group_id, floodlight_activity_id, optional_params \\ [], opts \\ [])

Gets a Floodlight activity.

displayvideo_floodlight_groups_floodlight_activities_list(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

Lists Floodlight activities in a Floodlight group.

displayvideo_floodlight_groups_get(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

Gets a Floodlight group.

displayvideo_floodlight_groups_patch(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

Functions

displayvideo_floodlight_groups_floodlight_activities_get(connection, floodlight_group_id, floodlight_activity_id, optional_params \\ [], opts \\ [])

@spec displayvideo_floodlight_groups_floodlight_activities_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.FloodlightActivity.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Floodlight activity.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
floodlight_group_id (type: String.t) - Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
floodlight_activity_id (type: String.t) - Required. The ID of the Floodlight activity to fetch.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :partnerId (type: String.t) - Required. The ID of the partner through which the Floodlight activity is being accessed.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.FloodlightActivity{}} on success
{:error, info} on failure

displayvideo_floodlight_groups_floodlight_activities_list(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

@spec displayvideo_floodlight_groups_floodlight_activities_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.ListFloodlightActivitiesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Floodlight activities in a Floodlight group.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
floodlight_group_id (type: String.t) - Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :orderBy (type: String.t) - Optional. Field by which to sort the list. Acceptable values are: displayName (default) floodlightActivityId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.
- :pageSize (type: integer()) - Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
- :pageToken (type: String.t) - Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFloodlightActivities method. If not specified, the first page of results will be returned.
- :partnerId (type: String.t) - Required. The ID of the partner through which the Floodlight activities are being accessed.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.ListFloodlightActivitiesResponse{}} on success
{:error, info} on failure

displayvideo_floodlight_groups_get(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

@spec displayvideo_floodlight_groups_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.FloodlightGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Floodlight group.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
floodlight_group_id (type: String.t) - Required. The ID of the Floodlight group to fetch.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :partnerId (type: String.t) - Required. The partner context by which the Floodlight group is being accessed.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.FloodlightGroup{}} on success
{:error, info} on failure

displayvideo_floodlight_groups_patch(connection, floodlight_group_id, optional_params \\ [], opts \\ [])

@spec displayvideo_floodlight_groups_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V3.Model.FloodlightGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

Parameters

connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
floodlight_group_id (type: String.t) - Output only. The unique ID of the Floodlight group. Assigned by the system.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :partnerId (type: String.t) - Required. The partner context by which the Floodlight group is being accessed.
- :updateMask (type: String.t) - Required. The mask to control which fields to update.
- :body (type: GoogleApi.DisplayVideo.V3.Model.FloodlightGroup.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DisplayVideo.V3.Model.FloodlightGroup{}} on success
{:error, info} on failure