View Source GoogleApi.DisplayVideo.V1.Api.Advertisers (google_api_display_video v0.30.2)

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.

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

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

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.

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.

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

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

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.

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.

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.

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.

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.

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

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

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. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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.

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status. Returns the newly created line item if successful. There are default values based on the three fields: The insertion order's insertion_order_type The insertion order's automation_type * The given line_item_type

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.

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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.

Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.

Creates a new location list. Returns the newly created location list if successful.

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.

Creates a new manual trigger. Returns the newly created manual trigger if successful.

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.

Creates a new negative keyword list. Returns the newly created negative keyword list if successful.

Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

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

Specs

displayvideo_advertisers_assets_upload(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.CreateAssetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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_audit(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_audit(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.AuditAdvertiserResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser to audit.
  • 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").
    • :readMask (type: String.t) - Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: usedLineItemsCount usedInsertionOrdersCount usedCampaignsCount channelsCount negativelyTargetedChannelsCount negativeKeywordListsCount adGroupCriteriaCount campaignCriteriaCount
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_bulk_edit_advertiser_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkEditAdvertiserAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

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

Returns

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

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

View Source

Specs

displayvideo_advertisers_bulk_list_advertiser_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkListAdvertiserAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists assigned targeting options of an advertiser 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.
  • 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: - targetingType Examples: targetingType with value TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_CHANNEL" 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 BulkListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_campaigns_bulk_list_campaign_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkListCampaignAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists assigned targeting options of a campaign 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 campaign belongs to.
  • campaign_id (type: String.t) - Required. The ID of the campaign 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_LANGUAGE or TARGETING_TYPE_GENDER targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER" * 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 BulkListCampaignAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_campaigns_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_campaigns_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_campaigns_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_campaigns_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListCampaignsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). The operator must be EQUALS (=). Supported fields: - campaignId - displayName - entityStatus - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" 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 * updateTime 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

Specs

displayvideo_advertisers_campaigns_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Campaign.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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_campaigns_targeting_types_assigned_targeting_options_get(connection, advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_campaigns_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()}
  | {:ok, list()}
  | {:error, any()}

Gets a single targeting option assigned to a campaign.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the campaign belongs to.
  • campaign_id (type: String.t) - Required. The ID of the campaign the assigned targeting option belongs to.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: TARGETING_TYPE_AGE_RANGE TARGETING_TYPE_AUTHORIZED_SELLER_STATUS TARGETING_TYPE_CONTENT_INSTREAM_POSITION TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_ENVIRONMENT TARGETING_TYPE_EXCHANGE TARGETING_TYPE_GENDER TARGETING_TYPE_GEO_REGION TARGETING_TYPE_HOUSEHOLD_INCOME TARGETING_TYPE_INVENTORY_SOURCE TARGETING_TYPE_INVENTORY_SOURCE_GROUP TARGETING_TYPE_LANGUAGE TARGETING_TYPE_ON_SCREEN_POSITION TARGETING_TYPE_PARENTAL_STATUS TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION TARGETING_TYPE_SUB_EXCHANGE TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_VIEWABILITY
  • assigned_targeting_option_id (type: String.t) - Required. An identifier unique to the targeting type in this campaign 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_campaigns_targeting_types_assigned_targeting_options_list(connection, advertiser_id, campaign_id, targeting_type, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_campaigns_targeting_types_assigned_targeting_options_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.ListCampaignAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the targeting options assigned to a campaign for a specified targeting type.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the campaign belongs to.
  • campaign_id (type: String.t) - Required. The ID of the campaign to list assigned targeting options for.
  • targeting_type (type: String.t) - Required. Identifies the type of assigned targeting options to list. Supported targeting types: TARGETING_TYPE_AGE_RANGE TARGETING_TYPE_AUTHORIZED_SELLER_STATUS TARGETING_TYPE_CONTENT_INSTREAM_POSITION TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_ENVIRONMENT TARGETING_TYPE_EXCHANGE TARGETING_TYPE_GENDER TARGETING_TYPE_GEO_REGION TARGETING_TYPE_HOUSEHOLD_INCOME TARGETING_TYPE_INVENTORY_SOURCE TARGETING_TYPE_INVENTORY_SOURCE_GROUP TARGETING_TYPE_LANGUAGE TARGETING_TYPE_ON_SCREEN_POSITION TARGETING_TYPE_PARENTAL_STATUS TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION TARGETING_TYPE_SUB_EXCHANGE TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_VIEWABILITY
  • 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 5000. 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 ListCampaignAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

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

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the created channel.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :partnerId (type: String.t) - The ID of the partner that owns the created channel.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Channel.t) -
  • 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_get(connection, advertiser_id, channel_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_channels_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Channel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_channels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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_channels_patch(connection, advertiser_id, channel_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Updates a channel. Returns the updated channel if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the created channel.
  • channel_id (type: String.t) - Output only. The unique ID of the channel. Assigned by the system.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :partnerId (type: String.t) - The ID of the partner that owns the created channel.
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Channel.t) -
  • 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_sites_bulk_edit(connection, advertiser_id, channel_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_channels_sites_bulk_edit(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.BulkEditSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the sites belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.BulkEditSitesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_channels_sites_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a site in a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel in which the site will be created.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :partnerId (type: String.t) - The ID of the partner that owns the parent channel.
    • :body (type: GoogleApi.DisplayVideo.V1.Model.Site.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_channels_sites_delete(connection, advertiser_id, channel_id, url_or_app_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes a site from a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the site belongs.
  • url_or_app_id (type: String.t) - Required. The URL or app ID of the site to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :partnerId (type: String.t) - The ID of the partner that owns the parent channel.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_channels_sites_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists sites in a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the requested sites belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Allows filtering by site fields. Supported syntax: Filter expressions for site currently can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. The operator must be CONTAINS (:). Supported fields: - urlOrAppId Examples: All sites for which the URL or app ID contains "google": urlOrAppId : "google"
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * urlOrAppId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent channel.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_channels_sites_replace(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ReplaceSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel whose sites will be replaced.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.ReplaceSitesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_creatives_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_creatives_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_creatives_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_creatives_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListCreativesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 (=) for the following fields: - entityStatus - creativeType. - dimensions - minDuration - maxDuration - approvalStatus - exchangeReviewStatus - dynamic - creativeId The operator must be HAS (:) for the following fields: - lineItemIds 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. There may be multiple lineItemIds restrictions in order to search against multiple possible line item IDs. There may be multiple creativeId restrictions in order to search against multiple possible creative IDs. 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") All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) Find creatives by multiple creative IDs: creativeId=1 OR creativeId=2 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

Specs

displayvideo_advertisers_creatives_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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_bulk_list_insertion_order_assigned_targeting_options(connection, advertiser_id, insertion_order_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_insertion_orders_bulk_list_insertion_order_assigned_targeting_options(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.BulkListInsertionOrderAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists assigned targeting options of an insertion order 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 insertion order belongs to.
  • insertion_order_id (type: String.t) - Required. The ID of the insertion order 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 BulkListInsertionOrderAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_insertion_orders_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.InsertionOrder.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_insertion_orders_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListInsertionOrdersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 used on budget.budget_segments.date_range.end_date must be LESS THAN (<). The operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). The operators used on all other fields must be EQUALS (=). Supported fields: - campaignId - displayName - entityStatus - budget.budget_segments.date_range.end_date (input as YYYY-MM-DD) - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) 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") All insertion orders whose budget segments' dates end before March 28, 2019: budget.budget_segments.date_range.end_date<"2019-03-28" All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" 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" * "updateTime" 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

Specs

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()}
  | {:ok, list()}
  | {: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_insertion_orders_targeting_types_assigned_targeting_options_get(connection, advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_insertion_orders_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()}
  | {:ok, list()}
  | {:error, any()}

Gets a single targeting option assigned to an insertion order.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the insertion order belongs to.
  • insertion_order_id (type: String.t) - Required. The ID of the insertion order 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 insertion order 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_insertion_orders_targeting_types_assigned_targeting_options_list(connection, advertiser_id, insertion_order_id, targeting_type, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_insertion_orders_targeting_types_assigned_targeting_options_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.ListInsertionOrderAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the targeting options assigned to an insertion order.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser the insertion order belongs to.
  • insertion_order_id (type: String.t) - Required. The ID of the insertion order 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 5000. 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 ListInsertionOrderAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_invoices_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListInvoicesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser to list invoices 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").
    • :issueMonth (type: String.t) - The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
    • :loiSapinInvoiceType (type: String.t) - Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
    • :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 ListInvoices method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_invoices_lookup_invoice_currency(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LookupInvoiceCurrencyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the invoice currency used by an advertiser in a given month.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser to lookup currency 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").
    • :invoiceMonth (type: String.t) - Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.LookupInvoiceCurrencyResponse{}} 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

Specs

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()}
  | {:ok, list()}
  | {: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. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_line_items_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.LineItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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_generate_default(connection, advertiser_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status. Returns the newly created line item if successful. There are default values based on the three fields: The insertion order's insertion_order_type The insertion order's automation_type * The given line_item_type

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.
  • 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.GenerateDefaultLineItemRequest.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_get(connection, advertiser_id, line_item_id, optional_params \\ [], opts \\ [])

View Source

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_line_items_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListLineItemsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 used on flight.dateRange.endDate must be LESS THAN (<). The operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). The operator used on warningMessages must be HAS (:). The operators used on all other fields must be EQUALS (=). Supported properties: - campaignId - displayName - insertionOrderId - entityStatus - lineItemId - lineItemType - flight.dateRange.endDate (input formatted as YYYY-MM-DD) - warningMessages - flight.triggerId - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - targetedChannelId - targetedNegativeKeywordListId 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" All line items whose flight dates end before March 28, 2019: flight.dateRange.endDate<"2019-03-28" All line items that have NO_VALID_CREATIVE in warningMessages: warningMessages:"NO_VALID_CREATIVE" All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" * All line items that are using both the specified channel and specified negative keyword list in their targeting: targetedNegativeKeywordListId=789 AND targetedChannelId=12345 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" “flight.dateRange.endDate” "updateTime" 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

Specs

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()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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

Specs

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()}
  | {:ok, list()}
  | {:error, any()}

Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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

Specs

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()}
  | {:ok, list()}
  | {:error, any()}

Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditLineItemAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption

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

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

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()}
  | {:ok, list()}
  | {: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 5000. 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

Specs

displayvideo_advertisers_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListAdvertisersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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 used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). The operator must be EQUALS (=). Supported fields: - advertiserId - displayName - entityStatus - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE" All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" 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 * updateTime 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_assigned_locations_bulk_edit(connection, advertiser_id, location_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_location_lists_assigned_locations_bulk_edit(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.BulkEditAssignedLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.

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 location list belongs.
  • location_list_id (type: String.t) - Required. The ID of the location list to which these assignments are assigned.
  • 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.BulkEditAssignedLocationsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_location_lists_assigned_locations_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.AssignedLocation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an assignment between a location and 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 location list belongs.
  • location_list_id (type: String.t) - Required. The ID of the location list for which the assignment will be created.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.AssignedLocation.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_location_lists_assigned_locations_delete(connection, advertiser_id, location_list_id, assigned_location_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes the assignment between a location and 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 location list belongs.
  • location_list_id (type: String.t) - Required. The ID of the location list to which this assignment is assigned.
  • assigned_location_id (type: String.t) - Required. The ID of the assigned location 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_location_lists_assigned_locations_list(connection, advertiser_id, location_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_location_lists_assigned_locations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListAssignedLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists locations assigned to 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 location list belongs.
  • location_list_id (type: String.t) - Required. The ID of the location list to which these assignments are assigned.
  • 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 assignment fields. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by the logical operator OR. A restriction has the form of {field} {operator} {value}. The operator must be EQUALS (=). * Supported fields: - assignedLocationId 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: * assignedLocationId (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: assignedLocationId 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 ListAssignedLocations method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Creates a new location list. Returns the newly created location list if successful.

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 location list belongs.
  • 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.LocationList.t) -
  • 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_get(connection, advertiser_id, location_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_location_lists_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListLocationListsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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_location_lists_patch(connection, advertiser_id, location_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Updates a location list. Returns the updated location list if successful.

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 location lists belongs.
  • location_list_id (type: String.t) - Output only. The unique ID of the location list. 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.LocationList.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_manual_triggers_activate(connection, advertiser_id, trigger_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_manual_triggers_activate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ManualTrigger.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser that the manual trigger belongs.
  • trigger_id (type: String.t) - Required. The ID of the manual trigger to activate.
  • 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.ActivateManualTriggerRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_manual_triggers_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ManualTrigger.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new manual trigger. Returns the newly created manual trigger if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. Immutable. The unique ID of the advertiser that the manual trigger 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.ManualTrigger.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_manual_triggers_deactivate(connection, advertiser_id, trigger_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_manual_triggers_deactivate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ManualTrigger.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deactivates a manual trigger.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser that the manual trigger belongs.
  • trigger_id (type: String.t) - Required. The ID of the manual trigger to deactivate.
  • 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.DeactivateManualTriggerRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_manual_triggers_get(connection, advertiser_id, trigger_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_manual_triggers_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ManualTrigger.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a manual trigger.

Parameters

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

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

View Source

Specs

displayvideo_advertisers_manual_triggers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListManualTriggersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser that the fetched manual triggers 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").
    • :filter (type: String.t) - Allows filtering by manual trigger 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: - displayName - state Examples: All active manual triggers under an advertiser: state="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) state 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 ListManualTriggers method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_manual_triggers_patch(connection, advertiser_id, trigger_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_manual_triggers_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ManualTrigger.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a manual trigger. Returns the updated manual trigger if successful.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  • trigger_id (type: String.t) - Output only. The unique ID of the manual trigger.
  • 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.ManualTrigger.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Creates a new negative keyword list. Returns the newly created negative keyword list if successful.

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 negative keyword list will belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.NegativeKeywordList.t) -
  • 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_delete(connection, advertiser_id, negative_keyword_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes 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 negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the negative keyword list 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_negative_keyword_lists_get(connection, advertiser_id, negative_keyword_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

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()}
  | {:ok, list()}
  | {: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

Specs

displayvideo_advertisers_negative_keyword_lists_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListNegativeKeywordListsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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_negative_keyword_lists_negative_keywords_bulk_edit(connection, advertiser_id, negative_keyword_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_negative_keyword_lists_negative_keywords_bulk_edit(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.BulkEditNegativeKeywordsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

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 parent negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the parent negative keyword list to which the negative keywords belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.BulkEditNegativeKeywordsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_negative_keyword_lists_negative_keywords_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.NegativeKeyword.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a negative keyword in a negative keyword 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 parent negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the parent negative keyword list in which the negative keyword will be created.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.NegativeKeyword.t) -
  • opts (type: keyword()) - Call options

Returns

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

displayvideo_advertisers_negative_keyword_lists_negative_keywords_delete(connection, advertiser_id, negative_keyword_list_id, keyword_value, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes a negative keyword from a negative keyword 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 parent negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the parent negative keyword list to which the negative keyword belongs.
  • keyword_value (type: String.t) - Required. The keyword value of the negative keyword 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_negative_keyword_lists_negative_keywords_list(connection, advertiser_id, negative_keyword_list_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_negative_keyword_lists_negative_keywords_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListNegativeKeywordsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists negative keywords in a negative keyword 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 parent negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the parent negative keyword list to which the requested negative keywords 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 negative keyword fields. Supported syntax: Filter expressions for negative keyword currently can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. The operator must be CONTAINS (:). Supported fields: - keywordValue Examples: All negative keywords for which the keyword value contains "google": keywordValue : "google"
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * keywordValue (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: keywordValue desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 1000. 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 ListNegativeKeywords method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_negative_keyword_lists_negative_keywords_replace(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ReplaceNegativeKeywordsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

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 parent negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Required. The ID of the parent negative keyword list to which the negative keywords belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.ReplaceNegativeKeywordsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Updates a negative keyword list. Returns the updated negative keyword list if successful.

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 negative keyword list belongs.
  • negative_keyword_list_id (type: String.t) - Output only. The unique ID of the negative keyword list. 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.NegativeKeywordList.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

displayvideo_advertisers_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {: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
Link to this function

displayvideo_advertisers_targeting_types_assigned_targeting_options_create(connection, advertiser_id, targeting_type, optional_params \\ [], opts \\ [])

View Source

Specs

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

Assigns a targeting option to an advertiser. 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.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: TARGETING_TYPE_CHANNEL TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_OMID TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • 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_targeting_types_assigned_targeting_options_delete(connection, advertiser_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes an assigned targeting option from an advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: TARGETING_TYPE_CHANNEL TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_OMID TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • 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_targeting_types_assigned_targeting_options_get(connection, advertiser_id, targeting_type, assigned_targeting_option_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Gets a single targeting option assigned to an advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser.
  • targeting_type (type: String.t) - Required. Identifies the type of this assigned targeting option. Supported targeting types: TARGETING_TYPE_CHANNEL TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_OMID TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • assigned_targeting_option_id (type: String.t) - Required. An identifier unique to the targeting type in this advertiser 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_targeting_types_assigned_targeting_options_list(connection, advertiser_id, targeting_type, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_targeting_types_assigned_targeting_options_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DisplayVideo.V1.Model.ListAdvertiserAssignedTargetingOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the targeting options assigned to an advertiser.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - Required. The ID of the advertiser.
  • targeting_type (type: String.t) - Required. Identifies the type of assigned targeting options to list. Supported targeting types: TARGETING_TYPE_CHANNEL TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION TARGETING_TYPE_OMID TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • 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 Examples: AssignedTargetingOption with ID 123456 assignedTargetingOptionId="123456" 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 5000. 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 ListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.
  • opts (type: keyword()) - Call options

Returns

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