Class: Google::Apis::DisplayvideoV3::DisplayVideoService

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::DisplayvideoV3::DisplayVideoService

Defined in:

lib/google/apis/displayvideo_v3/service.rb

Overview

Display & Video 360 API

Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.

Examples:

require 'google/apis/displayvideo_v3'

Displayvideo = Google::Apis::DisplayvideoV3 # Alias the module
service = Displayvideo::DisplayVideoService.new

See Also:

• https://developers.google.com/display-video/

Constant Summary

DEFAULT_ENDPOINT_TEMPLATE =

"https://displayvideo.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  Available to use for quota purposes for server-side applications.

Instance Method Summary

• #audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AuditAdvertiserResponse

  Audits an advertiser.

• #bulk_advertiser_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, ad_group_ids: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse

  Lists assigned targeting options for multiple ad groups across targeting types.

• #bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditSitesResponse

  Bulk edits sites under a single channel.

• #bulk_advertiser_line_item_list_assigned_targeting_options(advertiser_id, filter: nil, line_item_ids: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse

  Lists assigned targeting options for multiple line items across targeting types.

• #bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse

  Bulk edits multiple assignments between inventory sources and a single inventory source group.

• #bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse

  Bulk edits multiple assignments between locations and a single location list.

• #bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse

  Bulk edits user roles for a user.

• #bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse

  Bulk edits negative keywords in a single negative keyword list.

• #bulk_line_item_edit_assigned_targeting_options(advertiser_id, bulk_edit_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse

  Bulk edits targeting options under multiple line items.

• #bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditSitesResponse

  Bulk edits sites under a single channel.

• #bulk_update_line_items(advertiser_id, bulk_update_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse

  Updates multiple line items.

• #create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

  Creates a new advertiser.

• #create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

  Creates a new campaign.

• #create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Creates a new channel.

• #create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Site

  Creates a site in a channel.

• #create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

  Creates a new creative.

• #create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

  Creates a new insertion order.

• #create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Assigns a targeting option to an insertion order.

• #create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

  Creates a new line item.

• #create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Assigns a targeting option to a line item.

• #create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

  Creates a new location list.

• #create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedLocation

  Creates an assignment between a location and a location list.

• #create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

  Creates a new negative keyword list.

• #create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeyword

  Creates a negative keyword in a negative keyword list.

• #create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Assigns a targeting option to an advertiser.

• #create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

  Creates a new custom bidding algorithm.

• #create_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules

  Creates a new rules resource.

• #create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScript

  Creates a new custom bidding script.

• #create_first_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

  Creates a FirstAndThirdPartyAudience.

• #create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

  Creates a new guaranteed order.

• #create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

  Creates a new inventory source.

• #create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

  Creates a new inventory source group.

• #create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedInventorySource

  Creates an assignment between an inventory source and an inventory source group.

• #create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Creates a new channel.

• #create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Site

  Creates a site in a channel.

• #create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Assigns a targeting option to a partner.

• #create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Operation

  Creates an SDF Download Task.

• #create_user(user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

  Creates a new user.

• #delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an advertiser.

• #delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Permanently deletes a campaign.

• #delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a site from a channel.

• #delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a creative.

• #delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an insertion order.

• #delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an assigned targeting option from an insertion order.

• #delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a line item.

• #delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an assigned targeting option from a line item.

• #delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes the assignment between a location and a location list.

• #delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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

• #delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a negative keyword from a negative keyword list.

• #delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an assigned targeting option from an advertiser.

• #delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an inventory source group.

• #delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes the assignment between an inventory source and an inventory source group.

• #delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a site from a channel.

• #delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes an assigned targeting option from a partner.

• #delete_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

  Deletes a user.

• #download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleBytestreamMedia

  Downloads media.

• #duplicate_line_item(advertiser_id, line_item_id, duplicate_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::DuplicateLineItemResponse

  Duplicates a line item.

• #edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse

  Edits targeting options under a single advertiser.

• #edit_first_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse

  Updates the member list of a Customer Match audience.

• #edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse

  Edits read advertisers of a guaranteed order.

• #edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceAccessors

  Edits read/write accessors of an inventory source.

• #edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse

  Edits targeting options under a single partner.

• #generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

  Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status.

• #get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

  Gets an advertiser.

• #get_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AdGroup

  Gets an ad group.

• #get_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AdGroupAd

  Gets an ad group ad.

• #get_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to an ad group.

• #get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

  Gets a campaign.

• #get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to a campaign.

• #get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Gets a channel for a partner or advertiser.

• #get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

  Gets a creative.

• #get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

  Gets an insertion order.

• #get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to an insertion order.

• #get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

  Gets a line item.

• #get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to a line item.

• #get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

  Gets a location list.

• #get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

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

• #get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to an advertiser.

• #get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CombinedAudience

  Gets a combined audience.

• #get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

  Gets a custom bidding algorithm.

• #get_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules

  Retrieves a rules resource.

• #get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScript

  Gets a custom bidding script.

• #get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomList

  Gets a custom list.

• #get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

  Gets a first and third party audience.

• #get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightGroup

  Gets a Floodlight group.

• #get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightActivity

  Gets a Floodlight activity.

• #get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleAudience

  Gets a Google audience.

• #get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

  Gets a guaranteed order.

• #get_inventory_source(inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

  Gets an inventory source.

• #get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

  Gets an inventory source group.

• #get_partner(partner_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Partner

  Gets a partner.

• #get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Gets a channel for a partner or advertiser.

• #get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

  Gets a single targeting option assigned to a partner.

• #get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Operation

  Gets the latest state of an asynchronous SDF download task operation.

• #get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::TargetingOption

  Gets a single targeting option.

• #get_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

  Gets a user.

• #initialize ⇒ DisplayVideoService constructor

  A new instance of DisplayVideoService.

• #list_advertiser_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse

  Lists ad group ads.

• #list_advertiser_ad_group_targeting_type_assigned_targeting_options(advertiser_id, ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse

  Lists the targeting options assigned to an ad group.

• #list_advertiser_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupsResponse

  Lists ad groups.

• #list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse

  Lists assigned targeting options of an advertiser across targeting types.

• #list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse

  Lists assigned targeting options of a campaign across targeting types.

• #list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse

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

• #list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCampaignsResponse

  Lists campaigns in an advertiser.

• #list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListSitesResponse

  Lists sites in a channel.

• #list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListChannelsResponse

  Lists channels for a partner or advertiser.

• #list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCreativesResponse

  Lists creatives in an advertiser.

• #list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse

  Lists assigned targeting options of an insertion order across targeting types.

• #list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse

  Lists the targeting options assigned to an insertion order.

• #list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse

  Lists insertion orders in an advertiser.

• #list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInvoicesResponse

  Lists invoices posted for an advertiser in a given month.

• #list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse

  Lists the targeting options assigned to a line item.

• #list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLineItemsResponse

  Lists line items in an advertiser.

• #list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse

  Lists locations assigned to a location list.

• #list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLocationListsResponse

  Lists location lists based on a given advertiser id.

• #list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse

  Lists negative keywords in a negative keyword list.

• #list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse

  Lists negative keyword lists based on a given advertiser id.

• #list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse

  Lists the targeting options assigned to an advertiser.

• #list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdvertisersResponse

  Lists advertisers that are accessible to the current user.

• #list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse

  Lists combined audiences.

• #list_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse

  Lists rules resources that belong to the given algorithm.

• #list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse

  Lists custom bidding scripts that belong to the given algorithm.

• #list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse

  Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.

• #list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomListsResponse

  Lists custom lists.

• #list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse

  Lists first and third party audiences.

• #list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse

  Lists Floodlight activities in a Floodlight group.

• #list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse

  Lists Google audiences.

• #list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse

  Lists guaranteed orders that are accessible to the current user.

• #list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse

  Lists inventory sources assigned to an inventory source group.

• #list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse

  Lists inventory source groups that are accessible to the current user.

• #list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInventorySourcesResponse

  Lists inventory sources that are accessible to the current user.

• #list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListSitesResponse

  Lists sites in a channel.

• #list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListChannelsResponse

  Lists channels for a partner or advertiser.

• #list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse

  Lists the targeting options assigned to a partner.

• #list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListPartnersResponse

  Lists partners that are accessible to the current user.

• #list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse

  Lists targeting options of a given type.

• #list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListUsersResponse

  Lists users that are accessible to the current user.

• #lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse

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

• #patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

  Updates an existing advertiser.

• #patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

  Updates an existing campaign.

• #patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Updates a channel.

• #patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

  Updates an existing creative.

• #patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

  Updates an existing insertion order.

• #patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

  Updates an existing line item.

• #patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

  Updates a location list.

• #patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

  Updates a negative keyword list.

• #patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

  Updates an existing custom bidding algorithm.

• #patch_first_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

  Updates an existing FirstAndThirdPartyAudience.

• #patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightGroup

  Updates an existing Floodlight group.

• #patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

  Updates an existing guaranteed order.

• #patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

  Updates an existing inventory source.

• #patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

  Updates an inventory source group.

• #patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

  Updates a channel.

• #patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

  Updates an existing user.

• #replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceSitesResponse

  Replaces all of the sites under a single channel.

• #replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse

  Replaces all negative keywords in a single negative keyword list.

• #replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceSitesResponse

  Replaces all of the sites under a single channel.

• #search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse

  Searches for targeting options of a given type based on the given search terms.

• #upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CreateAssetResponse

  Uploads an asset.

• #upload_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef

  Creates a rules reference object for an AlgorithmRules file.

• #upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScriptRef

  Creates a custom bidding script reference object for a script file.

• #upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleBytestreamMedia

  Uploads media.

Constructor Details

#initialize ⇒ DisplayVideoService

Returns a new instance of DisplayVideoService.

# File 'lib/google/apis/displayvideo_v3/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-displayvideo_v3',
        client_version: Google::Apis::DisplayvideoV3::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

• (String) —

  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.

# File 'lib/google/apis/displayvideo_v3/service.rb', line 42

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

• (String) —

  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.

# File 'lib/google/apis/displayvideo_v3/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AuditAdvertiserResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to audit.

• read_mask (String) (defaults to: nil) —

  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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AuditAdvertiserResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AuditAdvertiserResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 84

def audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}:audit', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AuditAdvertiserResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AuditAdvertiserResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, ad_group_ids: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line items belongs to.

• ad_group_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

  Required. The IDs of the ad groups to list assigned targeting options for.

• filter (String) (defaults to: nil) —

  Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or TARGETING_TYPE_YOUTUBE_CHANNEL: targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType=" TARGETING_TYPE_YOUTUBE_CHANNEL" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the list. Acceptable values are: * adGroupId (default) * assignedTargetingOption.targetingType 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.

• page_size (Fixnum) (defaults to: nil) —

  Optional. 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.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 530

def bulk_advertiser_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, ad_group_ids: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkListAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['adGroupIds'] = ad_group_ids unless ad_group_ids.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditSitesResponse

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:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the sites belong.

• bulk_edit_sites_request_object (Google::Apis::DisplayvideoV3::BulkEditSitesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1414

def bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_line_item_list_assigned_targeting_options(advertiser_id, filter: nil, line_item_ids: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse

Lists assigned targeting options for multiple line items across targeting types.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line items belongs to.

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR on the same field. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType * inheritance Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL: targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" TARGETING_TYPE_CHANNEL" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• line_item_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

  Required. The IDs of the line items to list assigned targeting options for.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * lineItemId ( default) * assignedTargetingOption.targetingType 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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2565

def bulk_advertiser_line_item_list_assigned_targeting_options(advertiser_id, filter: nil, line_item_ids: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkListAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['lineItemIds'] = line_item_ids unless line_item_ids.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse

Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest. deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest. created_assigned_inventory_sources.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to which the assignments are assigned.

• bulk_edit_assigned_inventory_sources_request_object (Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5796

def bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesRequest::Representation
  command.request_object = bulk_edit_assigned_inventory_sources_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditAssignedInventorySourcesResponse
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location list belongs.

• location_list_id (Fixnum) —

  Required. The ID of the location list to which these assignments are assigned.

• bulk_edit_assigned_locations_request_object (Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3406

def bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsRequest::Representation
  command.request_object = bulk_edit_assigned_locations_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditAssignedLocationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse

Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest. createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• user_id (Fixnum) —

  Required. The ID of the user to which the assigned user roles belong.

• bulk_edit_assigned_user_roles_request_object (Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7215

def bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/users/{+userId}:bulkEditAssignedUserRoles', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesRequest::Representation
  command.request_object = bulk_edit_assigned_user_roles_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditAssignedUserRolesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the parent negative keyword list to which the negative keywords belong.

• bulk_edit_negative_keywords_request_object (Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3768

def bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsRequest::Representation
  command.request_object = bulk_edit_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_line_item_edit_assigned_targeting_options(advertiser_id, bulk_edit_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest. create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions. delete YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line items belong to.

• bulk_edit_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2501

def bulk_line_item_edit_assigned_targeting_options(advertiser_id, bulk_edit_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditSitesResponse

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:

• partner_id (Fixnum) —

  The ID of the partner that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the sites belong.

• bulk_edit_sites_request_object (Google::Apis::DisplayvideoV3::BulkEditSitesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6585

def bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_update_line_items(advertiser_id, bulk_update_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions. create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this line item belongs to.

• bulk_update_line_items_request_object (Google::Apis::DisplayvideoV3::BulkUpdateLineItemsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2605

def bulk_update_line_items(advertiser_id, bulk_update_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems:bulkUpdate', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkUpdateLineItemsRequest::Representation
  command.request_object = bulk_update_line_items_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkUpdateLineItemsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

Creates a new advertiser. Returns the newly created advertiser if successful. * This method regularly experiences high latency.* We recommend increasing your default timeout to avoid errors.

Parameters:

• advertiser_object (Google::Apis::DisplayvideoV3::Advertiser) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Advertiser) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Advertiser)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 117

def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV3::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Advertiser
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

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

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the campaign belongs to.

• campaign_object (Google::Apis::DisplayvideoV3::Campaign) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Campaign) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Campaign)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 829

def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/campaigns', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV3::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

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

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the created channel.

• channel_object (Google::Apis::DisplayvideoV3::Channel) (defaults to: nil)
• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the created channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1238

def create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Site

Creates a site in a channel.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel in which the site will be created.

• site_object (Google::Apis::DisplayvideoV3::Site) (defaults to: nil)
• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Site) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Site)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1452

def create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV3::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Site
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

Creates a new creative. Returns the newly created creative if successful. A " Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the creative belongs to.

• creative_object (Google::Apis::DisplayvideoV3::Creative) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Creative) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Creative)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1631

def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/creatives', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV3::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

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

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the insertion order belongs to.

• insertion_order_object (Google::Apis::DisplayvideoV3::InsertionOrder) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InsertionOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InsertionOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1860

def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/insertionOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV3::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

• TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order the assigned targeting option will belong to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

  • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY
• assigned_targeting_option_object (Google::Apis::DisplayvideoV3::AssignedTargetingOption) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2159

def create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the line item belongs to.

• line_item_object (Google::Apis::DisplayvideoV3::LineItem) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LineItem) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LineItem)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2639

def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems', options)
  command.request_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

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: * lineItems. bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item the assigned targeting option will belong to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
• assigned_targeting_option_object (Google::Apis::DisplayvideoV3::AssignedTargetingOption) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2969

def create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location list belongs.

• location_list_object (Google::Apis::DisplayvideoV3::LocationList) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LocationList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LocationList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3236

def create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/locationLists', options)
  command.request_representation = Google::Apis::DisplayvideoV3::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV3::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedLocation

Creates an assignment between a location and a location list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location list belongs.

• location_list_id (Fixnum) —

  Required. The ID of the location list for which the assignment will be created.

• assigned_location_object (Google::Apis::DisplayvideoV3::AssignedLocation) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedLocation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedLocation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3442

def create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedLocation::Representation
  command.request_object = assigned_location_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedLocation::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedLocation
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the negative keyword list will belong.

• negative_keyword_list_object (Google::Apis::DisplayvideoV3::NegativeKeywordList) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::NegativeKeywordList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::NegativeKeywordList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3573

def create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.request_representation = Google::Apis::DisplayvideoV3::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV3::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeyword

Creates a negative keyword in a negative keyword list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the parent negative keyword list in which the negative keyword will be created.

• negative_keyword_object (Google::Apis::DisplayvideoV3::NegativeKeyword) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::NegativeKeyword) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::NegativeKeyword)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3806

def create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.request_representation = Google::Apis::DisplayvideoV3::NegativeKeyword::Representation
  command.request_object = negative_keyword_object
  command.response_representation = Google::Apis::DisplayvideoV3::NegativeKeyword::Representation
  command.response_class = Google::Apis::DisplayvideoV3::NegativeKeyword
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser.

• targeting_type (String) —

  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 * TARGETING_TYPE_KEYWORD

• assigned_targeting_option_object (Google::Apis::DisplayvideoV3::AssignedTargetingOption) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3986

def create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

Parameters:

• custom_bidding_algorithm_object (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4260

def create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/customBiddingAlgorithms', options)
  command.request_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules

Creates a new rules resource. Returns the newly created rules resource if successful.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm that owns the rules resource.

• custom_bidding_algorithm_rules_object (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4518

def create_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules', options)
  command.request_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules::Representation
  command.request_object = custom_bidding_algorithm_rules_object
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScript

Creates a new custom bidding script. Returns the newly created script if successful.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm that owns the script.

• custom_bidding_script_object (Google::Apis::DisplayvideoV3::CustomBiddingScript) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingScript) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingScript)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4651

def create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.request_representation = Google::Apis::DisplayvideoV3::CustomBiddingScript::Representation
  command.request_object = custom_bidding_script_object
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingScript
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_first_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

• first_and_third_party_audience_object (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4872

def create_first_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/firstAndThirdPartyAudiences', options)
  command.request_representation = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience::Representation
  command.request_object = first_and_third_party_audience_object
  command.response_representation = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

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

Parameters:

• guaranteed_order_object (Google::Apis::DisplayvideoV3::GuaranteedOrder) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that the request is being made within.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that the request is being made within.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GuaranteedOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GuaranteedOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5350

def create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/guaranteedOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV3::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV3::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GuaranteedOrder
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

Creates a new inventory source. Returns the newly created inventory source if successful.

Parameters:

• inventory_source_object (Google::Apis::DisplayvideoV3::InventorySource) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that the request is being made within.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that the request is being made within.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySource) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySource)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5985

def create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/inventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySource
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

Creates a new inventory source group. Returns the newly created inventory source group if successful.

Parameters:

• inventory_source_group_object (Google::Apis::DisplayvideoV3::InventorySourceGroup) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySourceGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySourceGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5571

def create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/inventorySourceGroups', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySourceGroup
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedInventorySource

Creates an assignment between an inventory source and an inventory source group.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to which the assignment will be assigned.

• assigned_inventory_source_object (Google::Apis::DisplayvideoV3::AssignedInventorySource) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedInventorySource) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedInventorySource)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5837

def create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedInventorySource::Representation
  command.request_object = assigned_inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedInventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedInventorySource
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

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

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the created channel.

• channel_object (Google::Apis::DisplayvideoV3::Channel) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the created channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6409

def create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{+partnerId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Site

Creates a site in a channel.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel in which the site will be created.

• site_object (Google::Apis::DisplayvideoV3::Site) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Site) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Site)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6623

def create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{partnerId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV3::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Site
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

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

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

• assigned_targeting_option_object (Google::Apis::DisplayvideoV3::AssignedTargetingOption) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6804

def create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Operation

Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

Parameters:

• create_sdf_download_task_request_object (Google::Apis::DisplayvideoV3::CreateSdfDownloadTaskRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6979

def create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/sdfdownloadtasks', options)
  command.request_representation = Google::Apis::DisplayvideoV3::CreateSdfDownloadTaskRequest::Representation
  command.request_object = create_sdf_download_task_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user(user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• user_object (Google::Apis::DisplayvideoV3::User) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::User) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::User)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7250

def create_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/users', options)
  command.request_representation = Google::Apis::DisplayvideoV3::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV3::User::Representation
  command.response_class = Google::Apis::DisplayvideoV3::User
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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:

• advertiser_id (Fixnum) —

  The ID of the advertiser we need to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 150

def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser this campaign belongs to.

• campaign_id (Fixnum) —

  The ID of the campaign we need to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 868

def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes a site from a channel.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the site belongs.

• url_or_app_id (String) —

  Required. The URL or app ID of the site to delete.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1492

def delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser this creative belongs to.

• creative_id (Fixnum) —

  The ID of the creative to be deleted.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1669

def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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:

• advertiser_id (Fixnum) —

  The ID of the advertiser this insertion order belongs to.

• insertion_order_id (Fixnum) —

  The ID of the insertion order to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1896

def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes an assigned targeting option from an insertion order. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

• TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order the assigned targeting option belongs to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

  • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY
• assigned_targeting_option_id (String) —

  Required. The ID of the assigned targeting option to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2216

def delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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. YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser this line item belongs to.

• line_item_id (Fixnum) —

  The ID of the line item to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2676

def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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: * lineItems.bulkEditAssignedTargetingOptions * lineItems. bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item the assigned targeting option belongs to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
• assigned_targeting_option_id (String) —

  Required. The ID of the assigned targeting option to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3038

def delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes the assignment between a location and a location list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location list belongs.

• location_list_id (Fixnum) —

  Required. The ID of the location list to which this assignment is assigned.

• assigned_location_id (Fixnum) —

  Required. The ID of the assigned location to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3479

def delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.params['assignedLocationId'] = assigned_location_id unless assigned_location_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the negative keyword list to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3609

def delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes a negative keyword from a negative keyword list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the parent negative keyword list to which the negative keyword belongs.

• keyword_value (String) —

  Required. The keyword value of the negative keyword to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3845

def delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.params['keywordValue'] = keyword_value unless keyword_value.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes an assigned targeting option from an advertiser.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser.

• targeting_type (String) —

  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 * TARGETING_TYPE_KEYWORD

• assigned_targeting_option_id (String) —

  Required. The ID of the assigned targeting option to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4026

def delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes an inventory source group.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to delete.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5610

def delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes the assignment between an inventory source and an inventory source group.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to which this assignment is assigned.

• assigned_inventory_source_id (Fixnum) —

  Required. The ID of the assigned inventory source to delete.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5881

def delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.params['assignedInventorySourceId'] = assigned_inventory_source_id unless assigned_inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes a site from a channel.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the site belongs.

• url_or_app_id (String) —

  Required. The URL or app ID of the site to delete.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6663

def delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes an assigned targeting option from a partner.

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

• assigned_targeting_option_id (String) —

  Required. The ID of the assigned targeting option to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6842

def delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Empty

Deletes a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• user_id (Fixnum) —

  Required. The ID of the user to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7284

def delete_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Empty
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleBytestreamMedia

Downloads media. Download is supported on the URI /download/resource_name= ?alt=media. **Note: Download requests will not be successful without including alt=media query string.

Parameters:

• resource_name (String) —

  Name of the media that is being downloaded. See ReadRequest.resource_name.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• download_dest (IO, String) (defaults to: nil) —

  IO stream or filename to receive content download

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GoogleBytestreamMedia) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GoogleBytestreamMedia)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6204

def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'download/{+resourceName}', options)
  else
    command = make_download_command(:get, 'download/{+resourceName}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DisplayvideoV3::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GoogleBytestreamMedia
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#duplicate_line_item(advertiser_id, line_item_id, duplicate_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::DuplicateLineItemResponse

Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. ** This method regularly experiences high latency.** We recommend increasing your default timeout to avoid errors.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item to duplicate.

• duplicate_line_item_request_object (Google::Apis::DisplayvideoV3::DuplicateLineItemRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::DuplicateLineItemResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::DuplicateLineItemResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2714

def duplicate_line_item(advertiser_id, line_item_id, duplicate_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate', options)
  command.request_representation = Google::Apis::DisplayvideoV3::DuplicateLineItemRequest::Representation
  command.request_object = duplicate_line_item_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::DuplicateLineItemResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::DuplicateLineItemResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser.

• bulk_edit_advertiser_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 185

def edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_first_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse

Updates the member list of a Customer Match audience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

• first_and_third_party_audience_id (Fixnum) —

  Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.

• edit_customer_match_members_request_object (Google::Apis::DisplayvideoV3::EditCustomerMatchMembersRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4908

def edit_first_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers', options)
  command.request_representation = Google::Apis::DisplayvideoV3::EditCustomerMatchMembersRequest::Representation
  command.request_object = edit_customer_match_members_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::EditCustomerMatchMembersResponse
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse

Edits read advertisers of a guaranteed order.

Parameters:

• guaranteed_order_id (String) —

  Required. The ID of the guaranteed order to edit. The ID is of the format exchange`-`legacy_guaranteed_order_id

• edit_guaranteed_order_read_accessors_request_object (Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5385

def edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsRequest::Representation
  command.request_object = edit_guaranteed_order_read_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::EditGuaranteedOrderReadAccessorsResponse
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceAccessors

Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.

Parameters:

• inventory_source_id (Fixnum) —

  Required. The ID of inventory source to update.

• edit_inventory_source_read_write_accessors_request_object (Google::Apis::DisplayvideoV3::EditInventorySourceReadWriteAccessorsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySourceAccessors) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySourceAccessors)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6020

def edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV3::EditInventorySourceReadWriteAccessorsRequest::Representation
  command.request_object = edit_inventory_source_read_write_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySourceAccessors::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySourceAccessors
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse

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

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner.

• bulk_edit_partner_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6289

def edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{+partnerId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkEditPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

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 YouTube & Partners line items cannot be created or updated using the API.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this line item belongs to.

• generate_default_line_item_request_object (Google::Apis::DisplayvideoV3::GenerateDefaultLineItemRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LineItem) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LineItem)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2753

def generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/lineItems:generateDefault', options)
  command.request_representation = Google::Apis::DisplayvideoV3::GenerateDefaultLineItemRequest::Representation
  command.request_object = generate_default_line_item_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

Gets an advertiser.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Advertiser) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Advertiser)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 217

def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AdGroup

Gets an ad group.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this ad group belongs to.

• ad_group_id (Fixnum) —

  Required. The ID of the ad group to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AdGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AdGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 567

def get_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AdGroupAd

Gets an ad group ad.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this ad group ad belongs to.

• ad_group_ad_id (Fixnum) —

  Required. The ID of the ad group ad to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AdGroupAd) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AdGroupAd)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 409

def get_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupAdId'] = ad_group_ad_id unless ad_group_ad_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the ad group belongs to.

• ad_group_id (Fixnum) —

  Required. The ID of the ad group the assigned targeting option belongs to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

• assigned_targeting_option_id (String) —

  Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 675

def get_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

Gets a campaign.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this campaign belongs to.

• campaign_id (Fixnum) —

  Required. The ID of the campaign to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Campaign) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Campaign)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 901

def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to a campaign.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the campaign belongs to.

• campaign_id (Fixnum) —

  Required. The ID of the campaign the assigned targeting option belongs to.

• targeting_type (String) —

  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 (String) —

  Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1122

def get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

Gets a channel for a partner or advertiser.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the fetched channel.

• channel_id (Fixnum) —

  Required. The ID of the channel to fetch.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the fetched channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1275

def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

Gets a creative.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this creative belongs to.

• creative_id (Fixnum) —

  Required. The ID of the creative to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Creative) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Creative)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1702

def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InsertionOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InsertionOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1930

def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to an insertion order.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order the assigned targeting option belongs to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
• assigned_targeting_option_id (String) —

  Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2282

def get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

Gets a line item.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LineItem) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LineItem)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2787

def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to a line item.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item the assigned targeting option belongs to.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_YOUTUBE_CHANNEL (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items) * TARGETING_TYPE_YOUTUBE_VIDEO (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items)
• assigned_targeting_option_id (String) —

  Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3106

def get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

Gets a location list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the fetched location list belongs.

• location_list_id (Fixnum) —

  Required. The ID of the location list to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LocationList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LocationList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3271

def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the negative keyword list to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::NegativeKeywordList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::NegativeKeywordList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3644

def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to an advertiser.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser.

• targeting_type (String) —

  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 * TARGETING_TYPE_YOUTUBE_VIDEO * TARGETING_TYPE_YOUTUBE_CHANNEL

• assigned_targeting_option_id (String) —

  Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4067

def get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CombinedAudience

Gets a combined audience.

Parameters:

• combined_audience_id (Fixnum) —

  Required. The ID of the combined audience to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched combined audience.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched combined audience.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CombinedAudience) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CombinedAudience)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4168

def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/combinedAudiences/{+combinedAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CombinedAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CombinedAudience
  command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

Gets a custom bidding algorithm.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 partner that has access to the custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 partner that has access to the custom bidding algorithm.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4295

def get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules

Retrieves a rules resource.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm that owns the rules resource.

• custom_bidding_algorithm_rules_id (Fixnum) —

  Required. The ID of the rules resource to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4558

def get_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.params['customBiddingAlgorithmRulesId'] = custom_bidding_algorithm_rules_id unless custom_bidding_algorithm_rules_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScript

Gets a custom bidding script.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm owns the script.

• custom_bidding_script_id (Fixnum) —

  Required. The ID of the custom bidding script to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingScript) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingScript)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4692

def get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingScript
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.params['customBiddingScriptId'] = custom_bidding_script_id unless custom_bidding_script_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomList

Gets a custom list.

Parameters:

• custom_list_id (Fixnum) —

  Required. The ID of the custom list to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 advertiser that has access to the fetched custom lists.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4781

def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customLists/{+customListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomList
  command.params['customListId'] = custom_list_id unless custom_list_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

Gets a first and third party audience.

Parameters:

• first_and_third_party_audience_id (Fixnum) —

  Required. The ID of the first and third party audience to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched first and third party audience.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched first and third party audience.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4946

def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightGroup

Gets a Floodlight group.

Parameters:

• floodlight_group_id (Fixnum) —

  Required. The ID of the Floodlight group to fetch.

• partner_id (Fixnum) (defaults to: nil) —

  Required. The partner context by which the Floodlight group is being accessed.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FloodlightGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FloodlightGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5089

def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/floodlightGroups/{+floodlightGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightActivity

Gets a Floodlight activity.

Parameters:

• floodlight_group_id (Fixnum) —

  Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.

• floodlight_activity_id (Fixnum) —

  Required. The ID of the Floodlight activity to fetch.

• partner_id (Fixnum) (defaults to: nil) —

  Required. The ID of the partner through which the Floodlight activity is being accessed.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FloodlightActivity) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FloodlightActivity)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5166

def get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::FloodlightActivity::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FloodlightActivity
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.params['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleAudience

Gets a Google audience.

Parameters:

• google_audience_id (Fixnum) —

  Required. The ID of the Google audience to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched Google audience.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched Google audience.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GoogleAudience) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GoogleAudience)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5254

def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/googleAudiences/{+googleAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::GoogleAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GoogleAudience
  command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

Gets a guaranteed order.

Parameters:

• guaranteed_order_id (String) —

  Required. The ID of the guaranteed order to fetch. The ID is of the format exchange`-`legacy_guaranteed_order_id

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the guaranteed order.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the guaranteed order.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GuaranteedOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GuaranteedOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5422

def get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/guaranteedOrders/{+guaranteedOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_source(inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

Gets an inventory source.

Parameters:

• inventory_source_id (Fixnum) —

  Required. The ID of the inventory source to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.

• partner_id (Fixnum) (defaults to: nil) —

  Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySource) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySource)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6059

def get_inventory_source(inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/inventorySources/{+inventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySource
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

Gets an inventory source group.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySourceGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySourceGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5649

def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySourceGroup
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner(partner_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Partner

Gets a partner.

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Partner) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Partner)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6321

def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Partner::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Partner
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

Gets a channel for a partner or advertiser.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the fetched channel.

• channel_id (Fixnum) —

  Required. The ID of the channel to fetch.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the fetched channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6446

def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::AssignedTargetingOption

Gets a single targeting option assigned to a partner.

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner.

• targeting_type (String) —

  Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

• assigned_targeting_option_id (String) —

  Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::AssignedTargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::AssignedTargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6880

def get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::AssignedTargetingOption
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Operation

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Parameters:

• name (String) —

  The name of the operation resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7011

def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::TargetingOption

Gets a single targeting option.

Parameters:

• targeting_type (String) —

  Required. The type of targeting option to retrieve. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

• targeting_option_id (String) —

  Required. The ID of the of targeting option to retrieve.

• advertiser_id (Fixnum) (defaults to: nil) —

  Required. The Advertiser this request is being made in the context of.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::TargetingOption) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::TargetingOption)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7060

def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::TargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV3::TargetingOption
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

Gets a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• user_id (Fixnum) —

  Required. The ID of the user to fetch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::User) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::User)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7317

def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV3::User::Representation
  command.response_class = Google::Apis::DisplayvideoV3::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse

Lists ad group ads.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the ad groups belongs to.

• filter (String) (defaults to: nil) —

  Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND . * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * adGroupId * displayName * entityStatus * adGroupAdId Examples: * All ad group ads under an ad group: adGroupId="1234" * All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: ( entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAds method. If not specified, the first page of results will be returned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 467

def list_advertiser_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroupAds', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAdGroupAdsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_group_targeting_type_assigned_targeting_options(advertiser_id, ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse

Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the ad group belongs to.

• ad_group_id (Fixnum) —

  Required. The ID of the ad group to list assigned targeting options for.

• targeting_type (String) —

  Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

• filter (String) (defaults to: nil) —

  Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Optional. 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.

• page_size (Fixnum) (defaults to: nil) —

  Optional. 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.

• page_token (String) (defaults to: nil) —

  Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAssignedTargetingOptions method. If not specified, the first page of results will be returned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 744

def list_advertiser_ad_group_targeting_type_assigned_targeting_options(advertiser_id, ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdGroupsResponse

Lists ad groups.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the ad groups belongs to.

• filter (String) (defaults to: nil) —

  Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND . * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported properties: * adGroupId * displayName * entityStatus * lineItemId * adGroupFormat Examples: * All ad groups under an line item: lineItemId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroups method. If not specified, the first page of results will be returned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAdGroupsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAdGroupsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 626

def list_advertiser_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/adGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAdGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAdGroupsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse

Lists assigned targeting options of an advertiser across targeting types.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line item belongs to.

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 337

def list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse

Lists assigned targeting options of a campaign across targeting types.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the campaign belongs to.

• campaign_id (Fixnum) —

  Required. The ID of the campaign to list assigned targeting options for.

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType * inheritance Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER: targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1029

def list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkListCampaignAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the campaign belongs to.

• campaign_id (Fixnum) —

  Required. The ID of the campaign to list assigned targeting options for.

• targeting_type (String) —

  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
• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId * inheritance Examples: * AssignedTargetingOption resources with ID 1 or 2 assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1199

def list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCampaignAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCampaignsResponse

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:

• advertiser_id (Fixnum) —

  The ID of the advertiser to list campaigns for.

• filter (String) (defaults to: nil) —

  Allows filtering by campaign 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 updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCampaignsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCampaignsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 965

def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/campaigns', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCampaignsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCampaignsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListSitesResponse

Lists sites in a channel.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the requested sites belong.

• filter (String) (defaults to: nil) —

  Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent channel.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1552

def list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the channels.

• filter (String) (defaults to: nil) —

  Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the channels.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListChannelsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListChannelsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1332

def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListChannelsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCreativesResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to list creatives for.

• filter (String) (defaults to: nil) —

  Allows filtering by creative 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 lineItemIds field must use the HAS (:) operator. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. * For entityStatus, minDuration, maxDuration, updateTime, and dynamic fields, there may be at most one restriction. Supported Fields: * approvalStatus * creativeId * creativeType * dimensions (input in the form of width`x`height) * dynamic * entityStatus * exchangeReviewStatus (input in the form of exchange`-`reviewStatus) * lineItemIds * maxDuration (input in the form of duration`s`. Only seconds are supported) * `minDuration` (input in the form ofdurations. Only seconds are supported) * updateTime (input in ISO 8601 format, or YYYY-MM- DDTHH:MM:SSZ) Notes: * For updateTime, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). 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 * All creatives 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCreativesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCreativesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1783

def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/creatives', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCreativesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCreativesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse

Lists assigned targeting options of an insertion order across targeting types.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order to list assigned targeting options for.

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType * inheritance Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL: targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" TARGETING_TYPE_CHANNEL" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2061

def list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::BulkListInsertionOrderAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse

Lists the targeting options assigned to an insertion order.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Required. The ID of the insertion order to list assigned targeting options for.

• targeting_type (String) —

  Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId * inheritance Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2371

def list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListInsertionOrderAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to list insertion orders for.

• filter (String) (defaults to: nil) —

  Allows filtering by insertion order 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 updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * 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 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1996

def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/insertionOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListInsertionOrdersResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInvoicesResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to list invoices for.

• issue_month (String) (defaults to: nil) —

  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.

• loi_sapin_invoice_type (String) (defaults to: nil) —

  Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListInvoicesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListInvoicesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2424

def list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/invoices', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListInvoicesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListInvoicesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['issueMonth'] = issue_month unless issue_month.nil?
  command.query['loiSapinInvoiceType'] = loi_sapin_invoice_type unless loi_sapin_invoice_type.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse

Lists the targeting options assigned to a line item.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser the line item belongs to.

• line_item_id (Fixnum) —

  Required. The ID of the line item to list assigned targeting options for.

• targeting_type (String) —

  Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

  • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * 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_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_YOUTUBE_CHANNEL (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items) * TARGETING_TYPE_YOUTUBE_VIDEO (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items)
• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId * inheritance Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" * AssignedTargetingOption resources 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3198

def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListLineItemAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLineItemsResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to list line items for.

• filter (String) (defaults to: nil) —

  Allows filtering by line item 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 updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * insertionOrderId * lineItemId * lineItemType * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) 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 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" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListLineItemsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListLineItemsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2854

def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/lineItems', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListLineItemsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse

Lists locations assigned to a location list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location list belongs.

• location_list_id (Fixnum) —

  Required. The ID of the location list to which these assignments are assigned.

• filter (String) (defaults to: nil) —

  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 OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedLocationId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3535

def list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAssignedLocationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListLocationListsResponse

Lists location lists based on a given advertiser id.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the fetched location lists belong.

• filter (String) (defaults to: nil) —

  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. * All fields must use the EQUALS (=) operator. Supported fields: * locationType Examples: * All regional location list: locationType=" TARGETING_LOCATION_TYPE_REGIONAL" * All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListLocationListsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListLocationListsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3327

def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/locationLists', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListLocationListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListLocationListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse

Lists negative keywords in a negative keyword list.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the parent negative keyword list to which the requested negative keywords belong.

• filter (String) (defaults to: nil) —

  Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * keywordValue Examples: * All negative keywords for which the keyword value contains "google": keywordValue : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3904

def list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse

Lists negative keyword lists based on a given advertiser id.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3684

def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListNegativeKeywordListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse

Lists the targeting options assigned to an advertiser.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser.

• targeting_type (String) —

  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 * TARGETING_TYPE_YOUTUBE_VIDEO * TARGETING_TYPE_YOUTUBE_CHANNEL

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption with ID 123456: assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4129

def list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAdvertisersResponse

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:

• filter (String) (defaults to: nil) —

  Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. * A restriction has the form of field` ` operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. 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. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

  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.

• partner_id (Fixnum) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAdvertisersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAdvertisersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 279

def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAdvertisersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAdvertisersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse

Lists combined audiences. The order is defined by the order_by parameter.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched combined audiences.

• filter (String) (defaults to: nil) —

  Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * combinedAudienceId (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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched combined audiences.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4225

def list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/combinedAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCombinedAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse

Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm that owns the rules resource.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * createTime desc ( default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4609

def list_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmRulesResponse
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm owns the script.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * createTime desc ( default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4744

def list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCustomBiddingScriptsResponse
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 advertiser that has access to the custom bidding algorithm.

• filter (String) (defaults to: nil) —

  Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The customBiddingAlgorithmType field must use the EQUALS (=) operator. * The displayName field must use the HAS (:) operator. Supported fields: * customBiddingAlgorithmType * displayName Examples: * All custom bidding algorithms for which the display name contains "politics": displayName:" politics". * All custom bidding algorithms for which the type is " SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName ( 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: displayName desc.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 partner that has access to the custom bidding algorithm.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4359

def list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCustomBiddingAlgorithmsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListCustomListsResponse

Lists custom lists. The order is defined by the order_by parameter.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the DV360 advertiser that has access to the fetched custom lists.

• filter (String) (defaults to: nil) —

  Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All custom lists for which the display name contains "Google": displayName:"Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * customListId ( 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListCustomListsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListCustomListsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4835

def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customLists', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListCustomListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListCustomListsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse

Lists first and third party audiences. The order is defined by the order_by parameter.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched first and third party audiences.

• filter (String) (defaults to: nil) —

  Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of field` `operator` ` value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All first and third party audiences for which the display name contains "Google": displayName:"Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * firstAndThirdPartyAudienceId (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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched first and third party audiences.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5007

def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/firstAndThirdPartyAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListFirstAndThirdPartyAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse

Lists Floodlight activities in a Floodlight group.

Parameters:

• floodlight_group_id (Fixnum) —

  Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.

• order_by (String) (defaults to: nil) —

  Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * floodlightActivityId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFloodlightActivities method. If not specified, the first page of results will be returned.

• partner_id (Fixnum) (defaults to: nil) —

  Required. The ID of the partner through which the Floodlight activities are being accessed.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5216

def list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListFloodlightActivitiesResponse
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse

Lists Google audiences. The order is defined by the order_by parameter.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the fetched Google audiences.

• filter (String) (defaults to: nil) —

  Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All Google audiences for which the display name contains "Google": displayName:" Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * googleAudienceId ( 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the fetched Google audiences.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5311

def list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/googleAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListGoogleAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse

Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the guaranteed order.

• filter (String) (defaults to: nil) —

  Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * guaranteed_order_id * exchange * display_name * status.entityStatus Examples: * All active guaranteed orders: status.entityStatus="ENTITY_STATUS_ACTIVE" * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: exchange=" EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName ( default) 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the guaranteed order.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5485

def list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/guaranteedOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListGuaranteedOrdersResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse

Lists inventory sources assigned to an inventory source group.

Parameters:

• inventory_source_group_id (Fixnum) —

  Required. The ID of the inventory source group to which these assignments are assigned.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.

• filter (String) (defaults to: nil) —

  Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedInventorySourceId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * assignedInventorySourceId (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: assignedInventorySourceId desc.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5945

def list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListAssignedInventorySourcesResponse
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse

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

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

• filter (String) (defaults to: nil) —

  Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * inventorySourceGroupId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName ( default) * inventorySourceGroupId 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5708

def list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/inventorySourceGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListInventorySourceGroupsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListInventorySourcesResponse

Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that has access to the inventory source.

• filter (String) (defaults to: nil) —

  Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * All fields must use the EQUALS (=) operator. Supported fields: * status.entityStatus * commitment * deliveryMethod * rateDetails.rateType

  • exchange Examples: * All active inventory sources: status.entityStatus=" ENTITY_STATUS_ACTIVE" * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange=" EXCHANGE_RUBICON" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName ( default) 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

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

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that has access to the inventory source.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListInventorySourcesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListInventorySourcesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6122

def list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/inventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListInventorySourcesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListSitesResponse

Lists sites in a channel.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel to which the requested sites belong.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent channel.

• filter (String) (defaults to: nil) —

  Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  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.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6723

def list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the channels.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the channels.

• filter (String) (defaults to: nil) —

  Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListChannelsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListChannelsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6503

def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListChannelsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse

Lists the targeting options assigned to a partner.

Parameters:

• partner_id (Fixnum) —

  Required. The ID of the partner.

• targeting_type (String) —

  Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL

• filter (String) (defaults to: nil) —

  Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resource with ID 123456: assignedTargetingOptionId=" 123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

  A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartnerAssignedTargetingOptions method. If not specified, the first page of results will be returned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6939

def list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListPartnersResponse

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

Parameters:

• filter (String) (defaults to: nil) —

  Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * entityStatus Examples: * All active partners: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

  A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartners method. If not specified, the first page of results will be returned.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListPartnersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListPartnersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6373

def list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/partners', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListPartnersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListPartnersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse

Lists targeting options of a given type.

Parameters:

• targeting_type (String) —

  Required. The type of targeting option to be listed. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

• advertiser_id (Fixnum) (defaults to: nil) —

  Required. The Advertiser this request is being made in the context of.

• filter (String) (defaults to: nil) —

  Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by OR logical operators. * A restriction has the form of field` ` operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * carrierAndIspDetails.type * geoRegionDetails.geoRegionType * targetingOptionId Examples: * All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails. geoRegionType="GEO_REGION_TYPE_STATE" * All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * targetingOptionId ( 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: targetingOptionId desc.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7138

def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/targetingTypes/{+targetingType}/targetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ListUsersResponse

Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• filter (String) (defaults to: nil) —

  Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator AND. * A restriction has the form of field` `operator` ` value. * The displayName and email fields must use the HAS (:) operator. * The lastLoginTime field must use either the LESS THAN OR EQUAL TO (<=) or GREATER THAN OR EQUAL TO (>=) operator. * All other fields must use the EQUALS (=) operator. Supported fields: * assignedUserRole. advertiserId * assignedUserRole.entityType: This is synthetic field of AssignedUserRole used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are Partner and Advertiser. * assignedUserRole.parentPartnerId: This is a synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * assignedUserRole.partnerId * assignedUserRole.userRole * displayName * email * lastLoginTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * The user with displayName containing "foo": displayName:"foo" * The user with email containing "bar": email:"bar" * All users with standard user roles: assignedUserRole.userRole="STANDARD" * All users with user roles for partner 123: assignedUserRole.partnerId="123" * All users with user roles for advertiser 123: assignedUserRole.advertiserId="123" * All users with partner level user roles: entityType="PARTNER" * All users with user roles for partner 123 and advertisers under partner 123: parentPartnerId="123" * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601) : lastLoginTime>="2023-01-01T00:00:00Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

• order_by (String) (defaults to: nil) —

  Field by which to sort the list. Acceptable values are: * displayName ( default) 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.

• page_size (Fixnum) (defaults to: nil) —

  Requested page size. Must be between 1 and 200. If unspecified will default to 100.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ListUsersResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ListUsersResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7390

def list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/users', options)
  command.response_representation = Google::Apis::DisplayvideoV3::ListUsersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ListUsersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser to lookup currency for.

• invoice_month (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2461

def lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency', options)
  command.response_representation = Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LookupInvoiceCurrencyResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['invoiceMonth'] = invoice_month unless invoice_month.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Advertiser

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

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser. Assigned by the system.

• advertiser_object (Google::Apis::DisplayvideoV3::Advertiser) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Advertiser) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Advertiser)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 374

def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV3::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Campaign

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

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the campaign belongs to.

• campaign_id (Fixnum) —

  Output only. The unique ID of the campaign. Assigned by the system.

• campaign_object (Google::Apis::DisplayvideoV3::Campaign) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Campaign) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Campaign)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1069

def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV3::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the created channel.

• channel_id (Fixnum) —

  Output only. The unique ID of the channel. Assigned by the system.

• channel_object (Google::Apis::DisplayvideoV3::Channel) (defaults to: nil)
• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the created channel.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1374

def patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Creative

Updates an existing creative. Returns the updated creative if successful. A " Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the creative belongs to.

• creative_id (Fixnum) —

  Output only. The unique ID of the creative. Assigned by the system.

• creative_object (Google::Apis::DisplayvideoV3::Creative) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Creative) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Creative)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1824

def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV3::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InsertionOrder

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

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the insertion order belongs to.

• insertion_order_id (Fixnum) —

  Output only. The unique ID of the insertion order. Assigned by the system.

• insertion_order_object (Google::Apis::DisplayvideoV3::InsertionOrder) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InsertionOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InsertionOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2102

def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV3::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LineItem

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: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

• advertiser_id (Fixnum) —

  Output only. The unique ID of the advertiser the line item belongs to.

• line_item_id (Fixnum) —

  Output only. The unique ID of the line item. Assigned by the system.

• line_item_object (Google::Apis::DisplayvideoV3::LineItem) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LineItem) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LineItem)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 2900

def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV3::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::LocationList

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the location lists belongs.

• location_list_id (Fixnum) —

  Output only. The unique ID of the location list. Assigned by the system.

• location_list_object (Google::Apis::DisplayvideoV3::LocationList) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::LocationList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::LocationList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3366

def patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV3::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::NegativeKeywordList

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

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Output only. The unique ID of the negative keyword list. Assigned by the system.

• negative_keyword_list_object (Google::Apis::DisplayvideoV3::NegativeKeywordList) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::NegativeKeywordList) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::NegativeKeywordList)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3724

def patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV3::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV3::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

• custom_bidding_algorithm_object (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4399

def patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_first_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience

Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

• first_and_third_party_audience_id (Fixnum) —

  Output only. The unique ID of the first and third party audience. Assigned by the system.

• first_and_third_party_audience_object (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update. Updates are only supported for the following fields: * displayName * description * membershipDurationDays

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5053

def patch_first_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience::Representation
  command.request_object = first_and_third_party_audience_object
  command.response_representation = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::FloodlightGroup

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

Parameters:

• floodlight_group_id (Fixnum) —

  Output only. The unique ID of the Floodlight group. Assigned by the system.

• floodlight_group_object (Google::Apis::DisplayvideoV3::FloodlightGroup) (defaults to: nil)
• partner_id (Fixnum) (defaults to: nil) —

  Required. The partner context by which the Floodlight group is being accessed.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::FloodlightGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::FloodlightGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5126

def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/floodlightGroups/{floodlightGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::FloodlightGroup::Representation
  command.request_object = floodlight_group_object
  command.response_representation = Google::Apis::DisplayvideoV3::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GuaranteedOrder

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

Parameters:

• guaranteed_order_id (String) —

  Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format exchange`-`legacy_guaranteed_order_id.

• guaranteed_order_object (Google::Apis::DisplayvideoV3::GuaranteedOrder) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that the request is being made within.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that the request is being made within.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GuaranteedOrder) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GuaranteedOrder)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5529

def patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/guaranteedOrders/{+guaranteedOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV3::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySource

Updates an existing inventory source. Returns the updated inventory source if successful.

Parameters:

• inventory_source_id (Fixnum) —

  Output only. The unique ID of the inventory source. Assigned by the system.

• inventory_source_object (Google::Apis::DisplayvideoV3::InventorySource) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that the request is being made within.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that the request is being made within.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySource) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySource)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6165

def patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/inventorySources/{+inventorySourceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySource
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::InventorySourceGroup

Updates an inventory source group. Returns the updated inventory source group if successful.

Parameters:

• inventory_source_group_id (Fixnum) —

  Output only. The unique ID of the inventory source group. Assigned by the system.

• inventory_source_group_object (Google::Apis::DisplayvideoV3::InventorySourceGroup) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::InventorySourceGroup) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::InventorySourceGroup)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 5754

def patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/inventorySourceGroups/{inventorySourceGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV3::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV3::InventorySourceGroup
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the created channel.

• channel_id (Fixnum) —

  Output only. The unique ID of the channel. Assigned by the system.

• channel_object (Google::Apis::DisplayvideoV3::Channel) (defaults to: nil)
• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the created channel.

• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::Channel) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::Channel)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6545

def patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/partners/{+partnerId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV3::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV3::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::User

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

• user_id (Fixnum) —

  Output only. The unique ID of the user. Assigned by the system.

• user_object (Google::Apis::DisplayvideoV3::User) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The mask to control which fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::User) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::User)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7430

def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/users/{+userId}', options)
  command.request_representation = Google::Apis::DisplayvideoV3::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV3::User::Representation
  command.response_class = Google::Apis::DisplayvideoV3::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceSitesResponse

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

Parameters:

• advertiser_id (Fixnum) —

  The ID of the advertiser that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel whose sites will be replaced.

• replace_sites_request_object (Google::Apis::DisplayvideoV3::ReplaceSitesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ReplaceSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ReplaceSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 1595

def replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV3::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ReplaceSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse

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:

• advertiser_id (Fixnum) —

  Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

• negative_keyword_list_id (Fixnum) —

  Required. The ID of the parent negative keyword list to which the negative keywords belong.

• replace_negative_keywords_request_object (Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 3946

def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsRequest::Representation
  command.request_object = replace_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ReplaceNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::ReplaceSitesResponse

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

Parameters:

• partner_id (Fixnum) —

  The ID of the partner that owns the parent channel.

• channel_id (Fixnum) —

  Required. The ID of the parent channel whose sites will be replaced.

• replace_sites_request_object (Google::Apis::DisplayvideoV3::ReplaceSitesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::ReplaceSitesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::ReplaceSitesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6766

def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV3::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::ReplaceSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse

Searches for targeting options of a given type based on the given search terms.

Parameters:

• targeting_type (String) —

  Required. The type of targeting options to retrieve. Accepted values are: * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_POI * TARGETING_TYPE_BUSINESS_CHAIN

• search_targeting_options_request_object (Google::Apis::DisplayvideoV3::SearchTargetingOptionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 7176

def search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/targetingTypes/{+targetingType}/targetingOptions:search', options)
  command.request_representation = Google::Apis::DisplayvideoV3::SearchTargetingOptionsRequest::Representation
  command.request_object = search_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::SearchTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CreateAssetResponse

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. Must be used within the multipart media upload process. Examples using provided client libraries can be found in our Creating Creatives guide.

Parameters:

• advertiser_id (Fixnum) —

  Required. The ID of the advertiser this asset belongs to.

• create_asset_request_object (Google::Apis::DisplayvideoV3::CreateAssetRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• upload_source (IO, String) (defaults to: nil) —

  IO stream or filename containing content to upload

• content_type (String) (defaults to: nil) —

  Content type of the uploaded content.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CreateAssetResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CreateAssetResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 790

def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v3/advertisers/{+advertiserId}/assets', options)
  else
    command = make_upload_command(:post, 'v3/advertisers/{+advertiserId}/assets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV3::CreateAssetRequest::Representation
  command.request_object = create_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV3::CreateAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CreateAssetResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm that owns the rules resource.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4439

def upload_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScriptRef

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

Parameters:

• custom_bidding_algorithm_id (Fixnum) —

  Required. The ID of the custom bidding algorithm owns the script.

• advertiser_id (Fixnum) (defaults to: nil) —

  The ID of the advertiser that owns the parent custom bidding algorithm.

• partner_id (Fixnum) (defaults to: nil) —

  The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::CustomBiddingScriptRef) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::CustomBiddingScriptRef)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 4479

def upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript', options)
  command.response_representation = Google::Apis::DisplayvideoV3::CustomBiddingScriptRef::Representation
  command.response_class = Google::Apis::DisplayvideoV3::CustomBiddingScriptRef
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV3::GoogleBytestreamMedia

Uploads media. Upload is supported on the URI /upload/media/resource_name= ?upload_type=media. **Note: Upload requests will not be successful without including upload_type=media query string.

Parameters:

• resource_name (String) —

  Name of the media that is being downloaded. See ReadRequest.resource_name.

• google_bytestream_media_object (Google::Apis::DisplayvideoV3::GoogleBytestreamMedia) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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.

• upload_source (IO, String) (defaults to: nil) —

  IO stream or filename containing content to upload

• content_type (String) (defaults to: nil) —

  Content type of the uploaded content.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::DisplayvideoV3::GoogleBytestreamMedia) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::DisplayvideoV3::GoogleBytestreamMedia)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/displayvideo_v3/service.rb', line 6246

def upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'media/{+resourceName}', options)
  else
    command = make_upload_command(:post, 'media/{+resourceName}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV3::GoogleBytestreamMedia::Representation
  command.request_object = google_bytestream_media_object
  command.response_representation = Google::Apis::DisplayvideoV3::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV3::GoogleBytestreamMedia
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end