google_api_display_video v0.4.0 GoogleApi.DisplayVideo.V1.Api.Advertisers View Source

API calls for all endpoints tagged Advertisers.

Link to this section Summary

Functions

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

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

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.

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

Deletes a creative. Returns error code NOT_FOUND if the creative does not exist. The creative should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, before it can be deleted.

Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.

Creates a new insertion order. Returns the newly created insertion order if successful.

Deletes an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist.

Updates an existing insertion order. Returns the updated insertion order if successful.

Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .

Creates a new line item. Returns the newly created line item if successful.

Deletes a line item. Returns error code NOT_FOUND if the line item does not exist. The line item should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Updates an existing line item. Returns the updated line item if successful.

Lists advertisers that are accessible to the current user.

Updates an existing advertiser. Returns the updated advertiser if successful.

Link to this section Functions

Link to this function

displayvideo_advertisers_assets_upload(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_assets_upload(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.CreateAssetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this asset belongs to.
  • 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.V1.Model.CreateAssetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.CreateAssetResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_assets_upload_iodata(connection, advertiser_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_assets_upload_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.DisplayVideo.V1.Model.CreateAssetRequest.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.CreateAssetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this asset belongs to.
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.DisplayVideo.V1.Model.CreateAssetRequest.t) - object metadata
  • data (type: iodata) - Content to upload, as a string or iolist
  • 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.V1.Model.CreateAssetResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_assets_upload_simple(connection, advertiser_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_assets_upload_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.DisplayVideo.V1.Model.CreateAssetRequest.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.CreateAssetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this asset belongs to.
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.DisplayVideo.V1.Model.CreateAssetRequest.t) - object metadata
  • data (type: String.t) - Path to file containing content to upload
  • 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.V1.Model.CreateAssetResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_campaigns_create(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_campaigns_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the campaign belongs to.
  • 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.V1.Model.Campaign.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Campaign{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_campaigns_delete(connection, advertiser_id, campaign_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_campaigns_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser this campaign belongs to.
  • campaign_id (type: String.t) - The ID of the campaign we need 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_campaigns_get(connection, advertiser_id, campaign_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_campaigns_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a campaign.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this campaign belongs to.
  • campaign_id (type: String.t) - Required. The ID of the campaign 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.V1.Model.Campaign{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_campaigns_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_campaigns_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListCampaignsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists campaigns in an advertiser.

The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - The ID of the advertiser to list campaigns for.

  • 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 campaign properties.

      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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • entityStatus

      Examples:

      • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • displayName (default)
      • entityStatus

      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 100. 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 ListCampaigns method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListCampaignsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_campaigns_patch(connection, advertiser_id, campaign_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_campaigns_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing campaign. Returns the updated campaign if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the campaign belongs to.
  • campaign_id (type: String.t) - Output only. The unique ID of the campaign. 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Campaign.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Campaign{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_channels_get(connection, advertiser_id, channel_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_channels_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Channel.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a channel for a partner or advertiser.

Parameters

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

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Channel{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_channels_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_channels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists channels for a partner or advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - The ID of the advertiser 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").

    • :filter (type: String.t) - Allows filtering by channel fields.

      Supported syntax:

      • Filter expressions for channel currently can only contain at most one
      • restriction.
      • A restriction has the form of {field} {operator} {value}.
      • The operator must be CONTAINS (:).
      • 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.

    • :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 100. 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.

    • :partnerId (type: String.t) - The ID of the partner that owns the channels.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListChannelsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
displayvideo_advertisers_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.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").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Advertiser.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Advertiser{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_creatives_create(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_creatives_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the creative belongs to.
  • 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.V1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Creative{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_creatives_delete(connection, advertiser_id, creative_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_creatives_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes a creative. Returns error code NOT_FOUND if the creative does not exist. The creative should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, before it can be deleted.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser this creative belongs to.
  • creative_id (type: String.t) - The ID of the creative to be deleted.
  • 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_creatives_get(connection, advertiser_id, creative_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_creatives_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a creative.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this creative belongs to.
  • creative_id (type: String.t) - Required. The ID of the creative 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.V1.Model.Creative{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_creatives_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_creatives_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListCreativesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists creatives in an advertiser.

The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the advertiser to list creatives for.

  • 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 creative properties.

      Supported syntax:

      • Filter expressions are made up of one or more restrictions.
      • Restriction for the same field must be combined by OR.
      • Restriction for different fields must be combined by AND.
      • Between ( and ) there can only be restrictions combined by OR for the same field.
      • A restriction has the form of {field} {operator} {value}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • entityStatus
        • creativeType.
        • dimensions
        • minDuration
        • maxDuration
        • approvalStatus
        • exchangeReviewStatus
        • dynamic
      • For entityStatus, minDuration, maxDuration, and dynamic there may be at most one restriction.
      • For dimensions, the value is in the form of "{width}x{height}".
      • For exchangeReviewStatus, the value is in the form of {exchange}-{reviewStatus}.
      • For minDuration and maxDuration, the value is in the form of "{duration}s". Only seconds are supported with millisecond granularity.

      Examples:

      • All native creatives: creativeType="CREATIVE_TYPE_NATIVE"
      • All active creatives with 300x400 or 50x100 dimensions: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
      • All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • creativeId (default)
      • createTime
      • mediaDuration
      • dimensions (sorts by width first, then by height)

      The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: createTime desc.

    • :pageSize (type: integer()) - 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) - 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 ListCreatives method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListCreativesResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_creatives_patch(connection, advertiser_id, creative_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_creatives_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing creative. Returns the updated creative if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the creative belongs to.
  • creative_id (type: String.t) - Output only. The unique ID of the creative. 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Creative{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_delete(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser we need 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_get(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets an advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser 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.V1.Model.Advertiser{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_insertion_orders_create(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_insertion_orders_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.InsertionOrder.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new insertion order. Returns the newly created insertion order if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the insertion order belongs to.
  • 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.V1.Model.InsertionOrder.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.InsertionOrder{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_insertion_orders_delete(connection, advertiser_id, insertion_order_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_insertion_orders_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser this insertion order belongs to.
  • insertion_order_id (type: String.t) - The ID of the insertion order we need 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_insertion_orders_get(connection, advertiser_id, insertion_order_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_insertion_orders_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.InsertionOrder.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this insertion order belongs to.
  • insertion_order_id (type: String.t) - Required. The ID of the insertion order 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.V1.Model.InsertionOrder{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_insertion_orders_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_insertion_orders_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListInsertionOrdersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists insertion orders in an advertiser.

The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the advertiser to list insertion orders for.

  • 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 insertion order properties.

      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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • campaignId
        • entityStatus

      Examples:

      • All insertion orders under a campaign: campaignId="1234"
      • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED insertion orders under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • "displayName" (default)
      • "entityStatus"

      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 100. 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 ListInsertionOrders method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListInsertionOrdersResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_insertion_orders_patch(connection, advertiser_id, insertion_order_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_insertion_orders_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.InsertionOrder.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing insertion order. Returns the updated insertion order if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the insertion order belongs to.
  • insertion_order_id (type: String.t) - Output only. The unique ID of the insertion order. 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.InsertionOrder.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.InsertionOrder{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_bulk_edit_line_item_assigned_targeting_options(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_bulk_edit_line_item_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkEditLineItemAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.
  • line_item_id (type: String.t) - Required. The ID of the line item the assigned targeting option will belong to.
  • 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.V1.Model.BulkEditLineItemAssignedTargetingOptionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.BulkEditLineItemAssignedTargetingOptionsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_bulk_list_line_item_assigned_targeting_options(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_bulk_list_line_item_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkListLineItemAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists assigned targeting options of a line item across targeting types.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.

  • line_item_id (type: String.t) - Required. The ID of the line item to list assigned targeting options for.

  • 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 properties. Supported syntax:

      • Filter expressions are made up of one or more restrictions.
      • Restrictions can be combined by the logical operator OR on the same field.
      • A restriction has the form of {field} {operator} {value}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • targetingType
        • inheritance

      Examples:

      • AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"
      • AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • targetingType (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: targetingType desc.

    • :pageSize (type: integer()) - Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is '5000'. Returns error code INVALID_ARGUMENT if an invalid value is specified.

    • :pageToken (type: String.t) - A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to BulkListLineItemAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.BulkListLineItemAssignedTargetingOptionsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_create(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LineItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new line item. Returns the newly created line item if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the line item belongs to.
  • 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.V1.Model.LineItem.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.LineItem{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_delete(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes a line item. Returns error code NOT_FOUND if the line item does not exist. The line item should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser this line item belongs to.
  • line_item_id (type: String.t) - The ID of the line item we need 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_get(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LineItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a line item.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser this line item belongs to.
  • line_item_id (type: String.t) - Required. The ID of the line item 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.V1.Model.LineItem{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListLineItemsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists line items in an advertiser.

The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the advertiser to list line items for.

  • 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 line item properties.

      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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • campaignId
        • insertionOrderId
        • entityStatus
        • lineItemType.

      Examples:

      • All line items under an insertion order: insertionOrderId="1234"
      • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED and LINE_ITEM_TYPE_DISPLAY_DEFAULT line items under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • "displayName" (default)
      • "entityStatus"

      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 100. 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 ListLineItems method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListLineItemsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_patch(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LineItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing line item. Returns the updated line item if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser the line item belongs to.
  • line_item_id (type: String.t) - Output only. The unique ID of the line item. 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.LineItem.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.LineItem{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_create(connection, advertiser_id, line_item_id, targeting_type, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.AssignedTargetingOption.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Assigns a targeting option to a line item. Returns the assigned targeting option if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.
  • line_item_id (type: String.t) - Required. The ID of the line item the assigned targeting option will belong to.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option.
  • 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.V1.Model.AssignedTargetingOption.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.AssignedTargetingOption{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_delete(connection, advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes an assigned targeting option from a line item.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.
  • line_item_id (type: String.t) - Required. The ID of the line item the assigned targeting option belongs to.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option.
  • 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.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_get(connection, advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.AssignedTargetingOption.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a single targeting option assigned to a line item.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.
  • line_item_id (type: String.t) - Required. The ID of the line item the assigned targeting option belongs to.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option.
  • assigned_targeting_option_id (type: String.t) - Required. An identifier unique to the targeting type in this line item 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.V1.Model.AssignedTargetingOption{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_list(connection, advertiser_id, line_item_id, targeting_type, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.ListLineItemAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the targeting options assigned to a line item.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the advertiser the line item belongs to.

  • line_item_id (type: String.t) - Required. The ID of the line item to list assigned targeting options for.

  • targeting_type (type: String.t) - Required. Identifies the type of assigned targeting options to list.

  • 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 properties.

      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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • assignedTargetingOptionId
        • inheritance

      Examples:

      • AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
      • AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

      The length of this field should be no more than 500 characters.

    • :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 100. 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 ListLineItemAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListLineItemAssignedTargetingOptionsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
displayvideo_advertisers_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListAdvertisersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists advertisers that are accessible to the current user.

The order is defined by the order_by parameter.

A single partner_id is required. Cross-partner listing is not supported.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.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 advertiser properties.

      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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • entityStatus

      Examples:

      • All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE"

      The length of this field should be no more than 500 characters.

    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • displayName (default)
      • entityStatus

      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 100. 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 ListAdvertisers method. If not specified, the first page of results will be returned.

    • :partnerId (type: String.t) - Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListAdvertisersResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_location_lists_get(connection, advertiser_id, location_list_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_location_lists_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LocationList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a location list.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the DV360 advertiser to which the fetched location list belongs.
  • location_list_id (type: String.t) - Required. The ID of the location list 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.V1.Model.LocationList{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_location_lists_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_location_lists_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListLocationListsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists location lists based on a given advertiser id.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the DV360 advertiser to which the fetched location lists 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").

    • :filter (type: String.t) - Allows filtering by location list 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}.
      • The operator must be EQUALS (=).
      • Supported fields:

        • locationType

      Examples:

      • All regional location list: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
      • All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are:

      • locationListId (default)
      • displayName

      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 100. Defaults to 100 if not set. 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 ListLocationLists method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListLocationListsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_negative_keyword_lists_get(connection, advertiser_id, negative_keyword_list_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_negative_keyword_lists_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.NegativeKeywordList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a negative keyword list given an advertiser ID and a negative keyword list ID.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the negative keyword list 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.V1.Model.NegativeKeywordList{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_negative_keyword_lists_list(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_negative_keyword_lists_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListNegativeKeywordListsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists negative keyword lists based on a given advertiser id.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server

  • advertiser_id (type: String.t) - Required. The ID of the DV360 advertiser to which the fetched negative keyword lists 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").
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 100. Defaults to 100 if not set. 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 ListNegativeKeywordLists method. If not specified, the first page of results will be returned.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListNegativeKeywordListsResponse{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_advertisers_patch(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source
displayvideo_advertisers_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing advertiser. Returns the updated advertiser if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Output only. The unique ID of the advertiser. 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").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Advertiser.t) -
  • opts (type: keyword()) - Call options

Returns

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