2020-02-28 00:38:47 +00:00
|
|
|
# Copyright 2015 Google Inc.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
require 'google/apis/core/base_service'
|
|
|
|
require 'google/apis/core/json_representation'
|
|
|
|
require 'google/apis/core/hashable'
|
|
|
|
require 'google/apis/errors'
|
|
|
|
|
|
|
|
module Google
|
|
|
|
module Apis
|
|
|
|
module DisplayvideoV1
|
|
|
|
# Display & Video 360 API
|
|
|
|
#
|
|
|
|
# Display & Video 360 API allows users to manage and create campaigns and
|
|
|
|
# reports.
|
|
|
|
#
|
|
|
|
# @example
|
|
|
|
# require 'google/apis/displayvideo_v1'
|
|
|
|
#
|
|
|
|
# Displayvideo = Google::Apis::DisplayvideoV1 # Alias the module
|
|
|
|
# service = Displayvideo::DisplayVideoService.new
|
|
|
|
#
|
|
|
|
# @see https://developers.google.com/display-video/
|
|
|
|
class DisplayVideoService < Google::Apis::Core::BaseService
|
|
|
|
# @return [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.
|
|
|
|
attr_accessor :key
|
|
|
|
|
|
|
|
# @return [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.
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
super('https://displayvideo.googleapis.com/', '')
|
|
|
|
@batch_path = 'batch'
|
|
|
|
end
|
|
|
|
|
2020-07-25 00:38:17 +00:00
|
|
|
# Audits an advertiser. Returns the counts of used entities per resource type
|
2020-08-08 00:38:23 +00:00
|
|
|
# under the advertiser provided. Used entities count towards their respective
|
|
|
|
# resource limit. See https://support.google.com/displayvideo/answer/6071450.
|
2020-07-25 00:38:17 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser to audit.
|
|
|
|
# @param [String] read_mask
|
|
|
|
# Optional. The specific fields to return. If no mask is specified, all fields
|
|
|
|
# in the response proto will be filled. Valid values are: * usedLineItemsCount *
|
2020-08-21 00:38:20 +00:00
|
|
|
# usedInsertionOrdersCount * usedCampaignsCount * channelsCount *
|
|
|
|
# negativelyTargetedChannelsCount * negativeKeywordListsCount *
|
|
|
|
# adGroupCriteriaCount * campaignCriteriaCount
|
2020-07-25 00:38:17 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AuditAdvertiserResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AuditAdvertiserResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}:audit', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AuditAdvertiserResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Bulk edits targeting options under a single advertiser. The operation will
|
|
|
|
# delete the assigned targeting options provided in
|
|
|
|
# BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then
|
|
|
|
# create the assigned targeting options provided in
|
2020-05-28 00:38:07 +00:00
|
|
|
# BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsRequest] bulk_edit_advertiser_assigned_targeting_options_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def bulk_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, 'v1/advertisers/{+advertiserId}:bulkEditAdvertiserAssignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
|
|
|
|
command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists assigned targeting options of an advertiser across targeting types.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`.. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `targetingType` Examples: * targetingType with value
|
|
|
|
# TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of
|
|
|
|
# this field should be no more than 500 characters.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def bulk_advertiser_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, 'v1/advertisers/{+advertiserId}:bulkListAdvertiserAssignedTargetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Creates a new advertiser. Returns the newly created advertiser if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# This method can take up to 180 seconds to complete.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
|
|
|
command.request_object = advertiser_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::Advertiser
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser we need to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets an advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by advertiser properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
2020-09-14 23:21:28 +00:00
|
|
|
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
|
|
# advertiserId` - `displayName` - `entityStatus` Examples: * All active
|
2020-08-21 00:38:20 +00:00
|
|
|
# advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` The length
|
|
|
|
# of this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
|
|
# default) * `entityStatus` The default sorting order is ascending. To specify
|
|
|
|
# descending order for a field, a suffix "desc" should be added to the field
|
|
|
|
# name. For example, `displayName desc`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner that the fetched advertisers should all belong
|
2020-07-21 00:38:15 +00:00
|
|
|
# to. The system only supports listing advertisers for one partner at a time.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertisersResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListAdvertisersResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertisersResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing advertiser. Returns the updated advertiser if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Advertiser]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
|
|
|
command.request_object = advertiser_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this asset belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [IO, String] upload_source
|
|
|
|
# IO stream or filename containing content to upload
|
|
|
|
# @param [String] content_type
|
|
|
|
# Content type of the uploaded content.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::CreateAssetResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::CreateAssetResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/assets', options)
|
|
|
|
else
|
|
|
|
command = make_upload_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
|
|
|
|
command.upload_source = upload_source
|
|
|
|
command.upload_content_type = content_type
|
|
|
|
end
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::CreateAssetRequest::Representation
|
|
|
|
command.request_object = create_asset_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::CreateAssetResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Creates a new campaign. Returns the newly created campaign if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/campaigns', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
|
|
|
command.request_object = campaign_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser this campaign belongs to.
|
|
|
|
# @param [Fixnum] campaign_id
|
|
|
|
# The ID of the campaign we need to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a campaign.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this campaign belongs to.
|
|
|
|
# @param [Fixnum] campaign_id
|
|
|
|
# Required. The ID of the campaign to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser to list campaigns for.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by campaign properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
|
|
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
2020-08-21 00:38:20 +00:00
|
|
|
# campaignId` - `displayName` - `entityStatus` Examples: * All `
|
|
|
|
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser:
|
|
|
|
# `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")`
|
|
|
|
# The length of this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListCampaignsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/campaigns', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing campaign. Returns the updated campaign if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
|
|
|
# @param [Fixnum] campaign_id
|
|
|
|
# Output only. The unique ID of the campaign. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Campaign]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
|
|
|
command.request_object = campaign_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-06-24 00:38:30 +00:00
|
|
|
# Creates a new channel. Returns the newly created channel if successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the created channel.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the created channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/channels', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.request_object = channel_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-05-07 20:07:42 +00:00
|
|
|
# Gets a channel for a partner or advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the fetched channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the channel to fetch.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the fetched channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists channels for a partner or advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the channels.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
|
|
# channel currently can only contain at most one * restriction. * A restriction
|
|
|
|
# has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
|
|
|
|
# (:)`. * Supported fields: - `displayName` Examples: * All channels for which
|
|
|
|
# the display name contains "google": `displayName : "google"`. The length of
|
|
|
|
# this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the channels.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/channels', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Updates a channel. Returns the updated channel if successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the created channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Output only. The unique ID of the channel. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the created channel.
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/channels/{channelId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.request_object = channel_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Bulk edits sites under a single channel. The operation will delete the sites
|
|
|
|
# provided in BulkEditSitesRequest.deleted_sites and then create the sites
|
2020-06-02 00:38:11 +00:00
|
|
|
# provided in BulkEditSitesRequest.created_sites.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the sites belong.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation
|
|
|
|
command.request_object = bulk_edit_sites_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Creates a site in a channel.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel in which the site will be created.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Site] site_object
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Site] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Site]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
|
|
command.request_object = site_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes a site from a channel.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the site belongs.
|
|
|
|
# @param [String] url_or_app_id
|
|
|
|
# Required. The URL or app ID of the site to delete.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists sites in a channel.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the requested sites belong.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
|
|
# site currently can only contain at most one * restriction. * A restriction has
|
|
|
|
# the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
|
|
|
|
# . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
|
|
|
|
# or app ID contains "google": `urlOrAppId : "google"`
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListSitesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListSitesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Creates a new creative. Returns the newly created creative if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Creative] creative_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Creative]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/creatives', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
|
|
|
command.request_object = creative_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser this creative belongs to.
|
|
|
|
# @param [Fixnum] creative_id
|
|
|
|
# The ID of the creative to be deleted.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a creative.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this creative belongs to.
|
|
|
|
# @param [Fixnum] creative_id
|
|
|
|
# Required. The ID of the creative to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Creative]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser to list creatives for.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by creative properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restriction for the
|
|
|
|
# same field must be combined by `OR`. * Restriction for different fields must
|
|
|
|
# be combined by `AND`. * Between `(` and `)` there can only be restrictions
|
|
|
|
# combined by `OR` for the same field. * A restriction has the form of ``field` `
|
|
|
|
# operator` `value``. * The operator must be `EQUALS (=)` for the following
|
|
|
|
# fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `
|
|
|
|
# maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `
|
|
|
|
# creativeId` * The operator must be `HAS (:)` for the following fields: - `
|
|
|
|
# lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic`
|
|
|
|
# there may be at most one restriction. * For `dimensions`, the value is in the
|
|
|
|
# form of `"`width`x`height`"`. * For `exchangeReviewStatus`, the value is in
|
|
|
|
# the form of ``exchange`-`reviewStatus``. * For `minDuration` and `maxDuration`,
|
|
|
|
# the value is in the form of `"`duration`s"`. Only seconds are supported with
|
|
|
|
# millisecond granularity. * There may be multiple `lineItemIds` restrictions in
|
|
|
|
# order to search against multiple possible line item IDs. * There may be
|
|
|
|
# multiple `creativeId` restrictions in order to search against multiple
|
|
|
|
# possible creative IDs. Examples: * All native creatives: `creativeType="
|
|
|
|
# CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100
|
|
|
|
# dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR
|
|
|
|
# dimensions="50x100")` * All dynamic creatives that are approved by AdX or
|
|
|
|
# AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND
|
|
|
|
# minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-
|
|
|
|
# REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-
|
|
|
|
# REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line
|
|
|
|
# item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR
|
|
|
|
# lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR
|
|
|
|
# creativeId=2` The length of this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCreativesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListCreativesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/creatives', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListCreativesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing creative. Returns the updated creative if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
|
|
|
# @param [Fixnum] creative_id
|
|
|
|
# Output only. The unique ID of the creative. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Creative] creative_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Creative]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
|
|
|
command.request_object = creative_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Creates a new insertion order. Returns the newly created insertion order if
|
|
|
|
# successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
|
|
|
command.request_object = insertion_order_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser this insertion order belongs to.
|
|
|
|
# @param [Fixnum] insertion_order_id
|
|
|
|
# The ID of the insertion order we need to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order
|
|
|
|
# does not exist.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this insertion order belongs to.
|
|
|
|
# @param [Fixnum] insertion_order_id
|
|
|
|
# Required. The ID of the insertion order to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser to list insertion orders for.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by insertion order properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
2020-08-21 00:38:20 +00:00
|
|
|
# value``. * The operator used on `budget.budget_segments.date_range.end_date`
|
|
|
|
# must be LESS THAN (<). * The operators used on all other fields must be `
|
|
|
|
# EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `
|
|
|
|
# entityStatus` - `budget.budget_segments.date_range.end_date` (input as YYYY-MM-
|
|
|
|
# DD) Examples: * All insertion orders under a campaign: `campaignId="1234"` *
|
|
|
|
# All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an
|
|
|
|
# advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
|
|
|
# ENTITY_STATUS_PAUSED")` * All insertion orders whose budget segments' dates
|
|
|
|
# end before March 28, 2019: `budget.budget_segments.date_range.end_date<"2019-
|
|
|
|
# 03-28"` The length of this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing insertion order. Returns the updated insertion order if
|
|
|
|
# successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the insertion order belongs to.
|
|
|
|
# @param [Fixnum] insertion_order_id
|
|
|
|
# Output only. The unique ID of the insertion order. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::InsertionOrder]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
|
|
|
command.request_object = insertion_order_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Bulk edits targeting options under a single line item. The operation will
|
|
|
|
# delete the assigned targeting options provided in
|
|
|
|
# BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then
|
|
|
|
# create the assigned targeting options provided in
|
2020-05-07 20:07:42 +00:00
|
|
|
# BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item the assigned targeting option will belong to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest] bulk_edit_line_item_assigned_targeting_options_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def bulk_edit_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest::Representation
|
|
|
|
command.request_object = bulk_edit_line_item_assigned_targeting_options_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse
|
|
|
|
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
|
|
|
|
|
|
|
|
# Lists assigned targeting options of a line item across targeting types.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item to list assigned targeting options for.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR` on the same field. * A restriction
|
|
|
|
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
|
|
|
# )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
|
|
|
|
# AssignedTargetingOptions of targeting type
|
|
|
|
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
|
|
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
|
|
# TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of
|
|
|
|
# NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR
|
|
|
|
# inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
|
|
|
# more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# A token that lets the client fetch the next page of results. Typically, this
|
|
|
|
# is the value of next_page_token returned from the previous call to `
|
|
|
|
# BulkListLineItemAssignedTargetingOptions` method. If not specified, the first
|
|
|
|
# page of results will be returned.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse
|
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
|
|
command.params['lineItemId'] = line_item_id unless line_item_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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Creates a new line item. Returns the newly created line item if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
|
|
|
command.request_object = line_item_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser this line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# The ID of the line item we need to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a line item.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser to list line items for.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by line item properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
2020-07-25 00:38:17 +00:00
|
|
|
# value``. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<
|
2020-10-08 00:39:03 +00:00
|
|
|
# ). * The operator used on `warningMessages` must be `HAS (:)`. * The operators
|
|
|
|
# used on all other fields must be `EQUALS (=)`. * Supported fields: - `
|
|
|
|
# campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `
|
|
|
|
# lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as
|
feat: Automated regeneration of displayvideo v1 client (#1342)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-10-31 02:19:30,572 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-displayvideo-v1
nothing to commit, working tree clean
2020-10-31 02:19:30,601 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.47.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.0512
Installing mime-types-data 3.2020.0512
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=displayvideo.v1 --names-out=/workspace/api_names_out.yaml
Loading displayvideo, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/displayvideo.v1.json
conflict google/apis/displayvideo_v1.rb
<displayvideo_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/displayvideo_v1.rb
conflict google/apis/displayvideo_v1/service.rb
force google/apis/displayvideo_v1/service.rb
conflict google/apis/displayvideo_v1/classes.rb
force google/apis/displayvideo_v1/classes.rb
conflict google/apis/displayvideo_v1/representations.rb
force google/apis/displayvideo_v1/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-10-31 02:20:00,676 synthtool [DEBUG] > Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/5274240a-feae-402a-a0d1-97d4066cae29/targets
- [ ] To automatically regenerate this PR, check this box.
2020-10-31 09:34:01 +00:00
|
|
|
# YYYY-MM-DD) - `warningMessages` - `flight.triggerId` Examples: * All line
|
|
|
|
# items under an insertion order: `insertionOrderId="1234"` * All `
|
|
|
|
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `
|
|
|
|
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=
|
|
|
|
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND
|
|
|
|
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight
|
|
|
|
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All
|
|
|
|
# line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
|
|
|
# warningMessages:"NO_VALID_CREATIVE"` The length of this field should be no
|
|
|
|
# more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
|
|
|
# default) * "entityStatus" * “flight.dateRange.endDate” 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListLineItemsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing line item. Returns the updated line item if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Output only. The unique ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Output only. The unique ID of the line item. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
|
|
|
command.request_object = line_item_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Assigns a targeting option to a line item. Returns the assigned targeting
|
|
|
|
# option if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item the assigned targeting option will belong to.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.request_object = assigned_targeting_option_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes an assigned targeting option from a line item.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item the assigned targeting option belongs to.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [String] assigned_targeting_option_id
|
|
|
|
# Required. The ID of the assigned targeting option to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a single targeting option assigned to a line item.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item the assigned targeting option belongs to.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [String] assigned_targeting_option_id
|
|
|
|
# Required. An identifier unique to the targeting type in this line item that
|
|
|
|
# identifies the assigned targeting option being requested.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists the targeting options assigned to a line item.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser the line item belongs to.
|
|
|
|
# @param [Fixnum] line_item_id
|
|
|
|
# Required. The ID of the line item to list assigned targeting options for.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of assigned targeting options to list.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
|
|
|
|
# AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
|
|
|
|
# assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
|
|
|
|
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
|
|
|
|
# OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
|
|
|
# more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Creates a new location list. Returns the newly created location list if
|
|
|
|
# successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::LocationList] location_list_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/locationLists', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
|
|
command.request_object = location_list_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-05-07 20:07:42 +00:00
|
|
|
# Gets a location list.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the fetched location list
|
|
|
|
# belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Required. The ID of the location list to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists location lists based on a given advertiser id.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the fetched location lists
|
|
|
|
# belong.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by location list fields. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
|
|
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
|
|
# locationType` Examples: * All regional location list: `locationType="
|
|
|
|
# TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `
|
|
|
|
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-07-21 00:38:15 +00:00
|
|
|
# Requested page size. Must be between `1` and `100`. Defaults to `100` if not
|
|
|
|
# set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListLocationListsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListLocationListsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/locationLists', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListLocationListsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Updates a location list. Returns the updated location list if successful.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. The ID of the DV360 advertiser to which the location lists belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Output only. The unique ID of the location list. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::LocationList] location_list_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::LocationList]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
|
|
command.request_object = location_list_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::LocationList
|
2020-05-07 20:07:42 +00:00
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
|
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Bulk edits multiple assignments between locations and a single location list.
|
2020-06-02 00:38:11 +00:00
|
|
|
# The operation will delete the assigned locations provided in
|
2020-07-21 00:38:15 +00:00
|
|
|
# BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create
|
|
|
|
# the assigned locations provided in BulkEditAssignedLocationsRequest.
|
|
|
|
# created_assigned_locations.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Required. The ID of the location list to which these assignments are assigned.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest] bulk_edit_assigned_locations_request_object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest::Representation
|
|
|
|
command.request_object = bulk_edit_assigned_locations_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse
|
2020-05-07 20:07:42 +00:00
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Creates an assignment between a location and a location list.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Required. The ID of the location list for which the assignment will be created.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::AssignedLocation] assigned_location_object
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedLocation] parsed result object
|
2020-05-28 00:38:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedLocation]
|
2020-05-28 00:38:07 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
|
|
|
|
command.request_object = assigned_location_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::AssignedLocation
|
2020-05-28 00:38:07 +00:00
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.params['locationListId'] = location_list_id unless location_list_id.nil?
|
2020-05-28 00:38:07 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Deletes the assignment between a location and a location list.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Required. The ID of the location list to which this assignment is assigned.
|
|
|
|
# @param [Fixnum] assigned_location_id
|
|
|
|
# Required. The ID of the assigned location to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists locations assigned to a location list.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the location list belongs.
|
|
|
|
# @param [Fixnum] location_list_id
|
|
|
|
# Required. The ID of the location list to which these assignments are assigned.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by location list assignment fields. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `assignedLocationId` The length of this field should be no more than
|
|
|
|
# 500 characters.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
feat: Automated regeneration of displayvideo v1 client (#1342)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-10-31 02:19:30,572 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-displayvideo-v1
nothing to commit, working tree clean
2020-10-31 02:19:30,601 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.47.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.0512
Installing mime-types-data 3.2020.0512
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=displayvideo.v1 --names-out=/workspace/api_names_out.yaml
Loading displayvideo, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/displayvideo.v1.json
conflict google/apis/displayvideo_v1.rb
<displayvideo_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/displayvideo_v1.rb
conflict google/apis/displayvideo_v1/service.rb
force google/apis/displayvideo_v1/service.rb
conflict google/apis/displayvideo_v1/classes.rb
force google/apis/displayvideo_v1/classes.rb
conflict google/apis/displayvideo_v1/representations.rb
force google/apis/displayvideo_v1/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-10-31 02:20:00,676 synthtool [DEBUG] > Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/5274240a-feae-402a-a0d1-97d4066cae29/targets
- [ ] To automatically regenerate this PR, check this box.
2020-10-31 09:34:01 +00:00
|
|
|
# Activates a manual trigger. Each activation of the manual trigger must be at
|
|
|
|
# least 5 minutes apart, otherwise an error will be returned.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
|
|
# @param [Fixnum] trigger_id
|
|
|
|
# Required. The ID of the manual trigger to activate.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::ActivateManualTriggerRequest] activate_manual_trigger_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ManualTrigger]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def activate_manual_trigger(advertiser_id, trigger_id, activate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::ActivateManualTriggerRequest::Representation
|
|
|
|
command.request_object = activate_manual_trigger_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger
|
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
|
|
command.params['triggerId'] = trigger_id unless trigger_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
|
|
|
|
|
|
|
|
# Creates a new manual trigger. Returns the newly created manual trigger if
|
|
|
|
# successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
|
|
# belongs to.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::ManualTrigger] manual_trigger_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ManualTrigger]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_advertiser_manual_trigger(advertiser_id, manual_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.request_object = manual_trigger_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger
|
|
|
|
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
|
|
|
|
|
|
|
|
# Deactivates a manual trigger.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
|
|
# @param [Fixnum] trigger_id
|
|
|
|
# Required. The ID of the manual trigger to deactivate.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::DeactivateManualTriggerRequest] deactivate_manual_trigger_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ManualTrigger]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def deactivate_manual_trigger(advertiser_id, trigger_id, deactivate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::DeactivateManualTriggerRequest::Representation
|
|
|
|
command.request_object = deactivate_manual_trigger_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger
|
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
|
|
command.params['triggerId'] = trigger_id unless trigger_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
|
|
|
|
|
|
|
|
# Gets a manual trigger.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser this manual trigger belongs to.
|
|
|
|
# @param [Fixnum] trigger_id
|
|
|
|
# Required. The ID of the manual trigger to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ManualTrigger]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_advertiser_manual_trigger(advertiser_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger
|
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
|
|
command.params['triggerId'] = trigger_id unless trigger_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
|
|
|
|
|
|
|
|
# Lists manual triggers that are accessible to the current user for a given
|
feat: Automated regeneration of displayvideo v1 client (#1512)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-11-14 02:12:49,040 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-displayvideo-v1
nothing to commit, working tree clean
2020-11-14 02:12:49,065 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.8
Installing tzinfo 1.2.8
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.49.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.0
Installing parallel 1.20.0
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=displayvideo.v1 --names-out=/workspace/api_names_out.yaml
Loading displayvideo, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/displayvideo.v1.json
conflict google/apis/displayvideo_v1.rb
<displayvideo_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/displayvideo_v1.rb
conflict google/apis/displayvideo_v1/service.rb
force google/apis/displayvideo_v1/service.rb
conflict google/apis/displayvideo_v1/classes.rb
force google/apis/displayvideo_v1/classes.rb
identical google/apis/displayvideo_v1/representations.rb
identical /workspace/api_names_out.yaml
2020-11-14 02:13:14,760 synthtool [DEBUG] > Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/29212574-cbbb-4b1e-a3d1-a48fbacb74be/targets
- [ ] To automatically regenerate this PR, check this box.
2020-11-14 10:26:02 +00:00
|
|
|
# advertiser ID. The order is defined by the order_by parameter. A single
|
feat: Automated regeneration of displayvideo v1 client (#1342)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-10-31 02:19:30,572 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-displayvideo-v1
nothing to commit, working tree clean
2020-10-31 02:19:30,601 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth displayvideo v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.47.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.0512
Installing mime-types-data 3.2020.0512
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=displayvideo.v1 --names-out=/workspace/api_names_out.yaml
Loading displayvideo, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/displayvideo.v1.json
conflict google/apis/displayvideo_v1.rb
<displayvideo_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/displayvideo_v1.rb
conflict google/apis/displayvideo_v1/service.rb
force google/apis/displayvideo_v1/service.rb
conflict google/apis/displayvideo_v1/classes.rb
force google/apis/displayvideo_v1/classes.rb
conflict google/apis/displayvideo_v1/representations.rb
force google/apis/displayvideo_v1/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-10-31 02:20:00,676 synthtool [DEBUG] > Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/displayvideo_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/5274240a-feae-402a-a0d1-97d4066cae29/targets
- [ ] To automatically regenerate this PR, check this box.
2020-10-31 09:34:01 +00:00
|
|
|
# advertiser_id is required.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser that the fetched manual triggers belong to.
|
|
|
|
# @param [String] filter
|
|
|
|
# Allows filtering by manual trigger properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
|
|
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
|
|
|
|
# displayName` - `state` Examples: * All active manual triggers under an
|
|
|
|
# advertiser: `state="ACTIVE"` The length of this field should be no more than
|
|
|
|
# 500 characters.
|
|
|
|
# @param [String] order_by
|
|
|
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
|
|
# default) * `state` The default sorting order is ascending. To specify
|
|
|
|
# descending order for a field, a suffix "desc" should be added to the field
|
|
|
|
# name. For example, `displayName desc`.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
|
|
|
# A token identifying a page of results the server should return. Typically,
|
|
|
|
# this is the value of next_page_token returned from the previous call to `
|
|
|
|
# ListManualTriggers` method. If not specified, the first page of results will
|
|
|
|
# be returned.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListManualTriggersResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListManualTriggersResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def list_advertiser_manual_triggers(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, 'v1/advertisers/{+advertiserId}/manualTriggers', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListManualTriggersResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ListManualTriggersResponse
|
|
|
|
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
|
|
|
|
|
|
|
|
# Updates a manual trigger. Returns the updated manual trigger if successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
|
|
# belongs to.
|
|
|
|
# @param [Fixnum] trigger_id
|
|
|
|
# Output only. The unique ID of the manual trigger.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::ManualTrigger] manual_trigger_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ManualTrigger]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def patch_advertiser_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.request_object = manual_trigger_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger
|
|
|
|
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
|
|
|
command.params['triggerId'] = trigger_id unless trigger_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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Creates a new negative keyword list. Returns the newly created negative
|
|
|
|
# keyword list if successful.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
2020-07-21 00:38:15 +00:00
|
|
|
# will belong.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
|
|
command.request_object = negative_keyword_list_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Deletes a negative keyword list given an advertiser ID and a negative keyword
|
|
|
|
# list ID.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
|
|
# belongs.
|
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the negative keyword list to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a negative keyword list given an advertiser ID and a negative keyword
|
|
|
|
# list ID.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# list belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the negative keyword list to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists negative keyword lists based on a given advertiser id.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the fetched negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# lists belong.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-07-21 00:38:15 +00:00
|
|
|
# Requested page size. Must be between `1` and `100`. Defaults to `100` if not
|
|
|
|
# set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates a negative keyword list. Returns the updated negative keyword list if
|
|
|
|
# successful.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the negative keyword list
|
|
|
|
# belongs.
|
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Output only. The unique ID of the negative keyword list. Assigned by the
|
|
|
|
# system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
|
|
command.request_object = negative_keyword_list_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# list belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the parent negative keyword list to which the negative
|
2020-07-21 00:38:15 +00:00
|
|
|
# keywords belong.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest] bulk_edit_negative_keywords_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest::Representation
|
|
|
|
command.request_object = bulk_edit_negative_keywords_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Creates a negative keyword in a negative keyword list.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# list belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the parent negative keyword list in which the negative
|
2020-07-21 00:38:15 +00:00
|
|
|
# keyword will be created.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Google::Apis::DisplayvideoV1::NegativeKeyword] negative_keyword_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeyword] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::NegativeKeyword]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
|
|
|
command.request_object = negative_keyword_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes a negative keyword from a negative keyword list.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# list belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the parent negative keyword list to which the negative
|
2020-07-21 00:38:15 +00:00
|
|
|
# keyword belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] keyword_value
|
|
|
|
# Required. The keyword value of the negative keyword to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists negative keywords in a negative keyword list.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
2020-07-21 00:38:15 +00:00
|
|
|
# list belongs.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] negative_keyword_list_id
|
|
|
|
# Required. The ID of the parent negative keyword list to which the requested
|
2020-07-21 00:38:15 +00:00
|
|
|
# negative keywords belong.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by negative keyword fields. Supported syntax: * Filter
|
|
|
|
# expressions for negative keyword currently can only contain at most one *
|
|
|
|
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
|
|
# The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue`
|
|
|
|
# Examples: * All negative keywords for which the keyword value contains "google"
|
|
|
|
# : `keywordValue : "google"`
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Assigns a targeting option to an advertiser. Returns the assigned targeting
|
|
|
|
# option if successful.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.request_object = assigned_targeting_option_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes an assigned targeting option from an advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [String] assigned_targeting_option_id
|
|
|
|
# Required. The ID of the assigned targeting option to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a single targeting option assigned to an advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option.
|
|
|
|
# @param [String] assigned_targeting_option_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. An identifier unique to the targeting type in this advertiser that
|
|
|
|
# identifies the assigned targeting option being requested.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists the targeting options assigned to an advertiser.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The ID of the advertiser.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of assigned targeting options to list.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
|
|
|
|
# ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
|
|
|
|
# be no more than 500 characters.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a combined audience.
|
|
|
|
# @param [Fixnum] combined_audience_id
|
|
|
|
# Required. The ID of the combined audience to fetch.
|
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched combined audience.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that has access to the fetched combined audience.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::CombinedAudience] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::CombinedAudience]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/combinedAudiences/{+combinedAudienceId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::CombinedAudience::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Lists combined audiences. The order is defined by the order_by parameter.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched combined audiences.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by combined audience fields. Supported syntax: * Filter
|
|
|
|
# expressions for combined audiences currently can only contain at most one
|
|
|
|
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
|
|
# The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
|
|
|
|
# Examples: * All combined audiences for which the display name contains "Google"
|
|
|
|
# : `displayName : "Google"`. The length of this field should be no more than
|
|
|
|
# 500 characters.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that has access to the fetched combined audiences.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/combinedAudiences', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-07-29 00:37:55 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Gets a custom bidding algorithm.
|
|
|
|
# @param [Fixnum] custom_bidding_algorithm_id
|
|
|
|
# Required. The ID of the custom bidding algorithm to fetch.
|
|
|
|
# @param [Fixnum] advertiser_id
|
2020-08-08 00:38:23 +00:00
|
|
|
# The ID of the DV360 partner that has access to the custom bidding algorithm.
|
2020-07-29 00:37:55 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-08-08 00:38:23 +00:00
|
|
|
# The ID of the DV360 partner that has access to the custom bidding algorithm.
|
2020-07-29 00:37:55 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::CustomBiddingAlgorithm] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::CustomBiddingAlgorithm]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::CustomBiddingAlgorithm::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [Fixnum] advertiser_id
|
2020-08-08 00:38:23 +00:00
|
|
|
# The ID of the DV360 advertiser that has access to the custom bidding algorithm.
|
2020-07-29 00:37:55 +00:00
|
|
|
# @param [String] filter
|
|
|
|
# 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 operator must
|
|
|
|
# be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for
|
|
|
|
# the following field: - `displayName` * The operator must be `EQUALS (=)` for
|
|
|
|
# the following field: - `customBiddingAlgorithmType` * For `displayName`, the
|
|
|
|
# value is a string. We return all custom bidding algorithms whose display_name
|
|
|
|
# contains such string. * For `customBiddingAlgorithmType`, the value is a
|
|
|
|
# string. We return all algorithms whose custom_bidding_algorithm_type is equal
|
|
|
|
# to the given type. 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.
|
|
|
|
# @param [String] order_by
|
|
|
|
# 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`.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# 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.
|
|
|
|
# @param [String] page_token
|
|
|
|
# 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.
|
|
|
|
# @param [Fixnum] partner_id
|
2020-08-08 00:38:23 +00:00
|
|
|
# The ID of the DV360 partner that has access to the custom bidding algorithm.
|
2020-07-29 00:37:55 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomBiddingAlgorithmsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListCustomBiddingAlgorithmsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/customBiddingAlgorithms', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListCustomBiddingAlgorithmsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-06-02 00:38:11 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Gets a custom list.
|
|
|
|
# @param [Fixnum] custom_list_id
|
|
|
|
# Required. The ID of the custom list to fetch.
|
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::CustomList] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::CustomList]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/customLists/{+customListId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Lists custom lists. The order is defined by the order_by parameter.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by custom list fields. Supported syntax: * Filter expressions
|
|
|
|
# for custom lists currently can only contain at most one restriction. * A
|
|
|
|
# restriction has the form of ``field` `operator` `value``. * The operator must
|
|
|
|
# be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom
|
|
|
|
# lists for which the display name contains "Google": `displayName : "Google"`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# The length of this field should be no more than 500 characters.
|
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomListsResponse] parsed result object
|
2020-05-28 00:38:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListCustomListsResponse]
|
2020-05-28 00:38:07 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/customLists', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-05-28 00:38:07 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Gets a first and third party audience.
|
|
|
|
# @param [Fixnum] first_and_third_party_audience_id
|
|
|
|
# Required. The ID of the first and third party audience to fetch.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched first and third party
|
|
|
|
# audience.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that has access to the fetched first and third party
|
|
|
|
# audience.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] parsed result object
|
2020-05-28 00:38:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience]
|
2020-05-28 00:38:07 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-05-28 00:38:07 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Lists first and third party audiences. The order is defined by the order_by
|
|
|
|
# parameter.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched first and third party
|
|
|
|
# audiences.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by first and third party audience fields. Supported syntax: *
|
|
|
|
# Filter expressions for first and third party audiences currently can only
|
|
|
|
# contain at most one restriction. * A restriction has the form of ``field` `
|
|
|
|
# operator` `value``. * The operator must be `CONTAINS (:)`. * Supported fields:
|
|
|
|
# - `displayName` Examples: * All 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.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that has access to the fetched first and third party
|
|
|
|
# audiences.
|
2020-05-28 00:38:07 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] parsed result object
|
2020-05-28 00:38:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse]
|
2020-05-28 00:38:07 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/firstAndThirdPartyAudiences', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse
|
|
|
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-05-28 00:38:07 +00:00
|
|
|
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?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2020-05-28 00:38:07 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Gets a Floodlight group.
|
|
|
|
# @param [Fixnum] floodlight_group_id
|
|
|
|
# Required. The ID of the Floodlight group to fetch.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The partner context by which the Floodlight group is being accessed.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/floodlightGroups/{+floodlightGroupId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an existing Floodlight group. Returns the updated Floodlight group if
|
|
|
|
# successful.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] floodlight_group_id
|
|
|
|
# Output only. The unique ID of the Floodlight group. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The partner context by which the Floodlight group is being accessed.
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/floodlightGroups/{floodlightGroupId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
|
|
command.request_object = floodlight_group_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a Google audience.
|
|
|
|
# @param [Fixnum] google_audience_id
|
|
|
|
# Required. The ID of the Google audience to fetch.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched Google audience.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# The ID of the partner that has access to the fetched Google audience.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::GoogleAudience] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::GoogleAudience]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/googleAudiences/{+googleAudienceId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::GoogleAudience
|
|
|
|
command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Lists Google audiences. The order is defined by the order_by parameter.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# The ID of the advertiser that has access to the fetched Google audiences.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by Google audience fields. Supported syntax: * Filter
|
|
|
|
# expressions for Google audiences currently can only contain at most one
|
|
|
|
# restriction. * A restriction has the form of ``field` `operator` `value``. *
|
|
|
|
# The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
|
|
|
|
# Examples: * All Google audiences for which the display name contains "Google":
|
|
|
|
# `displayName : "Google"`. The length of this field should be no more than 500
|
|
|
|
# characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# The ID of the partner that has access to the fetched Google audiences.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/googleAudiences', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Creates a new inventory source group. Returns the newly created inventory
|
|
|
|
# source group if successful.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that owns the inventory source group. The parent
|
|
|
|
# partner will not have access to this group.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
|
|
command.request_object = inventory_source_group_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Deletes an inventory source group.
|
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Required. The ID of the inventory source group to delete.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that owns the inventory source group. The parent
|
|
|
|
# partner does not have access to this group.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that owns the inventory source group. Only this partner
|
|
|
|
# has write access to this group.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.query['partnerId'] = partner_id unless partner_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Gets an inventory source group.
|
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Required. The ID of the inventory source group to fetch.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that has access to the inventory source group. A partner
|
|
|
|
# cannot access an advertiser-owned inventory source group.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Lists inventory source groups that are accessible to the current user. The
|
|
|
|
# order is defined by the order_by parameter.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by inventory source group properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `inventorySourceGroupId` The length of this field should be no more
|
|
|
|
# than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-06-02 00:38:11 +00:00
|
|
|
# default to `100`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that has access to the inventory source group. A partner
|
|
|
|
# cannot access advertiser-owned inventory source groups.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Updates an inventory source group. Returns the updated inventory source group
|
|
|
|
# if successful.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Output only. The unique ID of the inventory source group. Assigned by the
|
|
|
|
# system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
|
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that owns the inventory source group. The parent
|
|
|
|
# partner does not have access to this group.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that owns the inventory source group. Only this partner
|
|
|
|
# has write access to this group.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{inventorySourceGroupId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
|
|
command.request_object = inventory_source_group_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
|
|
|
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Bulk edits multiple assignments between inventory sources and a single
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Required. The ID of the inventory source group to which the assignments are
|
|
|
|
# assigned.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest] bulk_edit_assigned_inventory_sources_request_object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest::Representation
|
|
|
|
command.request_object = bulk_edit_assigned_inventory_sources_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Creates an assignment between an inventory source and an inventory source
|
|
|
|
# group.
|
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Required. The ID of the inventory source group to which the assignment will be
|
|
|
|
# assigned.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::AssignedInventorySource] assigned_inventory_source_object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that owns the parent inventory source group. The
|
|
|
|
# parent partner will not have access to this assigned inventory source.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that owns the parent inventory source group. Only this
|
|
|
|
# partner will have write access to this assigned inventory source.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedInventorySource] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedInventorySource]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation
|
|
|
|
command.request_object = assigned_inventory_source_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::AssignedInventorySource
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Deletes the assignment between an inventory source and an inventory source
|
|
|
|
# group.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] inventory_source_group_id
|
2020-06-02 00:38:11 +00:00
|
|
|
# Required. The ID of the inventory source group to which this assignment is
|
|
|
|
# assigned.
|
|
|
|
# @param [Fixnum] assigned_inventory_source_id
|
|
|
|
# Required. The ID of the assigned inventory source to delete.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the advertiser that owns the parent inventory source group. The
|
|
|
|
# parent partner does not have access to this assigned inventory source.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# The ID of the partner that owns the parent inventory source group. Only this
|
|
|
|
# partner has write access to this assigned inventory source.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::Empty
|
2020-05-07 20:07:42 +00:00
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-06-02 00:38:11 +00:00
|
|
|
command.params['assignedInventorySourceId'] = assigned_inventory_source_id unless assigned_inventory_source_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
2020-06-02 00:38:11 +00:00
|
|
|
# Lists inventory sources assigned to an inventory source group.
|
|
|
|
# @param [Fixnum] inventory_source_group_id
|
|
|
|
# Required. The ID of the inventory source group to which these assignments are
|
|
|
|
# assigned.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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 logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `assignedInventorySourceId` The length of this field should be no
|
|
|
|
# more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2020-06-02 00:38:11 +00:00
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse] parsed result object
|
2020-05-07 20:07:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
2020-06-02 00:38:11 +00:00
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse]
|
2020-05-07 20:07:42 +00:00
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-06-02 00:38:11 +00:00
|
|
|
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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse
|
|
|
|
command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
|
2020-05-07 20:07:42 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# Gets an inventory source.
|
|
|
|
# @param [Fixnum] inventory_source_id
|
|
|
|
# Required. The ID of the inventory source to fetch.
|
|
|
|
# @param [Fixnum] partner_id
|
2020-07-21 00:38:15 +00:00
|
|
|
# Required. The ID of the DV360 partner to which the fetched inventory source is
|
|
|
|
# permissioned.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::InventorySource]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/inventorySources/{+inventorySourceId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::InventorySource
|
|
|
|
command.params['inventorySourceId'] = inventory_source_id unless inventory_source_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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that has access to the inventory source.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by inventory source properties. Supported syntax: * Filter
|
|
|
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
|
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
|
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
|
|
# value``. * The operator must be `EQUALS (=)`. * Supported fields: - `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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that has access to the inventory source.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/inventorySources', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-02-28 00:38:47 +00:00
|
|
|
# Downloads media. Download is supported on the URI `/download/`resource_name=**`
|
2020-07-21 00:38:15 +00:00
|
|
|
# ?alt=media.` **Note**: Download requests will not be successful without
|
|
|
|
# including `alt=media` query string.
|
2020-02-28 00:38:47 +00:00
|
|
|
# @param [String] resource_name
|
2020-07-21 00:38:15 +00:00
|
|
|
# Name of the media that is being downloaded. See ReadRequest.resource_name.
|
2020-02-28 00:38:47 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [IO, String] download_dest
|
|
|
|
# IO stream or filename to receive content download
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::GoogleBytestreamMedia]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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::DisplayvideoV1::GoogleBytestreamMedia::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-25 00:38:17 +00:00
|
|
|
# Bulk edits targeting options under a single partner. The operation will delete
|
|
|
|
# the assigned targeting options provided in
|
2020-08-08 00:38:23 +00:00
|
|
|
# BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create
|
2020-07-25 00:38:17 +00:00
|
|
|
# the assigned targeting options provided in
|
2020-08-08 00:38:23 +00:00
|
|
|
# BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .
|
2020-07-25 00:38:17 +00:00
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsRequest] bulk_edit_partner_assigned_targeting_options_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def bulk_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, 'v1/partners/{+partnerId}:bulkEditPartnerAssignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
|
|
|
|
command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a partner.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Partner] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Partner]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/partners/{+partnerId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Partner::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists partners that are accessible to the current user. The order is defined
|
|
|
|
# by the order_by parameter.
|
|
|
|
# @param [String] filter
|
|
|
|
# Allows filtering by partner properties. Supported syntax: * Filter expressions
|
|
|
|
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
|
|
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
|
|
# AND`. * A restriction has the form of ``field` `operator` `value``. * The
|
|
|
|
# operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: *
|
|
|
|
# All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
|
|
|
|
# field should be no more than 500 characters.
|
|
|
|
# @param [String] order_by
|
|
|
|
# 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`.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
|
|
|
# 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.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListPartnersResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListPartnersResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListPartnersResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-06-24 00:38:30 +00:00
|
|
|
# Creates a new channel. Returns the newly created channel if successful.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the created channel.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the created channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/channels', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.request_object = channel_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-05-07 20:07:42 +00:00
|
|
|
# Gets a channel for a partner or advertiser.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the fetched channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the channel to fetch.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the fetched channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists channels for a partner or advertiser.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the channels.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the channels.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
|
|
# channel currently can only contain at most one * restriction. * A restriction
|
|
|
|
# has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
|
|
|
|
# (:)`. * Supported fields: - `displayName` Examples: * All channels for which
|
|
|
|
# the display name contains "google": `displayName : "google"`. The length of
|
|
|
|
# this field should be no more than 500 characters.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/channels', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-06-02 00:38:11 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Updates a channel. Returns the updated channel if successful.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the created channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Output only. The unique ID of the channel. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Channel] channel_object
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the created channel.
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Channel]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/channels/{channelId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.request_object = channel_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# Bulk edits sites under a single channel. The operation will delete the sites
|
|
|
|
# provided in BulkEditSitesRequest.deleted_sites and then create the sites
|
2020-06-02 00:38:11 +00:00
|
|
|
# provided in BulkEditSitesRequest.created_sites.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the sites belong.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation
|
|
|
|
command.request_object = bulk_edit_sites_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Creates a site in a channel.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel in which the site will be created.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::Site] site_object
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Site] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Site]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{partnerId}/channels/{+channelId}/sites', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
|
|
command.request_object = site_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes a site from a channel.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the site belongs.
|
|
|
|
# @param [String] url_or_app_id
|
|
|
|
# Required. The URL or app ID of the site to delete.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists sites in a channel.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# The ID of the partner that owns the parent channel.
|
|
|
|
# @param [Fixnum] channel_id
|
|
|
|
# Required. The ID of the parent channel to which the requested sites belong.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# The ID of the advertiser that owns the parent channel.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
|
|
# site currently can only contain at most one * restriction. * A restriction has
|
|
|
|
# the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
|
|
|
|
# . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
|
|
|
|
# or app ID contains "google": `urlOrAppId : "google"`
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-06-02 00:38:11 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListSitesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListSitesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/channels/{+channelId}/sites', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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?
|
2020-05-07 20:07:42 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-07-25 00:38:17 +00:00
|
|
|
# Assigns a targeting option to a partner. Returns the assigned targeting option
|
|
|
|
# if successful.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option. Supported
|
|
|
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.request_object = assigned_targeting_option_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Deletes an assigned targeting option from a partner.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option. Supported
|
|
|
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
|
|
# @param [String] assigned_targeting_option_id
|
|
|
|
# Required. The ID of the assigned targeting option to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a single targeting option assigned to a partner.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of this assigned targeting option. Supported
|
|
|
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
|
|
# @param [String] assigned_targeting_option_id
|
|
|
|
# Required. An identifier unique to the targeting type in this partner that
|
|
|
|
# identifies the assigned targeting option being requested.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists the targeting options assigned to a partner.
|
|
|
|
# @param [Fixnum] partner_id
|
|
|
|
# Required. The ID of the partner.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. Identifies the type of assigned targeting options to list. Supported
|
|
|
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
|
|
# @param [String] filter
|
|
|
|
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
|
|
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
|
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
|
|
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
|
|
|
# fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
|
|
|
|
# ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
|
|
|
|
# be no more than 500 characters.
|
|
|
|
# @param [String] order_by
|
|
|
|
# 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`.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# 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.
|
|
|
|
# @param [String] page_token
|
|
|
|
# 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.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-02-28 00:38:47 +00:00
|
|
|
# @param [Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest] create_sdf_download_task_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/sdfdownloadtasks', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest::Representation
|
|
|
|
command.request_object = create_sdf_download_task_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Operation::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::Operation
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Gets the latest state of an asynchronous SDF download task operation. Clients
|
|
|
|
# should poll this method at intervals of 30 seconds.
|
|
|
|
# @param [String] name
|
|
|
|
# The name of the operation resource.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Operation] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Operation]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Operation::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
2020-05-07 20:07:42 +00:00
|
|
|
|
|
|
|
# Gets a single targeting option.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. The type of targeting option to retrieve.
|
|
|
|
# @param [String] targeting_option_id
|
|
|
|
# Required. The ID of the of targeting option to retrieve.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The Advertiser this request is being made in the context of.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::TargetingOption] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::TargetingOption]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::TargetingOption::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Lists targeting options of a given type.
|
|
|
|
# @param [String] targeting_type
|
|
|
|
# Required. The type of targeting option to be listed.
|
|
|
|
# @param [Fixnum] advertiser_id
|
|
|
|
# Required. The Advertiser this request is being made in the context of.
|
|
|
|
# @param [String] filter
|
2020-07-21 00:38:15 +00:00
|
|
|
# Allows filtering by targeting option properties. 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``. * The operator must be "=" (equal sign). * Supported
|
2020-10-16 00:39:01 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] order_by
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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`.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
2020-07-21 00:38:15 +00:00
|
|
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
|
|
# specified.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] page_token
|
2020-07-21 00:38:15 +00:00
|
|
|
# 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.
|
2020-05-07 20:07:42 +00:00
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/targetingTypes/{+targetingType}/targetingOptions', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
2020-07-25 00:38:17 +00:00
|
|
|
|
|
|
|
# Bulk edits user roles for a user. The operation will delete the assigned user
|
2020-08-08 00:38:23 +00:00
|
|
|
# roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles
|
2020-07-25 00:38:17 +00:00
|
|
|
# and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
|
2020-08-08 00:38:23 +00:00
|
|
|
# createdAssignedUserRoles.
|
2020-07-25 00:38:17 +00:00
|
|
|
# @param [Fixnum] user_id
|
|
|
|
# Required. The ID of the user to which the assigned user roles belong.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/users/{+userId}:bulkEditAssignedUserRoles', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest::Representation
|
|
|
|
command.request_object = bulk_edit_assigned_user_roles_request_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Creates a new user. Returns the newly created user if successful.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::User]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:post, 'v1/users', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
|
|
command.request_object = user_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::User
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Deletes a user.
|
|
|
|
# @param [Fixnum] user_id
|
|
|
|
# Required. The ID of the user to delete.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:delete, 'v1/users/{+userId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Gets a user.
|
|
|
|
# @param [Fixnum] user_id
|
|
|
|
# Required. The ID of the user to fetch.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::User]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:get, 'v1/users/{+userId}', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
# @param [String] filter
|
|
|
|
# Allows filtering by user properties. 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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator
|
|
|
|
# must be `CONTAINS (:)` for the following fields: - `displayName` - `email` *
|
|
|
|
# The operator must be `EQUALS (=)` for the following fields: - `
|
|
|
|
# assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.
|
|
|
|
# advertiserId` - `assignedUserRole.entityType`: A 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`: A synthetic field of AssignedUserRole used
|
|
|
|
# for filtering. Identifies the parent partner of the entity to which the user
|
|
|
|
# role is assigned." 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"` The length of this field should be no more than 500
|
|
|
|
# characters.
|
|
|
|
# @param [String] order_by
|
|
|
|
# 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`.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# Requested page size. Must be between `1` and `100`. If unspecified will
|
|
|
|
# default to `100`.
|
|
|
|
# @param [String] page_token
|
|
|
|
# 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.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::ListUsersResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::ListUsersResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
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, 'v1/users', options)
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::ListUsersResponse::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
|
|
|
|
|
|
|
# Updates an existing user. Returns the updated user if successful.
|
|
|
|
# @param [Fixnum] user_id
|
|
|
|
# Output only. The unique ID of the user. Assigned by the system.
|
|
|
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
|
|
|
# @param [String] update_mask
|
|
|
|
# Required. The mask to control which fields to update.
|
|
|
|
# @param [String] fields
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
# @param [String] quota_user
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::DisplayvideoV1::User] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::DisplayvideoV1::User]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
command = make_simple_command(:patch, 'v1/users/{+userId}', options)
|
|
|
|
command.request_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
|
|
command.request_object = user_object
|
|
|
|
command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
|
|
|
|
command.response_class = Google::Apis::DisplayvideoV1::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
|
2020-02-28 00:38:47 +00:00
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
|
|
|
command.query['key'] = key unless key.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|