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

View Source

API calls for all endpoints tagged Partners.

Summary

Functions

displayvideo_partners_channels_create(connection, partner_id, optional_params \\ [], opts \\ [])

Creates a new channel. Returns the newly created channel if successful.

displayvideo_partners_channels_get(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Gets a channel for a partner or advertiser.

displayvideo_partners_channels_list(connection, partner_id, optional_params \\ [], opts \\ [])

Lists channels for a partner or advertiser.

displayvideo_partners_channels_patch(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Updates a channel. Returns the updated channel if successful.

displayvideo_partners_channels_sites_bulk_edit(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

displayvideo_partners_channels_sites_create(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Creates a site in a channel.

displayvideo_partners_channels_sites_delete(connection, partner_id, channel_id, url_or_app_id, optional_params \\ [], opts \\ [])

Deletes a site from a channel.

displayvideo_partners_channels_sites_list(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Lists sites in a channel.

displayvideo_partners_channels_sites_replace(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

displayvideo_partners_edit_assigned_targeting_options(connection, partner_id, optional_params \\ [], opts \\ [])

Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

displayvideo_partners_get(connection, partner_id, optional_params \\ [], opts \\ [])

Gets a partner.

displayvideo_partners_list(connection, optional_params \\ [], opts \\ [])

Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

displayvideo_partners_targeting_types_assigned_targeting_options_create(connection, partner_id, targeting_type, optional_params \\ [], opts \\ [])

Assigns a targeting option to a partner. Returns the assigned targeting option if successful.

displayvideo_partners_targeting_types_assigned_targeting_options_delete(connection, partner_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

Deletes an assigned targeting option from a partner.

displayvideo_partners_targeting_types_assigned_targeting_options_get(connection, partner_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

Gets a single targeting option assigned to a partner.

displayvideo_partners_targeting_types_assigned_targeting_options_list(connection, partner_id, targeting_type, optional_params \\ [], opts \\ [])

Lists the targeting options assigned to a partner.

Functions

displayvideo_partners_channels_create(connection, partner_id, optional_params \\ [], opts \\ [])

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

Creates a new channel. Returns the newly created channel if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the created channel.
  • 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the created channel.
    • :body (type: GoogleApi.DisplayVideo.V3.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_get(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Gets a channel for a partner or advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the fetched channel.
  • channel_id (type: String.t) - Required. The ID of the channel 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the fetched channel.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_list(connection, partner_id, optional_params \\ [], opts \\ [])

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

Lists channels for a partner or advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the channels.
  • 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the channels.
    • :filter (type: String.t) - Allows filtering by channel fields. Supported syntax: Filter expressions for channel can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. All fields must use the HAS (:) operator. Supported fields: displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: displayName (default) channelId 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()) - Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
    • :pageToken (type: String.t) - 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 ListChannels method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_patch(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Updates a channel. Returns the updated channel if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the created channel.
  • channel_id (type: String.t) - Output only. The unique ID of the channel. 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the created channel.
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V3.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_sites_bulk_edit(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the sites 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").
    • :body (type: GoogleApi.DisplayVideo.V3.Model.BulkEditSitesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_sites_create(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Creates a site in a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel in which the site will be created.
  • 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the parent channel.
    • :body (type: GoogleApi.DisplayVideo.V3.Model.Site.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_sites_delete(connection, partner_id, channel_id, url_or_app_id, optional_params \\ [], opts \\ [])

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

Deletes a site from a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the site belongs.
  • url_or_app_id (type: String.t) - Required. The URL or app ID of the site to delete.
  • 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the parent channel.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_sites_list(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Lists sites in a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the requested sites 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").
    • :advertiserId (type: String.t) - The ID of the advertiser that owns the parent channel.
    • :filter (type: String.t) - Allows filtering by site fields. Supported syntax: Filter expressions for site retrieval can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. All fields must use the HAS (:) operator. Supported fields: urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * urlOrAppId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
    • :pageToken (type: String.t) - 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 ListSites method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_channels_sites_replace(connection, partner_id, channel_id, optional_params \\ [], opts \\ [])

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

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - The ID of the partner that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel whose sites will be replaced.
  • 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").
    • :body (type: GoogleApi.DisplayVideo.V3.Model.ReplaceSitesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_edit_assigned_targeting_options(connection, partner_id, optional_params \\ [], opts \\ [])

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

Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner.
  • 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").
    • :body (type: GoogleApi.DisplayVideo.V3.Model.BulkEditPartnerAssignedTargetingOptionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_get(connection, partner_id, optional_params \\ [], opts \\ [])

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

Gets a partner.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner 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").
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_list(connection, optional_params \\ [], opts \\ [])

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

Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • 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").
    • :filter (type: String.t) - Allows filtering by partner fields. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. A restriction has the form of {field} {operator} {value}. All fields must use the EQUALS (=) operator. Supported fields: entityStatus Examples: All active partners: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 200. If unspecified will default to 100.
    • :pageToken (type: String.t) - 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 ListPartners method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_targeting_types_assigned_targeting_options_create(connection, partner_id, targeting_type, optional_params \\ [], opts \\ [])

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

Assigns a targeting option to a partner. Returns the assigned targeting option if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
  • 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").
    • :body (type: GoogleApi.DisplayVideo.V3.Model.AssignedTargetingOption.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_targeting_types_assigned_targeting_options_delete(connection, partner_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

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

Deletes an assigned targeting option from a partner.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
  • assigned_targeting_option_id (type: String.t) - Required. The ID of the assigned targeting option to delete.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_targeting_types_assigned_targeting_options_get(connection, partner_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

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

Gets a single targeting option assigned to a partner.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
  • assigned_targeting_option_id (type: String.t) - Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_partners_targeting_types_assigned_targeting_options_list(connection, partner_id, targeting_type, optional_params \\ [], opts \\ [])

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

Lists the targeting options assigned to a partner.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V3.Connection.t) - Connection to server
  • partner_id (type: String.t) - Required. The ID of the partner.
  • targeting_type (type: String.t) - Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL
  • 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").
    • :filter (type: String.t) - Allows filtering by assigned targeting option fields. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by the logical operator OR. A restriction has the form of {field} {operator} {value}. All fields must use the EQUALS (=) operator. Supported fields: assignedTargetingOptionId Examples: AssignedTargetingOption resource with ID 123456: assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
    • :pageToken (type: String.t) - 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 ListPartnerAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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